{"items":[{"type":"link","label":"API Reference","link":"/v1-api-reference/api","routeSlug":"/v1-api-reference/api","content":{"contentType":"overview","meta":{"name":"API Reference"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api.json","url":"/_bundle/v1-api-reference/api.json?download"},{"kind":"download","label":"api.yaml","url":"/_bundle/v1-api-reference/api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"docs@zuora.com","label":"docs@zuora.com","withCopyButton":true,"copyContent":"docs@zuora.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"cURL","lang":"curl"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"API Reference (2026-10-16)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome to the v1 API reference for the Zuora Billing, Payments, and Platform!"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are new to the Zuora API, start with our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/get-started/introduction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get started"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide to make your first call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To learn about the common use cases of the Zuora v1 API, check out the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/get-started/tutorials/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Tutorials"},"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":"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 API Reference only showcases the parameters, fields, and behaviors available for the latest API minor version ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-08-12"},"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 about Zuora API versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"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":"We recommend that you upgrade to the latest API version to take advantage of the latest Zuora capabilities."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For instructions about upgrading the API version, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrade-guide/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrade guide"},"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":"Try the v1 API in our Postman collection:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://god.gw.postman.com/run-collection/931729-e324e9d4-9443-4759-8862-a25aa186dbbd?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D931729-e324e9d4-9443-4759-8862-a25aa186dbbd%26entityType%3Dcollection%26workspaceId%3D96800895-4ec5-4a21-af99-d701ba81924e"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"img","attrs":{"src":"https://run.pstmn.io/button.svg","alt":"Run In Postman","style":{"width":"128px","height":"32px"}}},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some of our older APIs are no longer recommended but still available, not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"affecting any existing integration. To find related API documentation, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/older-api/overview/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Older API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference"},"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 4-byte UTF-8 characters are not supported for text fields, such as the account names or bill-to contacts' first and last names."},"children":[]}]}]}]}],"sectionId":"/v1-api-reference/api"}],"sectionId":"/v1-api-reference/api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/more-openapi-specification-options"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More OpenAPI specification options"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To support your integration with our OpenAPI specifications, whether using in-house solutions or third-party tools, we provide the following resources:"},"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":"Order-to-Cash operations (detailed)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Download "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/yaml/apis/zuora-openapi-for-otc.yaml","download":""}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order-to-Cash OpenAPI spec"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which includes full descriptions and examples"},"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":"Order-to-Cash operations (compact)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Download "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/yaml/apis/zuora-openapi-for-otc-compact.yaml","download":""}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order-to-Cash Compact OpenAPI spec"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which excludes descriptions and code examples."},"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":"Full OpenAPI spec (compact)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Download "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/yaml/apis/zuora-openapi-full-compact.yaml","download":""}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compact OpenAPI Spec"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which covers the entire API set without descriptions or samples."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need a different API specification beyond the options above, contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and we will provide a custom spec tailored to your needs."},"children":[]}]}]}]}],"sectionId":"/v1-api-reference/api/section/more-openapi-specification-options"}]}]}},{"type":"link","label":"More OpenAPI specification options","link":"/v1-api-reference/api/section/more-openapi-specification-options","routeSlug":"/v1-api-reference/api/section/more-openapi-specification-options","content":null},{"type":"separator","label":"Authentication","content":null},{"type":"group","label":"OAuth","link":"/v1-api-reference/api/oauth","routeSlug":"/v1-api-reference/api/oauth","items":[{"label":"Create an OAuth token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/oauth/createtoken","routeSlug":"/v1-api-reference/api/oauth/createtoken","metadata":{"seo":{"title":"Create an OAuth token","description":"Creates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must have been created using the Zuora UI. See Authentication for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createToken","name":"Create an OAuth token","isWebhook":false,"pointer":"/paths/~1oauth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an OAuth 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 bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must have been created using the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/rest-api/general-concepts/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":" When using this operation, do not set any authentication headers such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiAccessKeyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecretAccessKey"},"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":"You should not use this operation to generate a large number of bearer tokens in a short period of time; each token should be used until it expires. If you receive a 429 Too Many Requests response when using this operation, reduce the frequency of requests. This endpoint is rate limited by IP address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the rate limit information of authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate and concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be a 36-character UUID that contains hyphens("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"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 your entity ID is not a valid UUID, convert it to a valid UUID before specifying this parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1oauth~1token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_2"}},"schemaId":"schema_2","pointer":"/paths/~1oauth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oauth/token","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"example":"11e643f4-a3ee-8bad-b061-0025904c756d","schemaId":"schema_1"}],"cookie":[]},"security":[],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_2"}},"responseCodes":["200","429"],"pointer":"/oauth/token","href":"oauth/createtoken","openApiOperationId":"createToken","summary":"Create an OAuth token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_2","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tokenResponse","exampleIds":["paths/~1oauth~1token/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/tokenResponse","exampleIds":["paths/~1oauth~1token/post/responses/200/content/application~1json/examples/response"],"headers":{"X-RateLimit-Limit-minute":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate limit of this operation, in requests per minute. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"integer"}},"X-RateLimit-Remaining-minute":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests that you may make in the next minute. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"integer"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_3"},{"code":"429","description":"Too Many Requests","headers":{"X-RateLimit-Limit-minute":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate limit of this operation, in requests per minute. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"integer"}},"X-RateLimit-Remaining-minute":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests that you may make in the next minute. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"integer"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_3"}],"pointer":"/paths/~1oauth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/tokenResponse","exampleIds":["paths/~1oauth~1token/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tokenResponse","exampleIds":["paths/~1oauth~1token/post/responses/200/content/application~1json/examples/response"]}}},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauth/createtoken"}],"panels":[]}]},"httpPath":"/oauth/token"}],"content":{"contentType":"group","meta":{"name":"OAuth"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OAuth","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":"Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must first create an OAuth client in the Zuora UI before using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to create an OAuth token. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/rest-api/general-concepts/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/oauth/token","summary":"Create an OAuth token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/oauth/createtoken","deprecated":false}]}]}]}]}},{"type":"separator","label":"Commerce","content":null},{"type":"group","label":"Commerce","link":"/v1-api-reference/api/commerce","routeSlug":"/v1-api-reference/api/commerce","items":[{"label":"Create a billable metric","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createbillablemetric","routeSlug":"/v1-api-reference/api/commerce/createbillablemetric","metadata":{"seo":{"title":"Create a billable metric","description":"Creates a billable metric that numbered metered features can use to measure entitlement usage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBillableMetric","name":"Create a billable metric","isWebhook":false,"pointer":"/paths/~1commerce~1billable-metrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a billable metric","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a billable metric that numbered metered features can use to measure entitlement usage.\n\nSpecify the event types to process, the aggregation method, optional filters, computed\nproperties, and group keys that calculate the metric separately for a subscription, model,\nor another dimension.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1billable-metrics/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBillableMetricRequest","exampleIds":["paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/entitlementMetric","paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/billableMetric","paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/percentileMetric"]}},"schemaId":"components/schemas/CreateBillableMetricRequest","exampleIds":["paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/entitlementMetric","paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/billableMetric","paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/percentileMetric"],"pointer":"/paths/~1commerce~1billable-metrics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/billable-metrics","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateBillableMetricRequest","exampleIds":["paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/entitlementMetric","paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/billableMetric","paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/percentileMetric"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/billable-metrics","href":"commerce/createbillablemetric","openApiOperationId":"createBillableMetric","summary":"Create a billable metric"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateBillableMetricRequest","exampleIds":["paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/entitlementMetric","paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/billableMetric","paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/percentileMetric"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBillableMetricRequest","exampleIds":["paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/entitlementMetric","paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/billableMetric","paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/percentileMetric"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1commerce~1billable-metrics/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1billable-metrics/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/createbillablemetric"}],"panels":[]}]},"httpPath":"/commerce/billable-metrics"},{"label":"List billable metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getbillablemetrics","routeSlug":"/v1-api-reference/api/commerce/getbillablemetrics","metadata":{"seo":{"title":"List billable metrics","description":"Lists billable metrics that numbered metered features can use to measure entitlement usage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillableMetrics","name":"List billable metrics","isWebhook":false,"pointer":"/paths/~1commerce~1billable-metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List billable metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists billable metrics that numbered metered features can use to measure entitlement usage.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagination.page_size","in":"query","schemaId":"schema_7","description":"Number of billable metrics returned per page."}],"pointer":"/paths/~1commerce~1billable-metrics/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1billable-metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commerce/billable-metrics","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pagination.page_size","in":"query","required":false,"schemaId":"schema_7"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/commerce/billable-metrics","href":"commerce/getbillablemetrics","openApiOperationId":"getBillableMetrics","summary":"List billable metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillableMetricsResponse","exampleIds":["paths/~1commerce~1billable-metrics/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListBillableMetricsResponse","exampleIds":["paths/~1commerce~1billable-metrics/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1billable-metrics/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBillableMetricsResponse","exampleIds":["paths/~1commerce~1billable-metrics/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillableMetricsResponse","exampleIds":["paths/~1commerce~1billable-metrics/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/getbillablemetrics"}],"panels":[]}]},"httpPath":"/commerce/billable-metrics"},{"label":"Retrieve a billable metric","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getbillablemetric","routeSlug":"/v1-api-reference/api/commerce/getbillablemetric","metadata":{"seo":{"title":"Retrieve a billable metric","description":"Retrieves a billable metric by its unique identifier or metric number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillableMetric","name":"Retrieve a billable metric","isWebhook":false,"pointer":"/paths/~1commerce~1billable-metrics~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a billable metric","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a billable metric by its unique identifier or metric number.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Unique identifier or metric number of the billable metric.","required":true}],"pointer":"/paths/~1commerce~1billable-metrics~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1billable-metrics~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commerce/billable-metrics/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/commerce/billable-metrics/{id}","href":"commerce/getbillablemetric","openApiOperationId":"getBillableMetric","summary":"Retrieve a billable metric"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1billable-metrics~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/getbillablemetric"}],"panels":[]}]},"httpPath":"/commerce/billable-metrics/{id}"},{"label":"Update a billable metric","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updatebillablemetric","routeSlug":"/v1-api-reference/api/commerce/updatebillablemetric","metadata":{"seo":{"title":"Update a billable metric","description":"Updates an existing billable metric. Use this operation to change fields such as name,description, filters, computed_properties, and group_keys. Include metric_keyin the request body to identify the metric."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBillableMetric","name":"Update a billable metric","isWebhook":false,"pointer":"/paths/~1commerce~1billable-metrics~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a billable metric","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 an existing billable metric. Use this operation to change fields such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"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":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"computed_properties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group_keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metric_key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the request body to identify the metric."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Unique identifier or metric number of the billable metric.","required":true}],"pointer":"/paths/~1commerce~1billable-metrics~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1billable-metrics~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/UpdateBillableMetricRequest","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateBillableMetricRequest","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1commerce~1billable-metrics~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/commerce/billable-metrics/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateBillableMetricRequest","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/billable-metrics/{id}","href":"commerce/updatebillablemetric","openApiOperationId":"updateBillableMetric","summary":"Update a billable metric"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateBillableMetricRequest","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBillableMetricRequest","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1billable-metrics~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/put/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/updatebillablemetric"}],"panels":[]}]},"httpPath":"/commerce/billable-metrics/{id}"},{"label":"Delete a billable metric","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/deletebillablemetric","routeSlug":"/v1-api-reference/api/commerce/deletebillablemetric","metadata":{"seo":{"title":"Delete a billable metric","description":"Deletes a billable metric by its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBillableMetric","name":"Delete a billable metric","isWebhook":false,"pointer":"/paths/~1commerce~1billable-metrics~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a billable metric","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a billable metric by its unique identifier.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Unique identifier or metric number of the billable metric.","required":true}],"pointer":"/paths/~1commerce~1billable-metrics~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1billable-metrics~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/commerce/billable-metrics/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204","400","401","500"],"pointer":"/commerce/billable-metrics/{id}","href":"commerce/deletebillablemetric","openApiOperationId":"deleteBillableMetric","summary":"Delete a billable metric"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"204","description":"No Content","headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/delete/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1billable-metrics~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteBillableMetricResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1billable-metrics~1{id}/delete/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/deletebillablemetric"}],"panels":[]}]},"httpPath":"/commerce/billable-metrics/{id}"},{"label":"Create a feature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createfeature","routeSlug":"/v1-api-reference/api/commerce/createfeature","metadata":{"seo":{"title":"Create a feature","description":"Creates a catalog feature. Supported feature types are boolean (bool), enum (enumType),numbered metered, and numbered unmetered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFeature","name":"Create a feature","isWebhook":false,"pointer":"/paths/~1commerce~1features/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a feature","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 catalog feature. Supported feature types are boolean ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), enum ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"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":"numbered metered, and numbered unmetered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numbered metered features must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metricId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reference a billable metric. Numbered"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unmetered features omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metricId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1features/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateFeatureRequest","exampleIds":["paths/~1commerce~1features/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/enumFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedMeteredFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedUnmeteredFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/taggedUnmeteredFeature"]}},"schemaId":"components/schemas/CreateFeatureRequest","exampleIds":["paths/~1commerce~1features/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/enumFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedMeteredFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedUnmeteredFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/taggedUnmeteredFeature"],"pointer":"/paths/~1commerce~1features/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/features","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateFeatureRequest","exampleIds":["paths/~1commerce~1features/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/enumFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedMeteredFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedUnmeteredFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/taggedUnmeteredFeature"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/features","href":"commerce/createfeature","openApiOperationId":"createFeature","summary":"Create a feature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateFeatureRequest","exampleIds":["paths/~1commerce~1features/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/enumFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedMeteredFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedUnmeteredFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/taggedUnmeteredFeature"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateFeatureRequest","exampleIds":["paths/~1commerce~1features/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/enumFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedMeteredFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedUnmeteredFeature","paths/~1commerce~1features/post/requestBody/content/application~1json/examples/taggedUnmeteredFeature"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1features/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1features/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1features/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1features/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1commerce~1features/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1features/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1features/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1features/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1features/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/createfeature"}],"panels":[]}]},"httpPath":"/commerce/features"},{"label":"List features","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getfeatures","routeSlug":"/v1-api-reference/api/commerce/getfeatures","metadata":{"seo":{"title":"List features","description":"Lists catalog features, including boolean, enum, numbered metered, and numbered unmetered features."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFeatures","name":"List features","isWebhook":false,"pointer":"/paths/~1commerce~1features/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List features","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists catalog features, including boolean, enum, numbered metered, and numbered unmetered features.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1features/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commerce/features","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/commerce/features","href":"commerce/getfeatures","openApiOperationId":"getFeatures","summary":"List features"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListFeaturesResponse","exampleIds":["paths/~1commerce~1features/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListFeaturesResponse","exampleIds":["paths/~1commerce~1features/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1features/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListFeaturesResponse","exampleIds":["paths/~1commerce~1features/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListFeaturesResponse","exampleIds":["paths/~1commerce~1features/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/getfeatures"}],"panels":[]}]},"httpPath":"/commerce/features"},{"label":"Update a feature","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updatefeature","routeSlug":"/v1-api-reference/api/commerce/updatefeature","metadata":{"seo":{"title":"Update a feature","description":"Updates an existing catalog feature. Use this operation to change fields such as name,description, values, and tags. Omit tags to preserve existing tags. Send clear_tags: trueto remove all tags."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFeature","name":"Update a feature","isWebhook":false,"pointer":"/paths/~1commerce~1features/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a feature","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 an existing catalog feature. Use this operation to change fields such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"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":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to preserve existing tags. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clear_tags: true"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to remove all tags."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1features/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateFeatureRequest","exampleIds":["paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateName","paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateTags","paths/~1commerce~1features/put/requestBody/content/application~1json/examples/clearTags"]}},"schemaId":"components/schemas/UpdateFeatureRequest","exampleIds":["paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateName","paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateTags","paths/~1commerce~1features/put/requestBody/content/application~1json/examples/clearTags"],"pointer":"/paths/~1commerce~1features/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/commerce/features","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateFeatureRequest","exampleIds":["paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateName","paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateTags","paths/~1commerce~1features/put/requestBody/content/application~1json/examples/clearTags"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/features","href":"commerce/updatefeature","openApiOperationId":"updateFeature","summary":"Update a feature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateFeatureRequest","exampleIds":["paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateName","paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateTags","paths/~1commerce~1features/put/requestBody/content/application~1json/examples/clearTags"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateFeatureRequest","exampleIds":["paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateName","paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateTags","paths/~1commerce~1features/put/requestBody/content/application~1json/examples/clearTags"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features/put/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1features/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features/put/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/updatefeature"}],"panels":[]}]},"httpPath":"/commerce/features"},{"label":"Search features","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/searchfeatures","routeSlug":"/v1-api-reference/api/commerce/searchfeatures","metadata":{"seo":{"title":"Search features","description":"Searches catalog features. Use filters to match fields such as feature_type or feature_tag,or send filter.feature_tag. Soft-deleted features are excluded from the results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchFeatures","name":"Search features","isWebhook":false,"pointer":"/paths/~1commerce~1features~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search features","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":"Searches catalog features. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to match fields such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feature_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feature_tag"},"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 send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter.feature_tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Soft-deleted features are excluded from the results."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1features~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchFeaturesRequest","exampleIds":["paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTagFilter","paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTag","paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byType"]}},"schemaId":"components/schemas/SearchFeaturesRequest","exampleIds":["paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTagFilter","paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTag","paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byType"],"pointer":"/paths/~1commerce~1features~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/features/search","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchFeaturesRequest","exampleIds":["paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTagFilter","paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTag","paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byType"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/features/search","href":"commerce/searchfeatures","openApiOperationId":"searchFeatures","summary":"Search features"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/SearchFeaturesRequest","exampleIds":["paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTagFilter","paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTag","paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byType"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchFeaturesRequest","exampleIds":["paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTagFilter","paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTag","paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byType"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListFeaturesResponse","exampleIds":["paths/~1commerce~1features~1search/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListFeaturesResponse","exampleIds":["paths/~1commerce~1features~1search/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1search/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1search/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1features~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListFeaturesResponse","exampleIds":["paths/~1commerce~1features~1search/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListFeaturesResponse","exampleIds":["paths/~1commerce~1features~1search/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1search/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1search/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/searchfeatures"}],"panels":[]}]},"httpPath":"/commerce/features/search"},{"label":"Retrieve a feature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getfeature","routeSlug":"/v1-api-reference/api/commerce/getfeature","metadata":{"seo":{"title":"Retrieve a feature","description":"Retrieves a catalog feature by its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFeature","name":"Retrieve a feature","isWebhook":false,"pointer":"/paths/~1commerce~1features~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a feature","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a catalog feature by its unique identifier.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Unique identifier of the feature.","required":true}],"pointer":"/paths/~1commerce~1features~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1features~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commerce/features/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/commerce/features/{id}","href":"commerce/getfeature","openApiOperationId":"getFeature","summary":"Retrieve a feature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/numberedMetered","paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/booleanFeature"]}},"schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/numberedMetered","paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/booleanFeature"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1{id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1{id}/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1features~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/numberedMetered","paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/booleanFeature"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateFeatureResponse","exampleIds":["paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/numberedMetered","paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/booleanFeature"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1{id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1{id}/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/getfeature"}],"panels":[]}]},"httpPath":"/commerce/features/{id}"},{"label":"Delete a feature","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/deletefeature","routeSlug":"/v1-api-reference/api/commerce/deletefeature","metadata":{"seo":{"title":"Delete a feature","description":"Deletes a catalog feature by its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFeature","name":"Delete a feature","isWebhook":false,"pointer":"/paths/~1commerce~1features~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a feature","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a catalog feature by its unique identifier.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Unique identifier of the feature.","required":true}],"pointer":"/paths/~1commerce~1features~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1features~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/commerce/features/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204","400","401","500"],"pointer":"/commerce/features/{id}","href":"commerce/deletefeature","openApiOperationId":"deleteFeature","summary":"Delete a feature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteFeatureResponse","exampleIds":["paths/~1commerce~1features~1{id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteFeatureResponse","exampleIds":["paths/~1commerce~1features~1{id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"204","description":"No Content","headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1{id}/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1{id}/delete/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1features~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteFeatureResponse","exampleIds":["paths/~1commerce~1features~1{id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteFeatureResponse","exampleIds":["paths/~1commerce~1features~1{id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1{id}/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1features~1{id}/delete/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/deletefeature"}],"panels":[]}]},"httpPath":"/commerce/features/{id}"},{"label":"Create a product rate plan charge with Dynamic Pricing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createproductrateplanchargewithdynamicpricing","routeSlug":"/v1-api-reference/api/commerce/createproductrateplanchargewithdynamicpricing","metadata":{"seo":{"title":"Create a product rate plan charge with Dynamic Pricing","description":"Create a product rate plan charge (PRPC) in the Product Catalog. Use this endpoint to configure Dynamic Pricing, including default pricing at the charge level and conditional rate cards evaluated by attribute values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductRatePlanChargeWithDynamicPricing","name":"Create a product rate plan charge with Dynamic Pricing","isWebhook":false,"pointer":"/paths/~1commerce~1charges/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a product rate plan charge with Dynamic Pricing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a product rate plan charge (PRPC) in the Product Catalog.\nUse this endpoint to configure Dynamic Pricing, including default pricing at the charge level \nand conditional rate cards evaluated by attribute values.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1charges/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateChargeRequest"}},"schemaId":"components/schemas/CreateChargeRequest","pointer":"/paths/~1commerce~1charges/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/charges","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateChargeRequest"}},"responseCodes":["200","400","401"],"pointer":"/commerce/charges","href":"commerce/createproductrateplanchargewithdynamicpricing","openApiOperationId":"createProductRatePlanChargeWithDynamicPricing","summary":"Create a product rate plan charge with Dynamic Pricing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateChargeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateChargeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateChargeResponse","exampleIds":["paths/~1commerce~1charges/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CreateChargeResponse","exampleIds":["paths/~1commerce~1charges/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_8"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1charges/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1charges/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_8"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:\\n\\n"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\n\\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\\n\\n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n"},"children":[]}]}]}],"schema":{"type":"string","enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"]}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1commerce~1charges/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateChargeResponse","exampleIds":["paths/~1commerce~1charges/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateChargeResponse","exampleIds":["paths/~1commerce~1charges/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1charges/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1charges/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/createproductrateplanchargewithdynamicpricing"}],"panels":[]}]},"httpPath":"/commerce/charges"},{"label":"Update a product rate plan charge with Dynamic Pricing","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateproductrateplanchargewithdynamicpricing","routeSlug":"/v1-api-reference/api/commerce/updateproductrateplanchargewithdynamicpricing","metadata":{"seo":{"title":"Update a product rate plan charge with Dynamic Pricing","description":"Update an existing product rate plan charge (PRPC). Use this API to update default pricing and/or conditional rate cards."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductRatePlanChargeWithDynamicPricing","name":"Update a product rate plan charge with Dynamic Pricing","isWebhook":false,"pointer":"/paths/~1commerce~1charges/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a product rate plan charge with Dynamic Pricing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing product rate plan charge (PRPC). Use this API to update default pricing and/or conditional rate cards.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1charges/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateChargeRequest","exampleIds":["paths/~1commerce~1charges/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateChargeRequest","exampleIds":["paths/~1commerce~1charges/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1commerce~1charges/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/commerce/charges","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateChargeRequest","exampleIds":["paths/~1commerce~1charges/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/charges","href":"commerce/updateproductrateplanchargewithdynamicpricing","openApiOperationId":"updateProductRatePlanChargeWithDynamicPricing","summary":"Update a product rate plan charge with Dynamic Pricing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateChargeRequest","exampleIds":["paths/~1commerce~1charges/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateChargeRequest","exampleIds":["paths/~1commerce~1charges/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateChargeResponse"}},"schemaId":"components/schemas/CreateChargeResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Request Errors or Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges/put/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges/put/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"schema":{"type":"string"}},"WWW-Authenticate":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}]},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_10"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1charges/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1charges/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1commerce~1charges/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateChargeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateChargeResponse"}}},{"code":"400","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges/put/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges/put/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1charges/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1charges/put/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/updateproductrateplanchargewithdynamicpricing"}],"panels":[]}]},"httpPath":"/commerce/charges"},{"label":"Query a product rate plan charge with Dynamic Pricing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/queryproductrateplanchargewithdynamicpricing","routeSlug":"/v1-api-reference/api/commerce/queryproductrateplanchargewithdynamicpricing","metadata":{"seo":{"title":"Query a product rate plan charge with Dynamic Pricing","description":"Returns a product rate plan charge (PRPC) by evaluating Dynamic Pricing against the provided attribute values. If a matching rate-card row is found, its pricing is returned; otherwise, the default charge-level pricing is used (if defined). This operation can be used to simulate pricing resolution without creating or updating the charge."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProductRatePlanChargeWithDynamicPricing","name":"Query a product rate plan charge with Dynamic Pricing","isWebhook":false,"pointer":"/paths/~1commerce~1charges~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query a product rate plan charge with Dynamic Pricing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a product rate plan charge (PRPC) by evaluating Dynamic Pricing against the provided attribute values.  \nIf a matching rate-card row is found, its pricing is returned; otherwise, the default charge-level pricing is used (if defined).  \nThis operation can be used to simulate pricing resolution without creating or updating the charge.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1charges~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryChargeRequest","exampleIds":["paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/minimal","paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/withAttributes"]}},"schemaId":"components/schemas/QueryChargeRequest","exampleIds":["paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/minimal","paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/withAttributes"],"pointer":"/paths/~1commerce~1charges~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/charges/query","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryChargeRequest","exampleIds":["paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/minimal","paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/withAttributes"]}},"responseCodes":["200","400","401"],"pointer":"/commerce/charges/query","href":"commerce/queryproductrateplanchargewithdynamicpricing","openApiOperationId":"queryProductRatePlanChargeWithDynamicPricing","summary":"Query a product rate plan charge with Dynamic Pricing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/QueryChargeRequest","exampleIds":["paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/minimal","paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/withAttributes"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryChargeRequest","exampleIds":["paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/minimal","paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/withAttributes"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateChargeResponse"}},"schemaId":"components/schemas/CreateChargeResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1charges~1query/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1charges~1query/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges~1query/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges~1query/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1commerce~1charges~1query/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateChargeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateChargeResponse"}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1charges~1query/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1charges~1query/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges~1query/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1charges~1query/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/queryproductrateplanchargewithdynamicpricing"}],"panels":[]}]},"httpPath":"/commerce/charges/query"},{"label":"Create a product with plans and charges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createproduct","routeSlug":"/v1-api-reference/api/commerce/createproduct","metadata":{"seo":{"title":"Create a product with plans and charges","description":"Create a product in the Product Catalog with one or more plans and charges. Charges can be usage (per-unit), recurring (flat fee), or other supported models."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProduct","name":"Create a product with plans and charges","isWebhook":false,"pointer":"/paths/~1commerce~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a product with plans and charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a product in the Product Catalog with one or more plans and charges.\nCharges can be usage (per-unit), recurring (flat fee), or other supported models.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1products/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProductRequest","exampleIds":["paths/~1commerce~1products/post/requestBody/content/application~1json/examples/createProductExample"]}},"schemaId":"components/schemas/CreateProductRequest","exampleIds":["paths/~1commerce~1products/post/requestBody/content/application~1json/examples/createProductExample"],"pointer":"/paths/~1commerce~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/products","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateProductRequest","exampleIds":["paths/~1commerce~1products/post/requestBody/content/application~1json/examples/createProductExample"]}},"responseCodes":["200","400"],"pointer":"/commerce/products","href":"commerce/createproduct","openApiOperationId":"createProduct","summary":"Create a product with plans and charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateProductRequest","exampleIds":["paths/~1commerce~1products/post/requestBody/content/application~1json/examples/createProductExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProductRequest","exampleIds":["paths/~1commerce~1products/post/requestBody/content/application~1json/examples/createProductExample"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateProductResponse","exampleIds":["paths/~1commerce~1products/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CreateProductResponse","exampleIds":["paths/~1commerce~1products/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"schema":{"type":"string"}},"RateLimit-Remaining":{"schema":{"type":"number"}},"RateLimit-Reset":{"schema":{"type":"number"}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_13"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1products/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1products/post/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1commerce~1products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateProductResponse","exampleIds":["paths/~1commerce~1products/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateProductResponse","exampleIds":["paths/~1commerce~1products/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1products/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1products/post/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/createproduct"}],"panels":[]}]},"httpPath":"/commerce/products"},{"label":"Update a product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateproduct","routeSlug":"/v1-api-reference/api/commerce/updateproduct","metadata":{"seo":{"title":"Update a product","description":"Updates an existing product in the Product Catalog. Use this API to update core product fields such as name, description, category, effective dates, and custom fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProduct","name":"Update a product","isWebhook":false,"pointer":"/paths/~1commerce~1products/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing product in the Product Catalog. Use this API to update core product fields\nsuch as name, description, category, effective dates, and custom fields.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1products/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateProductRequest","exampleIds":["paths/~1commerce~1products/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateProductRequest","exampleIds":["paths/~1commerce~1products/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1commerce~1products/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/commerce/products","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateProductRequest","exampleIds":["paths/~1commerce~1products/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/products","href":"commerce/updateproduct","openApiOperationId":"updateProduct","summary":"Update a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateProductRequest","exampleIds":["paths/~1commerce~1products/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateProductRequest","exampleIds":["paths/~1commerce~1products/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateProductResponse","exampleIds":["paths/~1commerce~1products/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdateProductResponse","exampleIds":["paths/~1commerce~1products/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Request Errors or Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1products/put/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1products/put/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"schema":{"type":"string"}},"WWW-Authenticate":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}]},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_10"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1products/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1products/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1commerce~1products/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateProductResponse","exampleIds":["paths/~1commerce~1products/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateProductResponse","exampleIds":["paths/~1commerce~1products/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1products/put/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1products/put/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1products/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1products/put/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/updateproduct"}],"panels":[]}]},"httpPath":"/commerce/products"},{"label":"Create a product rate plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createplan","routeSlug":"/v1-api-reference/api/commerce/createplan","metadata":{"seo":{"title":"Create a product rate plan","description":"Create a product rate plan (Plan) under an existing product.A plan includes one or more charges. Each charge must include:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPlan","name":"Create a product rate plan","isWebhook":false,"pointer":"/paths/~1commerce~1plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a product rate plan","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":"Create a product rate plan (Plan) under an existing product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A plan includes one or more "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each charge "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include:"},"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":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge_model"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bill_cycle"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger_event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional charge fields include: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unit_of_measure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_price_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounting_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferred_revenue_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recognized_revenue_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1plans/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePlanRequest","exampleIds":["paths/~1commerce~1plans/post/requestBody/content/application~1json/examples/createPlanExample"]}},"schemaId":"components/schemas/CreatePlanRequest","exampleIds":["paths/~1commerce~1plans/post/requestBody/content/application~1json/examples/createPlanExample"],"pointer":"/paths/~1commerce~1plans/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/plans","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePlanRequest","exampleIds":["paths/~1commerce~1plans/post/requestBody/content/application~1json/examples/createPlanExample"]}},"responseCodes":["200","400"],"pointer":"/commerce/plans","href":"commerce/createplan","openApiOperationId":"createPlan","summary":"Create a product rate plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreatePlanRequest","exampleIds":["paths/~1commerce~1plans/post/requestBody/content/application~1json/examples/createPlanExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePlanRequest","exampleIds":["paths/~1commerce~1plans/post/requestBody/content/application~1json/examples/createPlanExample"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePlanResponse","exampleIds":["paths/~1commerce~1plans/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CreatePlanResponse","exampleIds":["paths/~1commerce~1plans/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":"The request limit quota for the time window closest to exhaustion. See rate limits docs.","schema":{"type":"string"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the time window closest to quota exhaustion. See rate limits docs.","schema":{"type":"number"}},"RateLimit-Reset":{"description":"The number of seconds until the quota resets for the time window closest to exhaustion. See rate limits docs.","schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call.","schema":{"type":"string","minLength":36,"maxLength":36}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_14"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1plans/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1plans/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":"The request limit quota for the time window closest to exhaustion. See rate limits docs.","schema":{"type":"string"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the time window closest to quota exhaustion. See rate limits docs.","schema":{"type":"number"}},"RateLimit-Reset":{"description":"The number of seconds until the quota resets for the time window closest to exhaustion. See rate limits docs.","schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"type":"string","enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"]}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call.","schema":{"type":"string","minLength":36,"maxLength":36}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_15"}],"pointer":"/paths/~1commerce~1plans/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatePlanResponse","exampleIds":["paths/~1commerce~1plans/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePlanResponse","exampleIds":["paths/~1commerce~1plans/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1plans/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1plans/post/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/createplan"}],"panels":[]}]},"httpPath":"/commerce/plans"},{"label":"Update a product rate plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateproductrateplan","routeSlug":"/v1-api-reference/api/commerce/updateproductrateplan","metadata":{"seo":{"title":"Update a product rate plan","description":"Updates an existing Product Rate Plan (PRP) in the Product Catalog. Use this API to update core plan fields such as name, description, grade, and effective dates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductRatePlan","name":"Update a product rate plan","isWebhook":false,"pointer":"/paths/~1commerce~1plans/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a product rate plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing Product Rate Plan (PRP) in the Product Catalog. \nUse this API to update core plan fields such as name, description, grade, and effective dates.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1plans/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePlanRequest","exampleIds":["paths/~1commerce~1plans/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdatePlanRequest","exampleIds":["paths/~1commerce~1plans/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1commerce~1plans/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/commerce/plans","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePlanRequest","exampleIds":["paths/~1commerce~1plans/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/plans","href":"commerce/updateproductrateplan","openApiOperationId":"updateProductRatePlan","summary":"Update a product rate plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdatePlanRequest","exampleIds":["paths/~1commerce~1plans/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePlanRequest","exampleIds":["paths/~1commerce~1plans/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdatePlanResponse","exampleIds":["paths/~1commerce~1plans/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdatePlanResponse","exampleIds":["paths/~1commerce~1plans/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the time window closest to quota exhaustion.","schema":{"type":"number"}},"RateLimit-Reset":{"description":"The number of seconds until the quota resets for the time window closest to exhaustion.","schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_16"},{"code":"400","description":"Request Errors or Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1plans/put/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1plans/put/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"schema":{"type":"string"}},"WWW-Authenticate":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}]},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_10"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1plans/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1plans/put/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1commerce~1plans/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdatePlanResponse","exampleIds":["paths/~1commerce~1plans/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdatePlanResponse","exampleIds":["paths/~1commerce~1plans/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1plans/put/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1plans/put/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1plans/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1plans/put/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/updateproductrateplan"}],"panels":[]}]},"httpPath":"/commerce/plans"},{"label":"Query product rate plan details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/querycommerceproductrateplans","routeSlug":"/v1-api-reference/api/commerce/querycommerceproductrateplans","metadata":{"seo":{"title":"Query product rate plan details","description":"Retrieve details of a single product rate plan (PRP) from the Product Catalog. You can expand associated product rate plan charges for each plan.This operation is a strict lookup and requires product_rate_plan_key. It does not support attributes or other list-style filters.To browse or filter plans (including by attributes), use  the \"Query product rate plans\" operation (POST /commerce/plans/list)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCommerceProductRatePlans","name":"Query product rate plan details","isWebhook":false,"pointer":"/paths/~1commerce~1plans~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query product rate plan details","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":"Retrieve details of a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" product rate plan (PRP) from the Product Catalog. You can expand associated product rate plan charges for each plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"strict lookup"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requires"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_rate_plan_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It does "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" support "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or other list-style filters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To browse or filter plans (including by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), use  the \"Query product rate plans\" operation ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /commerce/plans/list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1plans~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryChargeRequest","exampleIds":["paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges","paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanKeyNoExpand"]}},"schemaId":"components/schemas/QueryChargeRequest","exampleIds":["paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges","paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanKeyNoExpand"],"pointer":"/paths/~1commerce~1plans~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/plans/query","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryChargeRequest","exampleIds":["paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges","paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanKeyNoExpand"]}},"responseCodes":["200","400","401"],"pointer":"/commerce/plans/query","href":"commerce/querycommerceproductrateplans","openApiOperationId":"queryCommerceProductRatePlans","summary":"Query product rate plan details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/QueryChargeRequest","exampleIds":["paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges","paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanKeyNoExpand"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryChargeRequest","exampleIds":["paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges","paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanKeyNoExpand"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateChargeResponse"}},"schemaId":"components/schemas/CreateChargeResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1plans~1query/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1plans~1query/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1plans~1query/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1plans~1query/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1commerce~1plans~1query/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateChargeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateChargeResponse"}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1plans~1query/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1plans~1query/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1plans~1query/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1plans~1query/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/querycommerceproductrateplans"}],"panels":[]}]},"httpPath":"/commerce/plans/query"},{"label":"Query product rate plans","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/querycommerceplanslist","routeSlug":"/v1-api-reference/api/commerce/querycommerceplanslist","metadata":{"seo":{"title":"Query product rate plans","description":"Queries product rate plans (PRPs) from the Product Catalog using filters such as plan ID, name, or product ID. You can optionally expand related Product Rate Plan Charges (PRPCs) in the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCommercePlansList","name":"Query product rate plans","isWebhook":false,"pointer":"/paths/~1commerce~1plans~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query product rate plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries product rate plans (PRPs) from the Product Catalog using filters such as plan ID, name, or product ID.  \nYou can optionally expand related Product Rate Plan Charges (PRPCs) in the response.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1plans~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListPlansRequest","exampleIds":["paths/~1commerce~1plans~1list/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ListPlansRequest","exampleIds":["paths/~1commerce~1plans~1list/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1commerce~1plans~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/plans/list","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListPlansRequest","exampleIds":["paths/~1commerce~1plans~1list/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/plans/list","href":"commerce/querycommerceplanslist","openApiOperationId":"queryCommercePlansList","summary":"Query product rate plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ListPlansRequest","exampleIds":["paths/~1commerce~1plans~1list/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListPlansRequest","exampleIds":["paths/~1commerce~1plans~1list/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPlansResponse","exampleIds":["paths/~1commerce~1plans~1list/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListPlansResponse","exampleIds":["paths/~1commerce~1plans~1list/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1plans~1list/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPlansResponse","exampleIds":["paths/~1commerce~1plans~1list/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPlansResponse","exampleIds":["paths/~1commerce~1plans~1list/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/querycommerceplanslist"}],"panels":[]}]},"httpPath":"/commerce/plans/list"},{"label":"Create an entitlement definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createentitlementdefinition","routeSlug":"/v1-api-reference/api/commerce/createentitlementdefinition","metadata":{"seo":{"title":"Create an entitlement definition","description":"Creates a catalog entitlement definition on a plan. The definition associates a productfeature with the plan. Include featureNumber or feature_number. Numbered features caninclude quantity or limitValue. Enum features can include values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEntitlementDefinition","name":"Create an entitlement definition","isWebhook":false,"pointer":"/paths/~1commerce~1plans~1{id}~1entitlements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an entitlement definition","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 catalog entitlement definition on a plan. The definition associates a product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature with the plan. Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feature_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Numbered features can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limitValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Enum features can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"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 catalog entitlement definition is not a runtime entitlement grant. Runtime grants are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created by the Z-EMS grant API when a subscription is created or a manual grant is issued."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Unique identifier of the plan.","required":true}],"pointer":"/paths/~1commerce~1plans~1{id}~1entitlements/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1plans~1{id}~1entitlements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEntitlementDefinitionRequest","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeatureById","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/enumFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/staticLimit"]}},"schemaId":"components/schemas/CreateEntitlementDefinitionRequest","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeatureById","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/enumFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/staticLimit"],"pointer":"/paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/plans/{id}/entitlements","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEntitlementDefinitionRequest","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeatureById","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/enumFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/staticLimit"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/plans/{id}/entitlements","href":"commerce/createentitlementdefinition","openApiOperationId":"createEntitlementDefinition","summary":"Create an entitlement definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateEntitlementDefinitionRequest","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeatureById","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/enumFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/staticLimit"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEntitlementDefinitionRequest","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeatureById","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/enumFeature","paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/staticLimit"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1plans~1{id}~1entitlements/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1{id}~1entitlements/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/createentitlementdefinition"}],"panels":[]}]},"httpPath":"/commerce/plans/{id}/entitlements"},{"label":"Update an entitlement definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateentitlementdefinition","routeSlug":"/v1-api-reference/api/commerce/updateentitlementdefinition","metadata":{"seo":{"title":"Update an entitlement definition","description":"Updates a catalog entitlement definition. Use this operation to link the definition to a charge, set boolean values, or change enforcement settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEntitlementDefinition","name":"Update an entitlement definition","isWebhook":false,"pointer":"/paths/~1commerce~1plans~1entitlements/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an entitlement definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a catalog entitlement definition. Use this operation to link the definition to a\ncharge, set boolean values, or change enforcement settings.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1plans~1entitlements/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementDefinitionRequest","exampleIds":["paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/linkCharge","paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/setBooleanValue"]}},"schemaId":"components/schemas/UpdateEntitlementDefinitionRequest","exampleIds":["paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/linkCharge","paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/setBooleanValue"],"pointer":"/paths/~1commerce~1plans~1entitlements/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/commerce/plans/entitlements","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementDefinitionRequest","exampleIds":["paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/linkCharge","paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/setBooleanValue"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/plans/entitlements","href":"commerce/updateentitlementdefinition","openApiOperationId":"updateEntitlementDefinition","summary":"Update an entitlement definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateEntitlementDefinitionRequest","exampleIds":["paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/linkCharge","paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/setBooleanValue"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementDefinitionRequest","exampleIds":["paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/linkCharge","paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/setBooleanValue"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1entitlements/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1entitlements/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1entitlements/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1entitlements/put/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1plans~1entitlements/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1entitlements/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1entitlements/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1entitlements/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1entitlements/put/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/updateentitlementdefinition"}],"panels":[]}]},"httpPath":"/commerce/plans/entitlements"},{"label":"Retrieve an entitlement definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getentitlementdefinition","routeSlug":"/v1-api-reference/api/commerce/getentitlementdefinition","metadata":{"seo":{"title":"Retrieve an entitlement definition","description":"Retrieves a catalog entitlement definition by its unique identifier or entitlement number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlementDefinition","name":"Retrieve an entitlement definition","isWebhook":false,"pointer":"/paths/~1commerce~1plans~1entitlements~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an entitlement definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a catalog entitlement definition by its unique identifier or entitlement number.\n\nA catalog entitlement definition is not a runtime entitlement grant. Runtime grants are\ncreated by the Z-EMS grant API when a subscription is created or a manual grant is issued.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Unique identifier or entitlement number of the entitlement definition.","required":true}],"pointer":"/paths/~1commerce~1plans~1entitlements~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1plans~1entitlements~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commerce/plans/entitlements/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/commerce/plans/entitlements/{id}","href":"commerce/getentitlementdefinition","openApiOperationId":"getEntitlementDefinition","summary":"Retrieve an entitlement definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1entitlements~1{id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1entitlements~1{id}/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1plans~1entitlements~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementDefinitionResponse","exampleIds":["paths/~1commerce~1plans~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1entitlements~1{id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1plans~1entitlements~1{id}/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/getentitlementdefinition"}],"panels":[]}]},"httpPath":"/commerce/plans/entitlements/{id}"},{"label":"Retrieve a product by key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getproductbykey","routeSlug":"/v1-api-reference/api/commerce/getproductbykey","metadata":{"seo":{"title":"Retrieve a product by key","description":"Retrieves detailed information about a specific product by its unique product number or ID. You can optionally specify related objects to expand in the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductByKey","name":"Retrieve a product by key","isWebhook":false,"pointer":"/paths/~1commerce~1products~1{product_key}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product by key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific product by its unique product number or ID. \nYou can optionally specify related objects to expand in the request body.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_key","in":"path","schemaId":"schema_5","description":"The unique number or ID of the product to be retrieved.","required":true}],"pointer":"/paths/~1commerce~1products~1{product_key}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1products~1{product_key}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17","exampleIds":["paths/~1commerce~1products~1{product_key}/post/requestBody/content/application~1json/examples/expand"]}},"schemaId":"schema_17","exampleIds":["paths/~1commerce~1products~1{product_key}/post/requestBody/content/application~1json/examples/expand"],"pointer":"/paths/~1commerce~1products~1{product_key}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/products/{product_key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"product_key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_17","exampleIds":["paths/~1commerce~1products~1{product_key}/post/requestBody/content/application~1json/examples/expand"]}},"responseCodes":["200","500","4XX"],"pointer":"/commerce/products/{product_key}","href":"commerce/getproductbykey","openApiOperationId":"getProductByKey","summary":"Retrieve a product by key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_17","exampleIds":["paths/~1commerce~1products~1{product_key}/post/requestBody/content/application~1json/examples/expand"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17","exampleIds":["paths/~1commerce~1products~1{product_key}/post/requestBody/content/application~1json/examples/expand"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetProductByKeyResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetProductByKeyResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.","schema":{"type":"string","minLength":36,"maxLength":36}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_8"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":"The request limit quota for the time window closest to exhaustion.","schema":{"type":"string"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the time window closest to quota exhaustion.","schema":{"type":"number"}},"RateLimit-Reset":{"description":"The number of seconds until the quota resets for the time window closest to quota exhaustion.","schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_18"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":"The request limit quota for the time window closest to exhaustion.","schema":{"type":"string"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the time window closest to quota exhaustion.","schema":{"type":"number"}},"RateLimit-Reset":{"description":"The number of seconds until the quota resets for the time window closest to quota exhaustion.","schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_18"}],"pointer":"/paths/~1commerce~1products~1{product_key}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetProductByKeyResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetProductByKeyResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1products~1{product_key}/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/getproductbykey"}],"panels":[]}]},"httpPath":"/commerce/products/{product_key}"},{"label":"Add a feature to a product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/addproductfeature","routeSlug":"/v1-api-reference/api/commerce/addproductfeature","metadata":{"seo":{"title":"Add a feature to a product","description":"Links a catalog feature to a product. Include feature_number or featureNumber.After a feature is linked to a product, you can create an entitlement definition on a planthat belongs to that product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addProductFeature","name":"Add a feature to a product","isWebhook":false,"pointer":"/paths/~1commerce~1products~1{id}~1features~1add/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a feature to a product","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":"Links a catalog feature to a product. Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feature_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureNumber"},"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":"After a feature is linked to a product, you can create an entitlement definition on a plan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that belongs to that product."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Unique identifier or product key of the product.","required":true}],"pointer":"/paths/~1commerce~1products~1{id}~1features~1add/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1products~1{id}~1features~1add/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddProductFeatureRequest","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureId","paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureNumber","paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byProductKey"]}},"schemaId":"components/schemas/AddProductFeatureRequest","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureId","paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureNumber","paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byProductKey"],"pointer":"/paths/~1commerce~1products~1{id}~1features~1add/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/commerce/products/{id}/features/add","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddProductFeatureRequest","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureId","paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureNumber","paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byProductKey"]}},"responseCodes":["200","204","400","401","500"],"pointer":"/commerce/products/{id}/features/add","href":"commerce/addproductfeature","openApiOperationId":"addProductFeature","summary":"Add a feature to a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/AddProductFeatureRequest","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureId","paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureNumber","paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byProductKey"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddProductFeatureRequest","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureId","paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureNumber","paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byProductKey"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddProductFeatureResponse","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AddProductFeatureResponse","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"204","description":"No Content","headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1products~1{id}~1features~1add/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddProductFeatureResponse","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddProductFeatureResponse","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/responses/200/content/application~1json/examples/response"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1products~1{id}~1features~1add/put/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/addproductfeature"}],"panels":[]}]},"httpPath":"/commerce/products/{id}/features/add"},{"label":"Query legacy products from the Product Catalog","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/querylegacyproducts","routeSlug":"/v1-api-reference/api/commerce/querylegacyproducts","metadata":{"seo":{"title":"Query legacy products from the Product Catalog","description":"This operation is functionally equivalent to the \"Query products from the Product Catalog\" operation, except that it returns resultsin the V1 response format. It is primarily intended for customers migrating from older V1 integrationswho want to use new Commerce capabilities — such as Dynamic Pricing—without refactoring their existing integrations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryLegacyProducts","name":"Query legacy products from the Product Catalog","isWebhook":false,"pointer":"/paths/~1commerce~1legacy~1products~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query legacy products from the Product Catalog","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":"This operation is functionally equivalent to the \"Query products from the Product Catalog\" operation, except that it returns results"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"V1 response format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is primarily intended for customers migrating from older V1 integrations"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"who want to use new Commerce capabilities — such as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—without refactoring their existing integrations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike the \"Query products from the Product Catalog\" operation, this operation does not retrieve a different set of products."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns the same product catalog data as the newer operation, but formatted in a flattened V1-style response structure that:"},"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":"Uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flattened fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of grouped objects such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discount_options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bill_cycle"},"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":"Retains "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"V1 field names"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for easier migration from existing V1 operations, for example:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/GET_RetrieveProductRatePlanCharge/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a product rate plan charge"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/queryProductRatePlanByKey/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a product rate plan"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/queryProductByKey/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a product"},"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":"Keeps certain objects, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"netsuite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as grouped structures instead of flattening them."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are returned in descending order by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_on"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 20, and the maximum "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 40."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To control pagination, specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagination.page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagination.pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"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":"Recommended Usage"},"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 this operation if you are migrating from V1 APIs and need to maintain compatibility with existing integrations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For new integrations, use the \"Query products from the Product Catalog\" operation instead, as it returns structured responses optimized for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1legacy~1products~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProductListLegacyRequest","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/requestBody/content/application~1json/examples/queryByIdExpandCharges"]}},"schemaId":"components/schemas/CreateProductListLegacyRequest","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/requestBody/content/application~1json/examples/queryByIdExpandCharges"],"pointer":"/paths/~1commerce~1legacy~1products~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/legacy/products/list","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateProductListLegacyRequest","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/requestBody/content/application~1json/examples/queryByIdExpandCharges"]}},"responseCodes":["200","400","401"],"pointer":"/commerce/legacy/products/list","href":"commerce/querylegacyproducts","openApiOperationId":"queryLegacyProducts","summary":"Query legacy products from the Product Catalog"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateProductListLegacyRequest","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/requestBody/content/application~1json/examples/queryByIdExpandCharges"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProductListLegacyRequest","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/requestBody/content/application~1json/examples/queryByIdExpandCharges"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful query","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateProductListLegacyResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CreateProductListLegacyResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion."},"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://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"},"children":[]}]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_19"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"schema":{"type":"string"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call.","schema":{"type":"string","minLength":36,"maxLength":36}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_20"}],"pointer":"/paths/~1commerce~1legacy~1products~1list/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateProductListLegacyResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateProductListLegacyResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1legacy~1products~1list/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/querylegacyproducts"}],"panels":[]}]},"httpPath":"/commerce/legacy/products/list"},{"label":"Update a product rate plan charge tier","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updatetier","routeSlug":"/v1-api-reference/api/commerce/updatetier","metadata":{"seo":{"title":"Update a product rate plan charge tier","description":"Updates the price and other editable attributes, when supported, for a specific Product Rate Plan Charge Tier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTier","name":"Update a product rate plan charge tier","isWebhook":false,"pointer":"/paths/~1commerce~1tiers/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a product rate plan charge tier","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 price and other editable attributes, when supported, for a specific "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Rate Plan Charge Tier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1tiers/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTierRequest","exampleIds":["paths/~1commerce~1tiers/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateTierRequest","exampleIds":["paths/~1commerce~1tiers/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1commerce~1tiers/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/commerce/tiers","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTierRequest","exampleIds":["paths/~1commerce~1tiers/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/tiers","href":"commerce/updatetier","openApiOperationId":"updateTier","summary":"Update a product rate plan charge tier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateTierRequest","exampleIds":["paths/~1commerce~1tiers/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTierRequest","exampleIds":["paths/~1commerce~1tiers/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateTierResponse","exampleIds":["paths/~1commerce~1tiers/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdateTierResponse","exampleIds":["paths/~1commerce~1tiers/put/responses/200/content/application~1json/examples/response"],"headers":{"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_21"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1tiers/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateTierResponse","exampleIds":["paths/~1commerce~1tiers/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateTierResponse","exampleIds":["paths/~1commerce~1tiers/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/updatetier"}],"panels":[]}]},"httpPath":"/commerce/tiers"},{"label":"Query purchase options by PRP ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/querypurchaseoptionsbyprpid","routeSlug":"/v1-api-reference/api/commerce/querypurchaseoptionsbyprpid","metadata":{"seo":{"title":"Query purchase options by PRP ID","description":"Retrieves one or more product rate plans (PRPs) from the Product Catalog based on specified filters such as product ID or PRP ID. You can optionally expand related product rate plan charges (PRPCs) in the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPurchaseOptionsbyPRPID","name":"Query purchase options by PRP ID","isWebhook":false,"pointer":"/paths/~1commerce~1purchase-options~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query purchase options by PRP ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves one or more product rate plans (PRPs) from the Product Catalog based on specified filters such as product ID or PRP ID.\nYou can optionally expand related product rate plan charges (PRPCs) in the response.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1purchase-options~1list/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1purchase-options~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseOptionRequest","exampleIds":["paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges","paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byProductId"]}},"schemaId":"components/schemas/PurchaseOptionRequest","exampleIds":["paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges","paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byProductId"],"pointer":"/paths/~1commerce~1purchase-options~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/purchase-options/list","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchaseOptionRequest","exampleIds":["paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges","paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byProductId"]}},"responseCodes":["200","400","401"],"pointer":"/commerce/purchase-options/list","href":"commerce/querypurchaseoptionsbyprpid","openApiOperationId":"queryPurchaseOptionsbyPRPID","summary":"Query purchase options by PRP ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PurchaseOptionRequest","exampleIds":["paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges","paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byProductId"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseOptionRequest","exampleIds":["paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges","paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byProductId"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseOptionResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/200/content/application~1json/examples/sampleSuccess"]}},"schemaId":"components/schemas/PurchaseOptionResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/200/content/application~1json/examples/sampleSuccess"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1commerce~1purchase-options~1list/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseOptionResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/200/content/application~1json/examples/sampleSuccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseOptionResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/200/content/application~1json/examples/sampleSuccess"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1commerce~1purchase-options~1list/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/querypurchaseoptionsbyprpid"}],"panels":[]}]},"httpPath":"/commerce/purchase-options/list"},{"label":"List entitlement audit events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getentitlementauditevents","routeSlug":"/v1-api-reference/api/commerce/getentitlementauditevents","metadata":{"seo":{"title":"List entitlement audit events","description":"Lists entitlement audit events. Filter results by account, feature, grant, subscription, event type, and date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlementAuditEvents","name":"List entitlement audit events","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1audit-events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List entitlement audit events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists entitlement audit events. Filter results by account, feature, grant, subscription, event type, and date.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountId","in":"query","schemaId":"schema_5","description":"Account ID used to filter audit events."},{"name":"accountKey","in":"query","schemaId":"schema_5","description":"Account number or account ID used to filter audit events."},{"name":"customer","in":"query","schemaId":"schema_5","description":"Customer name used to filter audit events."},{"name":"customerId","in":"query","schemaId":"schema_5","description":"Customer ID used to filter audit events."},{"name":"featureCode","in":"query","schemaId":"schema_5","description":"Feature code used to filter audit events."},{"name":"featureKey","in":"query","schemaId":"schema_5","description":"Feature key used to filter audit events."},{"name":"occurredFrom","in":"query","schemaId":"schema_23","description":"Return events that occurred at or after this date and time."},{"name":"occurredTo","in":"query","schemaId":"schema_23","description":"Return events that occurred at or before this date and time."},{"name":"entitlementKey","in":"query","schemaId":"schema_5","description":"Unique key of the runtime entitlement grant used to filter audit events."},{"name":"eventType","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type used to filter audit events, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"grantId","in":"query","schemaId":"schema_5","description":"Grant ID used to filter audit events."},{"name":"entitlementNumber","in":"query","schemaId":"schema_5","description":"Entitlement number used to filter audit events."},{"name":"subscriptionId","in":"query","schemaId":"schema_5","description":"Subscription ID used to filter audit events."},{"name":"subscriptionKey","in":"query","schemaId":"schema_5","description":"Subscription number or subscription ID used to filter audit events."},{"name":"sort","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for the results. Prefix a field name with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending order."},"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":"occurredAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-occurredAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_25","description":"Maximum number of audit events returned per page."},{"name":"pageToken","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token of the page to retrieve. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextPageToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the previous response."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1audit-events/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1audit-events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commerce/entitlements/audit-events","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"accountId","in":"query","required":false,"schemaId":"schema_5"},{"name":"accountKey","in":"query","required":false,"schemaId":"schema_5"},{"name":"customer","in":"query","required":false,"schemaId":"schema_5"},{"name":"customerId","in":"query","required":false,"schemaId":"schema_5"},{"name":"featureCode","in":"query","required":false,"schemaId":"schema_5"},{"name":"featureKey","in":"query","required":false,"schemaId":"schema_5"},{"name":"occurredFrom","in":"query","required":false,"schemaId":"schema_23"},{"name":"occurredTo","in":"query","required":false,"schemaId":"schema_23"},{"name":"entitlementKey","in":"query","required":false,"schemaId":"schema_5"},{"name":"eventType","in":"query","required":false,"schemaId":"schema_5"},{"name":"grantId","in":"query","required":false,"schemaId":"schema_5"},{"name":"entitlementNumber","in":"query","required":false,"schemaId":"schema_5"},{"name":"subscriptionId","in":"query","required":false,"schemaId":"schema_5"},{"name":"subscriptionKey","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort","in":"query","required":false,"example":"-occurredAt","schemaId":"schema_24"},{"name":"limit","in":"query","required":false,"schemaId":"schema_25"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/audit-events","href":"commerce/getentitlementauditevents","openApiOperationId":"getEntitlementAuditEvents","summary":"List entitlement audit events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementAuditEventsResponse","exampleIds":["paths/~1commerce~1entitlements~1audit-events/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListEntitlementAuditEventsResponse","exampleIds":["paths/~1commerce~1entitlements~1audit-events/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1audit-events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEntitlementAuditEventsResponse","exampleIds":["paths/~1commerce~1entitlements~1audit-events/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementAuditEventsResponse","exampleIds":["paths/~1commerce~1entitlements~1audit-events/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/getentitlementauditevents"}],"panels":[]}]},"httpPath":"/commerce/entitlements/audit-events"},{"label":"Authorize entitlement consumption","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/authorizeentitlementconsumption","routeSlug":"/v1-api-reference/api/commerce/authorizeentitlementconsumption","metadata":{"seo":{"title":"Authorize entitlement consumption","description":"Authorizes consumption against a numbered metered feature and deducts requestedQuantityfrom the remaining entitlement balance when the request is allowed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authorizeEntitlementConsumption","name":"Authorize entitlement consumption","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1authorize/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorize entitlement consumption","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":"Authorizes consumption against a numbered metered feature and deducts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestedQuantity"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the remaining entitlement balance when the request is allowed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1authorize/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyEntitlementConsumptionRequest","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ApplyEntitlementConsumptionRequest","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1commerce~1entitlements~1authorize/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/entitlements/authorize","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyEntitlementConsumptionRequest","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/authorize","href":"commerce/authorizeentitlementconsumption","openApiOperationId":"authorizeEntitlementConsumption","summary":"Authorize entitlement consumption"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ApplyEntitlementConsumptionRequest","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyEntitlementConsumptionRequest","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyEntitlementConsumptionResponse","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApplyEntitlementConsumptionResponse","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1authorize/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplyEntitlementConsumptionResponse","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyEntitlementConsumptionResponse","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1authorize/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/authorizeentitlementconsumption"}],"panels":[]}]},"httpPath":"/commerce/entitlements/authorize"},{"label":"Check entitlements by tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/validateentitlementsbytag","routeSlug":"/v1-api-reference/api/commerce/validateentitlementsbytag","metadata":{"seo":{"title":"Check entitlements by tag","description":"Checks whether an account has access to features that match featureTag, or to thefeatures in featureKeys. Do not send featureTag and featureKey in the same request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateEntitlementsByTag","name":"Check entitlements by tag","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1bulk-challenge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check entitlements by tag","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":"Checks whether an account has access to features that match "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureTag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"features in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureKeys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Do not send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureTag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the same request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1bulk-challenge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementsByTagRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byTag","paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byFeatureKeys"]}},"schemaId":"components/schemas/ValidateEntitlementsByTagRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byTag","paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byFeatureKeys"],"pointer":"/paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/entitlements/bulk-challenge","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementsByTagRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byTag","paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byFeatureKeys"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/bulk-challenge","href":"commerce/validateentitlementsbytag","openApiOperationId":"validateEntitlementsByTag","summary":"Check entitlements by tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ValidateEntitlementsByTagRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byTag","paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byFeatureKeys"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementsByTagRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byTag","paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byFeatureKeys"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementsByTagResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ValidateEntitlementsByTagResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1bulk-challenge/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ValidateEntitlementsByTagResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementsByTagResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-challenge/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/validateentitlementsbytag"}],"panels":[]}]},"httpPath":"/commerce/entitlements/bulk-challenge"},{"label":"Check multiple entitlements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/validateentitlementfeatures","routeSlug":"/v1-api-reference/api/commerce/validateentitlementfeatures","metadata":{"seo":{"title":"Check multiple entitlements","description":"Checks whether an account has access to multiple features in one request. IncluderequestedQuantity when evaluating numbered metered features."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateEntitlementFeatures","name":"Check multiple entitlements","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1bulk-check/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check multiple entitlements","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":"Checks whether an account has access to multiple features in one request. Include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when evaluating numbered metered features."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1bulk-check/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementFeaturesRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ValidateEntitlementFeaturesRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1commerce~1entitlements~1bulk-check/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/entitlements/bulk-check","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementFeaturesRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/bulk-check","href":"commerce/validateentitlementfeatures","openApiOperationId":"validateEntitlementFeatures","summary":"Check multiple entitlements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ValidateEntitlementFeaturesRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementFeaturesRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementFeaturesResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ValidateEntitlementFeaturesResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1bulk-check/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ValidateEntitlementFeaturesResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementFeaturesResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-check/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/validateentitlementfeatures"}],"panels":[]}]},"httpPath":"/commerce/entitlements/bulk-check"},{"label":"Create entitlement grants in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/bulkgrantentitlements","routeSlug":"/v1-api-reference/api/commerce/bulkgrantentitlements","metadata":{"seo":{"title":"Create entitlement grants in bulk","description":"Creates runtime entitlement grants for multiple accounts or subscriptions in a singlecall. Each item uses the same shape as POST /commerce/entitlements/grant, but thisoperation reports each item's outcome independently instead of failing the whole batchon the first bad item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkGrantEntitlements","name":"Create entitlement grants in bulk","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1bulk-grant/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create entitlement grants in bulk","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 runtime entitlement grants for multiple accounts or subscriptions in a single"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"call. Each item uses the same shape as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /commerce/entitlements/grant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operation reports each item's outcome independently instead of failing the whole batch"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the first bad item."},"children":[]}]}]},{"$$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":"skipExisting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make batch re-submission idempotent, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continueOnError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"keep processing remaining items after a failure. The request is rejected if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantEntitlementRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty or contains more than 500 items."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing is synchronous and not transactional across items. Each item's rows are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"written independently, so a partially applied item is safe to resubmit when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipExisting"},"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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1bulk-grant/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkGrantEntitlementsRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/batchCreate","paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/idempotentResubmit"]}},"schemaId":"components/schemas/BulkGrantEntitlementsRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/batchCreate","paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/idempotentResubmit"],"pointer":"/paths/~1commerce~1entitlements~1bulk-grant/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/entitlements/bulk-grant","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkGrantEntitlementsRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/batchCreate","paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/idempotentResubmit"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/bulk-grant","href":"commerce/bulkgrantentitlements","openApiOperationId":"bulkGrantEntitlements","summary":"Create entitlement grants in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/BulkGrantEntitlementsRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/batchCreate","paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/idempotentResubmit"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkGrantEntitlementsRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/batchCreate","paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/idempotentResubmit"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkGrantEntitlementsResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/succeeded","paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/partialSuccess"]}},"schemaId":"components/schemas/BulkGrantEntitlementsResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/succeeded","paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/partialSuccess"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementApiError","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/responses/400/content/application~1json/examples/emptyOrTooLarge"]}},"schemaId":"components/schemas/EntitlementApiError","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/responses/400/content/application~1json/examples/emptyOrTooLarge"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1bulk-grant/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkGrantEntitlementsResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/succeeded","paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/partialSuccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkGrantEntitlementsResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/succeeded","paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/partialSuccess"]}}},{"code":"400","schemaId":"components/schemas/EntitlementApiError","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/responses/400/content/application~1json/examples/emptyOrTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementApiError","exampleIds":["paths/~1commerce~1entitlements~1bulk-grant/post/responses/400/content/application~1json/examples/emptyOrTooLarge"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/bulkgrantentitlements"}],"panels":[]}]},"httpPath":"/commerce/entitlements/bulk-grant"},{"label":"Revoke entitlement grants","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/bulkrevokeentitlements","routeSlug":"/v1-api-reference/api/commerce/bulkrevokeentitlements","metadata":{"seo":{"title":"Revoke entitlement grants","description":"Revokes one or more runtime entitlement grants. Include revokedDate when the revocationshould take effect on a specific date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkRevokeEntitlements","name":"Revoke entitlement grants","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1bulk-revoke/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke entitlement grants","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":"Revokes one or more runtime entitlement grants. Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revokedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the revocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should take effect on a specific date."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1bulk-revoke/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkRevokeEntitlementsRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/BulkRevokeEntitlementsRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1commerce~1entitlements~1bulk-revoke/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/entitlements/bulk-revoke","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkRevokeEntitlementsRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","204","400","401","500"],"pointer":"/commerce/entitlements/bulk-revoke","href":"commerce/bulkrevokeentitlements","openApiOperationId":"bulkRevokeEntitlements","summary":"Revoke entitlement grants"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/BulkRevokeEntitlementsRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkRevokeEntitlementsRequest","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkRevokeEntitlementsResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/BulkRevokeEntitlementsResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"204","description":"No Content","headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1bulk-revoke/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkRevokeEntitlementsResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkRevokeEntitlementsResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/responses/200/content/application~1json/examples/response"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1bulk-revoke/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/bulkrevokeentitlements"}],"panels":[]}]},"httpPath":"/commerce/entitlements/bulk-revoke"},{"label":"Check entitlement access","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/validateentitlementaccess","routeSlug":"/v1-api-reference/api/commerce/validateentitlementaccess","metadata":{"seo":{"title":"Check entitlement access","description":"Checks whether an account has access to a feature. For numbered metered features, includerequestedQuantity. For enum features, include enumValues."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateEntitlementAccess","name":"Check entitlement access","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1challenge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check entitlement access","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":"Checks whether an account has access to a feature. For numbered metered features, include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For enum features, include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1challenge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementAccessRequest","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/numberedFeature","paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/enumFeature"]}},"schemaId":"components/schemas/ValidateEntitlementAccessRequest","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/numberedFeature","paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/enumFeature"],"pointer":"/paths/~1commerce~1entitlements~1challenge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/entitlements/challenge","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementAccessRequest","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/numberedFeature","paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/enumFeature"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/challenge","href":"commerce/validateentitlementaccess","openApiOperationId":"validateEntitlementAccess","summary":"Check entitlement access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ValidateEntitlementAccessRequest","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/numberedFeature","paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/enumFeature"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementAccessRequest","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/numberedFeature","paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/booleanFeature","paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/enumFeature"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementAccessResponse","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ValidateEntitlementAccessResponse","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1challenge/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ValidateEntitlementAccessResponse","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidateEntitlementAccessResponse","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1challenge/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/validateentitlementaccess"}],"panels":[]}]},"httpPath":"/commerce/entitlements/challenge"},{"label":"Create entitlement grants","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/createentitlementgrants","routeSlug":"/v1-api-reference/api/commerce/createentitlementgrants","metadata":{"seo":{"title":"Create entitlement grants","description":"Creates one or more runtime entitlement grants. Use this operation to issue a manual grant for an account, independently of a catalog entitlement definition on a plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEntitlementGrants","name":"Create entitlement grants","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1grant/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create entitlement grants","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates one or more runtime entitlement grants. Use this operation to issue a manual grant\nfor an account, independently of a catalog entitlement definition on a plan.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1grant/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEntitlementGrantsRequest","exampleIds":["paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/numberedGrant","paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/booleanGrant"]}},"schemaId":"components/schemas/CreateEntitlementGrantsRequest","exampleIds":["paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/numberedGrant","paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/booleanGrant"],"pointer":"/paths/~1commerce~1entitlements~1grant/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/entitlements/grant","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEntitlementGrantsRequest","exampleIds":["paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/numberedGrant","paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/booleanGrant"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/grant","href":"commerce/createentitlementgrants","openApiOperationId":"createEntitlementGrants","summary":"Create entitlement grants"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateEntitlementGrantsRequest","exampleIds":["paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/numberedGrant","paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/booleanGrant"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEntitlementGrantsRequest","exampleIds":["paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/numberedGrant","paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/booleanGrant"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEntitlementGrantsResponse","exampleIds":["paths/~1commerce~1entitlements~1grant/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CreateEntitlementGrantsResponse","exampleIds":["paths/~1commerce~1entitlements~1grant/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1grant/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1grant/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1grant/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateEntitlementGrantsResponse","exampleIds":["paths/~1commerce~1entitlements~1grant/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEntitlementGrantsResponse","exampleIds":["paths/~1commerce~1entitlements~1grant/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1grant/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1grant/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/createentitlementgrants"}],"panels":[]}]},"httpPath":"/commerce/entitlements/grant"},{"label":"List entitlement grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getentitlementgrants","routeSlug":"/v1-api-reference/api/commerce/getentitlementgrants","metadata":{"seo":{"title":"List entitlement grants","description":"Lists runtime entitlement grants. Filter results by account, subscription, feature, state, or charge source."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlementGrants","name":"List entitlement grants","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1grants/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List entitlement grants","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists runtime entitlement grants. Filter results by account, subscription, feature, state, or charge source.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountKey","in":"query","schemaId":"schema_5","description":"Account number or account ID used to filter grants."},{"name":"subscriptionKey","in":"query","schemaId":"schema_5","description":"Subscription number or subscription ID used to filter grants."},{"name":"featureKey","in":"query","schemaId":"schema_5","description":"Feature key used to filter grants."},{"name":"state","in":"query","schemaId":"schema_26","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grant state used to filter results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values: "},"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":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"chargeSource","in":"query","schemaId":"schema_5","description":"Charge source used to filter grants, for example a subscription charge or add-on."},{"name":"includeAddons","in":"query","schemaId":"schema_27","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes grants that originated from add-on subscriptions."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_25","description":"Number of grants returned per page."},{"name":"pageToken","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token of the page to retrieve. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextPageToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the previous response."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1grants/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1grants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commerce/entitlements/grants","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"accountKey","in":"query","required":false,"schemaId":"schema_5"},{"name":"subscriptionKey","in":"query","required":false,"schemaId":"schema_5"},{"name":"featureKey","in":"query","required":false,"schemaId":"schema_5"},{"name":"state","in":"query","required":false,"schemaId":"schema_26"},{"name":"chargeSource","in":"query","required":false,"schemaId":"schema_5"},{"name":"includeAddons","in":"query","required":false,"schemaId":"schema_27"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_25"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/grants","href":"commerce/getentitlementgrants","openApiOperationId":"getEntitlementGrants","summary":"List entitlement grants"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementGrantsResponse","exampleIds":["paths/~1commerce~1entitlements~1grants/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListEntitlementGrantsResponse","exampleIds":["paths/~1commerce~1entitlements~1grants/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1grants/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEntitlementGrantsResponse","exampleIds":["paths/~1commerce~1entitlements~1grants/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementGrantsResponse","exampleIds":["paths/~1commerce~1entitlements~1grants/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/getentitlementgrants"}],"panels":[]}]},"httpPath":"/commerce/entitlements/grants"},{"label":"Retrieve an entitlement grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/getentitlementgrant","routeSlug":"/v1-api-reference/api/commerce/getentitlementgrant","metadata":{"seo":{"title":"Retrieve an entitlement grant","description":"Retrieves one runtime entitlement grant by its entitlement key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlementGrant","name":"Retrieve an entitlement grant","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an entitlement grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves one runtime entitlement grant by its entitlement key.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementKey","in":"path","schemaId":"schema_5","description":"Unique key of the runtime entitlement grant.","required":true}],"pointer":"/paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commerce/entitlements/grants/{entitlementKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"entitlementKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/grants/{entitlementKey}","href":"commerce/getentitlementgrant","openApiOperationId":"getEntitlementGrant","summary":"Retrieve an entitlement grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEntitlementGrantResponse","exampleIds":["paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEntitlementGrantResponse","exampleIds":["paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEntitlementGrantResponse","exampleIds":["paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEntitlementGrantResponse","exampleIds":["paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/getentitlementgrant"}],"panels":[]}]},"httpPath":"/commerce/entitlements/grants/{entitlementKey}"},{"label":"Update an entitlement grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateentitlementgrant","routeSlug":"/v1-api-reference/api/commerce/updateentitlementgrant","metadata":{"seo":{"title":"Update an entitlement grant","description":"Updates the dates or quantity of a runtime entitlement grant. Use redate withstartDate and/or endDate to change the grant term, or increment and decrementwith delta to change the granted quantity. Billable grants may return status: queuedwith an orderIntentId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEntitlementGrant","name":"Update an entitlement grant","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an entitlement grant","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 dates or quantity of a runtime entitlement grant. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to change the grant term, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"increment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decrement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to change the granted quantity. Billable grants may return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: queued"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderIntentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementKey","in":"path","schemaId":"schema_5","description":"Unique key of the runtime entitlement grant.","required":true}],"pointer":"/paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementGrantRequest","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/increment","paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/decrement","paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/redate"]}},"schemaId":"components/schemas/UpdateEntitlementGrantRequest","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/increment","paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/decrement","paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/redate"],"pointer":"/paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/entitlements/{entitlementKey}/modify","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"entitlementKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementGrantRequest","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/increment","paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/decrement","paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/redate"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/{entitlementKey}/modify","href":"commerce/updateentitlementgrant","openApiOperationId":"updateEntitlementGrant","summary":"Update an entitlement grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateEntitlementGrantRequest","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/increment","paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/decrement","paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/redate"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementGrantRequest","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/increment","paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/decrement","paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/redate"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementGrantResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdateEntitlementGrantResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateEntitlementGrantResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementGrantResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/updateentitlementgrant"}],"panels":[]}]},"httpPath":"/commerce/entitlements/{entitlementKey}/modify"},{"label":"Update entitlement grant state","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commerce/updateentitlementgrantstate","routeSlug":"/v1-api-reference/api/commerce/updateentitlementgrantstate","metadata":{"seo":{"title":"Update entitlement grant state","description":"Updates the state of a runtime entitlement grant. Supported action values are pause,resume, activate, deactivate, and revoke."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEntitlementGrantState","name":"Update entitlement grant state","isWebhook":false,"pointer":"/paths/~1commerce~1entitlements~1{entitlementKey}~1state/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update entitlement grant state","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 state of a runtime entitlement grant. Supported "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pause"},"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":"resume"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deactivate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoke"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementKey","in":"path","schemaId":"schema_5","description":"Unique key of the runtime entitlement grant.","required":true}],"pointer":"/paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementGrantStateRequest","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/pause","paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/deactivate","paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/revoke"]}},"schemaId":"components/schemas/UpdateEntitlementGrantStateRequest","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/pause","paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/deactivate","paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/revoke"],"pointer":"/paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commerce/entitlements/{entitlementKey}/state","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"entitlementKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementGrantStateRequest","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/pause","paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/deactivate","paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/revoke"]}},"responseCodes":["200","400","401","500"],"pointer":"/commerce/entitlements/{entitlementKey}/state","href":"commerce/updateentitlementgrantstate","openApiOperationId":"updateEntitlementGrantState","summary":"Update entitlement grant state"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateEntitlementGrantStateRequest","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/pause","paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/deactivate","paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/revoke"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementGrantStateRequest","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/pause","paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/deactivate","paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/revoke"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementGrantStateResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdateEntitlementGrantStateResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateEntitlementGrantStateResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEntitlementGrantStateResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce/updateentitlementgrantstate"}],"panels":[]}]},"httpPath":"/commerce/entitlements/{entitlementKey}/state"}],"content":{"contentType":"group","meta":{"name":"Commerce"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Commerce","showPageActions":true},{"nodeType":"markdoc","content":"The Commerce APIs provide access to product catalog, billable metrics, features, plans, charges, runtime\nentitlement grants, access decisions, audit events, and order management functionality in Zuora. These endpoints are used to create, update,\nand query billable metrics, features, product-feature links, plan entitlement definitions, product rate plans,\ncharges, dynamic pricing details, runtime entitlement grants, entitlement access decisions, and entitlement audit events that drive subscription and billing behavior.\n\nIn a typical use case, the Commerce APIs are called to provision new products\nor plans in the catalog, configure dimensional pricing, or submit orders that\ncreate and modify subscriptions.\n\nChanges made with these APIs affect the product catalog and active subscriptions,\ndepending on the endpoint. Catalog changes update future subscription behavior,\nwhile order operations directly impact customer subscriptions in real time.'"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/commerce/billable-metrics","summary":"Create a billable metric","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/createbillablemetric","deprecated":false},{"title":"/commerce/billable-metrics","summary":"List billable metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commerce/getbillablemetrics","deprecated":false},{"title":"/commerce/billable-metrics/{id}","summary":"Retrieve a billable metric","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commerce/getbillablemetric","deprecated":false},{"title":"/commerce/billable-metrics/{id}","summary":"Update a billable metric","prefix":{"name":"put","color":"put"},"badges":[],"link":"/commerce/updatebillablemetric","deprecated":false},{"title":"/commerce/billable-metrics/{id}","summary":"Delete a billable metric","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/commerce/deletebillablemetric","deprecated":false},{"title":"/commerce/features","summary":"Create a feature","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/createfeature","deprecated":false},{"title":"/commerce/features","summary":"List features","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commerce/getfeatures","deprecated":false},{"title":"/commerce/features","summary":"Update a feature","prefix":{"name":"put","color":"put"},"badges":[],"link":"/commerce/updatefeature","deprecated":false},{"title":"/commerce/features/search","summary":"Search features","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/searchfeatures","deprecated":false},{"title":"/commerce/features/{id}","summary":"Retrieve a feature","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commerce/getfeature","deprecated":false},{"title":"/commerce/features/{id}","summary":"Delete a feature","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/commerce/deletefeature","deprecated":false},{"title":"/commerce/charges","summary":"Create a product rate plan charge with Dynamic Pricing","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/createproductrateplanchargewithdynamicpricing","deprecated":false},{"title":"/commerce/charges","summary":"Update a product rate plan charge with Dynamic Pricing","prefix":{"name":"put","color":"put"},"badges":[],"link":"/commerce/updateproductrateplanchargewithdynamicpricing","deprecated":false},{"title":"/commerce/charges/query","summary":"Query a product rate plan charge with Dynamic Pricing","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/queryproductrateplanchargewithdynamicpricing","deprecated":false},{"title":"/commerce/products","summary":"Create a product with plans and charges","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/createproduct","deprecated":false},{"title":"/commerce/products","summary":"Update a product","prefix":{"name":"put","color":"put"},"badges":[],"link":"/commerce/updateproduct","deprecated":false},{"title":"/commerce/plans","summary":"Create a product rate plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/createplan","deprecated":false},{"title":"/commerce/plans","summary":"Update a product rate plan","prefix":{"name":"put","color":"put"},"badges":[],"link":"/commerce/updateproductrateplan","deprecated":false},{"title":"/commerce/plans/query","summary":"Query product rate plan details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/querycommerceproductrateplans","deprecated":false},{"title":"/commerce/plans/list","summary":"Query product rate plans","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/querycommerceplanslist","deprecated":false},{"title":"/commerce/plans/{id}/entitlements","summary":"Create an entitlement definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/createentitlementdefinition","deprecated":false},{"title":"/commerce/plans/entitlements","summary":"Update an entitlement definition","prefix":{"name":"put","color":"put"},"badges":[],"link":"/commerce/updateentitlementdefinition","deprecated":false},{"title":"/commerce/plans/entitlements/{id}","summary":"Retrieve an entitlement definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commerce/getentitlementdefinition","deprecated":false},{"title":"/commerce/products/{product_key}","summary":"Retrieve a product by key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/getproductbykey","deprecated":false},{"title":"/commerce/products/{id}/features/add","summary":"Add a feature to a product","prefix":{"name":"put","color":"put"},"badges":[],"link":"/commerce/addproductfeature","deprecated":false},{"title":"/commerce/legacy/products/list","summary":"Query legacy products from the Product Catalog","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/querylegacyproducts","deprecated":false},{"title":"/commerce/tiers","summary":"Update a product rate plan charge tier","prefix":{"name":"put","color":"put"},"badges":[],"link":"/commerce/updatetier","deprecated":false},{"title":"/commerce/purchase-options/list","summary":"Query purchase options by PRP ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/querypurchaseoptionsbyprpid","deprecated":false},{"title":"/commerce/entitlements/audit-events","summary":"List entitlement audit events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commerce/getentitlementauditevents","deprecated":false},{"title":"/commerce/entitlements/authorize","summary":"Authorize entitlement consumption","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/authorizeentitlementconsumption","deprecated":false},{"title":"/commerce/entitlements/bulk-challenge","summary":"Check entitlements by tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/validateentitlementsbytag","deprecated":false},{"title":"/commerce/entitlements/bulk-check","summary":"Check multiple entitlements","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/validateentitlementfeatures","deprecated":false},{"title":"/commerce/entitlements/bulk-grant","summary":"Create entitlement grants in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/bulkgrantentitlements","deprecated":false},{"title":"/commerce/entitlements/bulk-revoke","summary":"Revoke entitlement grants","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/bulkrevokeentitlements","deprecated":false},{"title":"/commerce/entitlements/challenge","summary":"Check entitlement access","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/validateentitlementaccess","deprecated":false},{"title":"/commerce/entitlements/grant","summary":"Create entitlement grants","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/createentitlementgrants","deprecated":false},{"title":"/commerce/entitlements/grants","summary":"List entitlement grants","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commerce/getentitlementgrants","deprecated":false},{"title":"/commerce/entitlements/grants/{entitlementKey}","summary":"Retrieve an entitlement grant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commerce/getentitlementgrant","deprecated":false},{"title":"/commerce/entitlements/{entitlementKey}/modify","summary":"Update an entitlement grant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/updateentitlementgrant","deprecated":false},{"title":"/commerce/entitlements/{entitlementKey}/state","summary":"Update entitlement grant state","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce/updateentitlementgrantstate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Customer Accounts","content":null},{"type":"group","label":"Accounts","link":"/v1-api-reference/api/accounts","routeSlug":"/v1-api-reference/api/accounts","items":[{"label":"Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/post_account","routeSlug":"/v1-api-reference/api/accounts/post_account","metadata":{"seo":{"title":"Create an account","description":"Creates a customer account with a payment method, a bill-to contact,and optional sold-to and ship-to contacts. Request and response field descriptions and sample code are provided. Use this operation to optionally create a subscription,invoice for that subscription, and collect payment through the default payment method. The transaction is atomic; if any part fails for any reason, the entiretransaction is rolled back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Account","name":"Create an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account","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 customer account with a payment method, a bill-to contact,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and optional sold-to and ship-to contacts. Request and response field descriptions and sample code are provided. Use this operation to optionally create a subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice for that subscription, and collect payment through the default payment method. The transaction is atomic; if any part fails for any reason, the entire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction is rolled back."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is CORS Enabled, so you can use client-side Javascript to invoke the call."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounts/post_account/request/notes","deepLinkHash":"/accounts/post_account#accounts/post_account/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account is created in active status."},"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":"autoPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request, you must provide one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hpmCreditCardPaymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field, but not multiple. The one provided becomes the default payment method"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for this account. If the credit card information is declined or cannot be verified,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no account is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer accounts created with this call are automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be set to Auto Pay."},"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":"invoiceDeliveryPrefsEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the request, the account's email delivery preference is always automatically"},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no matter whether the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  or  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personalEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounts/post_account/request/defaults-for-customeracceptancedate-and-serviceactivationdate","deepLinkHash":"/accounts/post_account#accounts/post_account/request/defaults-for-customeracceptancedate-and-serviceactivationdate"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults for customerAcceptanceDate and serviceActivationDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default values for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customerAcceptanceDate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are set as follows."},"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":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceActivationDate(SA) specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceActivationDate (SA) NOT specified"},"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":"customerAcceptanceDate (CA) specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA uses value in the request call; CA uses value in the request call"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CA uses value in the request call;SA uses CE as default"},"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":"customerAcceptanceDate (CA) NOT specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA uses value in the request call; CA uses SA as default"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA and CA use CE as default"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call supports a subset of the functionality of our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For use cases where you create a subscription and a billing account at the same time, we recommend using \"Create an order\" instead of this call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Orders call has the following advantages:"},"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":"Provides options for managing the entire subscription lifecycle from creation through to cancellation using different order actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the creation or modifying of multiple subscriptions in a single order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows a single order to combine both recurring subscription digital goods or services with order line items for physical goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders are treated as atomic transactions. If any part fails, the entire order, subscription, and billing account creation are rolled back."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should use this call if you need to create a standalone billing account, and create orders, subscriptions, standalone invoices, or dynamic usage charges later."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no deprecation plans for this call and we will continue to support this call for existing users."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTAccountType"}},"schemaId":"components/schemas/POSTAccountType","pointer":"/paths/~1v1~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTAccountType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts","href":"accounts/post_account","openApiOperationId":"POST_Account","summary":"Create an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTAccountType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTAccountType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTAccountResponseType","exampleIds":["paths/~1v1~1accounts/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTAccountResponseType","exampleIds":["paths/~1v1~1accounts/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTAccountResponseType","exampleIds":["paths/~1v1~1accounts/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTAccountResponseType","exampleIds":["paths/~1v1~1accounts/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/post_account"}],"panels":[]}]},"httpPath":"/v1/accounts"},{"label":"Delete an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/delete_account","routeSlug":"/v1-api-reference/api/accounts/delete_account","metadata":{"seo":{"title":"Delete an account","description":"Deletes a specific account asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_Account","name":"Delete an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{account-key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an account","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 specific account asynchronously."},"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":"Notes and Limitations:"},"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":"For account deletion, the system will start a backend job to remove all transactions under the accounts and change the status of the accounts to 'Cancelled'. This backend job is asynchronous and will take some time, depending on the job size."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An account cannot be deleted when the account is either the invoice owner or the subscription owner of a subscription and the subscription's invoice owner and subscription owner are two different accounts. An exception to this limitation is if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable Force Deletion for Account?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can force delete an account that is the subscription owner of a subscription while the invoice owner is a different account. Force deleting this account deletes all its subscriptions, but the relevant invoices will not be impacted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An account cannot be deleted if this account has ever been involved in an Owner Transfer amendment or order action, either as the current owner or as the previous owner."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account-key","in":"path","schemaId":"schema_5","description":"Account number or account ID.","required":true}],"pointer":"/paths/~1v1~1accounts~1{account-key}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{account-key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/accounts/{account-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"account-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/{account-key}","href":"accounts/delete_account","openApiOperationId":"DELETE_Account","summary":"Delete an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteAccountResponseType","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteAccountResponseType","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1{account-key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteAccountResponseType","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteAccountResponseType","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/delete_account"}],"panels":[]}]},"httpPath":"/v1/accounts/{account-key}"},{"label":"Retrieve an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/get_account","routeSlug":"/v1-api-reference/api/accounts/get_account","metadata":{"seo":{"title":"Retrieve an account","description":"Retrieves basic information about a customer account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Account","name":"Retrieve an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{account-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves basic information about a customer account.\n\nThis operation is a quick retrieval that doesn't include the account's subscriptions, invoices, payments, or usage details. Use Get account summary to get more detailed information about an account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account-key","in":"path","schemaId":"schema_5","description":"Account number or account ID.","required":true}],"pointer":"/paths/~1v1~1accounts~1{account-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{account-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts/{account-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"account-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/{account-key}","href":"accounts/get_account","openApiOperationId":"GET_Account","summary":"Retrieve an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountType","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAccountType","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1{account-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAccountType","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountType","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/get_account"}],"panels":[]}]},"httpPath":"/v1/accounts/{account-key}"},{"label":"Update an account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/put_account","routeSlug":"/v1-api-reference/api/accounts/put_account","metadata":{"seo":{"title":"Update an account","description":"Updates a customer account by specifying the account-key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_Account","name":"Update an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{account-key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an account","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 customer account by specifying the account-key."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounts/put_account/request/notes","deepLinkHash":"/accounts/put_account#accounts/put_account/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the fields to be changed should be specified.  Any field that is not included in the request body will not be 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 field is submitted with this operation, the corresponding field in the account is emptied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email addresses: If no email addresses are specified, no change is made to the email addresses or to the email delivery preference. If either the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personalEmail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workEmail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billToContact"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified (or both), the system updates the corresponding email address(es) and the email delivery preference is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". (In that case, emails go to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workEmail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address, if it exists, or else the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personalEmail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".) On the other hand, if as a result of this call both of the email addresses for the account are empty, the email delivery preference is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"The Bill To, Sold To, and Ship To contacts are separate contact entities. However, if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToSameAsBillTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating an account, the Bill To and Sold To contacts will refer to the same contact entity. As a result, updating either contact will update both. The same behavior applies to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToSameAsBillTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and the Ship To contact. In this case, if you want to update only one of the contacts, you must create a new contact and then update the Bill To, Sold To, or Ship To contact to reference the newly created one."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account-key","in":"path","schemaId":"schema_5","description":"Account number or account ID.","required":true}],"pointer":"/paths/~1v1~1accounts~1{account-key}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{account-key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTAccountType"}},"schemaId":"components/schemas/PUTAccountType","pointer":"/paths/~1v1~1accounts~1{account-key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounts/{account-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"account-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTAccountType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/{account-key}","href":"accounts/put_account","openApiOperationId":"PUT_Account","summary":"Update an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTAccountType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTAccountType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1{account-key}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/put_account"}],"panels":[]}]},"httpPath":"/v1/accounts/{account-key}"},{"label":"List payment methods of an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/get_acountpaymentmethods","routeSlug":"/v1-api-reference/api/accounts/get_acountpaymentmethods","metadata":{"seo":{"title":"List payment methods of an account","description":"Retrieves the payment methods of the specified customer account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AcountPaymentMethods","name":"List payment methods of an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment methods of an account","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 the payment methods of the specified customer account."},"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 also supports retrieving custom payment methods created through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-specialized-payment-connections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open Payment Method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" service."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account-key","in":"path","schemaId":"schema_5","description":"Account number or account ID.","required":true}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isDefaultOnly","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to only retrieve the default payment method of the account. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only the default payment method is retrieved."},"children":[]}]}]}]},{"name":"isActiveOnly","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to only retrieve the active payment methods of the account. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only the active payment methods are retrieved."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts/{account-key}/payment-methods","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"account-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"isDefaultOnly","in":"query","required":false,"schemaId":"schema_27"},{"name":"isActiveOnly","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/{account-key}/payment-methods","href":"accounts/get_acountpaymentmethods","openApiOperationId":"GET_AcountPaymentMethods","summary":"List payment methods of an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountPaymentMethodType","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAccountPaymentMethodType","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAccountPaymentMethodType","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountPaymentMethodType","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/get_acountpaymentmethods"}],"panels":[]}]},"httpPath":"/v1/accounts/{account-key}/payment-methods"},{"label":"Retrieve configuration of cascading payment methods for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/getaccountpaymentmethodcascading","routeSlug":"/v1-api-reference/api/accounts/getaccountpaymentmethodcascading","metadata":{"seo":{"title":"Retrieve configuration of cascading payment methods for an account","description":"Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to retrieve the configuration information for Cascading Payment Method of a specified account, including the cascading consent value and the priority list of payment methods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAccountPaymentMethodCascading","name":"Retrieve configuration of cascading payment methods for an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve configuration of cascading payment methods for an account","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":"Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to retrieve the configuration information for Cascading Payment Method of a specified account, including the cascading consent value and the priority list of payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-cascade-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cascade payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account-key","in":"path","schemaId":"schema_5","description":"Account ID.","required":true}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts/{account-key}/payment-methods/cascading","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"account-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/{account-key}/payment-methods/cascading","href":"accounts/getaccountpaymentmethodcascading","openApiOperationId":"GetAccountPaymentMethodCascading","summary":"Retrieve configuration of cascading payment methods for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCascadingPaymentMethodsConfigurationResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetCascadingPaymentMethodsConfigurationResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCascadingPaymentMethodsConfigurationResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCascadingPaymentMethodsConfigurationResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/getaccountpaymentmethodcascading"}],"panels":[]}]},"httpPath":"/v1/accounts/{account-key}/payment-methods/cascading"},{"label":"Configure cascading payment methods for an account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/putaccountpaymentmethodcascading","routeSlug":"/v1-api-reference/api/accounts/putaccountpaymentmethodcascading","metadata":{"seo":{"title":"Configure cascading payment methods for an account","description":"Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to configure the cascading consent for a specified account and set up the priority list of payment methods to be used in Cascading Payment Method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAccountPaymentMethodCascading","name":"Configure cascading payment methods for an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure cascading payment methods for an account","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":"Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to configure the cascading consent for a specified account and set up the priority list of payment methods to be used in Cascading Payment Method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-cascade-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cascade payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account-key","in":"path","schemaId":"schema_5","description":"Account ID.","required":true}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutCascadingPaymentMethodsConfigurationRequest"}},"schemaId":"components/schemas/PutCascadingPaymentMethodsConfigurationRequest","pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounts/{account-key}/payment-methods/cascading","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"account-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutCascadingPaymentMethodsConfigurationRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/{account-key}/payment-methods/cascading","href":"accounts/putaccountpaymentmethodcascading","openApiOperationId":"PutAccountPaymentMethodCascading","summary":"Configure cascading payment methods for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutCascadingPaymentMethodsConfigurationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutCascadingPaymentMethodsConfigurationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/putaccountpaymentmethodcascading"}],"panels":[]}]},"httpPath":"/v1/accounts/{account-key}/payment-methods/cascading"},{"label":"Retrieve the default payment method of an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/get_acountdefaultpaymentmethod","routeSlug":"/v1-api-reference/api/accounts/get_acountdefaultpaymentmethod","metadata":{"seo":{"title":"Retrieve the default payment method of an account","description":"Retrieves the default payment method of the specified customer account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AcountDefaultPaymentMethod","name":"Retrieve the default payment method of an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the default payment method of an account","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 the default payment method of the specified customer account."},"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":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation also supports retrieving the custom payment method created through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-specialized-payment-connections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open Payment Method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" service. "},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation only works with an electronic payment method and does not work with non-electronic payment methods."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account-key","in":"path","schemaId":"schema_5","description":"Account number or account ID.","required":true}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts/{account-key}/payment-methods/default","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"account-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/{account-key}/payment-methods/default","href":"accounts/get_acountdefaultpaymentmethod","openApiOperationId":"GET_AcountDefaultPaymentMethod","summary":"Retrieve the default payment method of an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentMethodResponseForAccount","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentMethodResponseForAccount","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentMethodResponseForAccount","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentMethodResponseForAccount","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/get_acountdefaultpaymentmethod"}],"panels":[]}]},"httpPath":"/v1/accounts/{account-key}/payment-methods/default"},{"label":"Retrieve an account summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounts/get_accountsummary","routeSlug":"/v1-api-reference/api/accounts/get_accountsummary","metadata":{"seo":{"title":"Retrieve an account summary","description":"Retrieves detailed information about the specified customer account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AccountSummary","name":"Retrieve an account summary","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{account-key}~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account summary","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 detailed information about the specified customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounts/get_accountsummary/request/notes","deepLinkHash":"/accounts/get_accountsummary#accounts/get_accountsummary/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns only the six most recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans and many rate plan charges. These items are subject to the maximum limit on the array size."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account-key","in":"path","schemaId":"schema_5","description":"Account number or account ID.","required":true}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1summary/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeUsage","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicate whether to exclude usage information in the response. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1summary/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts/{account-key}/summary","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"account-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"excludeUsage","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/{account-key}/summary","href":"accounts/get_accountsummary","openApiOperationId":"GET_AccountSummary","summary":"Retrieve an account summary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountSummaryType","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAccountSummaryType","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1{account-key}~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAccountSummaryType","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountSummaryType","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{account-key}~1summary/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/get_accountsummary"}],"panels":[]}]},"httpPath":"/v1/accounts/{account-key}/summary"}],"content":{"contentType":"group","meta":{"name":"Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","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":"Some operations in this section are similar to each other, but are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provided for different use scenarios. You should choose the one that best suits"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your needs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/GET_Account/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation retrieves the basic information of an account, such as bill-to and sold-to contacts, billing and payments setup information, and metrics data for the account."},"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":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/GET_AccountSummary/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an account summary"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation returns the more detailed information of an account, such as bill-to and sold-to contacts, subscriptions, invoices, payments, and usages associated with this account."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/accounts","summary":"Create an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounts/post_account","deprecated":false},{"title":"/v1/accounts/{account-key}","summary":"Delete an account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/accounts/delete_account","deprecated":false},{"title":"/v1/accounts/{account-key}","summary":"Retrieve an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/get_account","deprecated":false},{"title":"/v1/accounts/{account-key}","summary":"Update an account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounts/put_account","deprecated":false},{"title":"/v1/accounts/{account-key}/payment-methods","summary":"List payment methods of an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/get_acountpaymentmethods","deprecated":false},{"title":"/v1/accounts/{account-key}/payment-methods/cascading","summary":"Retrieve configuration of cascading payment methods for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/getaccountpaymentmethodcascading","deprecated":false},{"title":"/v1/accounts/{account-key}/payment-methods/cascading","summary":"Configure cascading payment methods for an account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounts/putaccountpaymentmethodcascading","deprecated":false},{"title":"/v1/accounts/{account-key}/payment-methods/default","summary":"Retrieve the default payment method of an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/get_acountdefaultpaymentmethod","deprecated":false},{"title":"/v1/accounts/{account-key}/summary","summary":"Retrieve an account summary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/get_accountsummary","deprecated":false}]}]}]}]}},{"type":"group","label":"Contacts","link":"/v1-api-reference/api/contacts","routeSlug":"/v1-api-reference/api/contacts","items":[{"label":"Create a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/post_createcontact","routeSlug":"/v1-api-reference/api/contacts/post_createcontact","metadata":{"seo":{"title":"Create a contact","description":"Creates a contact for a specified account. Each account must have at least one contact before it can be saved. You can add a maximum of 2000 contacts to an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateContact","name":"Create a contact","isWebhook":false,"pointer":"/paths/~1v1~1contacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a contact for a specified account. Each account must have at least one contact before it can be saved. You can add a maximum of 2000 contacts to an account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1contacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTContactType"}},"schemaId":"components/schemas/POSTContactType","pointer":"/paths/~1v1~1contacts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/contacts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTContactType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/contacts","href":"contacts/post_createcontact","openApiOperationId":"POST_CreateContact","summary":"Create a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTContactType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTContactType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1contacts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/post_createcontact"}],"panels":[]}]},"httpPath":"/v1/contacts"},{"label":"Delete a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/delete_contact","routeSlug":"/v1-api-reference/api/contacts/delete_contact","metadata":{"seo":{"title":"Delete a contact","description":"Deletes a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_Contact","name":"Delete a contact","isWebhook":false,"pointer":"/paths/~1v1~1contacts~1{contactId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a contact.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contactId","in":"path","schemaId":"schema_5","description":"The ID of the contact that you want to delete.\n","required":true}],"pointer":"/paths/~1v1~1contacts~1{contactId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1contacts~1{contactId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/contacts/{contactId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"contactId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/contacts/{contactId}","href":"contacts/delete_contact","openApiOperationId":"DELETE_Contact","summary":"Delete a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1contacts~1{contactId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/delete_contact"}],"panels":[]}]},"httpPath":"/v1/contacts/{contactId}"},{"label":"Retrieve a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/get_contact","routeSlug":"/v1-api-reference/api/contacts/get_contact","metadata":{"seo":{"title":"Retrieve a contact","description":"Retrieves detailed information about a specific contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Contact","name":"Retrieve a contact","isWebhook":false,"pointer":"/paths/~1v1~1contacts~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific contact.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contactId","in":"path","schemaId":"schema_5","description":"The ID of the contact that you want to retrieve.\n","required":true}],"pointer":"/paths/~1v1~1contacts~1{contactId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1contacts~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/contacts/{contactId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"contactId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/contacts/{contactId}","href":"contacts/get_contact","openApiOperationId":"GET_Contact","summary":"Retrieve a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1contacts~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/get_contact"}],"panels":[]}]},"httpPath":"/v1/contacts/{contactId}"},{"label":"Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/put_contact","routeSlug":"/v1-api-reference/api/contacts/put_contact","metadata":{"seo":{"title":"Update a contact","description":"Updates a contact for a specified account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_Contact","name":"Update a contact","isWebhook":false,"pointer":"/paths/~1v1~1contacts~1{contactId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a contact for a specified account.\n\nYou can update contacts for cancelled accounts.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contactId","in":"path","schemaId":"schema_5","description":"The ID of the contact that you want to update.\n","required":true}],"pointer":"/paths/~1v1~1contacts~1{contactId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1contacts~1{contactId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTContactType"}},"schemaId":"components/schemas/PUTContactType","pointer":"/paths/~1v1~1contacts~1{contactId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/contacts/{contactId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"contactId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTContactType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/contacts/{contactId}","href":"contacts/put_contact","openApiOperationId":"PUT_Contact","summary":"Update a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTContactType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTContactType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1contacts~1{contactId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/put_contact"}],"panels":[]}]},"httpPath":"/v1/contacts/{contactId}"},{"label":"Transfer a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/transfercontent","routeSlug":"/v1-api-reference/api/contacts/transfercontent","metadata":{"seo":{"title":"Transfer a contact","description":"This operation transfers contacts of the accounts within the Customer Hierarchy when removing the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferContent","name":"Transfer a contact","isWebhook":false,"pointer":"/paths/~1v1~1contacts~1{contactId}~1transfer/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation transfers contacts of the accounts within the Customer Hierarchy when removing the account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contactId","in":"path","schemaId":"schema_5","description":"The ID of the contact that you want to scrub sensitive data from.\n","required":true}],"pointer":"/paths/~1v1~1contacts~1{contactId}~1transfer/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1contacts~1{contactId}~1transfer/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTTransferContact"}},"schemaId":"components/schemas/PUTTransferContact","pointer":"/paths/~1v1~1contacts~1{contactId}~1transfer/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/contacts/{contactId}/transfer","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"contactId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTTransferContact"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/contacts/{contactId}/transfer","href":"contacts/transfercontent","openApiOperationId":"transferContent","summary":"Transfer a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTTransferContact","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTTransferContact"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1contacts~1{contactId}~1transfer/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/transfercontent"}],"panels":[]}]},"httpPath":"/v1/contacts/{contactId}/transfer"},{"label":"Scrub a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contacts/put_scrubcontact","routeSlug":"/v1-api-reference/api/contacts/put_scrubcontact","metadata":{"seo":{"title":"Scrub a contact","description":"Scrubs the sensitive data of a specific contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_ScrubContact","name":"Scrub a contact","isWebhook":false,"pointer":"/paths/~1v1~1contacts~1{contactId}~1scrub/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scrub a contact","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":"Scrubs the sensitive data of a specific contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this operation to replace all sensitive data in a contact and its related contact snapshot with dummy values that will be stored in Zuora databases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After scrubbing a contact, it is good practice to delete it. Otherwise, it might cause errors in subsequent operations."},"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":": To use this operation, you must ensure that the \"Scrub Sensitive Data of Contact\" billing permission is enabled in your user role. Contact your tenant administrator if you want to enable this permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-scrub-contacts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scrub Contacts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contactId","in":"path","schemaId":"schema_5","description":"The ID of the contact that you want to scrub sensitive data from.\n","required":true}],"pointer":"/paths/~1v1~1contacts~1{contactId}~1scrub/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1contacts~1{contactId}~1scrub/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/contacts/{contactId}/scrub","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"contactId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/contacts/{contactId}/scrub","href":"contacts/put_scrubcontact","openApiOperationId":"PUT_ScrubContact","summary":"Scrub a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1contacts~1{contactId}~1scrub/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/put_scrubcontact"}],"panels":[]}]},"httpPath":"/v1/contacts/{contactId}/scrub"}],"content":{"contentType":"group","meta":{"name":"Contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts","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":"A contact defines the customer who holds an account or who is otherwise a person to contact about an account. An account requires a contact for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillToId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SoldToId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields before the account can be active."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/contacts","summary":"Create a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/post_createcontact","deprecated":false},{"title":"/v1/contacts/{contactId}","summary":"Delete a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/delete_contact","deprecated":false},{"title":"/v1/contacts/{contactId}","summary":"Retrieve a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/get_contact","deprecated":false},{"title":"/v1/contacts/{contactId}","summary":"Update a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/put_contact","deprecated":false},{"title":"/v1/contacts/{contactId}/transfer","summary":"Transfer a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/transfercontent","deprecated":false},{"title":"/v1/contacts/{contactId}/scrub","summary":"Scrub a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/put_scrubcontact","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Snapshots","link":"/v1-api-reference/api/contact-snapshots","routeSlug":"/v1-api-reference/api/contact-snapshots","items":[{"label":"Retrieve a contact snapshot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/contact-snapshots/get_contactsnapshot","routeSlug":"/v1-api-reference/api/contact-snapshots/get_contactsnapshot","metadata":{"seo":{"title":"Retrieve a contact snapshot","description":"Retrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ContactSnapshot","name":"Retrieve a contact snapshot","isWebhook":false,"pointer":"/paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a contact snapshot","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact-snapshot-id","in":"path","schemaId":"schema_5","description":"The unique ID of the contact snapshot to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab.\n","required":true}],"pointer":"/paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/contact-snapshots/{contact-snapshot-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"contact-snapshot-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/contact-snapshots/{contact-snapshot-id}","href":"contact-snapshots/get_contactsnapshot","openApiOperationId":"GET_ContactSnapshot","summary":"Retrieve a contact snapshot"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETContactSnapshotResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETContactSnapshotResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETContactSnapshotResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETContactSnapshotResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-snapshots/get_contactsnapshot"}],"panels":[]}]},"httpPath":"/v1/contact-snapshots/{contact-snapshot-id}"}],"content":{"contentType":"group","meta":{"name":"Contact Snapshots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Snapshots","showPageActions":true},{"nodeType":"markdoc","content":"Every time a contact is updated a snapshot is taken."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/contact-snapshots/{contact-snapshot-id}","summary":"Retrieve a contact snapshot","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-snapshots/get_contactsnapshot","deprecated":false}]}]}]}]}},{"type":"separator","label":"Orders and Subscriptions","content":null},{"type":"group","label":"Sign Up","link":"/v1-api-reference/api/sign-up","routeSlug":"/v1-api-reference/api/sign-up","items":[{"label":"Sign up","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sign-up/post_signup","routeSlug":"/v1-api-reference/api/sign-up/post_signup","metadata":{"seo":{"title":"Sign up","description":"This call performs many actions. You can use this operation to implementthe standard requirements for signing up a customer, such as validating theuniqueness of an account and limiting the number of subscriptions per account.Also, you can use this operation to create a subscription, generate an invoice,and collect payment for a new or existing customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_SignUp","name":"Sign up","isWebhook":false,"pointer":"/paths/~1v1~1sign-up/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sign up","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":"This call performs many actions. You can use this operation to implement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the standard requirements for signing up a customer, such as validating the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uniqueness of an account and limiting the number of subscriptions per account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also, you can use this operation to create a subscription, generate an invoice,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and collect payment for a new or existing customer."},"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":" You need to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled to use this API. For a new customer, you can perform the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"following tasks in one call. Note that you can skip creating a payment meethod"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and still get the subscription and invoice successfully created."},"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":"Create an account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a payment method"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe to a product in the product catalog and create a subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate an invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collect payment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For an existing customer, you can use an account identification field of an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"external system to specify the account. You can make "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/rest-api/general-concepts/async-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"make asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when using the \"Sign up\" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call supports a subset of the functionality of our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We generally recommend using \"Create an order\" instead of this call because the Orders call has the following advantages:"},"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":"Provides options for managing the entire subscription lifecycle from creation through to cancellation using different order actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the creation or modifying of multiple subscriptions in a single order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows a single order to combine both recurring subscription digital goods or services with order line items for physical goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders are treated as atomic transactions. If any part fails, the entire order, subscription, and billing account creation are rolled back."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call does have some unique abilities not supported by \"Create an order\". You should consider using this call when you need 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":"Use Account UPSERT functionality by specifying a custom external identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit the number of subscriptions on an account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no deprecation plans for this call and we will continue to support this call."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Accept","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expressed as MIME types that the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header. The possible response MIME types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json-seq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" compatible with http://jsonlines.org/, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" compatible with RFC 4180. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json-seq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the default response MIME type. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is not sepecified, or set "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response body is returned in application/json-seq MIME type."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1sign-up/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SignUpRequest"}},"schemaId":"components/schemas/SignUpRequest","pointer":"/paths/~1v1~1sign-up/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/sign-up","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Accept","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SignUpRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/sign-up","href":"sign-up/post_signup","openApiOperationId":"POST_SignUp","summary":"Sign up"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/SignUpRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SignUpRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignUpResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SignUpResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1sign-up/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignUpResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignUpResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sign-up/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sign-up/post_signup"}],"panels":[]}]},"httpPath":"/v1/sign-up"}],"content":{"contentType":"group","meta":{"name":"Sign Up"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sign Up","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":"A light-weight API to sign up customers and subscribe."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled to use this API."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/sign-up","summary":"Sign up","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sign-up/post_signup","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/v1-api-reference/api/orders","routeSlug":"/v1-api-reference/api/orders","items":[{"label":"Preview an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/post_previeworder","routeSlug":"/v1-api-reference/api/orders/post_previeworder","metadata":{"seo":{"title":"Preview an order","description":"Notes:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_PreviewOrder","name":"Preview an order","isWebhook":false,"pointer":"/paths/~1v1~1orders~1preview/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":[{"$$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":"Notes"},"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":"This operation is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"functions for subscription and billing management and the new features on Zuora Billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. If you already have access to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot preview enhanced discounts and usage charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can skip the accounting period validation to avoid backdated subscription cancellation caused order preview failure. To skip the accounting period validation, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"Retrieves the preview of the charge metrics and invoice items of a specified order. Preview for subscriptions and order line items are both supported. This operation is only an order preview and no order is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also use this operation to preview billing for a standalone order. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders/create-a-subscription-using-a-standalone-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview billing for a standalone order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/post_previeworder/request/billing-preview-behavior-regarding-draft-invoices","deepLinkHash":"/orders/post_previeworder#orders/post_previeworder/request/billing-preview-behavior-regarding-draft-invoices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing preview behavior regarding draft invoices"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the billing preview behavior regarding draft invoices is as below:"},"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":"When you preview billing for your order and the order contains subscriptions only, the draft invoices are excluded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you preview billing for your order and the order contains order line items only, the draft invoices are included."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you preview billing for an order that contains both subscriptions  order line items, the draft invoices are included for both subscriptions and order line items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, if you want to always exclude the draft invoices in billing preview, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/post_previeworder/request/limits-on-orders-api","deepLinkHash":"/orders/post_previeworder#orders/post_previeworder/request/limits-on-orders-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits on Orders API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit of orders allowed on a subscription is 1000."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit of order line items allowed in an order is 100."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora has the following limits on the Orders synchronous API to prevent performance degradation:"},"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":"Up to 50 subscriptions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 50 order actions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 50 order actions are allowed on a single subscription in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:"},"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":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the status and response of a job"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for checking the status of the asynchronous API operations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:"},"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":"Up to 300 subscriptions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 300 order actions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 300 order actions are allowed on a single subscription"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operation call."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"summarizeInvoiceItem","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to return aggregated invoice item summaries for each invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this parameter set to "},"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":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItemSummary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is returned in the preview result."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The aggregated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItemSummary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field provides a forecast of the number of future invoices ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewInvoiceSequence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and the following information for each invoice:"},"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":"subTotal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servicePeriodStartDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servicePeriodEndDate"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1orders~1preview/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTOrderPreviewRequestType"}},"schemaId":"components/schemas/POSTOrderPreviewRequestType","pointer":"/paths/~1v1~1orders~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/preview","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"summarizeInvoiceItem","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTOrderPreviewRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/preview","href":"orders/post_previeworder","openApiOperationId":"POST_PreviewOrder","summary":"Preview an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTOrderPreviewRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTOrderPreviewRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostOrderPreviewResponseType","exampleIds":["paths/~1v1~1orders~1preview/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PostOrderPreviewResponseType","exampleIds":["paths/~1v1~1orders~1preview/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1preview/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1preview/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1preview/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1preview/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostOrderPreviewResponseType","exampleIds":["paths/~1v1~1orders~1preview/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostOrderPreviewResponseType","exampleIds":["paths/~1v1~1orders~1preview/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1preview/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1preview/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1preview/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1preview/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/post_previeworder"}],"panels":[]}]},"httpPath":"/v1/orders/preview"},{"label":"Preview an order asynchronously","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/post_previeworderasynchronously","routeSlug":"/v1-api-reference/api/orders/post_previeworderasynchronously","metadata":{"seo":{"title":"Preview an order asynchronously","description":"Notes:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_PreviewOrderAsynchronously","name":"Preview an order asynchronously","isWebhook":false,"pointer":"/paths/~1v1~1async~1orders~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview an order asynchronously","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"This operation is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August 2020). If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. If you already have access to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot preview enhanced discounts and usage charges."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case where a normal \"Preview an order\" operation call will time out, use this operation instead to preview an order asynchronously. A job will be previewing the order in the back end; the job ID will be returned for tracking the job status and result."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/post_previeworderasynchronously/request/billing-preview-behavior-regarding-draft-invoices","deepLinkHash":"/orders/post_previeworderasynchronously#orders/post_previeworderasynchronously/request/billing-preview-behavior-regarding-draft-invoices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing preview behavior regarding draft invoices"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the billing preview behavior regarding draft invoices is as below:"},"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":"When you preview billing for your order and the order contains subscriptions only, the draft invoices are excluded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you preview billing for your order and the order contains order line items only, the draft invoices are included."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you preview billing for an order that contains both subscriptions  order line items, the draft invoices are included for both subscriptions and order line items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, if you want to always exclude the draft invoices in billing preview, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"orders/post_previeworderasynchronously/request/limits-on-orders-api","deepLinkHash":"/orders/post_previeworderasynchronously#orders/post_previeworderasynchronously/request/limits-on-orders-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits on Orders API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit of orders allowed on a subscription is 1000."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit of order line items allowed in an order is 100."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora has the following limits on the Orders synchronous API to prevent performance degradation:"},"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":"Up to 50 subscriptions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 50 order actions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 50 order actions are allowed on a single subscription in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:"},"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":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the status and response of a job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for checking the status of the asynchronous API operations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:"},"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":"Up to 300 subscriptions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 300 order actions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 300 order actions are allowed on a single subscription in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"summarizeInvoiceItem","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to return aggregated invoice item summaries for each invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this parameter set to "},"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":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItemSummary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is returned in the preview result."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The aggregated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItemSummary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field provides a forecast of the number of future invoices ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewInvoiceSequence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and the following information for each invoice:"},"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":"subTotal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servicePeriodStartDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servicePeriodEndDate"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1async~1orders~1preview/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1async~1orders~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTOrderPreviewAsyncRequestType"}},"schemaId":"components/schemas/POSTOrderPreviewAsyncRequestType","pointer":"/paths/~1v1~1async~1orders~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/async/orders/preview","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"summarizeInvoiceItem","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTOrderPreviewAsyncRequestType"}},"responseCodes":["202"],"pointer":"/v1/async/orders/preview","href":"orders/post_previeworderasynchronously","openApiOperationId":"POST_PreviewOrderAsynchronously","summary":"Preview an order asynchronously"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTOrderPreviewAsyncRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTOrderPreviewAsyncRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30","exampleIds":["paths/~1v1~1async~1orders~1preview/post/responses/202/content/application~1json/examples/response"]}},"schemaId":"schema_30","exampleIds":["paths/~1v1~1async~1orders~1preview/post/responses/202/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"Location":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for accessing the job result, in the format of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/async-jobs/{jobId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/async-jobs/2c90a02d676688200167770ce20601b6"},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_31"}],"pointer":"/paths/~1v1~1async~1orders~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"schema_30","exampleIds":["paths/~1v1~1async~1orders~1preview/post/responses/202/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30","exampleIds":["paths/~1v1~1async~1orders~1preview/post/responses/202/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/post_previeworderasynchronously"}],"panels":[]}]},"httpPath":"/v1/async/orders/preview"},{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_allorders","routeSlug":"/v1-api-reference/api/orders/get_allorders","metadata":{"seo":{"title":"List orders","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AllOrders","name":"List orders","isWebhook":false,"pointer":"/paths/~1v1~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders","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":"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 feature is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves information about all orders in your tenant. You can set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and orders of all statuses are returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, it returns the first page of the orders."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"dateFilterOption","in":"query","schemaId":"schema_5","description":"The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate.\n"},{"name":"startDate","in":"query","schemaId":"schema_32","description":"The result will only contain the orders with the date of dateFilterOption later than or equal to this date.\n"},{"name":"endDate","in":"query","schemaId":"schema_32","description":"The result will only contains orders with the date of dateFilterOption earlier than or equal to this date.\n"},{"name":"status","in":"query","schemaId":"schema_33","description":"The status of orders."}],"pointer":"/paths/~1v1~1orders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"dateFilterOption","in":"query","required":false,"schemaId":"schema_5"},{"name":"startDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"endDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"status","in":"query","required":false,"schemaId":"schema_33"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/orders","href":"orders/get_allorders","openApiOperationId":"GET_AllOrders","summary":"List orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllOrdersResponseType","exampleIds":["paths/~1v1~1orders/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetAllOrdersResponseType","exampleIds":["paths/~1v1~1orders/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAllOrdersResponseType","exampleIds":["paths/~1v1~1orders/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllOrdersResponseType","exampleIds":["paths/~1v1~1orders/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get_allorders"}],"panels":[]}]},"httpPath":"/v1/orders"},{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/post_order","routeSlug":"/v1-api-reference/api/orders/post_order","metadata":{"seo":{"title":"Create an order","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the  new features on Zuora Billing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Order","name":"Create an order","isWebhook":false,"pointer":"/paths/~1v1~1orders/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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing functions for subscription and billing management and the  new features on Zuora Billing."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. If you already have access to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this operation to create subscriptions and make changes to subscriptions by creating orders. You can also use this operation to create order line items by creating orders. The following tutorials demonstrate how to use this operation:"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend/create-subscriptions/creating-a-subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Subscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/add-products-to-subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a Product to a Subscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/ramps-and-ramp-metrics/product-mid-interval-updates-on-ramp-deals-addition"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Ramp Deal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/ramps-and-ramp-metrics/product-mid-interval-updates-on-ramp-deals-addition"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a Product Mid-Interval Update on a Ramp Deal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/ramps-and-ramp-metrics/products-addition-in-ramp-deals"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a Product in a Ramp Deal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/ramps-and-ramp-metrics/terms-and-conditions-of-ramp-deals-changes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the Terms and Conditions of a Ramp Deal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/owners-of-subscriptions-changes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the Owner of a Subscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend/amend-subscriptions/terms-and-conditions-of-subscriptions/change-the-terms-and-conditions-of-a-subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the Terms and Conditions of a Subscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend/amend-subscriptions/subscriptions-renewal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Renew a Subscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/subscriptions-and-upgrade-products-renewal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Renew a Subscription and Upgrade a Product"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/replace-products-in-subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace a Product in a Subscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend/amend-subscriptions/products-updation-to-an-amendment/update-a-product-in-an-existing-subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Product in a Subscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/subscriptions-cancelation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel a Subscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/remove-products-from-subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a Product from a Subscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items/sales-order-line-items-creation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create sales order line items"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items/associate-order-line-items-with-subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associate order line items with new subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items/order-line-items-return"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return order line items"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also use this operation to create orders and save the orders as "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/scheduled-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled Orders"},"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":"In addition, you can use this operation to place a standalone order to subscribe without pre-defining a product catalog in Zuora Billing. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders/create-a-subscription-using-a-standalone-order","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a subscription using a standalone order"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you received a timeout error message when creating an order, the call is still running in the backend and the order will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit of orders allowed on a subscription is 1000."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit of order line items allowed in an order is 100."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora has the following limits on the Orders synchronous API to prevent performance degradation:"},"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":"Up to 50 subscriptions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 50 order actions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 50 order actions are allowed on a single subscription in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:"},"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":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the status and response of a job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for checking the status of the asynchronous API operations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:"},"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":"Up to 300 subscriptions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 300 order actions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 300 order actions are allowed on a single subscription in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"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":" When you are to suspend a subcription (via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action), if in the same \"Create an order\" call you are to perform other subsequent order actions on the supscription to suspend, you must first resume the subscription (via a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resume"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action)."},"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":" When using this operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. This means that the invoice will not be generated, the subscription will not be created, and the account will not be created."},"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 characters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"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":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not allowed in the Orders operations."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"returnIds","in":"query","schemaId":"schema_22","description":"Specify whether to return IDs associated with the numbers returned in the \"Create an order\" operation.\n"}],"pointer":"/paths/~1v1~1orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTOrderRequestType"}},"schemaId":"components/schemas/POSTOrderRequestType","pointer":"/paths/~1v1~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"returnIds","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTOrderRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/orders","href":"orders/post_order","openApiOperationId":"POST_Order","summary":"Create an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTOrderRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTOrderRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostOrderResponseType","exampleIds":["paths/~1v1~1orders/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PostOrderResponseType","exampleIds":["paths/~1v1~1orders/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostOrderResponseType","exampleIds":["paths/~1v1~1orders/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostOrderResponseType","exampleIds":["paths/~1v1~1orders/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/post_order"}],"panels":[]}]},"httpPath":"/v1/orders"},{"label":"Create an order asynchronously","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/post_createorderasynchronously","routeSlug":"/v1-api-reference/api/orders/post_createorderasynchronously","metadata":{"seo":{"title":"Create an order asynchronously","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateOrderAsynchronously","name":"Create an order asynchronously","isWebhook":false,"pointer":"/paths/~1v1~1async~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order asynchronously","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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. If you already have access to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case where a normal \"Create an order\" operation call will time out, use this operation instead to create an order asynchronously. A job will be creating the order in the back end; the job ID will be returned for tracking the job status and result."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this operation doesn't support auto-refund and invoice write-off during subscription cancellation. Use the \"Create an order\" operation instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit of orders allowed on a subscription is 1000."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit of order line items allowed in an order is 100."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora has the following limits on the Orders synchronous API to prevent performance degradation:"},"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":"Up to 50 subscriptions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 50 order actions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 50 order actions are allowed on a single subscription in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:"},"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":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the status and response of a job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for checking the status of the asynchronous API operations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:"},"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":"Up to 300 subscriptions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 300 order actions are allowed in a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 300 order actions are allowed on a single subscription in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview an order asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation call."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"returnIds","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify whether to return IDs for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get job status and response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. If you set this query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the corresponding IDs, which are associated with the numbers returned in this operation, can be returned in the \"Get job status and response\" response body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1async~1orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1async~1orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTOrderAsyncRequestType"}},"schemaId":"components/schemas/POSTOrderAsyncRequestType","pointer":"/paths/~1v1~1async~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/async/orders","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"returnIds","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTOrderAsyncRequestType"}},"responseCodes":["200"],"pointer":"/v1/async/orders","href":"orders/post_createorderasynchronously","openApiOperationId":"POST_CreateOrderAsynchronously","summary":"Create an order asynchronously"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTOrderAsyncRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTOrderAsyncRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34","exampleIds":["paths/~1v1~1async~1orders/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_34","exampleIds":["paths/~1v1~1async~1orders/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"Location":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for accessing the job result, in the format of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/async-jobs/{jobId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/async-jobs/1bc24f315d7b48d3a20245bfe73bdceb"},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_35"}],"pointer":"/paths/~1v1~1async~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","exampleIds":["paths/~1v1~1async~1orders/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34","exampleIds":["paths/~1v1~1async~1orders/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/post_createorderasynchronously"}],"panels":[]}]},"httpPath":"/v1/async/orders"},{"label":"Delete an order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/delete_order","routeSlug":"/v1-api-reference/api/orders/delete_order","metadata":{"seo":{"title":"Delete an order","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_Order","name":"Delete an order","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderNumber}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete 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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing functions for subscription and billing management and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Zuora Billing."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a specified order."},"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":"All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version."},"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":"All the order line items created in this order are deleted."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You are not allowed to delete an order if the charges that are affected by this order are invoiced."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderNumber","in":"path","schemaId":"schema_36","description":"The number of the order to be deleted.","required":true}],"pointer":"/paths/~1v1~1orders~1{orderNumber}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1{orderNumber}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/orders/{orderNumber}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"orderNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/{orderNumber}","href":"orders/delete_order","openApiOperationId":"DELETE_Order","summary":"Delete an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1{orderNumber}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/delete_order"}],"panels":[]}]},"httpPath":"/v1/orders/{orderNumber}"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_order","routeSlug":"/v1-api-reference/api/orders/get_order","metadata":{"seo":{"title":"Retrieve an order","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Order","name":"Retrieve an order","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderNumber}/get","hasSamples":false},"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":[{"$$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 feature is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the detailed information about a specified order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderNumber","in":"path","schemaId":"schema_36","description":"The order number to be retrieved.","required":true}],"pointer":"/paths/~1v1~1orders~1{orderNumber}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"getAccountDetails","in":"query","schemaId":"schema_27","description":"Retrieves the invoice owner account details and subscription owner account details in the Order."}],"pointer":"/paths/~1v1~1orders~1{orderNumber}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1{orderNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/{orderNumber}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"orderNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[{"name":"getAccountDetails","in":"query","schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/{orderNumber}","href":"orders/get_order","openApiOperationId":"GET_Order","summary":"Retrieve an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetOrderResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1{orderNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrderResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get_order"}],"panels":[]}]},"httpPath":"/v1/orders/{orderNumber}"},{"label":"Update an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_order","routeSlug":"/v1-api-reference/api/orders/put_order","metadata":{"seo":{"title":"Update an order","description":"Notes:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_Order","name":"Update an order","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderNumber}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"This operation is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing functions for subscription and billing management and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Zuora Billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an order is only valid for draft or scheduled orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation doesn't support auto-refund and invoice write-off during subscription cancellation. Use the \"Create an order\" operation instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must provide full payload when using the \"Update an order\" operation. That is, if you want to edit one order action, you need to provide all other order actions in the payload. Otherwise, the other order actions will be removed."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderNumber","in":"path","schemaId":"schema_36","description":"Order number of a order in which you are to update.","required":true}],"pointer":"/paths/~1v1~1orders~1{orderNumber}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1{orderNumber}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTOrderRequestType"}},"schemaId":"components/schemas/PUTOrderRequestType","pointer":"/paths/~1v1~1orders~1{orderNumber}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/orders/{orderNumber}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"orderNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTOrderRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/{orderNumber}","href":"orders/put_order","openApiOperationId":"PUT_Order","summary":"Update an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTOrderRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTOrderRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutOrderResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PutOrderResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1{orderNumber}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutOrderResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutOrderResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/put_order"}],"panels":[]}]},"httpPath":"/v1/orders/{orderNumber}"},{"label":"Delete an order asynchronously","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/deleteorderasynchronously","routeSlug":"/v1-api-reference/api/orders/deleteorderasynchronously","metadata":{"seo":{"title":"Delete an order asynchronously","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enableOrders Harmonization to access the Orders feature. With Orders, you can access both existingfunctions for subscription and billing management and the new features on Zuora Billing.Note: The Order Line Itemsfeature is now generally available to all Zuora customers. You need to enablethe Ordersfeature to access the Order Line Itemsfeature. As of Zuora Billing Release 313 (November 2021), new customers whoonboard on Orderswill have the Order Line Items feature enabled by default.Deletes a specified order.All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version.All the order line items created in this order are deleted.You are not allowed to delete an order if the charges that are affected by this order are invoiced."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderAsynchronously","name":"Delete an order asynchronously","isWebhook":false,"pointer":"/paths/~1v1~1async~1orders~1{orderNumber}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an order asynchronously","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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"functions for subscription and billing management and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Zuora Billing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature is now generally available to all Zuora customers. You need to enable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature. As of Zuora Billing Release 313 (November 2021), new customers who"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"onboard on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a specified order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the order line items created in this order are deleted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You are not allowed to delete an order if the charges that are affected by this order are invoiced."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderNumber","in":"path","schemaId":"schema_36","description":"The number of the order to be deleted.","required":true}],"pointer":"/paths/~1v1~1async~1orders~1{orderNumber}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1async~1orders~1{orderNumber}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/async/orders/{orderNumber}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"orderNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/async/orders/{orderNumber}","href":"orders/deleteorderasynchronously","openApiOperationId":"deleteOrderAsynchronously","summary":"Delete an order asynchronously"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteOrderAsyncResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DeleteOrderAsyncResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1async~1orders~1{orderNumber}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteOrderAsyncResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteOrderAsyncResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/deleteorderasynchronously"}],"panels":[]}]},"httpPath":"/v1/async/orders/{orderNumber}"},{"label":"Retrieve the status and response of a job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_jobstatusandresponse","routeSlug":"/v1-api-reference/api/orders/get_jobstatusandresponse","metadata":{"seo":{"title":"Retrieve the status and response of a job","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_JobStatusAndResponse","name":"Retrieve the status and response of a job","isWebhook":false,"pointer":"/paths/~1v1~1async-jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the status and response of a job","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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing functions for subscription and billing management and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Zuora Billing."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the status and response of an asynchronous job. Currently, an asynchronous job created by \"Create an order asynchronously\" or \"Preview an order asynchronously\" is supported."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_38","description":"UUID of the asynchronous job created by an asynchronous API operation.","required":true}],"pointer":"/paths/~1v1~1async-jobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1async-jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/async-jobs/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/async-jobs/{jobId}","href":"orders/get_jobstatusandresponse","openApiOperationId":"GET_JobStatusAndResponse","summary":"Retrieve the status and response of a job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAsyncOrderJobResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetAsyncOrderJobResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1async-jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAsyncOrderJobResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAsyncOrderJobResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1async-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get_jobstatusandresponse"}],"panels":[]}]},"httpPath":"/v1/async-jobs/{jobId}"},{"label":"List orders of a subscription owner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_ordersbysubscriptionowner","routeSlug":"/v1-api-reference/api/orders/get_ordersbysubscriptionowner","metadata":{"seo":{"title":"List orders of a subscription owner","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_OrdersBySubscriptionOwner","name":"List orders of a subscription owner","isWebhook":false,"pointer":"/paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders of a subscription owner","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":"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 feature is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the detailed information about all orders for a specified subscription owner. Any orders containing the changes on the subscriptions owned by this account are returned."},"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":": You cannot retrieve detailed information about draft orders or scheduled orders through this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountNumber","in":"path","schemaId":"schema_36","description":"The subscription owner account number.","required":true}],"pointer":"/paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"dateFilterOption","in":"query","schemaId":"schema_5","description":"The date type to filter on.\nThis field value can be 'orderDate' or 'updatedDate'. Default is orderDate.\n"},{"name":"startDate","in":"query","schemaId":"schema_32","description":"The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date.\n"},{"name":"endDate","in":"query","schemaId":"schema_32","description":"The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date.\n"}],"pointer":"/paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/subscriptionOwner/{accountNumber}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"accountNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"dateFilterOption","in":"query","required":false,"schemaId":"schema_5"},{"name":"startDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"endDate","in":"query","required":false,"schemaId":"schema_32"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/subscriptionOwner/{accountNumber}","href":"orders/get_ordersbysubscriptionowner","openApiOperationId":"GET_OrdersBySubscriptionOwner","summary":"List orders of a subscription owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get_ordersbysubscriptionowner"}],"panels":[]}]},"httpPath":"/v1/orders/subscriptionOwner/{accountNumber}"},{"label":"List orders by subscription number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_ordersbysubscriptionnumber","routeSlug":"/v1-api-reference/api/orders/get_ordersbysubscriptionnumber","metadata":{"seo":{"title":"List orders by subscription number","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_OrdersBySubscriptionNumber","name":"List orders by subscription number","isWebhook":false,"pointer":"/paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders by subscription number","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":"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 feature is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the detailed information about all orders for a specified subscription. You can set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and orders of all statuses are returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionNumber","in":"path","schemaId":"schema_5","description":"The subscription number.","required":true}],"pointer":"/paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"dateFilterOption","in":"query","schemaId":"schema_5","description":"The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate.\n"},{"name":"startDate","in":"query","schemaId":"schema_32","description":"The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date.\n"},{"name":"endDate","in":"query","schemaId":"schema_32","description":"The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date.\n"},{"name":"status","in":"query","schemaId":"schema_33","description":"The status of orders."}],"pointer":"/paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/subscription/{subscriptionNumber}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscriptionNumber","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"dateFilterOption","in":"query","required":false,"schemaId":"schema_5"},{"name":"startDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"endDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"status","in":"query","required":false,"schemaId":"schema_33"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/subscription/{subscriptionNumber}","href":"orders/get_ordersbysubscriptionnumber","openApiOperationId":"GET_OrdersBySubscriptionNumber","summary":"List orders by subscription number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get_ordersbysubscriptionnumber"}],"panels":[]}]},"httpPath":"/v1/orders/subscription/{subscriptionNumber}"},{"label":"List orders of an invoice owner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_ordersbyinvoiceowner","routeSlug":"/v1-api-reference/api/orders/get_ordersbyinvoiceowner","metadata":{"seo":{"title":"List orders of an invoice owner","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_OrdersByInvoiceOwner","name":"List orders of an invoice owner","isWebhook":false,"pointer":"/paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders of an invoice owner","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":"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 feature is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the detailed information about all orders for a specified invoice owner. You can set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and orders of all statuses are returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountNumber","in":"path","schemaId":"schema_36","description":"The invoice owner account number.","required":true}],"pointer":"/paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"dateFilterOption","in":"query","schemaId":"schema_5","description":"The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate.\n"},{"name":"startDate","in":"query","schemaId":"schema_32","description":"The result will only contain the orders with the date of dateFilterOption later than or equal to this date.\n"},{"name":"endDate","in":"query","schemaId":"schema_32","description":"The result will only contain the orders with the date of dateFilterOption earlier than or equal to this date.\n"},{"name":"status","in":"query","schemaId":"schema_33","description":"The status of orders."}],"pointer":"/paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/invoiceOwner/{accountNumber}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"accountNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"dateFilterOption","in":"query","required":false,"schemaId":"schema_5"},{"name":"startDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"endDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"status","in":"query","required":false,"schemaId":"schema_33"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/invoiceOwner/{accountNumber}","href":"orders/get_ordersbyinvoiceowner","openApiOperationId":"GET_OrdersByInvoiceOwner","summary":"List orders of an invoice owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get_ordersbyinvoiceowner"}],"panels":[]}]},"httpPath":"/v1/orders/invoiceOwner/{accountNumber}"},{"label":"Update order custom fields","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_updateordercustomfields","routeSlug":"/v1-api-reference/api/orders/put_updateordercustomfields","metadata":{"seo":{"title":"Update order custom fields","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateOrderCustomFields","name":"Update order custom fields","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderNumber}~1customFields/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update order custom fields","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":"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 feature is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."},"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":" To update the custom fields of an order line item, you must use the \"Update an order line item\" or \"Update order line items\" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the custom fields of a specified order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderNumber","in":"path","schemaId":"schema_36","description":"The order number.","required":true}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1customFields/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1customFields/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTOrderPatchRequestType"}},"schemaId":"components/schemas/PUTOrderPatchRequestType","pointer":"/paths/~1v1~1orders~1{orderNumber}~1customFields/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/orders/{orderNumber}/customFields","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"orderNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTOrderPatchRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/{orderNumber}/customFields","href":"orders/put_updateordercustomfields","openApiOperationId":"PUT_UpdateOrderCustomFields","summary":"Update order custom fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTOrderPatchRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTOrderPatchRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/put_updateordercustomfields"}],"panels":[]}]},"httpPath":"/v1/orders/{orderNumber}/customFields"},{"label":"Update subscription custom fields","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_updatesubscriptioncustomfields","routeSlug":"/v1-api-reference/api/orders/put_updatesubscriptioncustomfields","metadata":{"seo":{"title":"Update subscription custom fields","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateSubscriptionCustomFields","name":"Update subscription custom fields","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subscription custom fields","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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing functions for subscription and billing management and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Zuora Billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the custom fields of a specified subscription."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionNumber","in":"path","schemaId":"schema_36","description":"The subscription number to be updated.","required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionPatchRequestType"}},"schemaId":"components/schemas/PUTSubscriptionPatchRequestType","pointer":"/paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/subscriptions/{subscriptionNumber}/customFields","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscriptionNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionPatchRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscriptionNumber}/customFields","href":"orders/put_updatesubscriptioncustomfields","openApiOperationId":"PUT_UpdateSubscriptionCustomFields","summary":"Update subscription custom fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTSubscriptionPatchRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionPatchRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/put_updatesubscriptioncustomfields"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscriptionNumber}/customFields"},{"label":"Update order action trigger dates","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_ordertriggerdates","routeSlug":"/v1-api-reference/api/orders/put_ordertriggerdates","metadata":{"seo":{"title":"Update order action trigger dates","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_OrderTriggerDates","name":"Update order action trigger dates","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderNumber}~1triggerDates/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update order action trigger dates","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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing functions for subscription and billing management and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Zuora Billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the triggering dates for either of the following order actions:"},"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":"CreateSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AddProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TermsAndConditions"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderNumber","in":"path","schemaId":"schema_36","description":"Order number of a pending order in which you are to update an order action's triggering dates.","required":true}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTOrderActionTriggerDatesRequestType"}},"schemaId":"components/schemas/PUTOrderActionTriggerDatesRequestType","pointer":"/paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/orders/{orderNumber}/triggerDates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"orderNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTOrderActionTriggerDatesRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/{orderNumber}/triggerDates","href":"orders/put_ordertriggerdates","openApiOperationId":"PUT_OrderTriggerDates","summary":"Update order action trigger dates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTOrderActionTriggerDatesRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTOrderActionTriggerDatesRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTOrderTriggerDatesResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTOrderTriggerDatesResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTOrderTriggerDatesResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTOrderTriggerDatesResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/put_ordertriggerdates"}],"panels":[]}]},"httpPath":"/v1/orders/{orderNumber}/triggerDates"},{"label":"Activate an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_orderactivate","routeSlug":"/v1-api-reference/api/orders/put_orderactivate","metadata":{"seo":{"title":"Activate an order","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_OrderActivate","name":"Activate an order","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderNumber}~1activate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate 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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing functions for subscription and billing management and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Zuora Billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activate order is only available for draft orders."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderNumber","in":"path","schemaId":"schema_36","description":"Order number of a order in which you are to activate.","required":true}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1activate/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1activate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/orders/{orderNumber}/activate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"orderNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/{orderNumber}/activate","href":"orders/put_orderactivate","openApiOperationId":"PUT_OrderActivate","summary":"Activate an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostOrderResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PostOrderResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1activate/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostOrderResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostOrderResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/put_orderactivate"}],"panels":[]}]},"httpPath":"/v1/orders/{orderNumber}/activate"},{"label":"Cancel an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/put_ordercancel","routeSlug":"/v1-api-reference/api/orders/put_ordercancel","metadata":{"seo":{"title":"Cancel an order","description":"Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_OrderCancel","name":"Cancel an order","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderNumber}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel 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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you are an existing Zuora "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-subscribe-and-amend","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, we recommend you enable "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. With Orders, you can access both existing functions for subscription and billing management and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Zuora Billing."},"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":" Cancellation is only valid for draft or scheduled orders. If the order is not in draft or scheduled status, the API returns an error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderNumber","in":"path","schemaId":"schema_36","description":"The order number of the draft order you wish to cancel.","required":true}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39","pointer":"/paths/~1v1~1orders~1{orderNumber}~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/orders/{orderNumber}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"orderNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_39"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/{orderNumber}/cancel","href":"orders/put_ordercancel","openApiOperationId":"PUT_OrderCancel","summary":"Cancel an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutOrderCancelResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PutOrderCancelResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutOrderCancelResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutOrderCancelResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/put_ordercancel"}],"panels":[]}]},"httpPath":"/v1/orders/{orderNumber}/cancel"},{"label":"Rescan a commitment's account associations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/rescancommitmentaccountassociations","routeSlug":"/v1-api-reference/api/orders/rescancommitmentaccountassociations","metadata":{"seo":{"title":"Rescan a commitment's account associations","description":"Re-evaluates a commitment's account eligibility condition against current account data and activates (inserts or reactivates) any newly-eligible accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rescanCommitmentAccountAssociations","name":"Rescan a commitment's account associations","isWebhook":false,"pointer":"/paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rescan a commitment's account associations","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":"Re-evaluates a commitment's account eligibility condition against current account data and activates (inserts or reactivates) any newly-eligible accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additive only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": it never deactivates an account, even one that no longer satisfies the eligibility condition. It never evaluates, activates, or deactivates any associated charge/item — only account associations are affected. Running this operation twice in a row with no intervening data change performs no write on the second call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure that the the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commitment Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"commitmentNumber","in":"path","schemaId":"schema_36","description":"The commitment number to rescan.","required":true}],"pointer":"/paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/commitments/{commitmentNumber}/associations/rescan","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"commitmentNumber","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","4xx"],"pointer":"/v1/orders/commitments/{commitmentNumber}/associations/rescan","href":"orders/rescancommitmentaccountassociations","openApiOperationId":"rescanCommitmentAccountAssociations","summary":"Rescan a commitment's account associations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommitmentAccountRescanResponse","exampleIds":["paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CommitmentAccountRescanResponse","exampleIds":["paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"4xx","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/4xx/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/4xx/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommitmentAccountRescanResponse","exampleIds":["paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommitmentAccountRescanResponse","exampleIds":["paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/200/content/application~1json/example"]}}},{"code":"4xx","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/4xx/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/4xx/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/rescancommitmentaccountassociations"}],"panels":[]}]},"httpPath":"/v1/orders/commitments/{commitmentNumber}/associations/rescan"},{"label":"Retrieve the order delta metrics of an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/getorderdeltametricsbyordernumber","routeSlug":"/v1-api-reference/api/orders/getorderdeltametricsbyordernumber","metadata":{"seo":{"title":"Retrieve the order delta metrics of an order","description":"Note: This operation is only available if you have the OrderDelta Metricsfeature enabled. The Ordersfeature must be enabled before you can access Order Delta Metrics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderDeltaMetricsByOrderNumber","name":"Retrieve the order delta metrics of an order","isWebhook":false,"pointer":"/paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the order delta metrics of 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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics/overview-of-order-delta-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delta Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature must be enabled before you can access Order Delta Metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the Order Delta Metrics of a specified order, including the following"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"metrics:"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics/order-delta-mrr"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Mrr"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics/order-delta-tcv"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Tcv"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics/order-delta-tcb"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Tcb"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics/order-delta-quantity"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Qty"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Metrics are generated asynchronously after an order is completed."},"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":"generationStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response to tell whether the metrics are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ready. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generationStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the metrics are not available yet"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and you can retry the request later."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderNumber","in":"path","schemaId":"schema_5","description":"The number of the existing order.","required":true}],"pointer":"/paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/deltaMetrics/{orderNumber}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"orderNumber","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/v1/orders/deltaMetrics/{orderNumber}","href":"orders/getorderdeltametricsbyordernumber","openApiOperationId":"getOrderDeltaMetricsByOrderNumber","summary":"Retrieve the order delta metrics of an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderDeltaMetricsResponse","exampleIds":["paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetOrderDeltaMetricsResponse","exampleIds":["paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrderDeltaMetricsResponse","exampleIds":["paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderDeltaMetricsResponse","exampleIds":["paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/200/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getorderdeltametricsbyordernumber"}],"panels":[]}]},"httpPath":"/v1/orders/deltaMetrics/{orderNumber}"},{"label":"List pending orders by subscription number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/orders/get_pendingordersbysubscriptionnumber","routeSlug":"/v1-api-reference/api/orders/get_pendingordersbysubscriptionnumber","metadata":{"seo":{"title":"List pending orders by subscription number","description":"Note: This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PendingOrdersBySubscriptionNumber","name":"List pending orders by subscription number","isWebhook":false,"pointer":"/paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List pending orders by subscription number","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":"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 feature is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the detailed information about all pending orders for a specified subscription."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription-key","in":"path","schemaId":"schema_5","description":"Subscription number. For example, A-S00000135.\n","required":true}],"pointer":"/paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/subscription/{subscription-key}/pending","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscription-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/subscription/{subscription-key}/pending","href":"orders/get_pendingordersbysubscriptionnumber","openApiOperationId":"GET_PendingOrdersBySubscriptionNumber","summary":"List pending orders by subscription number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllOrdersResponseType","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetAllOrdersResponseType","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAllOrdersResponseType","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllOrdersResponseType","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get_pendingordersbysubscriptionnumber"}],"panels":[]}]},"httpPath":"/v1/orders/subscription/{subscription-key}/pending"}],"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":"Orders are contractual agreements between merchants and customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create multiple subscriptions and subscription amendments at once in a single order. All the operations on subscriptions in orders are done by order actions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also create order line items to support your non-subscription based business models."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora calculates order delta metrics when orders take place. You can retrieve order delta metrics and measure billed and unbilled amounts by 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 about Orders, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview Of Orders"},"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":"To learn how orders interacts with billing accounts, subscriptions, and product catalog, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/get-started/api-tutorials/orders-tutorials/order-basics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders API tutorials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which include orders code samples. You can also refer "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/object-model/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora object model"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/orders/preview","summary":"Preview an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/post_previeworder","deprecated":false},{"title":"/v1/async/orders/preview","summary":"Preview an order asynchronously","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/post_previeworderasynchronously","deprecated":false},{"title":"/v1/orders","summary":"List orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get_allorders","deprecated":false},{"title":"/v1/orders","summary":"Create an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/post_order","deprecated":false},{"title":"/v1/async/orders","summary":"Create an order asynchronously","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/post_createorderasynchronously","deprecated":false},{"title":"/v1/orders/{orderNumber}","summary":"Delete an order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/delete_order","deprecated":false},{"title":"/v1/orders/{orderNumber}","summary":"Retrieve an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get_order","deprecated":false},{"title":"/v1/orders/{orderNumber}","summary":"Update an order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/put_order","deprecated":false},{"title":"/v1/async/orders/{orderNumber}","summary":"Delete an order asynchronously","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/deleteorderasynchronously","deprecated":false},{"title":"/v1/async-jobs/{jobId}","summary":"Retrieve the status and response of a job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get_jobstatusandresponse","deprecated":false},{"title":"/v1/orders/subscriptionOwner/{accountNumber}","summary":"List orders of a subscription owner","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get_ordersbysubscriptionowner","deprecated":false},{"title":"/v1/orders/subscription/{subscriptionNumber}","summary":"List orders by subscription number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get_ordersbysubscriptionnumber","deprecated":false},{"title":"/v1/orders/invoiceOwner/{accountNumber}","summary":"List orders of an invoice owner","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get_ordersbyinvoiceowner","deprecated":false},{"title":"/v1/orders/{orderNumber}/customFields","summary":"Update order custom fields","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/put_updateordercustomfields","deprecated":false},{"title":"/v1/subscriptions/{subscriptionNumber}/customFields","summary":"Update subscription custom fields","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/put_updatesubscriptioncustomfields","deprecated":false},{"title":"/v1/orders/{orderNumber}/triggerDates","summary":"Update order action trigger dates","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/put_ordertriggerdates","deprecated":false},{"title":"/v1/orders/{orderNumber}/activate","summary":"Activate an order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/put_orderactivate","deprecated":false},{"title":"/v1/orders/{orderNumber}/cancel","summary":"Cancel an order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/put_ordercancel","deprecated":false},{"title":"/v1/orders/commitments/{commitmentNumber}/associations/rescan","summary":"Rescan a commitment's account associations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/rescancommitmentaccountassociations","deprecated":false},{"title":"/v1/orders/deltaMetrics/{orderNumber}","summary":"Retrieve the order delta metrics of an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorderdeltametricsbyordernumber","deprecated":false},{"title":"/v1/orders/subscription/{subscription-key}/pending","summary":"List pending orders by subscription number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get_pendingordersbysubscriptionnumber","deprecated":false}]}]}]}]}},{"type":"group","label":"Order Actions","link":"/v1-api-reference/api/order-actions","routeSlug":"/v1-api-reference/api/order-actions","items":[{"label":"Update an order action","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/order-actions/put_orderactions","routeSlug":"/v1-api-reference/api/order-actions/put_orderactions","metadata":{"seo":{"title":"Update an order action","description":"Updates the change reason and custom fields for an order action."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_OrderActions","name":"Update an order action","isWebhook":false,"pointer":"/paths/~1v1~1orderActions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an order action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the change reason and custom fields for an order action."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The id of the Order Action to update.","required":true}],"pointer":"/paths/~1v1~1orderActions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orderActions~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/PUTOrderActionsRequestType"}},"schemaId":"components/schemas/PUTOrderActionsRequestType","pointer":"/paths/~1v1~1orderActions~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/orderActions/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTOrderActionsRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/orderActions/{id}","href":"order-actions/put_orderactions","openApiOperationId":"PUT_OrderActions","summary":"Update an order action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTOrderActionsRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTOrderActionsRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orderActions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orderActions~1{id}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-actions/put_orderactions"}],"panels":[]}]},"httpPath":"/v1/orderActions/{id}"}],"content":{"contentType":"group","meta":{"name":"Order Actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Actions","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":"You need to have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled to use this API."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/orderActions/{id}","summary":"Update an order action","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-actions/put_orderactions","deprecated":false}]}]}]}]}},{"type":"group","label":"Order Line Items","link":"/v1-api-reference/api/order-line-items","routeSlug":"/v1-api-reference/api/order-line-items","items":[{"label":"Retrieve an order line item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/order-line-items/get_orderlineitem","routeSlug":"/v1-api-reference/api/order-line-items/get_orderlineitem","metadata":{"seo":{"title":"Retrieve an order line item","description":"Note: The Order Line Itemsfeature is now generally available to all Zuora customers. If you already have access to the Orders feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_OrderLineItem","name":"Retrieve an order line item","isWebhook":false,"pointer":"/paths/~1v1~1order-line-items~1{itemId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order line item","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":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature is now generally available to all Zuora customers. If you already have access to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the detailed information about a specified order line item. The following"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tutorial demonstrates how to use this operation:"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-details-view-of-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View details of an order line item"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemId","in":"path","schemaId":"schema_38","description":"The id of the Order Line Item to retrieve.","required":true}],"pointer":"/paths/~1v1~1order-line-items~1{itemId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fulfillment","in":"query","schemaId":"schema_22","description":"Return the related fulfillments or not.\n"}],"pointer":"/paths/~1v1~1order-line-items~1{itemId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1order-line-items~1{itemId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/order-line-items/{itemId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"itemId","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"fulfillment","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/order-line-items/{itemId}","href":"order-line-items/get_orderlineitem","openApiOperationId":"GET_OrderLineItem","summary":"Retrieve an order line item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderLineItemResponseType","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetOrderLineItemResponseType","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1order-line-items~1{itemId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrderLineItemResponseType","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderLineItemResponseType","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-line-items/get_orderlineitem"}],"panels":[]}]},"httpPath":"/v1/order-line-items/{itemId}"},{"label":"Update an order line item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/order-line-items/put_orderlineitem","routeSlug":"/v1-api-reference/api/order-line-items/put_orderlineitem","metadata":{"seo":{"title":"Update an order line item","description":"Note: The Order Line Itemsfeature is now generally available to all Zuora customers. If you already have access to the Orders feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_OrderLineItem","name":"Update an order line item","isWebhook":false,"pointer":"/paths/~1v1~1order-line-items~1{itemId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an order line item","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":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature is now generally available to all Zuora customers. If you already have access to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a specified order line item. The following tutorials demonstrate how to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"use this operation:"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-item-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an order line item"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items-cancelation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel an order line item"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemId","in":"path","schemaId":"schema_38","description":"The id of the Order Line Item to update.","required":true}],"pointer":"/paths/~1v1~1order-line-items~1{itemId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1order-line-items~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/PUTOrderLineItemRequestType"}},"schemaId":"components/schemas/PUTOrderLineItemRequestType","pointer":"/paths/~1v1~1order-line-items~1{itemId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/order-line-items/{itemId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"itemId","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTOrderLineItemRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/order-line-items/{itemId}","href":"order-line-items/put_orderlineitem","openApiOperationId":"PUT_OrderLineItem","summary":"Update an order line item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTOrderLineItemRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTOrderLineItemRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutOrderLineItemResponseType","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PutOrderLineItemResponseType","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1order-line-items~1{itemId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutOrderLineItemResponseType","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutOrderLineItemResponseType","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1{itemId}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-line-items/put_orderlineitem"}],"panels":[]}]},"httpPath":"/v1/order-line-items/{itemId}"},{"label":"Update order line items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/order-line-items/post_orderlineitems","routeSlug":"/v1-api-reference/api/order-line-items/post_orderlineitems","metadata":{"seo":{"title":"Update order line items","description":"Note: The Order Line Items feature is now generally available to all Zuora customers. If you already have access to the Orders feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Post_OrderLineItems","name":"Update order line items","isWebhook":false,"pointer":"/paths/~1v1~1order-line-items~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update order line items","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":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. If you already have access to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you automatically have access to Order Line Items as well. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk-updates multiple order line items. You can also choose to generate an invoice for these updated order line items."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of order line items allowable to update in a call is 100."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1order-line-items~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostOrderLineItemsRequestType"}},"schemaId":"components/schemas/PostOrderLineItemsRequestType","pointer":"/paths/~1v1~1order-line-items~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/order-line-items/bulk","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostOrderLineItemsRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/order-line-items/bulk","href":"order-line-items/post_orderlineitems","openApiOperationId":"Post_OrderLineItems","summary":"Update order line items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostOrderLineItemsRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostOrderLineItemsRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderLineItemResponseType"}},"schemaId":"components/schemas/GetOrderLineItemResponseType","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1bulk/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1bulk/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1bulk/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1bulk/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1order-line-items~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrderLineItemResponseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderLineItemResponseType"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1bulk/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1order-line-items~1bulk/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1bulk/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1order-line-items~1bulk/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-line-items/post_orderlineitems"}],"panels":[]}]},"httpPath":"/v1/order-line-items/bulk"}],"content":{"contentType":"group","meta":{"name":"Order Line Items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Line Items","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 order line item to launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about order line items, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/order-line-items/{itemId}","summary":"Retrieve an order line item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-line-items/get_orderlineitem","deprecated":false},{"title":"/v1/order-line-items/{itemId}","summary":"Update an order line item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-line-items/put_orderlineitem","deprecated":false},{"title":"/v1/order-line-items/bulk","summary":"Update order line items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-line-items/post_orderlineitems","deprecated":false}]}]}]}]}},{"type":"group","label":"Fulfillments","link":"/v1-api-reference/api/fulfillments","routeSlug":"/v1-api-reference/api/fulfillments","items":[{"label":"Create fulfillments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/create_fulfillment","routeSlug":"/v1-api-reference/api/fulfillments/create_fulfillment","metadata":{"seo":{"title":"Create fulfillments","description":"Creates one or multiple Fulfillment objects. You can also generate invoices or memos for these Fulfillment objects in this API call. The following tutorials demonstrate how to use this operation:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_Fulfillment","name":"Create fulfillments","isWebhook":false,"pointer":"/paths/~1v1~1fulfillments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create fulfillments","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 one or multiple Fulfillment objects. You can also generate invoices or memos for these Fulfillment objects in this API call. The following tutorials demonstrate how to use this operation:"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-add-fulfillments-sales-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a sales order line item with fulfillments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-return-order-with-fulfillments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a return order line item with fulfillments"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1fulfillments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostFulfillmentsRequestType"}},"schemaId":"components/schemas/PostFulfillmentsRequestType","pointer":"/paths/~1v1~1fulfillments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/fulfillments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostFulfillmentsRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/fulfillments","href":"fulfillments/create_fulfillment","openApiOperationId":"Create_Fulfillment","summary":"Create fulfillments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostFulfillmentsRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostFulfillmentsRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostFulfillmentsResponseType","exampleIds":["paths/~1v1~1fulfillments/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PostFulfillmentsResponseType","exampleIds":["paths/~1v1~1fulfillments/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1fulfillments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostFulfillmentsResponseType","exampleIds":["paths/~1v1~1fulfillments/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostFulfillmentsResponseType","exampleIds":["paths/~1v1~1fulfillments/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfillments/create_fulfillment"}],"panels":[]}]},"httpPath":"/v1/fulfillments"},{"label":"Delete a fulfillment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/delete_fulfillment","routeSlug":"/v1-api-reference/api/fulfillments/delete_fulfillment","metadata":{"seo":{"title":"Delete a fulfillment","description":"Deletes a specified fulfillment. A fulfillment can only be deleted when it is in the Executing state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_Fulfillment","name":"Delete a fulfillment","isWebhook":false,"pointer":"/paths/~1v1~1fulfillments~1{key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a fulfillment","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 specified fulfillment. A fulfillment can only be deleted when it is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_38","description":"The id or fulfillment number of the Fulfillment to delete.","required":true}],"pointer":"/paths/~1v1~1fulfillments~1{key}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1fulfillments~1{key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/fulfillments/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/fulfillments/{key}","href":"fulfillments/delete_fulfillment","openApiOperationId":"Delete_Fulfillment","summary":"Delete a fulfillment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1fulfillments~1{key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfillments/delete_fulfillment"}],"panels":[]}]},"httpPath":"/v1/fulfillments/{key}"},{"label":"Retrieve a fulfillment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/get_fulfillment","routeSlug":"/v1-api-reference/api/fulfillments/get_fulfillment","metadata":{"seo":{"title":"Retrieve a fulfillment","description":"Retrieves the detailed information about a specified fulfillment. The following tutorial demonstrates how to use this operation:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Fulfillment","name":"Retrieve a fulfillment","isWebhook":false,"pointer":"/paths/~1v1~1fulfillments~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a fulfillment","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 the detailed information about a specified fulfillment. The following tutorial demonstrates how to use this operation:"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-details-view-of-fulfillments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View details of a fulfillment"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_38","description":"The id or fulfillment number of the Fulfillment to retrieve.","required":true}],"pointer":"/paths/~1v1~1fulfillments~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fulfillment-items","in":"query","schemaId":"schema_22","description":"Return the related fulfillment items or not."}],"pointer":"/paths/~1v1~1fulfillments~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1fulfillments~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/fulfillments/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"fulfillment-items","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/fulfillments/{key}","href":"fulfillments/get_fulfillment","openApiOperationId":"GET_Fulfillment","summary":"Retrieve a fulfillment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetFulfillmentResponseType","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetFulfillmentResponseType","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1fulfillments~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetFulfillmentResponseType","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetFulfillmentResponseType","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfillments/get_fulfillment"}],"panels":[]}]},"httpPath":"/v1/fulfillments/{key}"},{"label":"Update a fulfillment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/put_fulfillment","routeSlug":"/v1-api-reference/api/fulfillments/put_fulfillment","metadata":{"seo":{"title":"Update a fulfillment","description":"Updates a specified fulfillment. The state field of a fulfillment can only be updated when it is in a different state, to trigger the state transition. The other fields of a fulfillment can only be updated when the fulfillment is in the Executing state, or when the fulfillment is in the Booked state and the user has the \"Allow Edit Of Booked Order Line Items\" permission.The following tutorial demonstrates how to use this operation:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_Fulfillment","name":"Update a fulfillment","isWebhook":false,"pointer":"/paths/~1v1~1fulfillments~1{key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a fulfillment","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 specified fulfillment. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of a fulfillment can only be updated when it is in a different state, to trigger the state transition. The other fields of a fulfillment can only be updated when the fulfillment is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, or when the fulfillment is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state and the user has the \"Allow Edit Of Booked Order Line Items\" permission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following tutorial demonstrates how to use this operation:"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-update-or-cancel-fulfillments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update or cancel a fulfillment"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_38","description":"The id or fulfillment number of the Fulfillment to update.","required":true}],"pointer":"/paths/~1v1~1fulfillments~1{key}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1fulfillments~1{key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutFulfillmentRequestType"}},"schemaId":"components/schemas/PutFulfillmentRequestType","pointer":"/paths/~1v1~1fulfillments~1{key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/fulfillments/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutFulfillmentRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/fulfillments/{key}","href":"fulfillments/put_fulfillment","openApiOperationId":"PUT_Fulfillment","summary":"Update a fulfillment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutFulfillmentRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutFulfillmentRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1fulfillments~1{key}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillments~1{key}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfillments/put_fulfillment"}],"panels":[]}]},"httpPath":"/v1/fulfillments/{key}"},{"label":"Create fulfillment items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/create_fulfillmentitem","routeSlug":"/v1-api-reference/api/fulfillments/create_fulfillmentitem","metadata":{"seo":{"title":"Create fulfillment items","description":"Creates one or multiple fulfillment items."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_FulfillmentItem","name":"Create fulfillment items","isWebhook":false,"pointer":"/paths/~1v1~1fulfillment-items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create fulfillment items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates one or multiple fulfillment items.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1fulfillment-items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostFulfillmentItemsRequestType"}},"schemaId":"components/schemas/PostFulfillmentItemsRequestType","pointer":"/paths/~1v1~1fulfillment-items/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/fulfillment-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostFulfillmentItemsRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/fulfillment-items","href":"fulfillments/create_fulfillmentitem","openApiOperationId":"Create_FulfillmentItem","summary":"Create fulfillment items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostFulfillmentItemsRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostFulfillmentItemsRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostFulfillmentItemsResponseType","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PostFulfillmentItemsResponseType","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1fulfillment-items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostFulfillmentItemsResponseType","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostFulfillmentItemsResponseType","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfillments/create_fulfillmentitem"}],"panels":[]}]},"httpPath":"/v1/fulfillment-items"},{"label":"Delete a fulfillment item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/delete_fulfillmentitem","routeSlug":"/v1-api-reference/api/fulfillments/delete_fulfillmentitem","metadata":{"seo":{"title":"Delete a fulfillment item","description":"Deletes a specified fulfillment item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_FulfillmentItem","name":"Delete a fulfillment item","isWebhook":false,"pointer":"/paths/~1v1~1fulfillment-items~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a fulfillment item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specified fulfillment item.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","description":"The id of the Fulfillment Item to delete.","required":true}],"pointer":"/paths/~1v1~1fulfillment-items~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1fulfillment-items~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/fulfillment-items/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/fulfillment-items/{id}","href":"fulfillments/delete_fulfillmentitem","openApiOperationId":"Delete_FulfillmentItem","summary":"Delete a fulfillment item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1fulfillment-items~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfillments/delete_fulfillmentitem"}],"panels":[]}]},"httpPath":"/v1/fulfillment-items/{id}"},{"label":"Retrieve a fulfillment item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/get_fulfillmentitem","routeSlug":"/v1-api-reference/api/fulfillments/get_fulfillmentitem","metadata":{"seo":{"title":"Retrieve a fulfillment item","description":"Retrieves the detailed information about a specified fulfillment item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_FulfillmentItem","name":"Retrieve a fulfillment item","isWebhook":false,"pointer":"/paths/~1v1~1fulfillment-items~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a fulfillment item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the detailed information about a specified fulfillment item. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","description":"The id of the Fulfillment Item to retrieve.","required":true}],"pointer":"/paths/~1v1~1fulfillment-items~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1fulfillment-items~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/fulfillment-items/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/fulfillment-items/{id}","href":"fulfillments/get_fulfillmentitem","openApiOperationId":"GET_FulfillmentItem","summary":"Retrieve a fulfillment item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetFulfillmentItemResponseType","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetFulfillmentItemResponseType","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1fulfillment-items~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetFulfillmentItemResponseType","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetFulfillmentItemResponseType","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfillments/get_fulfillmentitem"}],"panels":[]}]},"httpPath":"/v1/fulfillment-items/{id}"},{"label":"Update a fulfillment item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/fulfillments/put_fulfillmentitem","routeSlug":"/v1-api-reference/api/fulfillments/put_fulfillmentitem","metadata":{"seo":{"title":"Update a fulfillment item","description":"Updates a specified fulfillment item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_FulfillmentItem","name":"Update a fulfillment item","isWebhook":false,"pointer":"/paths/~1v1~1fulfillment-items~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a fulfillment item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specified fulfillment item. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","description":"The id of the Fulfillment Item to update.","required":true}],"pointer":"/paths/~1v1~1fulfillment-items~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1fulfillment-items~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/PutFulfillmentItemRequestType"}},"schemaId":"components/schemas/PutFulfillmentItemRequestType","pointer":"/paths/~1v1~1fulfillment-items~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/fulfillment-items/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutFulfillmentItemRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/fulfillment-items/{id}","href":"fulfillments/put_fulfillmentitem","openApiOperationId":"PUT_FulfillmentItem","summary":"Update a fulfillment item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutFulfillmentItemRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutFulfillmentItemRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1fulfillment-items~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1fulfillment-items~1{id}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfillments/put_fulfillmentitem"}],"panels":[]}]},"httpPath":"/v1/fulfillment-items/{id}"}],"content":{"contentType":"group","meta":{"name":"Fulfillments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fulfillments","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":"Fulfillments are subordinate objects attached to their related order line item. Fulfillment items are subordinate objects attached to their related fulfillment."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/fulfillments","summary":"Create fulfillments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fulfillments/create_fulfillment","deprecated":false},{"title":"/v1/fulfillments/{key}","summary":"Delete a fulfillment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fulfillments/delete_fulfillment","deprecated":false},{"title":"/v1/fulfillments/{key}","summary":"Retrieve a fulfillment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfillments/get_fulfillment","deprecated":false},{"title":"/v1/fulfillments/{key}","summary":"Update a fulfillment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/fulfillments/put_fulfillment","deprecated":false},{"title":"/v1/fulfillment-items","summary":"Create fulfillment items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fulfillments/create_fulfillmentitem","deprecated":false},{"title":"/v1/fulfillment-items/{id}","summary":"Delete a fulfillment item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fulfillments/delete_fulfillmentitem","deprecated":false},{"title":"/v1/fulfillment-items/{id}","summary":"Retrieve a fulfillment item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfillments/get_fulfillmentitem","deprecated":false},{"title":"/v1/fulfillment-items/{id}","summary":"Update a fulfillment item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/fulfillments/put_fulfillmentitem","deprecated":false}]}]}]}]}},{"type":"group","label":"Ramps","link":"/v1-api-reference/api/ramps","routeSlug":"/v1-api-reference/api/ramps","items":[{"label":"Retrieve a ramp","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/ramps/get_rampbyrampnumber","routeSlug":"/v1-api-reference/api/ramps/get_rampbyrampnumber","metadata":{"seo":{"title":"Retrieve a ramp","description":"Note: This operation is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RampByRampNumber","name":"Retrieve a ramp","isWebhook":false,"pointer":"/paths/~1v1~1ramps~1{rampNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a ramp","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":"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 is only available if you have the Ramps feature enabled. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must be enabled before you can access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information coming October 2020."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the latest definition of a specified ramp."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rampNumber","in":"path","schemaId":"schema_5","description":"The automatically generated number of a ramp. For example, R-00000268.\n","required":true}],"pointer":"/paths/~1v1~1ramps~1{rampNumber}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1ramps~1{rampNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/ramps/{rampNumber}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"rampNumber","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/ramps/{rampNumber}","href":"ramps/get_rampbyrampnumber","openApiOperationId":"GET_RampByRampNumber","summary":"Retrieve a ramp"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRampByRampNumberResponseType","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRampByRampNumberResponseType","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1ramps~1{rampNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRampByRampNumberResponseType","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRampByRampNumberResponseType","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ramps/get_rampbyrampnumber"}],"panels":[]}]},"httpPath":"/v1/ramps/{rampNumber}"},{"label":"List all ramp metrics of a ramp","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/ramps/get_rampmetricsbyrampnumber","routeSlug":"/v1-api-reference/api/ramps/get_rampmetricsbyrampnumber","metadata":{"seo":{"title":"List all ramp metrics of a ramp","description":"Note: This operation is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RampMetricsByRampNumber","name":"List all ramp metrics of a ramp","isWebhook":false,"pointer":"/paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all ramp metrics of a ramp","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":"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 is only available if you have the Ramps feature enabled. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must be enabled before you can access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information coming October 2020."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves key metrics about a specified ramp, including the following metrics:"},"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":"TCB, TCV in the Ramp level"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TCB, TCV in the Interval level"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TCB, TCV, Quantity, and MRR in Interval Metrics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta Metrics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-key-metrics-of-ramps"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key metrics for Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rampNumber","in":"path","schemaId":"schema_5","description":"The automatically generated number of a ramp. For example, R-00000268.\n","required":true}],"pointer":"/paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/ramps/{rampNumber}/ramp-metrics","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"rampNumber","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/ramps/{rampNumber}/ramp-metrics","href":"ramps/get_rampmetricsbyrampnumber","openApiOperationId":"GET_RampMetricsByRampNumber","summary":"List all ramp metrics of a ramp"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRampMetricsByRampNumberResponseType","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRampMetricsByRampNumberResponseType","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRampMetricsByRampNumberResponseType","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRampMetricsByRampNumberResponseType","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ramps/get_rampmetricsbyrampnumber"}],"panels":[]}]},"httpPath":"/v1/ramps/{rampNumber}/ramp-metrics"},{"label":"Retrieve a ramp by subscription key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/ramps/get_rampsbysubscriptionkey","routeSlug":"/v1-api-reference/api/ramps/get_rampsbysubscriptionkey","metadata":{"seo":{"title":"Retrieve a ramp by subscription key","description":"Note: This operation is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RampsBySubscriptionKey","name":"Retrieve a ramp by subscription key","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a ramp by subscription key","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":"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 is only available if you have the Ramps feature enabled. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must be enabled before you can access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information coming October 2020."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the definition of the ramp associated with a specified subscription."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionKey","in":"path","schemaId":"schema_5","description":"The ID or number of an existing subscription.\n","required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/subscriptions/{subscriptionKey}/ramps","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscriptionKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscriptionKey}/ramps","href":"ramps/get_rampsbysubscriptionkey","openApiOperationId":"GET_RampsBySubscriptionKey","summary":"Retrieve a ramp by subscription key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRampsBySubscriptionKeyResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRampsBySubscriptionKeyResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRampsBySubscriptionKeyResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRampsBySubscriptionKeyResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ramps/get_rampsbysubscriptionkey"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscriptionKey}/ramps"},{"label":"List ramp metrics by subscription key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/ramps/get_rampmetricsbysubscriptionkey","routeSlug":"/v1-api-reference/api/ramps/get_rampmetricsbysubscriptionkey","metadata":{"seo":{"title":"List ramp metrics by subscription key","description":"Note: This operation is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RampMetricsBySubscriptionKey","name":"List ramp metrics by subscription key","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List ramp metrics by subscription key","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":"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 is only available if you have the Ramps feature enabled. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must be enabled before you can access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information coming October 2020."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves key ramp metrics about a specified subscription, including the following metrics:"},"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":"TCB, TCV in the Ramp level"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TCB, TCV in the Interval level"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TCB, TCV, Quantity, and MRR in Interval Metrics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta Metrics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-key-metrics-of-ramps"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key metrics for Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionKey","in":"path","schemaId":"schema_5","description":"The ID or number of an existing subscription.\n","required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/subscriptions/{subscriptionKey}/ramp-metrics","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscriptionKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscriptionKey}/ramp-metrics","href":"ramps/get_rampmetricsbysubscriptionkey","openApiOperationId":"GET_RampMetricsBySubscriptionKey","summary":"List ramp metrics by subscription key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRampMetricsByRampNumberResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRampMetricsByRampNumberResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRampMetricsByRampNumberResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRampMetricsByRampNumberResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ramps/get_rampmetricsbysubscriptionkey"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscriptionKey}/ramp-metrics"},{"label":"List ramp metrics by order number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/ramps/get_rampmetricsbyordernumber","routeSlug":"/v1-api-reference/api/ramps/get_rampmetricsbyordernumber","metadata":{"seo":{"title":"List ramp metrics by order number","description":"Note: This operation is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RampMetricsByOrderNumber","name":"List ramp metrics by order number","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List ramp metrics by order number","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":"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 is only available if you have the Ramps feature enabled. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must be enabled before you can access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information coming October 2020."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves key ramp metrics about a specified order, including the following metrics:"},"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":"TCB, TCV in the Ramp level"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TCB, TCV in the Interval level"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TCB, TCV, Quantity, and MRR in Interval Metrics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta Metrics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-key-metrics-of-ramps"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key metrics for Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderNumber","in":"path","schemaId":"schema_5","description":"The number of the existing order.\n","required":true}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/{orderNumber}/ramp-metrics","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"orderNumber","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/orders/{orderNumber}/ramp-metrics","href":"ramps/get_rampmetricsbyordernumber","openApiOperationId":"GET_RampMetricsByOrderNumber","summary":"List ramp metrics by order number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRampMetricsByOrderNumberResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRampMetricsByOrderNumberResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRampMetricsByOrderNumberResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRampMetricsByOrderNumberResponseType","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ramps/get_rampmetricsbyordernumber"}],"panels":[]}]},"httpPath":"/v1/orders/{orderNumber}/ramp-metrics"}],"content":{"contentType":"group","meta":{"name":"Ramps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ramps","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":"A Ramp is a time container to associate with rate plan charges in your subscription. Inside the Ramp, you can further define a set of Ramp Intervals (time-based periods) where products or pricing can change. These periods are sub time containers to enable you to report out-of-the-box metrics based on Ramp Intervals."},"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":"Notes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You must have both the Ramps feature and Orders feature enabled for your tenant to use the Ramps operations."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramps and Ramp Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/ramps/{rampNumber}","summary":"Retrieve a ramp","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ramps/get_rampbyrampnumber","deprecated":false},{"title":"/v1/ramps/{rampNumber}/ramp-metrics","summary":"List all ramp metrics of a ramp","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ramps/get_rampmetricsbyrampnumber","deprecated":false},{"title":"/v1/subscriptions/{subscriptionKey}/ramps","summary":"Retrieve a ramp by subscription key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ramps/get_rampsbysubscriptionkey","deprecated":false},{"title":"/v1/subscriptions/{subscriptionKey}/ramp-metrics","summary":"List ramp metrics by subscription key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ramps/get_rampmetricsbysubscriptionkey","deprecated":false},{"title":"/v1/orders/{orderNumber}/ramp-metrics","summary":"List ramp metrics by order number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ramps/get_rampmetricsbyordernumber","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriptions","link":"/v1-api-reference/api/subscriptions","routeSlug":"/v1-api-reference/api/subscriptions","items":[{"label":"Preview a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/post_previewsubscription","routeSlug":"/v1-api-reference/api/subscriptions/post_previewsubscription","metadata":{"seo":{"title":"Preview a subscription","description":"The REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a subscription with complete details and charges before creating an account, or to let existing customers preview a subscription with all charges before committing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_PreviewSubscription","name":"Preview a subscription","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview a subscription","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":"The REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a subscription with complete details and charges before creating an account, or to let existing customers preview a subscription with all charges before committing."},"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":"Notes"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response of the Preview Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers."},"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":"If you have the Invoice Settlement feature enabled, we recommend that you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, an error is returned."},"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":"Default values for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customerAcceptanceDate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are set as follows."},"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":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceActivationDate(SA) specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceActivationDate (SA) NOT specified"},"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":"customerAcceptanceDate (CA) specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA uses value in the request call; CA uses value in the request call"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CA uses value in the request call;SA uses CE as default"},"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":"customerAcceptanceDate (CA) NOT specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA uses value in the request call; CA uses SA as default"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA and CA use CE as default"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionPreviewType"}},"schemaId":"components/schemas/POSTSubscriptionPreviewType","pointer":"/paths/~1v1~1subscriptions~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/subscriptions/preview","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionPreviewType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/preview","href":"subscriptions/post_previewsubscription","openApiOperationId":"POST_PreviewSubscription","summary":"Preview a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTSubscriptionPreviewType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionPreviewType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionPreviewResponseType","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTSubscriptionPreviewResponseType","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTSubscriptionPreviewResponseType","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionPreviewResponseType","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1preview/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/post_previewsubscription"}],"panels":[]}]},"httpPath":"/v1/subscriptions/preview"},{"label":"Preview a subscription by subscription key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/previewexistingsubscription","routeSlug":"/v1-api-reference/api/subscriptions/previewexistingsubscription","metadata":{"seo":{"title":"Preview a subscription by subscription key","description":"Describes how to preview an existing subscription to view information about existing and future invoices or credit memos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PreviewExistingSubscription","name":"Preview a subscription by subscription key","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview a subscription by subscription key","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":"Describes how to preview an existing subscription to view information about existing and future invoices or credit memos."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription-key","in":"path","schemaId":"schema_5","description":"Subscription number or ID","required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor version of the Zuora REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to set this parameter if you use 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":"text","inline":true,"attributes":{"content":"targetDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"includeExistingDraftDocItems"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"previewType"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxationItems"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewExistingSubscriptionRequest"}},"schemaId":"components/schemas/PreviewExistingSubscriptionRequest","pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/subscriptions/{subscription-key}/preview","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscription-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewExistingSubscriptionRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscription-key}/preview","href":"subscriptions/previewexistingsubscription","openApiOperationId":"PreviewExistingSubscription","summary":"Preview a subscription by subscription key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PreviewExistingSubscriptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewExistingSubscriptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PreviewExistingSubscriptionResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PreviewExistingSubscriptionResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PreviewExistingSubscriptionResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PreviewExistingSubscriptionResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/previewexistingsubscription"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscription-key}/preview"},{"label":"Create a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/post_subscription","routeSlug":"/v1-api-reference/api/subscriptions/post_subscription","metadata":{"seo":{"title":"Create a subscription","description":"This operation describes how to create a new subscription for an existing customer account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Subscription","name":"Create a subscription","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a subscription","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":"This operation describes how to create a new subscription for an existing customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscriptions/post_subscription/request/notes","deepLinkHash":"/subscriptions/post_subscription#subscriptions/post_subscription/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Invoice Settlement feature enabled, it is best practice to set"},"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":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"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":"Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default values for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customerAcceptanceDate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set as follows. This API operation does not support creating a pending subscription."},"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":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceActivationDate(SA) specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceActivationDate (SA) NOT specified"},"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":"customerAcceptanceDate (CA) specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA uses value in the request call; CA uses value in the request call"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CA uses value in the request call;SA uses CE as default"},"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":"customerAcceptanceDate (CA) NOT specified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA uses value in the request call; CA uses SA as default"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SA and CA use CE as default"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call supports a subset of the functionality of our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend using \"Create an order\" instead of this call because the Orders call has the following advantages:"},"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":"Provides options for managing the entire subscription lifecycle from creation through to cancellation using different order actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the creation or modifying of multiple subscriptions in a single order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows a single order to combine both recurring subscription digital goods or services with order line items for physical goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders are treated as atomic transactions. If any part fails, the entire order and subscription changes are rolled back."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call can be used to create a single subscription and there are no deprecation plans for this call. We will continue to support this call."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionType"}},"schemaId":"components/schemas/POSTSubscriptionType","pointer":"/paths/~1v1~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/subscriptions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions","href":"subscriptions/post_subscription","openApiOperationId":"POST_Subscription","summary":"Create a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTSubscriptionType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/post_subscription"}],"panels":[]}]},"httpPath":"/v1/subscriptions"},{"label":"List subscriptions by account key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/get_subscriptionsbyaccount","routeSlug":"/v1-api-reference/api/subscriptions/get_subscriptionsbyaccount","metadata":{"seo":{"title":"List subscriptions by account key","description":"Retrieves all subscriptions associated with the specified account. Zuora only returns the latest version of the subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_SubscriptionsByAccount","name":"List subscriptions by account key","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1accounts~1{account-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscriptions by account key","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 all subscriptions associated with the specified account. Zuora only returns the latest version of the subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription data is returned in reverse chronological order based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note that the rate plans inside the subscriptions are not sorted specifically and are returned in a random order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account-key","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"text","inline":true,"attributes":{"content":"an account number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an account ID"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1v1~1subscriptions~1accounts~1{account-key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"charge-detail","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The segmented rate plan charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last-segment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"current-segment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The segmented charge that is active on today’s date (effectiveStartDate <= today’s date <= effectiveEndDate)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"all-segments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All the segmented charges. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeSegments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is returned in the response. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeSegments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains an array of the charge information for all the charge segments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"specific-segment&as-of-date=date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd."},"children":[]}]}]}]}]}]},{"name":"as-of-date","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge-detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is only available when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge-detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific-segment"},"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 date should be in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"exclude-rate-plans-with-no-charges","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a rate plan charge has multiple segments, the last segment is returned by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this charge has been removed before the start date of the last segment (the latest one), with this parameter set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this charge is excluded from the response;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If all the charges under a rate plan are excluded, the rate plan is not returned 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 default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"getDetailedMetrics","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","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":"getDetailedMetrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"contractedNetMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asOfDayGrossMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asOfDayNetMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"netTotalContractedValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"asOfDay","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date for detailed metrics. Only available when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getDetailedMetrics"},"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 date should be in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"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 default value is the current date."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1accounts~1{account-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1accounts~1{account-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/subscriptions/accounts/{account-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"account-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"charge-detail","in":"query","required":false,"schemaId":"schema_5"},{"name":"as-of-date","in":"query","schemaId":"schema_5"},{"name":"exclude-rate-plans-with-no-charges","in":"query","required":false,"schemaId":"schema_27"},{"name":"getDetailedMetrics","in":"query","schemaId":"schema_22"},{"name":"asOfDay","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/accounts/{account-key}","href":"subscriptions/get_subscriptionsbyaccount","openApiOperationId":"GET_SubscriptionsByAccount","summary":"List subscriptions by account key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETSubscriptionWrapper","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETSubscriptionWrapper","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETSubscriptionWrapper","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETSubscriptionWrapper","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/get_subscriptionsbyaccount"}],"panels":[]}]},"httpPath":"/v1/subscriptions/accounts/{account-key}"},{"label":"Retrieve a subscription by key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/get_subscriptionsbykey","routeSlug":"/v1-api-reference/api/subscriptions/get_subscriptionsbykey","metadata":{"seo":{"title":"Retrieve a subscription by key","description":"This REST API reference describes how to retrieve detailed information about a specified subscription in the latest version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_SubscriptionsByKey","name":"Retrieve a subscription by key","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a subscription by key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This REST API reference describes how to retrieve detailed information\nabout a specified subscription in the latest version.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription-key","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"text","inline":true,"attributes":{"content":"a subscription number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a subscription ID"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"charge-detail","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last-segment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"current-segment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The segmented charge that is active on today’s date (effectiveStartDate <= today’s date <= effectiveEndDate)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"all-segments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All the segmented charges. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlans"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" >"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeSegments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested field is returned in the response. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeSegments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains an array of the charge information for all the charge segments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"specific-segment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use this value together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"as-of-date={specificDate}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The segmented charge that is active on a date you specified ((specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate)) is returned. The format of the date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"name":"as-of-date","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge-detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is only available when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge-detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific-segment"},"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 date should be in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"exclude-rate-plans-with-no-charges","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a rate plan charge has multiple segments, the last segment is returned by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this charge has been removed before the start date of the last segment (the latest one), with this parameter set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this charge is excluded from the response;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If all the charges under a rate plan are excluded, the rate plan is not returned 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 default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"getDetailedMetrics","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","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":"getDetailedMetrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"contractedNetMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asOfDayGrossMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asOfDayNetMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"netTotalContractedValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"asOfDay","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date for detailed metrics. Only available when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getDetailedMetrics"},"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":"The date should be in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"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 default value is the current date."},"children":[]}]}]}]},{"name":"getInvoiceOwnerDetails","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the invoice owner of a subscription. If this parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the invoice owner account details "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response."},"children":[]}]}]}]},{"name":"getSubscriptionOwnerDetails","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the owner of a subscription. If this parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription owner account details "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountOwnerDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/subscriptions/{subscription-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscription-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"charge-detail","in":"query","required":false,"schemaId":"schema_5"},{"name":"as-of-date","in":"query","schemaId":"schema_5"},{"name":"exclude-rate-plans-with-no-charges","in":"query","required":false,"schemaId":"schema_27"},{"name":"getDetailedMetrics","in":"query","schemaId":"schema_22"},{"name":"asOfDay","in":"query","schemaId":"schema_5"},{"name":"getInvoiceOwnerDetails","in":"query","schemaId":"schema_27"},{"name":"getSubscriptionOwnerDetails","in":"query","schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscription-key}","href":"subscriptions/get_subscriptionsbykey","openApiOperationId":"GET_SubscriptionsByKey","summary":"Retrieve a subscription by key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETSubscriptionByKeyWithSuccess","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETSubscriptionByKeyWithSuccess","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETSubscriptionByKeyWithSuccess","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETSubscriptionByKeyWithSuccess","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/get_subscriptionsbykey"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscription-key}"},{"label":"Update a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_subscription","routeSlug":"/v1-api-reference/api/subscriptions/put_subscription","metadata":{"seo":{"title":"Update a subscription","description":"Use this call to make the following kinds of changes to a subscription:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_Subscription","name":"Update a subscription","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a subscription","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":"Use this call to make the following kinds of changes to a subscription:"},"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":"Add a note"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the renewal term or auto-renewal flag"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the term length or change between evergreen and termed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a new product rate plan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove an existing subscription rate plan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the quantity or price of an existing subscription rate plan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change rate plans - to replace the existing rate plans in a subscription with other rate plans. Changing rate plans is currently not supported for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscriptions/put_subscription/request/notes:","deepLinkHash":"/subscriptions/put_subscription#subscriptions/put_subscription/request/notes:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"The \"Update a subscription\" call creates a new subscription object that has a new version number and to which the subscription changes are applied. The new subscription object has the same subscription name but a new, different, subscription ID. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the new subscription object will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unless the change applied was a cancelation or suspension in which case the status reflects that. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the originating subscription object changes from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not imply that the subscription itself has expired or ended, merely that this subscription object is no longer the most recent."},"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":"In one request, this call can make:"},"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":"Up to 9 combined add, update, and remove changes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No more than 1 change to terms & conditions"},"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":"Updates are performed in the following sequence:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First change the notes on the existing subscription, if requested."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Then change the terms and conditions, if requested."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Then perform the remaining amendments based upon the effective dates specified. If multiple amendments have the same contract-effective dates, then execute adds before updates, and updates before removes."},"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":"The update operation is atomic. If any of the updates fails, the entire operation is rolled back."},"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":"The response of the Update Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers."},"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":"If you have the Invoice Settlement feature enabled, it is best practice to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, an error occurs."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscriptions/put_subscription/request/override-a-tiered-price","deepLinkHash":"/subscriptions/put_subscription#subscriptions/put_subscription/request/override-a-tiered-price"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override a Tiered Price"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two ways you override a tiered price:"},"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":"Override a specific tier number. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tiers[{tier:1,price:8},{tier:2,price:6}]"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override the entire tier structure. For example:  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tiers[{tier:1,price:8,startingUnit:1,endingUnit:100,priceFormat:\"FlatFee\"}, {tier:2,price:6,startingUnit:101,priceFormat:\"FlatFee\"}]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you just override a specific tier, do not include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startingUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription-key","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription number or ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID can be the latest version or any history version of ID."},"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 make sure you update the last version of the subscription, use one of the following operations to retrieve the last version of ID:"},"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":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByAccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List subscriptions by account key"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByKey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a subscription by key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by using the subscription number as the subscription-key"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to use any history version of ID, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STABLE_ID_PUBLIC_API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission must be enabled. Submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable the permission. To retrieve a history version of ID, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByKeyAndVersion"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a subscription by key and version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionType"}},"schemaId":"components/schemas/PUTSubscriptionType","pointer":"/paths/~1v1~1subscriptions~1{subscription-key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/subscriptions/{subscription-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscription-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscription-key}","href":"subscriptions/put_subscription","openApiOperationId":"PUT_Subscription","summary":"Update a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTSubscriptionType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/put_subscription"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscription-key}"},{"label":"Retrieve a subscription by key and version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/get_subscriptionsbykeyandversion","routeSlug":"/v1-api-reference/api/subscriptions/get_subscriptionsbykeyandversion","metadata":{"seo":{"title":"Retrieve a subscription by key and version","description":"This REST API reference describes how to retrieve detailed information about a specified subscription in a specified version. When you create a subscription amendment, you create a new version of the subscription. You can use this method to retrieve information about a subscription in any version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_SubscriptionsByKeyAndVersion","name":"Retrieve a subscription by key and version","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a subscription by key and version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This REST API reference describes how to retrieve detailed information about a specified subscription in a specified version. When you create a subscription amendment, you create a new version of the subscription. You can use this method to retrieve information about a subscription in any version.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription-key","in":"path","schemaId":"schema_5","description":"Subscription number. For example, A-S00000135.\n","required":true},{"name":"version","in":"path","schemaId":"schema_5","description":"Subscription version. For example, 1.\n","required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"charge-detail","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last-segment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"current-segment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The segmented charge that is active on today’s date (effectiveStartDate <= today’s date <= effectiveEndDate)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"all-segments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All the segmented charges. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeSegments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is returned in the response. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeSegments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains an array of the charge information for all the charge segments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"specific-segment&as-of-date=date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd."},"children":[]}]}]}]}]}]},{"name":"as-of-date","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge-detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is only available when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge-detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific-segment"},"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 date should be in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"exclude-rate-plans-with-no-charges","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a rate plan charge has multiple segments, the last segment is returned by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this charge has been removed before the start date of the last segment (the latest one), with this parameter set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this charge is excluded from the response;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If all the charges under a rate plan are excluded, the rate plan is not returned 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 default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"getDetailedMetrics","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","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":"getDetailedMetrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"contractedNetMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asOfDayGrossMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asOfDayNetMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"netTotalContractedValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"asOfDay","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date for detailed metrics. Only available when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getDetailedMetrics"},"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 date should be in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"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 default value is the current date."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/subscriptions/{subscription-key}/versions/{version}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscription-key","in":"path","required":true,"schemaId":"schema_5"},{"name":"version","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"charge-detail","in":"query","required":false,"schemaId":"schema_5"},{"name":"as-of-date","in":"query","schemaId":"schema_5"},{"name":"exclude-rate-plans-with-no-charges","in":"query","required":false,"schemaId":"schema_27"},{"name":"getDetailedMetrics","in":"query","schemaId":"schema_22"},{"name":"asOfDay","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscription-key}/versions/{version}","href":"subscriptions/get_subscriptionsbykeyandversion","openApiOperationId":"GET_SubscriptionsByKeyAndVersion","summary":"Retrieve a subscription by key and version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETSubscriptionTypeWithSuccess","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETSubscriptionTypeWithSuccess","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETSubscriptionTypeWithSuccess","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETSubscriptionTypeWithSuccess","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/get_subscriptionsbykeyandversion"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscription-key}/versions/{version}"},{"label":"Renew a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_renewsubscription","routeSlug":"/v1-api-reference/api/subscriptions/put_renewsubscription","metadata":{"seo":{"title":"Renew a subscription","description":"Renews a termed subscription using existing renewal terms. When you renew a subscription, the current subscription term is extended by creating a new term.  If any charge in your subscription has the billing period set as SubscriptionTerm, a new charge segment is generated for the new term."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_RenewSubscription","name":"Renew a subscription","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1renew/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Renew a subscription","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":"Renews a termed subscription using existing renewal terms. When you renew a subscription, the current subscription term is extended by creating a new term.  If any charge in your subscription has the billing period set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a new charge segment is generated for the new term."},"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":": If you have the Invoice Settlement feature enabled, it is best practice to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, an error occurs."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription-key","in":"path","schemaId":"schema_5","description":"Subscription number or ID","required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTRenewSubscriptionType"}},"schemaId":"components/schemas/PUTRenewSubscriptionType","pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/subscriptions/{subscription-key}/renew","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscription-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTRenewSubscriptionType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscription-key}/renew","href":"subscriptions/put_renewsubscription","openApiOperationId":"PUT_RenewSubscription","summary":"Renew a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTRenewSubscriptionType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTRenewSubscriptionType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTRenewSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTRenewSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTRenewSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTRenewSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/put_renewsubscription"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscription-key}/renew"},{"label":"Cancel a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_cancelsubscription","routeSlug":"/v1-api-reference/api/subscriptions/put_cancelsubscription","metadata":{"seo":{"title":"Cancel a subscription","description":"This REST API reference describes how to cancel an active subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CancelSubscription","name":"Cancel a subscription","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a subscription","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":"This REST API reference describes how to cancel an active subscription."},"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":": If you have the Invoice Settlement feature enabled, it is best practice to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, an error occurs."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription-key","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription number or ID. Subscription status must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionCancellationType"}},"schemaId":"components/schemas/POSTSubscriptionCancellationType","pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/subscriptions/{subscription-key}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscription-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionCancellationType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscription-key}/cancel","href":"subscriptions/put_cancelsubscription","openApiOperationId":"PUT_CancelSubscription","summary":"Cancel a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTSubscriptionCancellationType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionCancellationType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionCancellationResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTSubscriptionCancellationResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTSubscriptionCancellationResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTSubscriptionCancellationResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/put_cancelsubscription"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscription-key}/cancel"},{"label":"Resume a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_resumesubscription","routeSlug":"/v1-api-reference/api/subscriptions/put_resumesubscription","metadata":{"seo":{"title":"Resume a subscription","description":"This REST API reference describes how to resume a suspended subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_ResumeSubscription","name":"Resume a subscription","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1resume/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resume a subscription","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":"This REST API reference describes how to resume a suspended subscription."},"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":": If you have the Invoice Settlement feature enabled, it is best practice to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, an error occurs."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription-key","in":"path","schemaId":"schema_5","description":"Subscription number or ID. Subscription status must be Suspended.","required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionResumeType"}},"schemaId":"components/schemas/PUTSubscriptionResumeType","pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/subscriptions/{subscription-key}/resume","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscription-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionResumeType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscription-key}/resume","href":"subscriptions/put_resumesubscription","openApiOperationId":"PUT_ResumeSubscription","summary":"Resume a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTSubscriptionResumeType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionResumeType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionResumeResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTSubscriptionResumeResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTSubscriptionResumeResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionResumeResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/put_resumesubscription"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscription-key}/resume"},{"label":"Suspend a subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_suspendsubscription","routeSlug":"/v1-api-reference/api/subscriptions/put_suspendsubscription","metadata":{"seo":{"title":"Suspend a subscription","description":"This REST API reference describes how to suspend an active subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_SuspendSubscription","name":"Suspend a subscription","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Suspend a subscription","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":"This REST API reference describes how to suspend an active subscription."},"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":": If you have the Invoice Settlement feature enabled, it is best practice to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, an error occurs. The response will be different if Orders is enabled in tenant and examples of the response can be found in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/orders/post_order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call response samples. Also, more examples can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/get-started/api-tutorials/orders-tutorials/order-basics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Basics for Developers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tutorial as well as the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/error-handling"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error handling code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If Orders is enabled in your tenant, you must plan for refactoring this API operation and the corresponding orders API operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription-key","in":"path","schemaId":"schema_5","description":"Subscription number or ID. Subscription status must be Active.","required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionSuspendType"}},"schemaId":"components/schemas/PUTSubscriptionSuspendType","pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/subscriptions/{subscription-key}/suspend","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscription-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionSuspendType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscription-key}/suspend","href":"subscriptions/put_suspendsubscription","openApiOperationId":"PUT_SuspendSubscription","summary":"Suspend a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTSubscriptionSuspendType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionSuspendType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionSuspendResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTSubscriptionSuspendResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTSubscriptionSuspendResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionSuspendResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/put_suspendsubscription"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscription-key}/suspend"},{"label":"Delete a subscription by number","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_deletesubscription","routeSlug":"/v1-api-reference/api/subscriptions/put_deletesubscription","metadata":{"seo":{"title":"Delete a subscription by number","description":"This REST API reference describes how to delete a subscription of the specified subscription number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_DeleteSubscription","name":"Delete a subscription by number","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1delete/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a subscription by number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This REST API reference describes how to delete a subscription of the specified subscription number.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription-key","in":"path","schemaId":"schema_5","description":"Subscription number","required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/subscriptions/{subscription-key}/delete","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscription-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscription-key}/delete","href":"subscriptions/put_deletesubscription","openApiOperationId":"PUT_DeleteSubscription","summary":"Delete a subscription by number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTDeleteSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTDeleteSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTDeleteSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTDeleteSubscriptionResponseType","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/put_deletesubscription"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscription-key}/delete"},{"label":"Update subscription custom fields of a subscription version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/put_updatesubscriptioncustomfieldsofaspecifiedversion","routeSlug":"/v1-api-reference/api/subscriptions/put_updatesubscriptioncustomfieldsofaspecifiedversion","metadata":{"seo":{"title":"Update subscription custom fields of a subscription version","description":"Updates the custom fields of a specified subscription version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateSubscriptionCustomFieldsOfASpecifiedVersion","name":"Update subscription custom fields of a subscription version","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subscription custom fields of a subscription version","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 specified subscription version.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionNumber","in":"path","schemaId":"schema_36","description":"The subscription number to be updated.","required":true},{"name":"version","in":"path","schemaId":"schema_36","description":"The subscription version to be updated.","required":true}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionPatchSpecificVersionRequestType"}},"schemaId":"components/schemas/PUTSubscriptionPatchSpecificVersionRequestType","pointer":"/paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscriptionNumber","in":"path","required":true,"schemaId":"schema_36"},{"name":"version","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionPatchSpecificVersionRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields","href":"subscriptions/put_updatesubscriptioncustomfieldsofaspecifiedversion","openApiOperationId":"PUT_UpdateSubscriptionCustomFieldsOfASpecifiedVersion","summary":"Update subscription custom fields of a subscription version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTSubscriptionPatchSpecificVersionRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSubscriptionPatchSpecificVersionRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/put_updatesubscriptioncustomfieldsofaspecifiedversion"}],"panels":[]}]},"httpPath":"/v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields"},{"label":"List subscription metrics by subscription numbers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/subscriptions/getmetricsbysubscriptionnumbers","routeSlug":"/v1-api-reference/api/subscriptions/getmetricsbysubscriptionnumbers","metadata":{"seo":{"title":"List subscription metrics by subscription numbers","description":"Lists subscription metrics for the subscriptions that you specify by subscription numbers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetMetricsBySubscriptionNumbers","name":"List subscription metrics by subscription numbers","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions~1subscription-metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscription metrics by subscription numbers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists subscription metrics for the subscriptions that you specify by subscription numbers.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"asOfDay","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date for the metrics. The date should be in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default value is the current date."},"children":[]}]}]}]},{"name":"subscriptionNumbers[]","in":"query","schemaId":"schema_42","description":"The subscription numbers of existing subscriptions.","required":true}],"pointer":"/paths/~1v1~1subscriptions~1subscription-metrics/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1subscriptions~1subscription-metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/subscriptions/subscription-metrics","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"asOfDay","in":"query","schemaId":"schema_5"},{"name":"subscriptionNumbers[]","in":"query","required":true,"schemaId":"schema_42"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/subscriptions/subscription-metrics","href":"subscriptions/getmetricsbysubscriptionnumbers","openApiOperationId":"GetMetricsBySubscriptionNumbers","summary":"List subscription metrics by subscription numbers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETMetricsBySubscriptionNumbersResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GETMetricsBySubscriptionNumbersResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1subscriptions~1subscription-metrics/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETMetricsBySubscriptionNumbersResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETMetricsBySubscriptionNumbersResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1subscriptions~1subscription-metrics/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/getmetricsbysubscriptionnumbers"}],"panels":[]}]},"httpPath":"/v1/subscriptions/subscription-metrics"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","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":"A subscription is a product or service that has recurring charges,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"such as a monthly flat fee or charges based on usage. Subscriptions can also include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one-time charges, such as activation fees. Every subscription must be associated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with an account. At least one active account must exist before any subscriptions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-manage-subscription-transactions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/subscriptions/preview","summary":"Preview a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/post_previewsubscription","deprecated":false},{"title":"/v1/subscriptions/{subscription-key}/preview","summary":"Preview a subscription by subscription key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/previewexistingsubscription","deprecated":false},{"title":"/v1/subscriptions","summary":"Create a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/post_subscription","deprecated":false},{"title":"/v1/subscriptions/accounts/{account-key}","summary":"List subscriptions by account key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/get_subscriptionsbyaccount","deprecated":false},{"title":"/v1/subscriptions/{subscription-key}","summary":"Retrieve a subscription by key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/get_subscriptionsbykey","deprecated":false},{"title":"/v1/subscriptions/{subscription-key}","summary":"Update a subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/put_subscription","deprecated":false},{"title":"/v1/subscriptions/{subscription-key}/versions/{version}","summary":"Retrieve a subscription by key and version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/get_subscriptionsbykeyandversion","deprecated":false},{"title":"/v1/subscriptions/{subscription-key}/renew","summary":"Renew a subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/put_renewsubscription","deprecated":false},{"title":"/v1/subscriptions/{subscription-key}/cancel","summary":"Cancel a subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/put_cancelsubscription","deprecated":false},{"title":"/v1/subscriptions/{subscription-key}/resume","summary":"Resume a subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/put_resumesubscription","deprecated":false},{"title":"/v1/subscriptions/{subscription-key}/suspend","summary":"Suspend a subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/put_suspendsubscription","deprecated":false},{"title":"/v1/subscriptions/{subscription-key}/delete","summary":"Delete a subscription by number","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/put_deletesubscription","deprecated":false},{"title":"/v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields","summary":"Update subscription custom fields of a subscription version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/put_updatesubscriptioncustomfieldsofaspecifiedversion","deprecated":false},{"title":"/v1/subscriptions/subscription-metrics","summary":"List subscription metrics by subscription numbers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/getmetricsbysubscriptionnumbers","deprecated":false}]}]}]}]}},{"type":"group","label":"Omnichannel Subscriptions","link":"/v1-api-reference/api/omnichannel-subscriptions","routeSlug":"/v1-api-reference/api/omnichannel-subscriptions","items":[{"label":"Create an omnichannel subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/omnichannel-subscriptions/postomnichannelsubscription","routeSlug":"/v1-api-reference/api/omnichannel-subscriptions/postomnichannelsubscription","metadata":{"seo":{"title":"Create an omnichannel subscription","description":"Creates or updates an omnichannel subscription for a customer account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postOmnichannelSubscription","name":"Create an omnichannel subscription","isWebhook":false,"pointer":"/paths/~1v1~1omni-channel-subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an omnichannel subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates an omnichannel subscription for a customer account.\n\nYou can also create a new customer account and assign it to the new omnichannel subscription.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1omni-channel-subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOmniChannelSubscriptionRequest"}},"schemaId":"components/schemas/CreateOmniChannelSubscriptionRequest","pointer":"/paths/~1v1~1omni-channel-subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/omni-channel-subscriptions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateOmniChannelSubscriptionRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/omni-channel-subscriptions","href":"omnichannel-subscriptions/postomnichannelsubscription","openApiOperationId":"postOmnichannelSubscription","summary":"Create an omnichannel subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateOmniChannelSubscriptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOmniChannelSubscriptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOmniChannelSubscriptionResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreateOmniChannelSubscriptionResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"}],"pointer":"/paths/~1v1~1omni-channel-subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateOmniChannelSubscriptionResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOmniChannelSubscriptionResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions/post/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/omnichannel-subscriptions/postomnichannelsubscription"}],"panels":[]}]},"httpPath":"/v1/omni-channel-subscriptions"},{"label":"Retrieve an omnichannel subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/omnichannel-subscriptions/getomnichannelsubscription","routeSlug":"/v1-api-reference/api/omnichannel-subscriptions/getomnichannelsubscription","metadata":{"seo":{"title":"Retrieve an omnichannel subscription","description":"Retrieves the information about a specific omnichannel subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOmnichannelSubscription","name":"Retrieve an omnichannel subscription","isWebhook":false,"pointer":"/paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an omnichannel subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the information about a specific omnichannel subscription. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionKey","in":"path","schemaId":"schema_5","description":"The ID or number of the omnichannel subscription to be retrieved. The ID may be a Zuora subscription ID or an external system subscription ID.","required":true}],"pointer":"/paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"getAccountDetails","in":"query","schemaId":"schema_27","description":"Retrieves the details of an account."}],"pointer":"/paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/omni-channel-subscriptions/{subscriptionKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscriptionKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"getAccountDetails","in":"query","schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/omni-channel-subscriptions/{subscriptionKey}","href":"omnichannel-subscriptions/getomnichannelsubscription","openApiOperationId":"getOmnichannelSubscription","summary":"Retrieve an omnichannel subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOmniChannelSubscriptionResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetOmniChannelSubscriptionResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"}],"pointer":"/paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOmniChannelSubscriptionResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOmniChannelSubscriptionResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/omnichannel-subscriptions/getomnichannelsubscription"}],"panels":[]}]},"httpPath":"/v1/omni-channel-subscriptions/{subscriptionKey}"},{"label":"Delete an omnichannel subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/omnichannel-subscriptions/deleteomnichannelsubscription","routeSlug":"/v1-api-reference/api/omnichannel-subscriptions/deleteomnichannelsubscription","metadata":{"seo":{"title":"Delete an omnichannel subscription","description":"Deletes a specified omnichannel subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOmnichannelSubscription","name":"Delete an omnichannel subscription","isWebhook":false,"pointer":"/paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an omnichannel subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specified omnichannel subscription. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriptionKey","in":"path","schemaId":"schema_5","description":"The key of the omnichannel subscription to be deleted.","required":true}],"pointer":"/paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/omni-channel-subscriptions/{subscriptionKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"subscriptionKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/omni-channel-subscriptions/{subscriptionKey}","href":"omnichannel-subscriptions/deleteomnichannelsubscription","openApiOperationId":"deleteOmnichannelSubscription","summary":"Delete an omnichannel subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/omnichannel-subscriptions/deleteomnichannelsubscription"}],"panels":[]}]},"httpPath":"/v1/omni-channel-subscriptions/{subscriptionKey}"}],"content":{"contentType":"group","meta":{"name":"Omnichannel Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Omnichannel Subscriptions","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":"An omnichannel subscription is a subscription originating from external and source systems, such as the Apple App Store, Google Play Store, and Roku Store."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create, update, delete, or retrieve an omnichannel subscription, you must turn on the Omni-Channel Subscription feature. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/common-subscription-information/omni-channel-subscription","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omni-Channel Subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/omni-channel-subscriptions","summary":"Create an omnichannel subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/omnichannel-subscriptions/postomnichannelsubscription","deprecated":false},{"title":"/v1/omni-channel-subscriptions/{subscriptionKey}","summary":"Retrieve an omnichannel subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/omnichannel-subscriptions/getomnichannelsubscription","deprecated":false},{"title":"/v1/omni-channel-subscriptions/{subscriptionKey}","summary":"Delete an omnichannel subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/omnichannel-subscriptions/deleteomnichannelsubscription","deprecated":false}]}]}]}]}},{"type":"group","label":"Rate Plans","link":"/v1-api-reference/api/rate-plans","routeSlug":"/v1-api-reference/api/rate-plans","items":[{"label":"Retrieve a rate plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/rate-plans/get_rateplan","routeSlug":"/v1-api-reference/api/rate-plans/get_rateplan","metadata":{"seo":{"title":"Retrieve a rate plan","description":"Retrieves the detailed information about a specific subscription rate plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RatePlan","name":"Retrieve a rate plan","isWebhook":false,"pointer":"/paths/~1v1~1rateplans~1{ratePlanId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a rate plan","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 the detailed information about a specific subscription rate plan."},"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":"If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled, this operation retrieves information about a subscription rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan and the related order that has amended the rate plan."},"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":"If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled, this operation retrieves information about a subscription rate plan and the related order and amendment that have amended the rate plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The returned objects may be different since amendment, order, and order action are generated asynchronously."},"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 all are generated, the related amendment and order, including the order action, are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not, only the related amendment may be returned before generating the order and order action."},"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":"If you are an existing Zuora Subscribe and Amend customer, this operation retrieves"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information about a subscription rate plan and the related amendment that has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amended the rate plan."},"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":" Orders is now generally available as of Zuora Billing Release 284 (August"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2020). If you are an existing Zuora Subscribe and Amend customer and want to adopt"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders-harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and join the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://community.zuora.com/t5/Orders-Harmonization/gp-p/Orders-Harmonization","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization community group"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information. If you want to enable Orders, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global Support"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can only retrieve information about the following order actions:"},"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":"addProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"removeProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changePlan"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ratePlanId","in":"path","schemaId":"schema_36","description":"The ID of the subscription rate plan to be retrieved.","required":true}],"pointer":"/paths/~1v1~1rateplans~1{ratePlanId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1rateplans~1{ratePlanId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/rateplans/{ratePlanId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ratePlanId","in":"path","required":true,"schemaId":"schema_36"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/rateplans/{ratePlanId}","href":"rate-plans/get_rateplan","openApiOperationId":"GET_RatePlan","summary":"Retrieve a rate plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderActionRatePlanResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetOrderActionRatePlanResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1rateplans~1{ratePlanId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrderActionRatePlanResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderActionRatePlanResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rateplans~1{ratePlanId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rate-plans/get_rateplan"}],"panels":[]}]},"httpPath":"/v1/rateplans/{ratePlanId}"}],"content":{"contentType":"group","meta":{"name":"Rate Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate Plans","showPageActions":true},{"nodeType":"markdoc","content":"A rate plan is part of a subscription or an amendment to a subscription, and it comes from a product rate plan. Like a product and its product rate plans, a subscription can have one or more rate plans. \nRate plans are sometimes called subscription rate plans. Rate plans that are part of an amendment are sometimes called amendment rate plans.\n\nRate plans represent a price or a collection of prices for a service you sell. An individual rate plan contains all charges specific to a particular subscription."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/rateplans/{ratePlanId}","summary":"Retrieve a rate plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate-plans/get_rateplan","deprecated":false}]}]}]}]}},{"type":"group","label":"Commitments","link":"/v1-api-reference/api/commitments","routeSlug":"/v1-api-reference/api/commitments","items":[{"label":"List commitments for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/getcommitments","routeSlug":"/v1-api-reference/api/commitments/getcommitments","metadata":{"seo":{"title":"List commitments for an account","description":"Retrieves a paginated list of commitments for a commitment owner account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommitments","name":"List commitments for an account","isWebhook":false,"pointer":"/paths/~1commitments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List commitments for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of commitments for a commitment owner account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountNumber","in":"query","schemaId":"schema_5","description":"Account number to fetch commitments for.","required":true},{"name":"type","in":"query","schemaId":"schema_43","description":"Filter commitments by type."},{"name":"page","in":"query","schemaId":"schema_28","description":"Page number for pagination."},{"name":"pageSize","in":"query","schemaId":"schema_44","description":"Page size for pagination."},{"name":"includeChildCommitments","in":"query","schemaId":"schema_22","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", each commitment's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"childCommitments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array contains full child commitment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"childCommitments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an empty array. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commitments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commitments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commitments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"accountNumber","in":"query","required":true,"schemaId":"schema_5"},{"name":"type","in":"query","required":false,"example":"MinCommitment","schemaId":"schema_43"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_44"},{"name":"includeChildCommitments","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/commitments","href":"commitments/getcommitments","openApiOperationId":"getCommitments","summary":"List commitments for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCommitmentsResponse","exampleIds":["paths/~1commitments/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetCommitmentsResponse","exampleIds":["paths/~1commitments/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1commitments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCommitmentsResponse","exampleIds":["paths/~1commitments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCommitmentsResponse","exampleIds":["paths/~1commitments/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commitments/getcommitments"}],"panels":[]}]},"httpPath":"/commitments"},{"label":"Retrieve a commitment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/getcommitmentbykey","routeSlug":"/v1-api-reference/api/commitments/getcommitmentbykey","metadata":{"seo":{"title":"Retrieve a commitment","description":"Retrieves the details of a specific commitment using its ID or number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommitmentByKey","name":"Retrieve a commitment","isWebhook":false,"pointer":"/paths/~1commitments~1{commitmentKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a commitment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the details of a specific commitment using its ID or number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"commitmentKey","in":"path","schemaId":"schema_5","description":"The unique identifier (ID or number) of the commitment.","required":true}],"pointer":"/paths/~1commitments~1{commitmentKey}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeChildCommitments","in":"query","schemaId":"schema_22","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"childCommitments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains full child commitment objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"childCommitments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an empty array. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commitments~1{commitmentKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commitments~1{commitmentKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commitments/{commitmentKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"commitmentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"includeChildCommitments","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/commitments/{commitmentKey}","href":"commitments/getcommitmentbykey","openApiOperationId":"getCommitmentByKey","summary":"Retrieve a commitment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCommitmentResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetCommitmentResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1commitments~1{commitmentKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCommitmentResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCommitmentResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commitments/getcommitmentbykey"}],"panels":[]}]},"httpPath":"/commitments/{commitmentKey}"},{"label":"List periods for a commitment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/getcommitmentperiods","routeSlug":"/v1-api-reference/api/commitments/getcommitmentperiods","metadata":{"seo":{"title":"List periods for a commitment","description":"Lists periods of the commitment. You can paginate the results using page and pageSize query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommitmentPeriods","name":"List periods for a commitment","isWebhook":false,"pointer":"/paths/~1commitments~1periods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List periods for a commitment","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":"Lists periods of the commitment. You can paginate the results using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"commitmentKey","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier or number of the commitment. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not all provided. Either specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" together."},"children":[]}]}]}]},{"name":"startDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the billing period in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Date filters must be up to 5 years apart. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided. Must be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"endDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the billing period in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Date filters must be up to 5 years apart. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided. Must be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"accountNumber","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number to which the commitment belongs to. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided. Must be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_28","description":"Page number for pagination.\n"},{"name":"pageSize","in":"query","schemaId":"schema_44","description":"Page size for pagination.\n"}],"pointer":"/paths/~1commitments~1periods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commitments~1periods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commitments/periods","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"commitmentKey","in":"query","required":false,"schemaId":"schema_5"},{"name":"startDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"endDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"accountNumber","in":"query","required":false,"schemaId":"schema_5"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/commitments/periods","href":"commitments/getcommitmentperiods","openApiOperationId":"getCommitmentPeriods","summary":"List periods for a commitment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCommitmentPeriodsResponse","exampleIds":["paths/~1commitments~1periods/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListCommitmentPeriodsResponse","exampleIds":["paths/~1commitments~1periods/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1periods/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1periods/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1periods/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1periods/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1commitments~1periods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCommitmentPeriodsResponse","exampleIds":["paths/~1commitments~1periods/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCommitmentPeriodsResponse","exampleIds":["paths/~1commitments~1periods/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1periods/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1periods/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1periods/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1periods/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commitments/getcommitmentperiods"}],"panels":[]}]},"httpPath":"/commitments/periods"},{"label":"Preview the balance for a commitment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/getcommitmentbalancepreview","routeSlug":"/v1-api-reference/api/commitments/getcommitmentbalancepreview","metadata":{"seo":{"title":"Preview the balance for a commitment","description":"Preview the balance for a commitment for current and past periods.Future periods are not covered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommitmentBalancePreview","name":"Preview the balance for a commitment","isWebhook":false,"pointer":"/paths/~1commitments~1{commitmentId}~1balancepreview/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview the balance for a commitment","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":"Preview the balance for a commitment for current and past periods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Future periods are not covered."},"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 API will not work for tenants that are configured to skip commitment evaluation in Zuora Billing, and calls to this API are rejected."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"commitmentId","in":"path","schemaId":"schema_5","description":"The unique identifier of the commitment.","required":true}],"pointer":"/paths/~1commitments~1{commitmentId}~1balancepreview/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":"Page number for pagination.\n"},{"name":"pageSize","in":"query","schemaId":"schema_44","description":"Page size for pagination.\n"},{"name":"asOfDate","in":"query","schemaId":"schema_32","description":"The date to calculate the balance as of.\nDefaults to the current date if not provided.\n"}],"pointer":"/paths/~1commitments~1{commitmentId}~1balancepreview/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commitments~1{commitmentId}~1balancepreview/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commitments/{commitmentId}/balancepreview","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"commitmentId","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_44"},{"name":"asOfDate","in":"query","required":false,"schemaId":"schema_32"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/commitments/{commitmentId}/balancepreview","href":"commitments/getcommitmentbalancepreview","openApiOperationId":"getCommitmentBalancePreview","summary":"Preview the balance for a commitment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCommitmentBalanceResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetCommitmentBalanceResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1commitments~1{commitmentId}~1balancepreview/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCommitmentBalanceResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCommitmentBalanceResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commitments/getcommitmentbalancepreview"}],"panels":[]}]},"httpPath":"/commitments/{commitmentId}/balancepreview"},{"label":"List schedules for a commitment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/listcommitmentschedules","routeSlug":"/v1-api-reference/api/commitments/listcommitmentschedules","metadata":{"seo":{"title":"List schedules for a commitment","description":"Retrieves all the schedules for a specific commitment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCommitmentSchedules","name":"List schedules for a commitment","isWebhook":false,"pointer":"/paths/~1commitments~1{commitmentKey}~1schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List schedules for a commitment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all the schedules for a specific commitment.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"commitmentKey","in":"path","schemaId":"schema_5","description":"The unique identifier (ID or number) of the commitment.","required":true}],"pointer":"/paths/~1commitments~1{commitmentKey}~1schedules/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":"Page number for pagination.\n"},{"name":"pageSize","in":"query","schemaId":"schema_44","description":"Page size for pagination.\n"}],"pointer":"/paths/~1commitments~1{commitmentKey}~1schedules/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commitments~1{commitmentKey}~1schedules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commitments/{commitmentKey}/schedules","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"commitmentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/commitments/{commitmentKey}/schedules","href":"commitments/listcommitmentschedules","openApiOperationId":"listCommitmentSchedules","summary":"List schedules for a commitment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCommitmentScheduleResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetCommitmentScheduleResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/200/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1commitments~1{commitmentKey}~1schedules/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCommitmentScheduleResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCommitmentScheduleResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1schedules/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commitments/listcommitmentschedules"}],"panels":[]}]},"httpPath":"/commitments/{commitmentKey}/schedules"},{"label":"Expire a commitment-linked prepayment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/expireprepayment","routeSlug":"/v1-api-reference/api/commitments/expireprepayment","metadata":{"seo":{"title":"Expire a commitment-linked prepayment","description":"Expires a single commitment-linked prepayment and returns the updated prepayment state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"expirePrepayment","name":"Expire a commitment-linked prepayment","isWebhook":false,"pointer":"/paths/~1prepayments~1{prepaymentId}~1expire/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expire a commitment-linked prepayment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Expires a single commitment-linked prepayment and returns the updated prepayment state.\n\nAfter the prepayment is expired, it does not participate in future drawdown. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"prepaymentId","in":"path","schemaId":"schema_5","description":"The identifier of the prepayment to expire.","required":true}],"pointer":"/paths/~1prepayments~1{prepaymentId}~1expire/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1prepayments~1{prepaymentId}~1expire/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/prepayments/{prepaymentId}/expire","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"prepaymentId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/prepayments/{prepaymentId}/expire","href":"commitments/expireprepayment","openApiOperationId":"expirePrepayment","summary":"Expire a commitment-linked prepayment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpirePrepaymentResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpirePrepaymentResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/200/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1prepayments~1{prepaymentId}~1expire/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpirePrepaymentResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpirePrepaymentResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1prepayments~1{prepaymentId}~1expire/put/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commitments/expireprepayment"}],"panels":[]}]},"httpPath":"/prepayments/{prepaymentId}/expire"},{"label":"List the change history for a commitment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/commitments/listcommitmenthistoricalchanges","routeSlug":"/v1-api-reference/api/commitments/listcommitmenthistoricalchanges","metadata":{"seo":{"title":"List the change history for a commitment","description":"Lists the historical changes made to a specific commitment, ordered by the most recent changes first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCommitmentHistoricalChanges","name":"List the change history for a commitment","isWebhook":false,"pointer":"/paths/~1commitments~1{commitmentKey}~1commitmentChanges/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the change history for a commitment","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":"Lists the historical changes made to a specific commitment, ordered by the most recent changes first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"Owner Transfer on Commitment accounts will transfer the associated subscription charges from source to destination account. If the destination account has commitments with matching charge filters, the charges get associated with the commitment in the destination account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-attribute pricing (MAP) charges are prorated based on overlapping days when the Billing Rule for Usage Drawdown Mode is By Day."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"commitmentKey","in":"path","schemaId":"schema_5","description":"The unique identifier (ID or number) of the commitment.","required":true}],"pointer":"/paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":"Page number for pagination.\n"},{"name":"pageSize","in":"query","schemaId":"schema_44","description":"Page size for commitment.\n"}],"pointer":"/paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commitments/{commitmentKey}/commitmentChanges","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"commitmentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/commitments/{commitmentKey}/commitmentChanges","href":"commitments/listcommitmenthistoricalchanges","openApiOperationId":"listCommitmentHistoricalChanges","summary":"List the change history for a commitment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCommitmentHistoricalChangesResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListCommitmentHistoricalChangesResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCommitmentHistoricalChangesResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCommitmentHistoricalChangesResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commitments/listcommitmenthistoricalchanges"}],"panels":[]}]},"httpPath":"/commitments/{commitmentKey}/commitmentChanges"}],"content":{"contentType":"group","meta":{"name":"Commitments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Commitments","showPageActions":true},{"nodeType":"markdoc","content":"A commitment represents a minimum or maximum spend amount a customer is obligated to pay within a spend period, compared with customer's actual fees incurred in connection with customer's accounts and their use of applicable products. \nThe Commitments API allows you to retrieve details of the commitments a customer has."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/commitments","summary":"List commitments for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commitments/getcommitments","deprecated":false},{"title":"/commitments/{commitmentKey}","summary":"Retrieve a commitment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commitments/getcommitmentbykey","deprecated":false},{"title":"/commitments/periods","summary":"List periods for a commitment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commitments/getcommitmentperiods","deprecated":false},{"title":"/commitments/{commitmentId}/balancepreview","summary":"Preview the balance for a commitment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commitments/getcommitmentbalancepreview","deprecated":false},{"title":"/commitments/{commitmentKey}/schedules","summary":"List schedules for a commitment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commitments/listcommitmentschedules","deprecated":false},{"title":"/prepayments/{prepaymentId}/expire","summary":"Expire a commitment-linked prepayment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/commitments/expireprepayment","deprecated":false},{"title":"/commitments/{commitmentKey}/commitmentChanges","summary":"List the change history for a commitment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/commitments/listcommitmenthistoricalchanges","deprecated":false}]}]}]}]}},{"type":"separator","label":"Advanced Consumption Billing","content":null},{"type":"group","label":"Prepaid with Drawdown","link":"/v1-api-reference/api/prepaid-with-drawdown","routeSlug":"/v1-api-reference/api/prepaid-with-drawdown","items":[{"label":"Reverse fund rollover","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/prepaid-with-drawdown/post_reverserollover","routeSlug":"/v1-api-reference/api/prepaid-with-drawdown/post_reverserollover","metadata":{"seo":{"title":"Reverse fund rollover","description":"This REST API reference describes how to manually reverse fund rollover from source validity period to destination validity period. There are no path or query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_ReverseRollover","name":"Reverse fund rollover","isWebhook":false,"pointer":"/paths/~1v1~1ppdd~1reverse-rollover/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverse fund rollover","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":"This REST API reference describes how to manually reverse fund rollover from source validity period to destination validity period. There are no path or query parameters."},"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 API will not work if the associated prepayment charge has rollover enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1ppdd~1reverse-rollover/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTReverseRolloverRequestType"}},"schemaId":"components/schemas/POSTReverseRolloverRequestType","pointer":"/paths/~1v1~1ppdd~1reverse-rollover/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/ppdd/reverse-rollover","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTReverseRolloverRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/ppdd/reverse-rollover","href":"prepaid-with-drawdown/post_reverserollover","openApiOperationId":"POST_ReverseRollover","summary":"Reverse fund rollover"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTReverseRolloverRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTReverseRolloverRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTReverseRolloverResponseType","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTReverseRolloverResponseType","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1ppdd~1reverse-rollover/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTReverseRolloverResponseType","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTReverseRolloverResponseType","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ppdd~1reverse-rollover/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prepaid-with-drawdown/post_reverserollover"}],"panels":[]}]},"httpPath":"/v1/ppdd/reverse-rollover"},{"label":"Trigger fund rollover","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/prepaid-with-drawdown/post_rollover","routeSlug":"/v1-api-reference/api/prepaid-with-drawdown/post_rollover","metadata":{"seo":{"title":"Trigger fund rollover","description":"Prepaid with Drawdown Rollover enables you to transfer the accumulative carryover of your customers’ prepaid balance funds to the following validity period when using Prepaid with Drawdown. This REST API reference describes how to manually trigger fund rollover from source validity period to destination validity period. There are no path or query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Rollover","name":"Trigger fund rollover","isWebhook":false,"pointer":"/paths/~1v1~1ppdd~1rollover/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger fund rollover","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":"Prepaid with Drawdown Rollover enables you to transfer the accumulative carryover of your customers’ prepaid balance funds to the following validity period when using Prepaid with Drawdown. This REST API reference describes how to manually trigger fund rollover from source validity period to destination validity period. There are no path or query parameters."},"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 API will not work if rollover is enabled in the associated prepayment charge. If you want to trigger rollover automatically, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/create-prepayment-charge-with-rollover","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create prepayment charge with rollover"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1ppdd~1rollover/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTTriggerRolloverRequestType"}},"schemaId":"components/schemas/POSTTriggerRolloverRequestType","pointer":"/paths/~1v1~1ppdd~1rollover/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/ppdd/rollover","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTTriggerRolloverRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/ppdd/rollover","href":"prepaid-with-drawdown/post_rollover","openApiOperationId":"POST_Rollover","summary":"Trigger fund rollover"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTTriggerRolloverRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTTriggerRolloverRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTTriggerRolloverResponseType","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTTriggerRolloverResponseType","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1ppdd~1rollover/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTTriggerRolloverResponseType","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTTriggerRolloverResponseType","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1ppdd~1rollover/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prepaid-with-drawdown/post_rollover"}],"panels":[]}]},"httpPath":"/v1/ppdd/rollover"},{"label":"Deplete funds","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/prepaid-with-drawdown/expireprepaidfunds","routeSlug":"/v1-api-reference/api/prepaid-with-drawdown/expireprepaidfunds","metadata":{"seo":{"title":"Deplete funds","description":"Depletes prepaid balance funds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"expirePrepaidFunds","name":"Deplete funds","isWebhook":false,"pointer":"/paths/~1v1~1prepaid-balance-funds~1deplete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deplete funds","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":"Depletes prepaid balance funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fund is depleted only when it exists, is not deleted, has a balance greater than zero,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and its source type is a prepayment fund: charge-based unit funds, upfront currency funds."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other funds in the request (for example in-arrears currency or non-prepayment sources) are not depleted;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"each appears in the response with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"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":"Supply exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteOptions"},"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":"code","inline":true,"attributes":{"content":"fundIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depletes each listed fund in full using the default accounting date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" selects funds through each entry's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and lets each entry specify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"its own accounting date and partial amount or quantity. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-empty,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it alone determines which funds are depleted; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single request cannot mix currency funds with unit or incentive funds."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Such a request is rejected in full."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If one fund fails, the remaining funds are still processed and the affected fund is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This applies to per-fund rejection before any depletion runs"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(unknown id, deleted, zero balance, non-prepayment, invalid partial amount or quantity, or invalid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"caller-supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteDate"},"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 request fails request-level validation (shape, batch limits, mixed depletable groups,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"blank or duplicate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on one entry,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or unrecognized body fields), no funds are depleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1prepaid-balance-funds~1deplete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTDepleteFundRequestType"}},"schemaId":"components/schemas/POSTDepleteFundRequestType","pointer":"/paths/~1v1~1prepaid-balance-funds~1deplete/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are accepted in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supply exactly one of them with at least one entry."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/prepaid-balance-funds/deplete","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTDepleteFundRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/prepaid-balance-funds/deplete","href":"prepaid-with-drawdown/expireprepaidfunds","openApiOperationId":"expirePrepaidFunds","summary":"Deplete funds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTDepleteFundRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTDepleteFundRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns per-fund results in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when depletion processing completes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field follows the common response pattern."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTDepleteFundResponseType","exampleIds":["paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTDepleteFundResponseType","exampleIds":["paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1prepaid-balance-funds~1deplete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTDepleteFundResponseType","exampleIds":["paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTDepleteFundResponseType","exampleIds":["paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prepaid-with-drawdown/expireprepaidfunds"}],"panels":[]}]},"httpPath":"/v1/prepaid-balance-funds/deplete"}],"content":{"contentType":"group","meta":{"name":"Prepaid with Drawdown"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prepaid with Drawdown","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":"The Prepaid with Drawdown feature is a pricing model for consumption-based services, such as data storage. Under this model, customers pay upfront to receive a number of units, usually for a period of time like a month or a year. Then they consume against that prepayment balance in a use-it-or-lose-it fashion, with a possibility of topping up more units or being charged for any overage. This model strikes a balance between upfront commitment and the pure pay-as-you-go pricing models. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/ppdd/reverse-rollover","summary":"Reverse fund rollover","prefix":{"name":"post","color":"post"},"badges":[],"link":"/prepaid-with-drawdown/post_reverserollover","deprecated":false},{"title":"/v1/ppdd/rollover","summary":"Trigger fund rollover","prefix":{"name":"post","color":"post"},"badges":[],"link":"/prepaid-with-drawdown/post_rollover","deprecated":false},{"title":"/v1/prepaid-balance-funds/deplete","summary":"Deplete funds","prefix":{"name":"post","color":"post"},"badges":[],"link":"/prepaid-with-drawdown/expireprepaidfunds","deprecated":false}]}]}]}]}},{"type":"separator","label":"Usage","content":null},{"type":"group","label":"Usage","link":"/v1-api-reference/api/usage","routeSlug":"/v1-api-reference/api/usage","items":[{"type":"link","label":"Note on dynamic pricing usage charges","link":"/v1-api-reference/api/usage/note-on-dynamic-pricing-usage-charges","routeSlug":"/v1-api-reference/api/usage/note-on-dynamic-pricing-usage-charges","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Note on dynamic pricing usage charges"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"usage/note-on-dynamic-pricing-usage-charges"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note on dynamic pricing usage charges"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy Billing Usage APIs (for example, \"Upload a usage file\" and the \"CRUD: Create/Update/Delete a   usage record\" operations) can support usage records that are associated with a dynamic pricing   usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about dynamic pricing for individual usage records, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/dynamic-pricing-for-individual-usage-records","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Upload a usage file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/post_usage","routeSlug":"/v1-api-reference/api/usage/post_usage","metadata":{"seo":{"title":"Upload a usage file","description":"This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. There are no path or query parameters. The data is uploaded using the HTTP multipart/form-data POST method and applied to the user's tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Usage","name":"Upload a usage file","isWebhook":false,"pointer":"/paths/~1v1~1usage/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a usage 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":"This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. There are no path or query parameters. The data is uploaded using the HTTP multipart/form-data POST method and applied to the user's tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"usage/post_usage/request/how-this-rest-api-call-works","deepLinkHash":"/usage/post_usage#usage/post_usage/request/how-this-rest-api-call-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How this REST API Call Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the uploaded usage file must follow the format used by the UI import tool. It must be a comma-separated (CSV) file with a corresponding .csv extension. The length of the file name must not exceed 50 characters. The file size must not exceed 4MB. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-download-usage-template"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Downloading the Usage Template"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to learn about how to download the usage file template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At the completion of the upload, before the file contents are actually being processed, the API returns a response containing the byte count of the received file and a URL for checking the status of the import process.  Of the five possible results displayed at that URL (Pending, Processing, Completed, Canceled, and Failed) only a Completed status indicates that the import was successful.  The operation is atomic; if any record fails, the file is rejected. In that case, the entire import is rolled back and all stored data is returned to its original state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the actual import status, enter the resulting status URL from the checkImportStatus response using a tool such as POSTMAN. This additional step provides more information about why the import has failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To manage the information after a successful upload, use the web-based UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"usage/post_usage/request/dynamic-pricing-usage-charges","deepLinkHash":"/usage/post_usage#usage/post_usage/request/dynamic-pricing-usage-charges"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic pricing usage charges"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the uploaded   file contains rows that reference a product rate plan charge configured for dynamic pricing,   the upload is rejected and those rows are not imported. Legacy Billing usage import does not   support sending usage to dynamic pricing usage charges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To send usage to a dynamic pricing   usage charge, use Mediation to ingest and rate the events. Mediation generates usage records   that are later consumed by Billing, instead of relying on this bulk upload endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"usage/post_usage/request/usage-file-format","deepLinkHash":"/usage/post_usage#usage/post_usage/request/usage-file-format"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage File Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The usage file uses the following headings:"},"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":"Heading"},"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":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"ACCOUNT_ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the account number, e.g., the default account number, such as A00000001, or your custom account number. Although this field is labeled as Account_Id, it is not the actual Account ID nor Account Name."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"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":"UOM"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the unit of measure. This must match the UOM for the usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"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":"QTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the quantity."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"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":"STARTDATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the start date of the usage. This date determines the invoice item service period the associated usage is billed to. Date format is based on locale of the current user. Default date format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM/DD/YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"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":"ENDDATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the end date of the usage. This is not used in calculations for usage billing and is optional. Date format is based on locale of the current user. Default date format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM/DD/YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"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 value of this column is optional, but the column header is required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"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":"PRODUCT_RATE_PLAN_CHARGE_ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter a product rate plan charge number so that you can charge your customer with a dynamic usage charge for the corresponding uploaded usage record. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"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 value of this column is optional, but the column header is required. To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"146"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"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":"SUBSCRIPTION_ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the subscription number or subscription name. If you created the subscription in the Zuora application, Zuora created a number automatically in a format similar to A-S00000001. If you do not provide a value for this field, the associated usage will be added to all subscriptions for the specified Account that use this Unit Of Measure. If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the Subscription or Charge ID in each usage record.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"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 value of this column is optional, but the column header is required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"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":"CHARGE_ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the charge number (not the charge name). You can see the charge ID, e.g., C-00000001, when you add your rate plan to your subscription and view your individual charges. If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the specific Subscription or Charge ID in each usage record. This field is related to the Charge Number on the subscription rate plan.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"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 value of this column is optional, but the column header is required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"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":"DESCRIPTION"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter a description for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"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":"UNIQUE_KEY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter a specific identifier for this usage record. "},"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 Heading is supported by the following features: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload usage record with unique key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1usage/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_45"}},"schemaId":"schema_45","pointer":"/paths/~1v1~1usage/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/usage","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_45"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/usage","href":"usage/post_usage","openApiOperationId":"POST_Usage","summary":"Upload a usage file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_45","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_45"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTUsageResponseType","exampleIds":["paths/~1v1~1usage/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTUsageResponseType","exampleIds":["paths/~1v1~1usage/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1usage/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1usage/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1usage/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1usage/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1usage/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTUsageResponseType","exampleIds":["paths/~1v1~1usage/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTUsageResponseType","exampleIds":["paths/~1v1~1usage/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1usage/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1usage/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1usage/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1usage/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/post_usage"}],"panels":[]}]},"httpPath":"/v1/usage"},{"label":"Retrieve usage rate detail for an invoice item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/get_usage_rate_detail_by_invoice_item","routeSlug":"/v1-api-reference/api/usage/get_usage_rate_detail_by_invoice_item","metadata":{"seo":{"title":"Retrieve usage rate detail for an invoice item","description":"Use this REST API operation to retrieve the usage rate detail for an invoice item to understand how the total amount is calculated. The information is the same as the Rate Detail presented on PDF invoices."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Usage_Rate_Detail_By_Invoice_Item","name":"Retrieve usage rate detail for an invoice item","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve usage rate detail for an invoice item","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":"Use this REST API operation to retrieve the usage rate detail for an invoice item to understand how the total amount is calculated. The information is the same as the Rate Detail presented on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-display-usage-charge-breakdown"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF invoices"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes and limitations:"},"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":"Do not support the Overage Charge Model, Tiered with Overage Charge Model, and Multi-attribute Pricing Charge Model."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not support invoices in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reversed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not support Active rating."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In terms of rating group options, only the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-usage-rating-by-billing-period"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage rating by billing period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not support "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-on-demand-usage-rating"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On-demand usage rating"},"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":"Tax calculation is not involved."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoice-item-id","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice item ID. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402880e57f725d85017f7267c4ad002b"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Available through Data Source export."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoice-item-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail","href":"usage/get_usage_rate_detail_by_invoice_item","openApiOperationId":"GET_Usage_Rate_Detail_By_Invoice_Item","summary":"Retrieve usage rate detail for an invoice item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETUsageRateDetailWrapper","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETUsageRateDetailWrapper","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETUsageRateDetailWrapper","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETUsageRateDetailWrapper","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/get_usage_rate_detail_by_invoice_item"}],"panels":[]}]},"httpPath":"/v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail"},{"label":"CRUD: Create a usage record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/object_postusage","routeSlug":"/v1-api-reference/api/usage/object_postusage","metadata":{"seo":{"title":"CRUD: Create a usage record","description":"Creates a usage record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_POSTUsage","name":"CRUD: Create a usage record","isWebhook":false,"pointer":"/paths/~1v1~1object~1usage/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: 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 record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1usage/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1usage/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyCreateUsage"}},"schemaId":"components/schemas/ProxyCreateUsage","pointer":"/paths/~1v1~1object~1usage/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/object/usage","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyCreateUsage"}},"responseCodes":["200","400","401"],"pointer":"/v1/object/usage","href":"usage/object_postusage","openApiOperationId":"Object_POSTUsage","summary":"CRUD: Create a usage record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyCreateUsage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyCreateUsage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1usage/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/object_postusage"}],"panels":[]}]},"httpPath":"/v1/object/usage"},{"label":"CRUD: Delete a usage record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/object_deleteusage","routeSlug":"/v1-api-reference/api/usage/object_deleteusage","metadata":{"seo":{"title":"CRUD: Delete a usage record","description":"Deletes a usage record. Usage records that are associated with a dynamic pricing usage charge cannot be deleted with this legacy Billing endpoint. When a delete request targets such a record, the operation fails and the usage record is not removed. Operations on dynamic pricing usage are supported only via Mediation-driven flows."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_DELETEUsage","name":"CRUD: Delete a usage record","isWebhook":false,"pointer":"/paths/~1v1~1object~1usage~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: 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. Usage records that are associated with a dynamic pricing usage charge cannot be deleted with this legacy Billing endpoint. When a delete request targets such a record, the operation fails and the usage record is not removed. Operations on dynamic pricing usage are supported only via Mediation-driven flows."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1usage~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1usage~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/object/usage/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v1/object/usage/{id}","href":"usage/object_deleteusage","openApiOperationId":"Object_DELETEUsage","summary":"CRUD: Delete a usage record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyDeleteResponse"}},"schemaId":"components/schemas/ProxyDeleteResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/delete/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/delete/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1usage~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyDeleteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyDeleteResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/delete/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/delete/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/object_deleteusage"}],"panels":[]}]},"httpPath":"/v1/object/usage/{id}"},{"label":"CRUD: Retrieve a usage record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/object_getusage","routeSlug":"/v1-api-reference/api/usage/object_getusage","metadata":{"seo":{"title":"CRUD: Retrieve a usage record","description":"Retrieve a usage record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_GETUsage","name":"CRUD: Retrieve a usage record","isWebhook":false,"pointer":"/paths/~1v1~1object~1usage~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: 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":"Retrieve a usage record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1usage~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_5","description":"Object fields to return"}],"pointer":"/paths/~1v1~1object~1usage~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1usage~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/object/usage/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v1/object/usage/{id}","href":"usage/object_getusage","openApiOperationId":"Object_GETUsage","summary":"CRUD: Retrieve a usage record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetUsage","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyGetUsage","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1object~1usage~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyGetUsage","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetUsage","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/object_getusage"}],"panels":[]}]},"httpPath":"/v1/object/usage/{id}"},{"label":"CRUD: Update a usage record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/usage/object_putusage","routeSlug":"/v1-api-reference/api/usage/object_putusage","metadata":{"seo":{"title":"CRUD: Update a usage record","description":"Updates a usage record. Updating usage records that are associated with a dynamic pricing usage charge is not supported through this endpoint. The request fails and the record is not updated. Use Mediation-based flows to manage such usage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_PUTUsage","name":"CRUD: Update a usage record","isWebhook":false,"pointer":"/paths/~1v1~1object~1usage~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Update a usage record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a usage record. Updating usage records that are associated with a dynamic pricing usage charge is not supported through this endpoint. The request fails and the record is not updated. Use Mediation-based flows to manage such usage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1usage~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1usage~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1usage~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/ProxyModifyUsage"}},"schemaId":"components/schemas/ProxyModifyUsage","pointer":"/paths/~1v1~1object~1usage~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/object/usage/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyModifyUsage"}},"responseCodes":["200","401"],"pointer":"/v1/object/usage/{id}","href":"usage/object_putusage","openApiOperationId":"Object_PUTUsage","summary":"CRUD: Update a usage record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyModifyUsage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyModifyUsage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/put/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/put/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1usage~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/put/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1usage~1{id}/put/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/object_putusage"}],"panels":[]}]},"httpPath":"/v1/object/usage/{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":"Consumption of a billable service or resource (such as database storage space or bundles of emails sent) provides the basis for some charge models - simple usage, tiered pricing, or volume pricing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To make this work, usage must be tracked in the system and usage charges must be calculated and invoiced."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage is always billed in arrears - for example, you might bill customers in February for their January usage. Usage can be billed on a recurring monthly, quarterly, semi-annual, or annual basis."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/usage","summary":"Upload a usage file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/usage/post_usage","deprecated":false},{"title":"/v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail","summary":"Retrieve usage rate detail for an invoice item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/usage/get_usage_rate_detail_by_invoice_item","deprecated":false},{"title":"/v1/object/usage","summary":"CRUD: Create a usage record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/usage/object_postusage","deprecated":false},{"title":"/v1/object/usage/{id}","summary":"CRUD: Delete a usage record","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/usage/object_deleteusage","deprecated":false},{"title":"/v1/object/usage/{id}","summary":"CRUD: Retrieve a usage record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/usage/object_getusage","deprecated":false},{"title":"/v1/object/usage/{id}","summary":"CRUD: Update a usage record","prefix":{"name":"put","color":"put"},"badges":[],"link":"/usage/object_putusage","deprecated":false}]}]}]}]}},{"type":"separator","label":"Mediation","content":null},{"type":"group","label":"Meters","link":"/v1-api-reference/api/meters","routeSlug":"/v1-api-reference/api/meters","items":[{"label":"Run a specific version of a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/runspecificversionofmeter","routeSlug":"/v1-api-reference/api/meters/runspecificversionofmeter","metadata":{"seo":{"title":"Run a specific version of a meter","description":"Executes a specific version of a meter in Zuora Mediation. You can choose to run it with either a local file or event store source by providing optional configurations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runSpecificVersionOfMeter","name":"Run a specific version of a meter","isWebhook":false,"pointer":"/paths/~1meters~1run~1{meterId}~1{version}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run a specific version of a meter","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":"Executes a specific version of a meter in Zuora Mediation. You can choose to run it with either a local file or event store source by providing optional configurations."},"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 on long-running meters and timeouts:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For large meters with many operators, this API call might take longer to return and, in some cases, can time out even though the meter run has been successfully triggered."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To safely handle this, provide a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the operation times out, retry the same request with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueKey"},"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 original run already exists, the API returns a 400 error indicating a duplicate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of creating a new run."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterId","in":"path","schemaId":"schema_5","description":"The ID of the meter to run. You can find this ID in the Zuora Mediation UI URL when viewing a meter.","required":true},{"name":"version","in":"path","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the meter to run. Currently, the only supported value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all meters. Always pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this path parameter."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1meters~1run~1{meterId}~1{version}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1run~1{meterId}~1{version}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RunMeterVersionRequest"}},"schemaId":"components/schemas/RunMeterVersionRequest","pointer":"/paths/~1meters~1run~1{meterId}~1{version}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/meters/run/{meterId}/{version}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterId","in":"path","required":true,"schemaId":"schema_5"},{"name":"version","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RunMeterVersionRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/meters/run/{meterId}/{version}","href":"meters/runspecificversionofmeter","openApiOperationId":"runSpecificVersionOfMeter","summary":"Run a specific version of a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/RunMeterVersionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RunMeterVersionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful meter run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RunMeterVersionResponse","exampleIds":["paths/~1meters~1run~1{meterId}~1{version}/post/responses/200/content/application~1json/examples/success"]}},"schemaId":"components/schemas/RunMeterVersionResponse","exampleIds":["paths/~1meters~1run~1{meterId}~1{version}/post/responses/200/content/application~1json/examples/success"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1run~1{meterId}~1{version}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RunMeterVersionResponse","exampleIds":["paths/~1meters~1run~1{meterId}~1{version}/post/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RunMeterVersionResponse","exampleIds":["paths/~1meters~1run~1{meterId}~1{version}/post/responses/200/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meters/runspecificversionofmeter"}],"panels":[]}]},"httpPath":"/meters/run/{meterId}/{version}"},{"label":"Stop a specific version of a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/stopmeterversion","routeSlug":"/v1-api-reference/api/meters/stopmeterversion","metadata":{"seo":{"title":"Stop a specific version of a meter","description":"Stops all runnable NORMAL-mode runs for a specific version of a meter in Zuora Mediation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stopMeterVersion","name":"Stop a specific version of a meter","isWebhook":false,"pointer":"/paths/~1meters~1stop~1{meterId}~1{version}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop a specific version of a meter","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 all runnable NORMAL-mode runs for a specific version of a meter in Zuora Mediation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the API gracefully stops streaming meters by creating a savepoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Streaming stops are asynchronous. A successful response means that the stop request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was accepted and triggered; the meter version might temporarily remain in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOPPING state before transitioning to PAUSED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For batch meters and DEBUG runs, the job is canceled synchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The caller must have at least one of the following permissions:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RunMeters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConfigureMetersAndEvents"},"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":"Force Stop is not supported when a run is already in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STOPPING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STOPPING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a temporary transition state while the system processes a graceful stop."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In most cases, the run quickly either returns to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RUNNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the graceful stop cannot be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed, or moves to its final terminal state. If Force Stop is required, retry the operation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after the run exits the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STOPPING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterId","in":"path","schemaId":"schema_49","description":"The numeric ID of the meter to stop.","required":true},{"name":"version","in":"path","schemaId":"schema_5","description":"The meter version to stop.","required":true,"example":"0.0.1"}],"pointer":"/paths/~1meters~1stop~1{meterId}~1{version}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"forceStop","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls whether the meter is stopped gracefully or forcefully."},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted, the API performs a graceful stop. For streaming"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meters, it creates a savepoint before stopping the job."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the API immediately cancels the job without creating a savepoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This might result in the loss of in-flight data, and the meter cannot resume"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from its previous state unless a valid recent savepoint exists for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"corresponding meter."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1stop~1{meterId}~1{version}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No request body is required. If specified, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1stop~1{meterId}~1{version}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/meters/stop/{meterId}/{version}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterId","in":"path","required":true,"schemaId":"schema_49"},{"name":"version","in":"path","required":true,"example":"0.0.1","schemaId":"schema_5"}],"query":[{"name":"forceStop","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":false,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/meters/stop/{meterId}/{version}","href":"meters/stopmeterversion","openApiOperationId":"stopMeterVersion","summary":"Stop a specific version of a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Meter stop request accepted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationStopMeterResponse","exampleIds":["paths/~1meters~1stop~1{meterId}~1{version}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/MediationStopMeterResponse","exampleIds":["paths/~1meters~1stop~1{meterId}~1{version}/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. The response error code can indicate one of the following conditions:"},"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":"70002103"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Meter does not exist."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"70002104"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Meter version does not exist."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"70003043"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A stop is already in progress for this meter version."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"70002122"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The meter version is not running."},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationStopMeterResponse","exampleIds":["paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/meterNotFound","paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/versionNotFound"]}},"schemaId":"components/schemas/MediationStopMeterResponse","exampleIds":["paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/meterNotFound","paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/versionNotFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1stop~1{meterId}~1{version}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MediationStopMeterResponse","exampleIds":["paths/~1meters~1stop~1{meterId}~1{version}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationStopMeterResponse","exampleIds":["paths/~1meters~1stop~1{meterId}~1{version}/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/MediationStopMeterResponse","exampleIds":["paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/meterNotFound","paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/versionNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationStopMeterResponse","exampleIds":["paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/meterNotFound","paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/versionNotFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meters/stopmeterversion"}],"panels":[]}]},"httpPath":"/meters/stop/{meterId}/{version}"},{"label":"Test a specific version of a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/testspecificversionofmeter","routeSlug":"/v1-api-reference/api/meters/testspecificversionofmeter","metadata":{"seo":{"title":"Test a specific version of a meter","description":"Test a specific version of a meter in Zuora Mediation without executing a full run. It supports multiple input methods, including uploaded files, sample files, and manual test data. This is useful for validating meter logic and transformations before meter run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"testSpecificVersionOfMeter","name":"Test a specific version of a meter","isWebhook":false,"pointer":"/paths/~1meters~1debug~1{meterId}~1{version}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test a specific version of a meter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Test a specific version of a meter in Zuora Mediation without executing a full run. It supports multiple input methods, including uploaded files, sample files, and manual test data. This is useful for validating meter logic and transformations before meter run."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterId","in":"path","schemaId":"schema_50","description":"The ID of the meter to be tested.","required":true},{"name":"version","in":"path","schemaId":"schema_5","description":"The version of the meter to be tested.","required":true}],"pointer":"/paths/~1meters~1debug~1{meterId}~1{version}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1debug~1{meterId}~1{version}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestSpecificMeterRequest"}},"schemaId":"components/schemas/TestSpecificMeterRequest","pointer":"/paths/~1meters~1debug~1{meterId}~1{version}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/meters/debug/{meterId}/{version}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterId","in":"path","required":true,"schemaId":"schema_50"},{"name":"version","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TestSpecificMeterRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/meters/debug/{meterId}/{version}","href":"meters/testspecificversionofmeter","openApiOperationId":"testSpecificVersionOfMeter","summary":"Test a specific version of a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/TestSpecificMeterRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestSpecificMeterRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully tested meter version.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestSpecificMeterResponse"}},"schemaId":"components/schemas/TestSpecificMeterResponse"},{"code":"400","description":"Bad Request - Invalid or missing parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"401","description":"Unauthorized - Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}},"schemaId":"components/schemas/MediationErrorResponse"},{"code":"500","description":"Internal Server Error - Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1debug~1{meterId}~1{version}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestSpecificMeterResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestSpecificMeterResponse"}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/MediationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meters/testspecificversionofmeter"}],"panels":[]}]},"httpPath":"/meters/debug/{meterId}/{version}"},{"label":"Retrieve summary data for a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/retrievemetersummarydata","routeSlug":"/v1-api-reference/api/meters/retrievemetersummarydata","metadata":{"seo":{"title":"Retrieve summary data for a meter","description":"Retrieves summary data for a specific meter in Zuora Mediation, providing a rolled-up view of a meter run or time window. The API supports grouping by Operator ID, Error Code, or Session ID, and allows optional filters such as Query From Time, Query To Time, Operator IDs, and Session IDs. The API returns aggregated output and error counts per group and includes validation with detailed error responses for invalid parameters or formats."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveMeterSummaryData","name":"Retrieve summary data for a meter","isWebhook":false,"pointer":"/paths/~1meters~1{meterId}~1summary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve summary data for a meter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves summary data for a specific meter in Zuora Mediation, providing a rolled-up view of a meter run or time window. The API supports grouping by Operator ID, Error Code, or Session ID, and allows optional filters such as Query From Time, Query To Time, Operator IDs, and Session IDs. The API returns aggregated output and error counts per group and includes validation with detailed error responses for invalid parameters or formats."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterId","in":"path","schemaId":"schema_49","description":"The ID of the meter.","required":true}],"pointer":"/paths/~1meters~1{meterId}~1summary/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1{meterId}~1summary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSpecificMeterSummaryRequest"}},"schemaId":"components/schemas/CreateSpecificMeterSummaryRequest","pointer":"/paths/~1meters~1{meterId}~1summary/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/meters/{meterId}/summary","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterId","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSpecificMeterSummaryRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/meters/{meterId}/summary","href":"meters/retrievemetersummarydata","openApiOperationId":"retrieveMeterSummaryData","summary":"Retrieve summary data for a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateSpecificMeterSummaryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSpecificMeterSummaryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateSpecificMeterSummaryResponse","exampleIds":["paths/~1meters~1{meterId}~1summary/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreateSpecificMeterSummaryResponse","exampleIds":["paths/~1meters~1{meterId}~1summary/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request - Invalid or missing parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"401","description":"Unauthorized - Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}},"schemaId":"components/schemas/MediationErrorResponse"},{"code":"500","description":"Internal Server Error - Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1{meterId}~1summary/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateSpecificMeterSummaryResponse","exampleIds":["paths/~1meters~1{meterId}~1summary/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateSpecificMeterSummaryResponse","exampleIds":["paths/~1meters~1{meterId}~1summary/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/MediationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meters/retrievemetersummarydata"}],"panels":[]}]},"httpPath":"/meters/{meterId}/summary"},{"label":"Retrieve the run status of a specific meter version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/getrunstatusofspecificmeterversion","routeSlug":"/v1-api-reference/api/meters/getrunstatusofspecificmeterversion","metadata":{"seo":{"title":"Retrieve the run status of a specific meter version","description":"Retrieves the current run status of a specific meter version in Zuora Mediation. It returns an integer code indicating the status, such as RUNNING, COMPLETED, or FAILED, which helps monitor the meter's execution state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRunStatusOfSpecificMeterVersion","name":"Retrieve the run status of a specific meter version","isWebhook":false,"pointer":"/paths/~1meters~1{meterId}~1{version}~1runStatus/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the run status of a specific meter version","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 the current run status of a specific meter version in Zuora Mediation. It returns an integer code indicating the status, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RUNNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which helps monitor the meter's execution state."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterId","in":"path","schemaId":"schema_50","description":"ID of the meter.","required":true},{"name":"version","in":"path","schemaId":"schema_5","description":"Version of the meter.","required":true}],"pointer":"/paths/~1meters~1{meterId}~1{version}~1runStatus/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1{meterId}~1{version}~1runStatus/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/meters/{meterId}/{version}/runStatus","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterId","in":"path","required":true,"schemaId":"schema_50"},{"name":"version","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/meters/{meterId}/{version}/runStatus","href":"meters/getrunstatusofspecificmeterversion","openApiOperationId":"getRunStatusOfSpecificMeterVersion","summary":"Retrieve the run status of a specific meter version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with run status data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RunStatusResponse"}},"schemaId":"components/schemas/RunStatusResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"404","description":"Meter not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}},"schemaId":"components/schemas/MediationErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1{meterId}~1{version}~1runStatus/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RunStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RunStatusResponse"}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"404","schemaId":"components/schemas/MediationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meters/getrunstatusofspecificmeterversion"}],"panels":[]}]},"httpPath":"/meters/{meterId}/{version}/runStatus"},{"label":"Export details of a specific meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/exportspecificmeter","routeSlug":"/v1-api-reference/api/meters/exportspecificmeter","metadata":{"seo":{"title":"Export details of a specific meter","description":"The Export Meter operation exports the full definition of a specific meter in Zuora Mediation, including metadata, all versions, event schemas, and operator configurations (source, processor, sink). It's useful for reviewing, backing up, or replicating meter setups across environments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportSpecificMeter","name":"Export details of a specific meter","isWebhook":false,"pointer":"/paths/~1meters~1export~1{meterId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export details of a specific meter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Export Meter operation exports the full definition of a specific meter in Zuora Mediation, including metadata, all versions, event schemas, and operator configurations (source, processor, sink). It's useful for reviewing, backing up, or replicating meter setups across environments.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterId","in":"path","schemaId":"schema_5","description":"ID of the meter to export.","required":true}],"pointer":"/paths/~1meters~1export~1{meterId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1export~1{meterId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/meters/export/{meterId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/meters/export/{meterId}","href":"meters/exportspecificmeter","openApiOperationId":"exportSpecificMeter","summary":"Export details of a specific meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with meter export data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportMeterResponse"}},"schemaId":"components/schemas/ExportMeterResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"404","description":"Meter not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}},"schemaId":"components/schemas/MediationErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1export~1{meterId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExportMeterResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportMeterResponse"}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"404","schemaId":"components/schemas/MediationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meters/exportspecificmeter"}],"panels":[]}]},"httpPath":"/meters/export/{meterId}"},{"label":"Import a meter definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/meters/importmeterdefinition","routeSlug":"/v1-api-reference/api/meters/importmeterdefinition","metadata":{"seo":{"title":"Import a meter definition","description":"Import a meter definition into Zuora Mediation using a file exported from the Export Meter API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importMeterDefinition","name":"Import a meter definition","isWebhook":false,"pointer":"/paths/~1meters~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import a meter definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Import a meter definition into Zuora Mediation using a file exported from the Export Meter API.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_51","description":"Content type for the request body.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ImportMeterRequest"}},"schemaId":"components/schemas/ImportMeterRequest","pointer":"/paths/~1meters~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/meters/import","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"example":"multipart/form-data","schemaId":"schema_51"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/ImportMeterRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/meters/import","href":"meters/importmeterdefinition","openApiOperationId":"importMeterDefinition","summary":"Import a meter definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ImportMeterRequest","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ImportMeterRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful import of meter definition","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportMeterResponse"}},"schemaId":"components/schemas/ImportMeterResponse"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"401","description":"Unauthorized access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}},"schemaId":"components/schemas/MediationErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1import/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportMeterResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportMeterResponse"}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/MediationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meters/importmeterdefinition"}],"panels":[]}]},"httpPath":"/meters/import"}],"content":{"contentType":"group","meta":{"name":"Meters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Meters","showPageActions":true},{"nodeType":"markdoc","content":"The Zuora Mediation APIs provide a comprehensive set of endpoints to manage, test, run, and monitor usage meters, including execution, status checks, and run-level summaries."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/meters/run/{meterId}/{version}","summary":"Run a specific version of a meter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/meters/runspecificversionofmeter","deprecated":false},{"title":"/meters/stop/{meterId}/{version}","summary":"Stop a specific version of a meter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/meters/stopmeterversion","deprecated":false},{"title":"/meters/debug/{meterId}/{version}","summary":"Test a specific version of a meter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/meters/testspecificversionofmeter","deprecated":false},{"title":"/meters/{meterId}/summary","summary":"Retrieve summary data for a meter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/meters/retrievemetersummarydata","deprecated":false},{"title":"/meters/{meterId}/{version}/runStatus","summary":"Retrieve the run status of a specific meter version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meters/getrunstatusofspecificmeterversion","deprecated":false},{"title":"/meters/export/{meterId}","summary":"Export details of a specific meter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meters/exportspecificmeter","deprecated":false},{"title":"/meters/import","summary":"Import a meter definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/meters/importmeterdefinition","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Ingestion","link":"/v1-api-reference/api/data-ingestion","routeSlug":"/v1-api-reference/api/data-ingestion","items":[{"label":"Upload a file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-ingestion/uploadmeteringfile","routeSlug":"/v1-api-reference/api/data-ingestion/uploadmeteringfile","metadata":{"seo":{"title":"Upload a file","description":"Uploads and stores a file in Zuora Mediation for use in meter processing. Supported formats include CSV, Excel, and JSON. You can specify metadata like headers, delimiters, sheets, and data ranges."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadMeteringFile","name":"Upload a file","isWebhook":false,"pointer":"/paths/~1meters~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Uploads and stores a file in Zuora Mediation for use in meter processing. Supported formats include CSV, Excel, and JSON. You can specify metadata like headers,\n delimiters, sheets, and data ranges.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_52"}},"schemaId":"schema_52","pointer":"/paths/~1meters~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/meters/files","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_52"}},"responseCodes":["200","400","401","500"],"pointer":"/meters/files","href":"data-ingestion/uploadmeteringfile","openApiOperationId":"uploadMeteringFile","summary":"Upload a file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_52","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_52"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File successfully uploaded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateFileResponse"}},"schemaId":"components/schemas/CreateFileResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}},"schemaId":"components/schemas/ProxyUnauthorizedResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateFileResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateFileResponse"}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-ingestion/uploadmeteringfile"}],"panels":[]}]},"httpPath":"/meters/files"},{"label":"Ingest usage events for a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-ingestion/ingestusageevents","routeSlug":"/v1-api-reference/api/data-ingestion/ingestusageevents","metadata":{"seo":{"title":"Ingest usage events for a meter","description":"Ingests usage events directly into Zuora Mediation in real time. You can send a single event or batch multiple events in a JSON array to optimize throughput. Each event must conform to the meter's event schema. This operation is supported only for meters that use the Streaming API as their source in Zuora Mediation. You can use this API to bulk-ingest events into a meter only when the meter's source is configured as a Streaming API operator. For meters that use other sources, use the appropriate ingestion mechanism for that source instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ingestUsageEvents","name":"Ingest usage events for a meter","isWebhook":false,"pointer":"/paths/~1usage~1bulk~1{meterGlobalId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ingest usage events for a meter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Ingests usage events directly into Zuora Mediation in real time. You can send a single event or batch multiple events in a JSON array to optimize throughput. Each event must conform to the meter's event schema. This operation is supported only for meters that use the Streaming API as their source in Zuora Mediation. You can use this API to bulk-ingest events into a meter only when the meter's source is configured as a Streaming API operator. For meters that use other sources, use the appropriate ingestion mechanism for that source instead.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterGlobalId","in":"path","schemaId":"schema_5","description":"The global ID of the meter.","required":true}],"pointer":"/paths/~1usage~1bulk~1{meterGlobalId}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1usage~1bulk~1{meterGlobalId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_53"}},"schemaId":"schema_53","pointer":"/paths/~1usage~1bulk~1{meterGlobalId}/post/requestBody","description":"A JSON object or an array of objects representing usage events. Each event must conform to the event schema defined in your meter."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/usage/bulk/{meterGlobalId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterGlobalId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_53"}},"responseCodes":["200","400","401","404","413","429","500"],"pointer":"/usage/bulk/{meterGlobalId}","href":"data-ingestion/ingestusageevents","openApiOperationId":"ingestUsageEvents","summary":"Ingest usage events for a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_53","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_53"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Usage event(s) ingested successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StreamingIngestionSuccessResponse"}},"schemaId":"components/schemas/StreamingIngestionSuccessResponse"},{"code":"400","description":"Bad request due to validation or business logic errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"401","description":"Unauthorized request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StreamingIngestionAuthError"}},"schemaId":"components/schemas/StreamingIngestionAuthError"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StreamingIngestionAuthError"}},"schemaId":"components/schemas/StreamingIngestionAuthError"},{"code":"413","description":"Payload too large.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StreamingIngestionAuthError"}},"schemaId":"components/schemas/StreamingIngestionAuthError"},{"code":"429","description":"Too many requests.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StreamingIngestionAuthError"}},"schemaId":"components/schemas/StreamingIngestionAuthError"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1usage~1bulk~1{meterGlobalId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StreamingIngestionSuccessResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StreamingIngestionSuccessResponse"}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/StreamingIngestionAuthError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StreamingIngestionAuthError"}}},{"code":"404","schemaId":"components/schemas/StreamingIngestionAuthError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StreamingIngestionAuthError"}}},{"code":"413","schemaId":"components/schemas/StreamingIngestionAuthError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StreamingIngestionAuthError"}}},{"code":"429","schemaId":"components/schemas/StreamingIngestionAuthError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StreamingIngestionAuthError"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-ingestion/ingestusageevents"}],"panels":[]}]},"httpPath":"/usage/bulk/{meterGlobalId}"}],"content":{"contentType":"group","meta":{"name":"Data Ingestion"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Ingestion","showPageActions":true},{"nodeType":"markdoc","content":"Use these APIs to upload source files for meters and to ingest usage events directly into Zuora Mediation in real time via streaming."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/meters/files","summary":"Upload a file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-ingestion/uploadmeteringfile","deprecated":false},{"title":"/usage/bulk/{meterGlobalId}","summary":"Ingest usage events for a meter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-ingestion/ingestusageevents","deprecated":false}]}]}]}]}},{"type":"group","label":"Audit Trail","link":"/v1-api-reference/api/audit-trail","routeSlug":"/v1-api-reference/api/audit-trail","items":[{"label":"Retrieve the audit trail entries for a meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-trail/getaudittrailentriesformeter","routeSlug":"/v1-api-reference/api/audit-trail/getaudittrailentriesformeter","metadata":{"seo":{"title":"Retrieve the audit trail entries for a meter","description":"Retrieves the audit trail entries for a specific meter in Zuora Mediation. The API provides detailed, record-level information about what happened during processing, including Payload and error details, operator information, and the trace ID/event ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditTrailEntriesForMeter","name":"Retrieve the audit trail entries for a meter","isWebhook":false,"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1entries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the audit trail entries for a meter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the audit trail entries for a specific meter in Zuora Mediation. The API provides detailed, record-level information about what happened during processing, including Payload and error details, operator information, and the trace ID/event ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterId","in":"path","schemaId":"schema_49","description":"ID of the meter.","required":true}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1entries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exportType","in":"query","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the export. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAMPLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an export of success records, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an export of error records."},"children":[]}]}]}],"required":true},{"name":"runType","in":"query","schemaId":"schema_55","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 run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEBUG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a test run, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NORMAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a live run."},"children":[]}]}]}],"required":true},{"name":"sessionId","in":"query","schemaId":"schema_5","description":"A specific session ID.\n","example":"R-000001"},{"name":"queryFromTime","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum timestamp of the audit trail data. The value must be an ISO 8601 timestamp with a numeric timezone offset in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SS±HHMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For UTC, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2025-07-18T00:00:00+0000"},{"name":"queryToTime","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum timestamp of the audit trail data. The value must be an ISO 8601 timestamp with a numeric timezone offset in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SS±HHMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For UTC, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2025-07-18T00:00:00+0000"},{"name":"operatorId","in":"query","schemaId":"schema_5","description":"The ID of the operator. The Operator ID is displayed for each operator node, for both current meters and historic runs. On the Mediation UI, click on a test ID or session ID to see the details of the run.\n"},{"name":"pageSize","in":"query","schemaId":"schema_56","description":"Page size for pagination.\n"},{"name":"cursor","in":"query","schemaId":"schema_5","description":"nextPage token from previous response.\n","example":"W3sib3JkZXJ="}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1entries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1entries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/meters/{meterId}/auditTrail/entries","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterId","in":"path","required":true,"schemaId":"schema_49"}],"query":[{"name":"exportType","in":"query","required":true,"schemaId":"schema_54"},{"name":"runType","in":"query","required":true,"schemaId":"schema_55"},{"name":"sessionId","in":"query","required":false,"example":"R-000001","schemaId":"schema_5"},{"name":"queryFromTime","in":"query","required":true,"example":"2025-07-18T00:00:00+0000","schemaId":"schema_5"},{"name":"queryToTime","in":"query","required":true,"example":"2025-07-18T00:00:00+0000","schemaId":"schema_5"},{"name":"operatorId","in":"query","required":false,"schemaId":"schema_5"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_56"},{"name":"cursor","in":"query","required":false,"example":"W3sib3JkZXJ=","schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/meters/{meterId}/auditTrail/entries","href":"audit-trail/getaudittrailentriesformeter","openApiOperationId":"getAuditTrailEntriesForMeter","summary":"Retrieve the audit trail entries for a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAuditTrailResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1entries/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetAuditTrailResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1entries/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1entries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAuditTrailResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1entries/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAuditTrailResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1entries/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-trail/getaudittrailentriesformeter"}],"panels":[]}]},"httpPath":"/meters/{meterId}/auditTrail/entries"},{"label":"Retrieve the list of export jobs for a meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-trail/getaudittrailexportjobs","routeSlug":"/v1-api-reference/api/audit-trail/getaudittrailexportjobs","metadata":{"seo":{"title":"Retrieve the list of export jobs for a meter","description":"Retrieves the list of previously initiated export jobs for a specific meter in Zuora Mediation.You can filter the results by export type, session IDs, or request ID by using the exportType,sessionIds, and requestId query parameters. Use the requestId returned when you create an exportjob to retrieve a specific job. If requestId is omitted, the API returns the list of export jobs.Use the status and fileList fields to determine whether a job is complete and which files to download.Then use the \"Retrieve the presigned URL for an export job\" operation with each fileKey in fileListto obtain the download URLs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditTrailExportJobs","name":"Retrieve the list of export jobs for a meter","isWebhook":false,"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the list of export jobs for a meter","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 the list of previously initiated export jobs for a specific meter in Zuora Mediation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can filter the results by export type, session IDs, or request ID by using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportType"},"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":"sessionIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned when you create an export"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"job to retrieve a specific job. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted, the API returns the list of export jobs."},"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":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to determine whether a job is complete and which files to download."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Then use the \"Retrieve the presigned URL for an export job\" operation with each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileList"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to obtain the download URLs."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterId","in":"path","schemaId":"schema_49","description":"ID of the meter.","required":true}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1export/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exportType","in":"query","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the export. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAMPLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an export of success records, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an export of error records."},"children":[]}]}]}]},{"name":"sessionIds","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The session IDs of the meter run. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"R-000001, R-000002"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"requestId","in":"query","schemaId":"schema_5","description":"The unique identifier of an audit trail export job. Use the request ID returned when \nyou create an export job to retrieve that specific job.\n","example":"cd3367fb-019d-4600-863f-07c51b7c9e10"},{"name":"pageSize","in":"query","schemaId":"schema_57","description":"Page size for pagination.\n"},{"name":"page","in":"query","schemaId":"schema_58","description":"The page number.\n"}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1export/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/meters/{meterId}/auditTrail/export","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterId","in":"path","required":true,"schemaId":"schema_49"}],"query":[{"name":"exportType","in":"query","required":false,"schemaId":"schema_54"},{"name":"sessionIds","in":"query","required":false,"schemaId":"schema_42"},{"name":"requestId","in":"query","required":false,"example":"cd3367fb-019d-4600-863f-07c51b7c9e10","schemaId":"schema_5"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_57"},{"name":"page","in":"query","required":false,"schemaId":"schema_58"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/meters/{meterId}/auditTrail/export","href":"audit-trail/getaudittrailexportjobs","openApiOperationId":"getAuditTrailExportJobs","summary":"Retrieve the list of export jobs for a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAuditTrailExportResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1export/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetAuditTrailExportResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1export/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1export/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAuditTrailExportResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1export/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAuditTrailExportResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1export/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-trail/getaudittrailexportjobs"}],"panels":[]}]},"httpPath":"/meters/{meterId}/auditTrail/export"},{"label":"Create a job to export audit trail data for a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-trail/createaudittrailexportjob","routeSlug":"/v1-api-reference/api/audit-trail/createaudittrailexportjob","metadata":{"seo":{"title":"Create a job to export audit trail data for a meter","description":"Creates a background job to export the audit trail entries for a specific meter in Zuora Mediation.This API is for large-scale, offline access to audit data. Only one export job is processed per tenantat a time, and each export has a record limit, for example, up to 5 million rows per report.Use the returned requestId as the requestId query parameter with the \"Retrieve the list of export jobs for a meter\"operation to track the status of that specific job and retrieve the generated file names from fileList.Then use the \"Retrieve the presigned URL for an export job\" operation with each fileKey in fileList todownload the files."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAuditTrailExportJob","name":"Create a job to export audit trail data for a meter","isWebhook":false,"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1export/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a job to export audit trail data for a meter","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 background job to export the audit trail entries for a specific meter in Zuora Mediation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is for large-scale, offline access to audit data. Only one export job is processed per tenant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at a time, and each export has a record limit, for example, up to 5 million rows per report."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter with the \"Retrieve the list of export jobs for a meter\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operation to track the status of that specific job and retrieve the generated file names from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileList"},"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 use the \"Retrieve the presigned URL for an export job\" operation with each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"download the files."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterId","in":"path","schemaId":"schema_49","description":"The ID of the meter.","required":true}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1export/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exportType","in":"query","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the export. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAMPLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an export of success records, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates an export of error records."},"children":[]}]}]}],"required":true},{"name":"runType","in":"query","schemaId":"schema_55","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 run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEBUG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a test run, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NORMAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a live run."},"children":[]}]}]}],"required":true},{"name":"sessionIds","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of specific run IDs to export. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"R-000001, R-000002"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"runStatuses","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters audit entries by their run status. If omitted, all statuses are included. Statuses are case-sensitive."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"text","inline":true,"attributes":{"content":"NEVER_RUN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TESTING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TESTING_FAILED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TESTING_PASSED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RUNNING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAUSED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INITIALIZING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USAGE_PUSHING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUSH_COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONSUME_COMPLETED"},"children":[]}]}]}]}]},{"name":"operatorIds","in":"query","schemaId":"schema_42","description":"A list of operator IDs to filter by. The Operator ID is displayed for each operator node, for both current meters and historic runs. On the Mediation UI, click on a test ID or session ID to see the details of the run.\n"},{"name":"queryFromTime","in":"query","schemaId":"schema_5","description":"The minimum timestamp for the data to be exported. The standard used is ISO 8601 with timezones.\n","required":true,"example":"2025-07-01T00:00:00+0530"},{"name":"queryToTime","in":"query","schemaId":"schema_5","description":"The maximum timestamp for the data to be exported. The standard used is ISO 8601 with timezones.\n","required":true,"example":"2025-07-01T00:00:00+0530"},{"name":"format","in":"query","schemaId":"schema_59","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required format for the exported data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values 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":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Row-based CSV output"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parquet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Columnar Parquet output"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"avro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Avro output"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If omitted, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used by default for backward compatibility."},"children":[]}]}]}]},{"name":"compression","in":"query","schemaId":"schema_60","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional compression algorithm applied to the exported file(s)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values 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":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No compression (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": GZIP compression"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lz4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": LZ4 compression"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zstd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Zstandard compression"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If omitted, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used and the export produces an uncompressed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file. When a compression value other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated export files are stored in compressed form and must be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decompressed by the client after download."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1export/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1export/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/meters/{meterId}/auditTrail/export","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterId","in":"path","required":true,"schemaId":"schema_49"}],"query":[{"name":"exportType","in":"query","required":true,"schemaId":"schema_54"},{"name":"runType","in":"query","required":true,"schemaId":"schema_55"},{"name":"sessionIds","in":"query","required":false,"schemaId":"schema_42"},{"name":"runStatuses","in":"query","required":false,"schemaId":"schema_42"},{"name":"operatorIds","in":"query","required":false,"schemaId":"schema_42"},{"name":"queryFromTime","in":"query","required":true,"example":"2025-07-01T00:00:00+0530","schemaId":"schema_5"},{"name":"queryToTime","in":"query","required":true,"example":"2025-07-01T00:00:00+0530","schemaId":"schema_5"},{"name":"format","in":"query","required":false,"schemaId":"schema_59"},{"name":"compression","in":"query","required":false,"schemaId":"schema_60"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/meters/{meterId}/auditTrail/export","href":"audit-trail/createaudittrailexportjob","openApiOperationId":"createAuditTrailExportJob","summary":"Create a job to export audit trail data for a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportAuditTrailResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1export/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExportAuditTrailResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1export/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request - Invalid or missing parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"401","description":"Unauthorized - Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}},"schemaId":"components/schemas/MediationErrorResponse"},{"code":"500","description":"Internal Server Error - Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1{meterId}~1auditTrail~1export/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExportAuditTrailResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1export/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportAuditTrailResponse","exampleIds":["paths/~1meters~1{meterId}~1auditTrail~1export/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/MediationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-trail/createaudittrailexportjob"}],"panels":[]}]},"httpPath":"/meters/{meterId}/auditTrail/export"},{"label":"Retrieve the presigned URL for an export job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-trail/getpresignedurlformeterexport","routeSlug":"/v1-api-reference/api/audit-trail/getpresignedurlformeterexport","metadata":{"seo":{"title":"Retrieve the presigned URL for an export job","description":"Returns a pre-signed URL that you can use to download a specific export file (usually from object storage such as S3). The fileKey corresponds to one entry from the fileList array in the List API. Use the returned URL in the data field directly in a browser or via a HTTP client to download the export file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPresignedURLForMeterExport","name":"Retrieve the presigned URL for an export job","isWebhook":false,"pointer":"/paths/~1meters~1auditTrail~1presignedUrl/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the presigned URL for an export job","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":"Returns a pre-signed URL that you can use to download a specific export file (usually from object storage such as S3). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponds to one entry from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array in the List API. Use the returned URL in the data field directly in a browser or via a HTTP client to download the export file."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fileKey","in":"query","schemaId":"schema_5","description":"The file key of the export file to download.","required":true}],"pointer":"/paths/~1meters~1auditTrail~1presignedUrl/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1auditTrail~1presignedUrl/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/meters/auditTrail/presignedUrl","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"fileKey","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/meters/auditTrail/presignedUrl","href":"audit-trail/getpresignedurlformeterexport","openApiOperationId":"getPresignedURLForMeterExport","summary":"Retrieve the presigned URL for an export job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPresignedURLResponse","exampleIds":["paths/~1meters~1auditTrail~1presignedUrl/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetPresignedURLResponse","exampleIds":["paths/~1meters~1auditTrail~1presignedUrl/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1auditTrail~1presignedUrl/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPresignedURLResponse","exampleIds":["paths/~1meters~1auditTrail~1presignedUrl/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPresignedURLResponse","exampleIds":["paths/~1meters~1auditTrail~1presignedUrl/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-trail/getpresignedurlformeterexport"}],"panels":[]}]},"httpPath":"/meters/auditTrail/presignedUrl"},{"label":"List prefetch audit records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-trail/listprefetchauditrecords","routeSlug":"/v1-api-reference/api/audit-trail/listprefetchauditrecords","metadata":{"seo":{"title":"List prefetch audit records","description":"List audit records for prefetch operations by processor ID with filtering and cursor-based pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPrefetchAuditRecords","name":"List prefetch audit records","isWebhook":false,"pointer":"/paths/~1meters~1{meterId}~1prefetchAudit/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List prefetch audit records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List audit records for prefetch operations by processor ID with filtering and cursor-based pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meterId","in":"path","schemaId":"schema_49","description":"The ID of the meter.","required":true}],"pointer":"/paths/~1meters~1{meterId}~1prefetchAudit/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"operatorId","in":"query","schemaId":"schema_61","description":"Unique identifier for the processor.","required":true},{"name":"startDate","in":"query","schemaId":"schema_62","description":"Start date for filtering audit records (inclusive) in YYYY-MM-DD format. If not provided, defaults to 7 days before today (UTC)."},{"name":"endDate","in":"query","schemaId":"schema_63","description":"End date for filtering audit records (inclusive) in YYYY-MM-DD format. If not provided, defaults to today (UTC)."},{"name":"triggerType","in":"query","schemaId":"schema_64","description":"Filter by trigger type."},{"name":"status","in":"query","schemaId":"schema_65","description":"Filter by job status. Repeat this parameter to specify multiple values."},{"name":"pageSize","in":"query","schemaId":"schema_66","description":"Number of records to return per page."},{"name":"cursor","in":"query","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor for pagination (obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextPage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previousPage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response)."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1{meterId}~1prefetchAudit/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1{meterId}~1prefetchAudit/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/meters/{meterId}/prefetchAudit","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"meterId","in":"path","required":true,"schemaId":"schema_49"}],"query":[{"name":"operatorId","in":"query","required":true,"example":"2c734651-1ca5-4a87-b104-fecba5bf1c35","schemaId":"schema_61"},{"name":"startDate","in":"query","required":false,"example":"2026-02-10","schemaId":"schema_62"},{"name":"endDate","in":"query","required":false,"example":"2026-02-16","schemaId":"schema_63"},{"name":"triggerType","in":"query","required":false,"schemaId":"schema_64"},{"name":"status","in":"query","required":false,"schemaId":"schema_65"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_66"},{"name":"cursor","in":"query","required":false,"example":"eyJqb2JJZCI6MTIzND...","schemaId":"schema_67"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/meters/{meterId}/prefetchAudit","href":"audit-trail/listprefetchauditrecords","openApiOperationId":"listPrefetchAuditRecords","summary":"List prefetch audit records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPrefetchAuditResponse","exampleIds":["paths/~1meters~1{meterId}~1prefetchAudit/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetPrefetchAuditResponse","exampleIds":["paths/~1meters~1{meterId}~1prefetchAudit/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1{meterId}~1prefetchAudit/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPrefetchAuditResponse","exampleIds":["paths/~1meters~1{meterId}~1prefetchAudit/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPrefetchAuditResponse","exampleIds":["paths/~1meters~1{meterId}~1prefetchAudit/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-trail/listprefetchauditrecords"}],"panels":[]}]},"httpPath":"/meters/{meterId}/prefetchAudit"}],"content":{"contentType":"group","meta":{"name":"Audit Trail"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit Trail","showPageActions":true},{"nodeType":"markdoc","content":"Use these APIs to retrieve meter audit trail entries, create and track export jobs, and download exported audit data for offline analysis and compliance reporting."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/meters/{meterId}/auditTrail/entries","summary":"Retrieve the audit trail entries for a meter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-trail/getaudittrailentriesformeter","deprecated":false},{"title":"/meters/{meterId}/auditTrail/export","summary":"Retrieve the list of export jobs for a meter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-trail/getaudittrailexportjobs","deprecated":false},{"title":"/meters/{meterId}/auditTrail/export","summary":"Create a job to export audit trail data for a meter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-trail/createaudittrailexportjob","deprecated":false},{"title":"/meters/auditTrail/presignedUrl","summary":"Retrieve the presigned URL for an export job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-trail/getpresignedurlformeterexport","deprecated":false},{"title":"/meters/{meterId}/prefetchAudit","summary":"List prefetch audit records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-trail/listprefetchauditrecords","deprecated":false}]}]}]}]}},{"type":"group","label":"Event Store","link":"/v1-api-reference/api/event-store","routeSlug":"/v1-api-reference/api/event-store","items":[{"label":"Bulk delete events from an event store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/event-store/bulkdeleteeventsfromeventstore","routeSlug":"/v1-api-reference/api/event-store/bulkdeleteeventsfromeventstore","metadata":{"seo":{"title":"Bulk delete events from an event store","description":"Allows you to delete multiple events from an event store in Zuora Mediation using a file that lists the event IDs to be removed. It is useful for cleaning up or correcting data in bulk."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkDeleteEventsFromEventStore","name":"Bulk delete events from an event store","isWebhook":false,"pointer":"/paths/~1meters~1events~1bulkDelete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk delete events from an event store","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows you to delete multiple events from an event store in Zuora Mediation using a file that lists the event IDs to be removed. It is useful for cleaning up or correcting data in bulk.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_5","description":"Specify the content type of the request. Use multipart/form-data.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1events~1bulkDelete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/BulkDeleteEventRequest"}},"schemaId":"components/schemas/BulkDeleteEventRequest","pointer":"/paths/~1meters~1events~1bulkDelete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/meters/events/bulkDelete","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_5"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/BulkDeleteEventRequest"}},"responseCodes":["200","400","500"],"pointer":"/meters/events/bulkDelete","href":"event-store/bulkdeleteeventsfromeventstore","openApiOperationId":"bulkDeleteEventsFromEventStore","summary":"Bulk delete events from an event store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/BulkDeleteEventRequest","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/BulkDeleteEventRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with query ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkDeleteEventResponse"}},"schemaId":"components/schemas/BulkDeleteEventResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1events~1bulkDelete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkDeleteEventResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkDeleteEventResponse"}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-store/bulkdeleteeventsfromeventstore"}],"panels":[]}]},"httpPath":"/meters/events/bulkDelete"},{"label":"Retrieve the latest query job of a specific event store","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/event-store/getlatestqueryjobofspecificeventstore","routeSlug":"/v1-api-reference/api/event-store/getlatestqueryjobofspecificeventstore","metadata":{"seo":{"title":"Retrieve the latest query job of a specific event store","description":"Retrieves the most recent query job executed on a specific event store in Zuora Mediation. It returns metadata such as query type (for example, DELETE), status, record counts, and timestamps."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLatestQueryJobOfSpecificEventStore","name":"Retrieve the latest query job of a specific event store","isWebhook":false,"pointer":"/paths/~1meters~1events~1stores~1{eventStoreId}~1jobs~1latest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the latest query job of a specific event store","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the most recent query job executed on a specific event store in Zuora Mediation. It returns metadata such as query type (for example, DELETE), status, record counts, and timestamps."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"eventStoreId","in":"path","schemaId":"schema_49","description":"ID of the event store.","required":true}],"pointer":"/paths/~1meters~1events~1stores~1{eventStoreId}~1jobs~1latest/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1events~1stores~1{eventStoreId}~1jobs~1latest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/meters/events/stores/{eventStoreId}/jobs/latest","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"eventStoreId","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/meters/events/stores/{eventStoreId}/jobs/latest","href":"event-store/getlatestqueryjobofspecificeventstore","openApiOperationId":"getLatestQueryJobOfSpecificEventStore","summary":"Retrieve the latest query job of a specific event store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with latest event store query job details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LatestEventStoreJobResponse"}},"schemaId":"components/schemas/LatestEventStoreJobResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"404","description":"Event store not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}},"schemaId":"components/schemas/MediationErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1events~1stores~1{eventStoreId}~1jobs~1latest/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LatestEventStoreJobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LatestEventStoreJobResponse"}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"404","schemaId":"components/schemas/MediationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-store/getlatestqueryjobofspecificeventstore"}],"panels":[]}]},"httpPath":"/meters/events/stores/{eventStoreId}/jobs/latest"},{"label":"Truncate all data from an event store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/event-store/truncateeventstore","routeSlug":"/v1-api-reference/api/event-store/truncateeventstore","metadata":{"seo":{"title":"Truncate all data from an event store","description":"Truncates (deletes) all events from a specific event store in Zuora Mediation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"truncateEventStore","name":"Truncate all data from an event store","isWebhook":false,"pointer":"/paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Truncate all data from an event store","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Truncates (deletes) all events from a specific event store in Zuora Mediation.\n\nThis operation runs asynchronously and returns a query job identifier that\nyou can use with the Event Store query job APIs to monitor status.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"eventStoreId","in":"path","schemaId":"schema_49","description":"ID of the event store to truncate.","required":true}],"pointer":"/paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/meters/events/stores/{eventStoreId}/truncate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"eventStoreId","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","409","500"],"pointer":"/meters/events/stores/{eventStoreId}/truncate","href":"event-store/truncateeventstore","openApiOperationId":"truncateEventStore","summary":"Truncate all data from an event store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Truncation job successfully submitted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TruncateEventStoreResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TruncateEventStoreResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request - Invalid eventStoreId parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/400/content/application~1json/example"]},{"code":"404","description":"Not Found - Event Store does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict - Event Store is in a non-modifiable state","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterWriting","paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/deletionInProgress","paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterRunning"]}},"schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterWriting","paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/deletionInProgress","paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterRunning"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TruncateEventStoreResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TruncateEventStoreResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterWriting","paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/deletionInProgress","paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterRunning"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationTruncateErrorResponse","exampleIds":["paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterWriting","paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/deletionInProgress","paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterRunning"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-store/truncateeventstore"}],"panels":[]}]},"httpPath":"/meters/events/stores/{eventStoreId}/truncate"},{"label":"Submit an event store query","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/event-store/submiteventstorequery","routeSlug":"/v1-api-reference/api/event-store/submiteventstorequery","metadata":{"seo":{"title":"Submit an event store query","description":"Submits a SQL-style asynchronous query to the Event Store to retrieve and inspect metering events for validation, troubleshooting, and reconciliation. The API returns a queryId that can be used to poll and fetch paginated results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitEventStoreQuery","name":"Submit an event store query","isWebhook":false,"pointer":"/paths/~1meters~1event-store-queries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit an event store query","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":"Submits a SQL-style asynchronous query to the Event Store to retrieve and inspect metering events for validation, troubleshooting, and reconciliation. The API returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can be used to poll and fetch paginated results."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1event-store-queries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmitEventStoreQueryRequest"}},"schemaId":"components/schemas/SubmitEventStoreQueryRequest","pointer":"/paths/~1meters~1event-store-queries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/meters/event-store-queries","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubmitEventStoreQueryRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/meters/event-store-queries","href":"event-store/submiteventstorequery","openApiOperationId":"submitEventStoreQuery","summary":"Submit an event store query"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/SubmitEventStoreQueryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmitEventStoreQueryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitEventStoreQueryResponse","exampleIds":["paths/~1meters~1event-store-queries/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SubmitEventStoreQueryResponse","exampleIds":["paths/~1meters~1event-store-queries/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request - Invalid or missing parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"401","description":"Unauthorized - Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}},"schemaId":"components/schemas/MediationErrorResponse"},{"code":"500","description":"Internal Server Error - Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1event-store-queries/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubmitEventStoreQueryResponse","exampleIds":["paths/~1meters~1event-store-queries/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitEventStoreQueryResponse","exampleIds":["paths/~1meters~1event-store-queries/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/MediationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MediationErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-store/submiteventstorequery"}],"panels":[]}]},"httpPath":"/meters/event-store-queries"},{"label":"Retrieve the results for an event store query","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/event-store/getqueryresultsforeventstore","routeSlug":"/v1-api-reference/api/event-store/getqueryresultsforeventstore","metadata":{"seo":{"title":"Retrieve the results for an event store query","description":"Retrieves paginated result rows and column metadata for a previously submitted Event Store query using its queryId, including total row count, row-level field values, and readiness status. Query execution is asynchronous."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueryResultsForEventStore","name":"Retrieve the results for an event store query","isWebhook":false,"pointer":"/paths/~1meters~1event-store-queries~1{queryId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the results for an event store query","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 paginated result rows and column metadata for a previously submitted Event Store query using its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including total row count, row-level field values, and readiness status. Query execution is asynchronous."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"queryId","in":"path","schemaId":"schema_5","description":"ID of the query.","required":true}],"pointer":"/paths/~1meters~1event-store-queries~1{queryId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_68","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page size for page-based pagination of query results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Maximum 50."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_58","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1-based page index for page-based pagination of query results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Combine with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to iterate through all matching rows."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1event-store-queries~1{queryId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_48","description":"Specify the content type of the request body. Use application/json.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1meters~1event-store-queries~1{queryId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/meters/event-store-queries/{queryId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"queryId","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_68"},{"name":"page","in":"query","required":false,"schemaId":"schema_58"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_48"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/meters/event-store-queries/{queryId}","href":"event-store/getqueryresultsforeventstore","openApiOperationId":"getQueryResultsForEventStore","summary":"Retrieve the results for an event store query"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetQueryResultsResponse","exampleIds":["paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful query results","paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful paginated results (page 2 of 2)","paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Failed query execution"]}},"schemaId":"components/schemas/GetQueryResultsResponse","exampleIds":["paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful query results","paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful paginated results (page 2 of 2)","paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Failed query execution"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}},"schemaId":"components/schemas/ProxyBadRequestResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1meters~1event-store-queries~1{queryId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetQueryResultsResponse","exampleIds":["paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful query results","paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful paginated results (page 2 of 2)","paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Failed query execution"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetQueryResultsResponse","exampleIds":["paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful query results","paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful paginated results (page 2 of 2)","paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Failed query execution"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-store/getqueryresultsforeventstore"}],"panels":[]}]},"httpPath":"/meters/event-store-queries/{queryId}"}],"content":{"contentType":"group","meta":{"name":"Event Store"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event Store","showPageActions":true},{"nodeType":"markdoc","content":"Event Store APIs let you query and manage raw metering events in Zuora Mediation, including submitting SQL-style queries, retrieving results, and performing bulk deletions or truncation."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/meters/events/bulkDelete","summary":"Bulk delete events from an event store","prefix":{"name":"post","color":"post"},"badges":[],"link":"/event-store/bulkdeleteeventsfromeventstore","deprecated":false},{"title":"/meters/events/stores/{eventStoreId}/jobs/latest","summary":"Retrieve the latest query job of a specific event store","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-store/getlatestqueryjobofspecificeventstore","deprecated":false},{"title":"/meters/events/stores/{eventStoreId}/truncate","summary":"Truncate all data from an event store","prefix":{"name":"post","color":"post"},"badges":[],"link":"/event-store/truncateeventstore","deprecated":false},{"title":"/meters/event-store-queries","summary":"Submit an event store query","prefix":{"name":"post","color":"post"},"badges":[],"link":"/event-store/submiteventstorequery","deprecated":false},{"title":"/meters/event-store-queries/{queryId}","summary":"Retrieve the results for an event store query","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-store/getqueryresultsforeventstore","deprecated":false}]}]}]}]}},{"type":"separator","label":"Billing Documents","content":null},{"type":"group","label":"Delivery Adjustments","link":"/v1-api-reference/api/delivery-adjustments","routeSlug":"/v1-api-reference/api/delivery-adjustments","items":[{"label":"List all delivery adjustments of a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/delivery-adjustments/get_subscription_adjustments","routeSlug":"/v1-api-reference/api/delivery-adjustments/get_subscription_adjustments","metadata":{"seo":{"title":"List all delivery adjustments of a subscription","description":"Describes how to retrieve detailed information about delivery adjustments of a subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Subscription_Adjustments","name":"List all delivery adjustments of a subscription","isWebhook":false,"pointer":"/paths/~1v1~1adjustments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all delivery adjustments of a subscription","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":"Describes how to retrieve detailed information about delivery adjustments of a subscription."},"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 Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable billing features by yourself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subscription-number","in":"query","schemaId":"schema_5","description":"A subscription number.\n","required":true}],"pointer":"/paths/~1v1~1adjustments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1adjustments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/adjustments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"subscription-number","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/adjustments","href":"delivery-adjustments/get_subscription_adjustments","openApiOperationId":"GET_Subscription_Adjustments","summary":"List all delivery adjustments of a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAdjustmentsBySubscriptionNumberResponseType","exampleIds":["paths/~1v1~1adjustments/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAdjustmentsBySubscriptionNumberResponseType","exampleIds":["paths/~1v1~1adjustments/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_69"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1adjustments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAdjustmentsBySubscriptionNumberResponseType","exampleIds":["paths/~1v1~1adjustments/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAdjustmentsBySubscriptionNumberResponseType","exampleIds":["paths/~1v1~1adjustments/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-adjustments/get_subscription_adjustments"}],"panels":[]}]},"httpPath":"/v1/adjustments"},{"label":"Create a delivery adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/delivery-adjustments/create_adjustment","routeSlug":"/v1-api-reference/api/delivery-adjustments/create_adjustment","metadata":{"seo":{"title":"Create a delivery adjustment","description":"Describes how to create one or more delivery adjustments for a subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_Adjustment","name":"Create a delivery adjustment","isWebhook":false,"pointer":"/paths/~1v1~1adjustments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a delivery adjustment","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":"Describes how to create one or more delivery adjustments for a subscription."},"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":"Notes"},"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":"The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable billing features by yourself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “success = true” as well as eligible delivery adjustments and ineligible delivery adjustments are returned in the response; only when no delivery adjustment is eligible, “success=false” is returned."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1adjustments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateBillingAdjustmentRequestType"}},"schemaId":"components/schemas/POSTCreateBillingAdjustmentRequestType","pointer":"/paths/~1v1~1adjustments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/adjustments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTCreateBillingAdjustmentRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/adjustments","href":"delivery-adjustments/create_adjustment","openApiOperationId":"Create_Adjustment","summary":"Create a delivery adjustment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTCreateBillingAdjustmentRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateBillingAdjustmentRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAdjustmentsResponseType","exampleIds":["paths/~1v1~1adjustments/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAdjustmentsResponseType","exampleIds":["paths/~1v1~1adjustments/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_69"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1adjustments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAdjustmentsResponseType","exampleIds":["paths/~1v1~1adjustments/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAdjustmentsResponseType","exampleIds":["paths/~1v1~1adjustments/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-adjustments/create_adjustment"}],"panels":[]}]},"httpPath":"/v1/adjustments"},{"label":"Preview a delivery adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/delivery-adjustments/preview_adjustment","routeSlug":"/v1-api-reference/api/delivery-adjustments/preview_adjustment","metadata":{"seo":{"title":"Preview a delivery adjustment","description":"Describes how to preview delivery adjustments of a subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Preview_Adjustment","name":"Preview a delivery adjustment","isWebhook":false,"pointer":"/paths/~1v1~1adjustments~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview a delivery adjustment","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":"Describes how to preview delivery adjustments of a subscription."},"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":"Notes"},"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":"The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable billing features by yourself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “success = true” as well as eligible delivery adjustments and ineligible delivery adjustments are returned in the response; only when no delivery adjustment is eligible, “success=false” is returned."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1adjustments~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPreviewBillingAdjustmentRequestType"}},"schemaId":"components/schemas/POSTPreviewBillingAdjustmentRequestType","pointer":"/paths/~1v1~1adjustments~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/adjustments/preview","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTPreviewBillingAdjustmentRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/adjustments/preview","href":"delivery-adjustments/preview_adjustment","openApiOperationId":"Preview_Adjustment","summary":"Preview a delivery adjustment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTPreviewBillingAdjustmentRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPreviewBillingAdjustmentRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAdjustmentsResponseType","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAdjustmentsResponseType","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_69"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1adjustments~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAdjustmentsResponseType","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAdjustmentsResponseType","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1preview/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-adjustments/preview_adjustment"}],"panels":[]}]},"httpPath":"/v1/adjustments/preview"},{"label":"Retrieve a delivery adjustment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/delivery-adjustments/get_adjustment","routeSlug":"/v1-api-reference/api/delivery-adjustments/get_adjustment","metadata":{"seo":{"title":"Retrieve a delivery adjustment","description":"Describes how to retrieve detailed information about a delivery adjustment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Adjustment","name":"Retrieve a delivery adjustment","isWebhook":false,"pointer":"/paths/~1v1~1adjustments~1{adjustment-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a delivery adjustment","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":"Describes how to retrieve detailed information about a delivery adjustment."},"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 Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable billing features by yourself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"adjustment-key","in":"path","schemaId":"schema_5","description":"The delivery adjustment ID or number to retrieve.","required":true}],"pointer":"/paths/~1v1~1adjustments~1{adjustment-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1adjustments~1{adjustment-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/adjustments/{adjustment-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"adjustment-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/adjustments/{adjustment-key}","href":"delivery-adjustments/get_adjustment","openApiOperationId":"GET_Adjustment","summary":"Retrieve a delivery adjustment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAdjustmentByIdResponseType","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAdjustmentByIdResponseType","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_69"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1adjustments~1{adjustment-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAdjustmentByIdResponseType","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAdjustmentByIdResponseType","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustment-key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-adjustments/get_adjustment"}],"panels":[]}]},"httpPath":"/v1/adjustments/{adjustment-key}"},{"label":"Cancel a delivery adjustment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/delivery-adjustments/put_canceladjustment","routeSlug":"/v1-api-reference/api/delivery-adjustments/put_canceladjustment","metadata":{"seo":{"title":"Cancel a delivery adjustment","description":"Describes how to cancel an unbilled delivery adjustment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CancelAdjustment","name":"Cancel a delivery adjustment","isWebhook":false,"pointer":"/paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a delivery adjustment","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":"Describes how to cancel an unbilled delivery adjustment."},"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 Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable billing features by yourself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"adjustmentId","in":"path","schemaId":"schema_38","description":"The ID of the delivery adjustment to cancel.\n","required":true}],"pointer":"/paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelBillingAdjustmentRequest"}},"schemaId":"components/schemas/CancelBillingAdjustmentRequest","pointer":"/paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/adjustments/{adjustmentId}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"adjustmentId","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancelBillingAdjustmentRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/adjustments/{adjustmentId}/cancel","href":"delivery-adjustments/put_canceladjustment","openApiOperationId":"PUT_CancelAdjustment","summary":"Cancel a delivery adjustment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CancelBillingAdjustmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelBillingAdjustmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCancelAdjustmentResponseType","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCancelAdjustmentResponseType","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_69"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCancelAdjustmentResponseType","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCancelAdjustmentResponseType","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-adjustments/put_canceladjustment"}],"panels":[]}]},"httpPath":"/v1/adjustments/{adjustmentId}/cancel"}],"content":{"contentType":"group","meta":{"name":"Delivery Adjustments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delivery Adjustments","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":"Delivery Adjustments are used to handle end customer delivery complaints for the Delivery Pricing charge model. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-delivery-adjustments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Adjustments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/adjustments","summary":"List all delivery adjustments of a subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery-adjustments/get_subscription_adjustments","deprecated":false},{"title":"/v1/adjustments","summary":"Create a delivery adjustment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/delivery-adjustments/create_adjustment","deprecated":false},{"title":"/v1/adjustments/preview","summary":"Preview a delivery adjustment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/delivery-adjustments/preview_adjustment","deprecated":false},{"title":"/v1/adjustments/{adjustment-key}","summary":"Retrieve a delivery adjustment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery-adjustments/get_adjustment","deprecated":false},{"title":"/v1/adjustments/{adjustmentId}/cancel","summary":"Cancel a delivery adjustment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/delivery-adjustments/put_canceladjustment","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Documents","link":"/v1-api-reference/api/billing-documents","routeSlug":"/v1-api-reference/api/billing-documents","items":[{"label":"List billing documents for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-documents/get_billingdocuments","routeSlug":"/v1-api-reference/api/billing-documents/get_billingdocuments","metadata":{"seo":{"title":"List billing documents for an account","description":"Retrieves the information about all billing documents associated with a specified account. The billing documents contain invoices, credit memos, and debit memos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_BillingDocuments","name":"List billing documents for an account","isWebhook":false,"pointer":"/paths/~1v1~1billing-documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List billing documents for an account","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 the information about all billing documents associated with a specified account. The billing documents contain invoices, credit memos, and debit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve information about credit memos and debit memos, you must have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use query parameters to restrict the data returned in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"/billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/billing-documents?accountNumber=A00000001&sort=+documentDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/billing-documents?accountNumber=A00000001&status=Posted"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"accountId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the customer account that the billing documents are associated with."},"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":": When retrieving information about all billing documents associated with an account, you must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the query parameters."},"children":[]}]}]}]},{"name":"accountNumber","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the customer account that the billing documents are associated with."},"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":": When retrieving information about all billing documents associated with an account, you must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the query parameters."},"children":[]}]}]}]},{"name":"documentDate","in":"query","schemaId":"schema_32","description":"The date of the billing document. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.\n"},{"name":"status","in":"query","schemaId":"schema_70","description":"The status of the billing document.\n"},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not specify any sortable field, the response data is sorted by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in descending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field. The supported sortable fields of this operation are as below:"},"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":"documentDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentType"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"/billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"&sort=+documentDate,-documentType"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"&status=Posted&sort=+documentDate&page=2&pageSize=15"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1billing-documents/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1billing-documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/billing-documents","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"accountId","in":"query","required":false,"schemaId":"schema_5"},{"name":"accountNumber","in":"query","required":false,"schemaId":"schema_5"},{"name":"documentDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"status","in":"query","required":false,"schemaId":"schema_70"},{"name":"sort","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/billing-documents","href":"billing-documents/get_billingdocuments","openApiOperationId":"GET_BillingDocuments","summary":"List billing documents for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingDocumentQueryResponseElementType","exampleIds":["paths/~1v1~1billing-documents/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/BillingDocumentQueryResponseElementType","exampleIds":["paths/~1v1~1billing-documents/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-documents/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-documents/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-documents/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-documents/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1billing-documents/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingDocumentQueryResponseElementType","exampleIds":["paths/~1v1~1billing-documents/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingDocumentQueryResponseElementType","exampleIds":["paths/~1v1~1billing-documents/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-documents/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-documents/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-documents/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-documents/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-documents/get_billingdocuments"}],"panels":[]}]},"httpPath":"/v1/billing-documents"},{"label":"Create a job to hard delete billing document files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-documents/post_billingdocumentfilesdeletionjob","routeSlug":"/v1-api-reference/api/billing-documents/post_billingdocumentfilesdeletionjob","metadata":{"seo":{"title":"Create a job to hard delete billing document files","description":"Creates an asynchronous job to permanently delete all billing document PDF files for specific accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_BillingDocumentFilesDeletionJob","name":"Create a job to hard delete billing document files","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a job to hard delete billing document files","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 asynchronous job to permanently delete all billing document PDF files for specific accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the deletion job is completed, all billing document PDF files are permanently deleted. To retrieve the status of a deletion job, call "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_BillingDocumentFilesDeletionJob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a job of hard deleting billing document files"},"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":"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 can be used only if you have the Billing user permission \"Hard Delete Billing Document Files\" enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTBillingDocumentFilesDeletionJobRequest"}},"schemaId":"components/schemas/POSTBillingDocumentFilesDeletionJobRequest","pointer":"/paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounts/billing-documents/files/deletion-jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTBillingDocumentFilesDeletionJobRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/billing-documents/files/deletion-jobs","href":"billing-documents/post_billingdocumentfilesdeletionjob","openApiOperationId":"POST_BillingDocumentFilesDeletionJob","summary":"Create a job to hard delete billing document files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTBillingDocumentFilesDeletionJobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTBillingDocumentFilesDeletionJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTBillingDocumentFilesDeletionJobResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTBillingDocumentFilesDeletionJobResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTBillingDocumentFilesDeletionJobResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTBillingDocumentFilesDeletionJobResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-documents/post_billingdocumentfilesdeletionjob"}],"panels":[]}]},"httpPath":"/v1/accounts/billing-documents/files/deletion-jobs"},{"label":"Retrieve a job of hard deleting billing document files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-documents/get_billingdocumentfilesdeletionjob","routeSlug":"/v1-api-reference/api/billing-documents/get_billingdocumentfilesdeletionjob","metadata":{"seo":{"title":"Retrieve a job of hard deleting billing document files","description":"Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_BillingDocumentFilesDeletionJob","name":"Retrieve a job of hard deleting billing document files","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a job of hard deleting billing document files","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 information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts."},"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 can be used only if you have the Billing user permission \"Hard Delete Billing Document Files\" enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_5","description":"The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c.","required":true}],"pointer":"/paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts/billing-documents/files/deletion-jobs/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/billing-documents/files/deletion-jobs/{jobId}","href":"billing-documents/get_billingdocumentfilesdeletionjob","openApiOperationId":"GET_BillingDocumentFilesDeletionJob","summary":"Retrieve a job of hard deleting billing document files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETBillingDocumentFilesDeletionJobResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETBillingDocumentFilesDeletionJobResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETBillingDocumentFilesDeletionJobResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETBillingDocumentFilesDeletionJobResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-documents/get_billingdocumentfilesdeletionjob"}],"panels":[]}]},"httpPath":"/v1/accounts/billing-documents/files/deletion-jobs/{jobId}"},{"label":"Generate billing documents by account ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-documents/post_generatebillingdocuments","routeSlug":"/v1-api-reference/api/billing-documents/post_generatebillingdocuments","metadata":{"seo":{"title":"Generate billing documents by account ID","description":"Generates draft or posted billing documents for a specified account. You can also generate billing documents for specified subscriptions of a specified account. The billing documents contain invoices and credit memos. To generate credit memos, you must have the Invoice Settlement feature enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_GenerateBillingDocuments","name":"Generate billing documents by account ID","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate billing documents by account ID","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":"Generates draft or posted billing documents for a specified account. You can also generate billing documents for specified subscriptions of a specified account. The billing documents contain invoices and credit memos. To generate credit memos, you must have the Invoice Settlement feature enabled."},"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":": You cannot generate billing documents for cancelled or suspended subscriptions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The ID or number of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419 or AC0000001.\n","required":true}],"pointer":"/paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostGenerateBillingDocumentType"}},"schemaId":"components/schemas/PostGenerateBillingDocumentType","pointer":"/paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounts/{key}/billing-documents/generate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostGenerateBillingDocumentType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/accounts/{key}/billing-documents/generate","href":"billing-documents/post_generatebillingdocuments","openApiOperationId":"POST_GenerateBillingDocuments","summary":"Generate billing documents by account ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostGenerateBillingDocumentType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostGenerateBillingDocumentType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenerateBillingDocumentResponseType","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GenerateBillingDocumentResponseType","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GenerateBillingDocumentResponseType","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenerateBillingDocumentResponseType","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-documents/post_generatebillingdocuments"}],"panels":[]}]},"httpPath":"/v1/accounts/{key}/billing-documents/generate"}],"content":{"contentType":"group","meta":{"name":"Billing Documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing 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":"Billing documents include invoices, credit memos, and debit memos."},"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":": Credit memos and debit memos are only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/billing-documents","summary":"List billing documents for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-documents/get_billingdocuments","deprecated":false},{"title":"/v1/accounts/billing-documents/files/deletion-jobs","summary":"Create a job to hard delete billing document files","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-documents/post_billingdocumentfilesdeletionjob","deprecated":false},{"title":"/v1/accounts/billing-documents/files/deletion-jobs/{jobId}","summary":"Retrieve a job of hard deleting billing document files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-documents/get_billingdocumentfilesdeletionjob","deprecated":false},{"title":"/v1/accounts/{key}/billing-documents/generate","summary":"Generate billing documents by account ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-documents/post_generatebillingdocuments","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoices","link":"/v1-api-reference/api/invoices","routeSlug":"/v1-api-reference/api/invoices","items":[{"label":"Create a standalone invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_standaloneinvoice","routeSlug":"/v1-api-reference/api/invoices/post_standaloneinvoice","metadata":{"seo":{"title":"Create a standalone invoice","description":"Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_StandaloneInvoice","name":"Create a standalone invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a standalone 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":"Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this operation, you must have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modify Invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and at least one of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Standalone Invoice With Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Standalone Invoice Without Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user permissions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostInvoiceType"}},"schemaId":"components/schemas/PostInvoiceType","pointer":"/paths/~1v1~1invoices/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoices","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostInvoiceType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices","href":"invoices/post_standaloneinvoice","openApiOperationId":"POST_StandaloneInvoice","summary":"Create a standalone invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostInvoiceType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostInvoiceType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostInvoiceResponse","exampleIds":["paths/~1v1~1invoices/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PostInvoiceResponse","exampleIds":["paths/~1v1~1invoices/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostInvoiceResponse","exampleIds":["paths/~1v1~1invoices/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostInvoiceResponse","exampleIds":["paths/~1v1~1invoices/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/post_standaloneinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices"},{"label":"Update invoices","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/put_batchupdateinvoices","routeSlug":"/v1-api-reference/api/invoices/put_batchupdateinvoices","metadata":{"seo":{"title":"Update invoices","description":"Updates multiple invoices in batches with one call. The following tutorials demonstrate how to use this operation:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_BatchUpdateInvoices","name":"Update invoices","isWebhook":false,"pointer":"/paths/~1v1~1invoices/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update invoices","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 multiple invoices in batches with one call. The following tutorials demonstrate how to use this operation:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/unified-invoicing/invoice-items-of-draft-standalone-invoices/manage-invoice-items-of-draft-standalone-invoices-through-the-rest-api","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add and delete invoice items of draft standalone invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/unified-invoicing/due-dates-of-draft-standalone-invoices-editing/edit-the-due-date-on-draft-standalone-invoices-through-the-rest-api","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit due dates of draft standalone invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/unified-invoicing/invoice-item-prices-and-custom-fields-of-draft-standalone-invoices-editing/edit-the-invoice-item-prices-and-custom-fields-of-standalone-invoices-through-the-rest-api","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit invoice item prices and custom fields of draft standalone invoices"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"invoices/put_batchupdateinvoices/request/limitations","deepLinkHash":"/invoices/put_batchupdateinvoices#invoices/put_batchupdateinvoices/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"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":"You can update a maximum of 50 invoices by one call."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutBatchInvoiceType"}},"schemaId":"components/schemas/PutBatchInvoiceType","pointer":"/paths/~1v1~1invoices/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoices","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutBatchInvoiceType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices","href":"invoices/put_batchupdateinvoices","openApiOperationId":"PUT_BatchUpdateInvoices","summary":"Update invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutBatchInvoiceType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutBatchInvoiceType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/put_batchupdateinvoices"}],"panels":[]}]},"httpPath":"/v1/invoices"},{"label":"Create standalone invoices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_standaloneinvoices","routeSlug":"/v1-api-reference/api/invoices/post_standaloneinvoices","metadata":{"seo":{"title":"Create standalone invoices","description":"Creates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_StandaloneInvoices","name":"Create standalone invoices","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create standalone invoices","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 multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this operation, you must have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modify Invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and at least one of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Standalone Invoice With Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Standalone Invoice Without Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user permissions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"invoices/post_standaloneinvoices/request/limitations","deepLinkHash":"/invoices/post_standaloneinvoices#invoices/post_standaloneinvoices/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation has the following limitations:"},"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":"You can create a maximum of 50 invoices in one request."},"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":"You can create a maximum of 1,000 invoice items in one request."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBatchInvoicesType"}},"schemaId":"components/schemas/PostBatchInvoicesType","pointer":"/paths/~1v1~1invoices~1batch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoices/batch","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostBatchInvoicesType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/batch","href":"invoices/post_standaloneinvoices","openApiOperationId":"POST_StandaloneInvoices","summary":"Create standalone invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostBatchInvoicesType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBatchInvoicesType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostBatchInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PostBatchInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostBatchInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostBatchInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1batch/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/post_standaloneinvoices"}],"panels":[]}]},"httpPath":"/v1/invoices/batch"},{"label":"Post invoices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_postinvoices","routeSlug":"/v1-api-reference/api/invoices/post_postinvoices","metadata":{"seo":{"title":"Post invoices","description":"Posts multiple invoices."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_PostInvoices","name":"Post invoices","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1bulk-post/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post invoices","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":"Posts multiple invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can post a maximum of 50 invoices in one single request. Additionally, you can also update invoice dates while posting the invoices."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 is synchronous and invoices within the bulk request are posted one by one. The maximum batch size depends on the posting performance, which varies with invoice complexity and integrations with external tax engines."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1bulk-post/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTInvoicesBatchPostType"}},"schemaId":"components/schemas/POSTInvoicesBatchPostType","pointer":"/paths/~1v1~1invoices~1bulk-post/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoices/bulk-post","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTInvoicesBatchPostType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/bulk-post","href":"invoices/post_postinvoices","openApiOperationId":"POST_PostInvoices","summary":"Post invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTInvoicesBatchPostType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTInvoicesBatchPostType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicesBatchPostResponseType","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/InvoicesBatchPostResponseType","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1bulk-post/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoicesBatchPostResponseType","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicesBatchPostResponseType","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1bulk-post/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/post_postinvoices"}],"panels":[]}]},"httpPath":"/v1/invoices/bulk-post"},{"label":"Retrieve the PDF file generation status of invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/getinvoicepdfstatus","routeSlug":"/v1-api-reference/api/invoices/getinvoicepdfstatus","metadata":{"seo":{"title":"Retrieve the PDF file generation status of invoices","description":"Retrieves the PDF generation statuses of a batch of invoices."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetInvoicePdfStatus","name":"Retrieve the PDF file generation status of invoices","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1pdf-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the PDF file generation status of invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the PDF generation statuses of a batch of invoices. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"invoiceKeys","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs or numbers of the invoices separated by commas. For example - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?invoiceKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,INV-0000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A maximum of 50 keys can be entered in this field."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1invoices~1pdf-status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1pdf-status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoices/pdf-status","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"invoiceKeys","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","500","4XX"],"pointer":"/v1/invoices/pdf-status","href":"invoices/getinvoicepdfstatus","openApiOperationId":"GetInvoicePdfStatus","summary":"Retrieve the PDF file generation status of invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetInvoicePdfStatusBatchResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetInvoicePdfStatusBatchResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/400/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/401/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"},"children":[]}]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}}},"headerSchemaId":"schema_71"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1pdf-status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetInvoicePdfStatusBatchResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetInvoicePdfStatusBatchResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1pdf-status/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoicepdfstatus"}],"panels":[]}]},"httpPath":"/v1/invoices/pdf-status"},{"label":"Delete an invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/delete_deleteinvoice","routeSlug":"/v1-api-reference/api/invoices/delete_deleteinvoice","metadata":{"seo":{"title":"Delete an invoice","description":"Deletes a specific invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_DeleteInvoice","name":"Delete an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete 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":"Deletes a specific invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to delete an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 100 items, the invoice is deleted synchronously. Otherwise, the invoice is deleted asynchronously. If you want to change the threshold, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/invoices/{invoiceKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}","href":"invoices/delete_deleteinvoice","openApiOperationId":"DELETE_DeleteInvoice","summary":"Delete an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/delete_deleteinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}"},{"label":"Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/get_getinvoice","routeSlug":"/v1-api-reference/api/invoices/get_getinvoice","metadata":{"seo":{"title":"Retrieve an invoice","description":"Retrieves a specific invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_GetInvoice","name":"Retrieve an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/get","hasSamples":false},"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 a specific invoice.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoices/{invoiceKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}","href":"invoices/get_getinvoice","openApiOperationId":"Get_GetInvoice","summary":"Retrieve an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/get_getinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}"},{"label":"Update an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/put_updateinvoice","routeSlug":"/v1-api-reference/api/invoices/put_updateinvoice","metadata":{"seo":{"title":"Update an invoice","description":"Updates a specific invoice.The following tutorials demonstrate how to use this operation:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateInvoice","name":"Update an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update 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":"Updates a specific invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following tutorials demonstrate how to use this operation:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/unified-invoicing/invoice-items-of-draft-standalone-invoices/manage-invoice-items-of-draft-standalone-invoices-through-the-rest-api","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add and delete invoice items of draft standalone invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/unified-invoicing/due-dates-of-draft-standalone-invoices-editing/edit-the-due-date-on-draft-standalone-invoices-through-the-rest-api","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit due dates of draft standalone invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/unified-invoicing/invoice-item-prices-and-custom-fields-of-draft-standalone-invoices-editing/edit-the-invoice-item-prices-and-custom-fields-of-standalone-invoices-through-the-rest-api","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit invoice item prices and custom fields of draft standalone invoices"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutInvoiceType"}},"schemaId":"components/schemas/PutInvoiceType","pointer":"/paths/~1v1~1invoices~1{invoiceKey}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoices/{invoiceKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutInvoiceType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}","href":"invoices/put_updateinvoice","openApiOperationId":"PUT_UpdateInvoice","summary":"Update an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutInvoiceType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutInvoiceType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PutInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/put_updateinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}"},{"label":"Cancel an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/cancelinvoice","routeSlug":"/v1-api-reference/api/invoices/cancelinvoice","metadata":{"seo":{"title":"Cancel an invoice","description":"Cancel the invoice synchronously or asynchronously based on the number of invoiceitems it contains. By default, Zuora cancels invoices with fewer than 1,000 invoiceitems synchronously and cancels invoices with 1,000 or more invoice items asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelInvoice","name":"Cancel an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel 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":"Cancel the invoice synchronously or asynchronously based on the number of invoice"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"items it contains. By default, Zuora cancels invoices with fewer than 1,000 invoice"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"items synchronously and cancels invoices with 1,000 or more invoice items asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For invoices with more than 1,000 invoice items, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to determine whether the operation is still in progress or has completed. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the operation has finished. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the operation is still"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in progress, and you must check the job status later to confirm completion."},"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":" To change this threshold, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoices/{invoiceKey}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/cancel","href":"invoices/cancelinvoice","openApiOperationId":"cancelInvoice","summary":"Cancel an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancelInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CancelInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CancelInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancelInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/cancelinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/cancel"},{"label":"List all application parts of an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/get_invoiceapplicationparts","routeSlug":"/v1-api-reference/api/invoices/get_invoiceapplicationparts","metadata":{"seo":{"title":"List all application parts of an invoice","description":"Note: This operation is only available if you have Invoice Settlementenabled. The Invoice Settlement feature is generally available as of Zuora BillingRelease 296 (March 2021). This feature includes Unapplied Payments, Credit andDebit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement,see Invoice Settlement Enablement and Checklist Guidefor more information.If you are using Zuora version 341 or later, this operation returns only processed payments applied to the invoice. If you are using a version earlier than 341, the behavior remains unchanged, and this operation returns all payments associated with the invoice, regardless of payment status.Retrieves information about the payments or credit memos that are applied to aspecified invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_InvoiceApplicationParts","name":"List all application parts of an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all application parts of 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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled. The Invoice Settlement feature is generally available as of Zuora Billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Release 296 (March 2021). This feature includes Unapplied Payments, Credit and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement,"},"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://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":"If you are using Zuora version 341 or later, this operation returns only processed payments applied to the invoice. If you are using a version earlier than 341, the behavior remains unchanged, and this operation returns all payments associated with the invoice, regardless of payment status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves information about the payments or credit memos that are applied to a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified invoice."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoices/{invoiceKey}/application-parts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/application-parts","href":"invoices/get_invoiceapplicationparts","openApiOperationId":"GET_InvoiceApplicationParts","summary":"List all application parts of an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetInvoiceApplicationPartCollectionType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetInvoiceApplicationPartCollectionType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetInvoiceApplicationPartCollectionType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetInvoiceApplicationPartCollectionType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/get_invoiceapplicationparts"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/application-parts"},{"label":"Email an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_emailinvoice","routeSlug":"/v1-api-reference/api/invoices/post_emailinvoice","metadata":{"seo":{"title":"Email an invoice","description":"Sends a posted invoice to the specified email addresses manually."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_EmailInvoice","name":"Email an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1emails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email 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":"Sends a posted invoice to the specified email addresses manually."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"invoices/post_emailinvoice/request/notes","deepLinkHash":"/invoices/post_emailinvoice#invoices/post_emailinvoice/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"You must activate the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Email For Invoice | Manual Email For Invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notification before emailing invoices. To include the invoice PDF in the email, select the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include Invoice PDF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" check box in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-notification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and Edit Notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"Zuora sends the email messages based on the email template you set. You can set the email template to use in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" panel of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. By default, the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Posted Default Email Template"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" template is used. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-email-template"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and Edit Email Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"The invoices are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useEmailTemplateSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"The email addresses are not specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailAddresses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1emails/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1emails/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostInvoiceEmailRequestType"}},"schemaId":"components/schemas/PostInvoiceEmailRequestType","pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1emails/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoices/{invoiceKey}/emails","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostInvoiceEmailRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/emails","href":"invoices/post_emailinvoice","openApiOperationId":"POST_EmailInvoice","summary":"Email an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostInvoiceEmailRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostInvoiceEmailRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/post_emailinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/emails"},{"label":"List all files of an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/get_invoicefiles","routeSlug":"/v1-api-reference/api/invoices/get_invoicefiles","metadata":{"seo":{"title":"List all files of an invoice","description":"Retrieves the information about all PDF files of a specified invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_InvoiceFiles","name":"List all files of an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all files of 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":"Retrieves the information about all PDF files of a specified invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice PDF files are returned in reverse chronological order by the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"versionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/Action_POSTquery"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action to get the latest PDF file, for example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"select Body from Invoice where Id = '2c93808457d787030157e0324aea5158'\""},"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":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-soap-api-object-invoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query an Invoice Body"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1files/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1files/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoices/{invoiceKey}/files","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/files","href":"invoices/get_invoicefiles","openApiOperationId":"GET_InvoiceFiles","summary":"List all files of an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETInvoiceFilesResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETInvoiceFilesResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETInvoiceFilesResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETInvoiceFilesResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/get_invoicefiles"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/files"},{"label":"Upload a file for an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_uploadfileforinvoice","routeSlug":"/v1-api-reference/api/invoices/post_uploadfileforinvoice","metadata":{"seo":{"title":"Upload a file for an invoice","description":"Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status.To use this operation, you must enable the Modify Invoice permission. See Billing Permissions for more information.This operation has the following restrictions:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_UploadFileForInvoice","name":"Upload a file for an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a file for 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":"Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this operation, you must enable the Modify Invoice permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Permissions"},"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":"This operation has the following restrictions:"},"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":"Only the PDF file format is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum size of the PDF file to upload is 4 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A maximum of 50 PDF files can be uploaded for one invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure that each uploaded PDF file has a unique name. Duplicate filenames are not allowed when attaching files to an invoice."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1files/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_72"}},"schemaId":"schema_72","pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoices/{invoiceKey}/files","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_72"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/files","href":"invoices/post_uploadfileforinvoice","openApiOperationId":"POST_UploadFileForInvoice","summary":"Upload a file for an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_72","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_72"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/post_uploadfileforinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/files"},{"label":"List all items of an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/get_invoiceitems","routeSlug":"/v1-api-reference/api/invoices/get_invoiceitems","metadata":{"seo":{"title":"List all items of an invoice","description":"Retrieves the information about all items of a specified invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_InvoiceItems","name":"List all items of an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all items of an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the information about all items of a specified invoice. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoices/{invoiceKey}/items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/items","href":"invoices/get_invoiceitems","openApiOperationId":"GET_InvoiceItems","summary":"List all items of an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETInvoiceItemsResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETInvoiceItemsResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETInvoiceItemsResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETInvoiceItemsResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/get_invoiceitems"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/items"},{"label":"List all taxation items of an invoice item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/get_taxationitemsofinvoiceitem","routeSlug":"/v1-api-reference/api/invoices/get_taxationitemsofinvoiceitem","metadata":{"seo":{"title":"List all taxation items of an invoice item","description":"Retrieves information about the taxation items of a specific invoice item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_TaxationItemsOfInvoiceItem","name":"List all taxation items of an invoice item","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all taxation items of 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 information about the taxation items of a specific invoice item. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n","required":true},{"name":"itemId","in":"path","schemaId":"schema_5","description":"The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoices/{invoiceKey}/items/{itemId}/taxation-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"},{"name":"itemId","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/items/{itemId}/taxation-items","href":"invoices/get_taxationitemsofinvoiceitem","openApiOperationId":"GET_TaxationItemsOfInvoiceItem","summary":"List all taxation items of an invoice item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETInvoiceTaxationItemsResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETInvoiceTaxationItemsResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.        \n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_73"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETInvoiceTaxationItemsResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETInvoiceTaxationItemsResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/get_taxationitemsofinvoiceitem"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/items/{itemId}/taxation-items"},{"label":"Reverse an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/put_reverseinvoice","routeSlug":"/v1-api-reference/api/invoices/put_reverseinvoice","metadata":{"seo":{"title":"Reverse an invoice","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_ReverseInvoice","name":"Reverse an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1reverse/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverse 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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverses a posted invoice. The reversal operation is performed asynchronously when the invoice contains more than 2,000 items in total."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the specified invoice was created through invoice splitting, reversing that  invoice also reverses all split invoices that were generated from the same original invoice.  The original parent invoice remains in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status and is not reversed."},"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":"Restrictions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You are not allowed to reverse an invoice if any of the following restrictions is met:"},"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":"Payments and credit memos are applied to the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice is split."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice is not in Posted status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of the invoice is less than 0 (a negative invoice)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using Tax Connector for Extension Platform to calculate taxes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An invoice contains more than 50,000 items in total, including invoice items, discount items, and taxation items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-Invoice-reversal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Reversal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutReverseInvoiceType"}},"schemaId":"components/schemas/PutReverseInvoiceType","pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoices/{invoiceKey}/reverse","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutReverseInvoiceType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/reverse","href":"invoices/put_reverseinvoice","openApiOperationId":"PUT_ReverseInvoice","summary":"Reverse an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutReverseInvoiceType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutReverseInvoiceType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutReverseInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PutReverseInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutReverseInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutReverseInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/put_reverseinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/reverse"},{"label":"Split an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/splitinvoice","routeSlug":"/v1-api-reference/api/invoices/splitinvoice","metadata":{"seo":{"title":"Split an invoice","description":"Splits a draft invoice into 2 to 20 invoices based on specified amounts or percentages. The source invoice must be in Draft status. For amount-based splits, the sum of all split amounts must exactly equal the original invoice total, and each split amount must be at least the minimum currency unit. For percentage-based splits, the sum of all split percentages must be exactly 100, up to 9 decimal places. Zuora distributes charges, discounts, tax amounts, and tax-exempt amounts proportionally across split invoices and uses a Largest Remainder algorithm to ensure precise rounding at both the line and invoice levels."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"splitInvoice","name":"Split an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1split/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Split 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":"Splits a draft invoice into 2 to 20 invoices based on specified amounts or percentages. The source invoice must be in Draft status. For amount-based splits, the sum of all split amounts must exactly equal the original invoice total, and each split amount must be at least the minimum currency unit. For percentage-based splits, the sum of all split percentages must be exactly 100, up to 9 decimal places. Zuora distributes charges, discounts, tax amounts, and tax-exempt amounts proportionally across split invoices and uses a Largest Remainder algorithm to ensure precise rounding at both the line and invoice levels."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In exclusive-tax mode, split amounts can be specified excluding tax, with tax calculated at posting, or including tax when draft tax is calculated. In inclusive-tax mode, split amounts always represent tax-inclusive invoice totals, with embedded tax distributed proportionally."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For invoices with a large number of invoice items, this operation might be processed asynchronously. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response to determine the job status:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the operation has finished and the response contains the result."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the operation is still in progress, and you must retrieve the job status later to confirm completion."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1split/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1split/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SplitInvoiceRequest"}},"schemaId":"components/schemas/SplitInvoiceRequest","pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1split/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoices/{invoiceKey}/split","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SplitInvoiceRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/split","href":"invoices/splitinvoice","openApiOperationId":"splitInvoice","summary":"Split an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/SplitInvoiceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SplitInvoiceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SplitInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SplitInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SplitInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SplitInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/splitinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/split"},{"label":"Create taxation items for an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/post_inv_taxationitems","routeSlug":"/v1-api-reference/api/invoices/post_inv_taxationitems","metadata":{"seo":{"title":"Create taxation items for an invoice","description":"Creates taxation items for an invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_INV_TaxationItems","name":"Create taxation items for an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create taxation items for an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates taxation items for an invoice.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTTaxationItemList"}},"schemaId":"components/schemas/POSTTaxationItemList","pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoices/{invoiceKey}/taxation-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTTaxationItemList"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/taxation-items","href":"invoices/post_inv_taxationitems","openApiOperationId":"POST_INV_TaxationItems","summary":"Create taxation items for an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTTaxationItemList","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTTaxationItemList"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/post_inv_taxationitems"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/taxation-items"},{"label":"Write off an invoice asynchronously","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/writeoffinvoiceasync","routeSlug":"/v1-api-reference/api/invoices/writeoffinvoiceasync","metadata":{"seo":{"title":"Write off an invoice asynchronously","description":"Asynchronously writes off a posted invoice. By writing off an invoice, a credit memo is created and applied to the invoice. If theinvoice contains more than 2,000 items, this operation is performed asynchronously. Use the Retrieve invoice write-off async joboperation to track the status of the async job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"writeOffInvoiceAsync","name":"Write off an invoice asynchronously","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Write off an invoice asynchronously","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":"Asynchronously writes off a posted invoice. By writing off an invoice, a credit memo is created and applied to the invoice. If the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice contains more than 2,000 items, this operation is performed asynchronously. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/invoices/retrieveinvoicewriteoffasyncjob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve invoice write-off async job"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operation to track the status of the async job."},"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/adjust-invoice-amounts/invoice-settlement/get-started-with-invoice-settlement/invoice-settlement-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/adjust-invoice-amounts/invoice-settlement/invoice-settlement-migration-checklist-and-guide","target":"“_blank”"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WriteOffInvoiceRequest"}},"schemaId":"components/schemas/WriteOffInvoiceRequest","pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoices/{invoiceKey}/write-off-async","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WriteOffInvoiceRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/write-off-async","href":"invoices/writeoffinvoiceasync","openApiOperationId":"writeOffInvoiceAsync","summary":"Write off an invoice asynchronously"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/WriteOffInvoiceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WriteOffInvoiceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOffInvoiceAsyncJobResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/WriteOffInvoiceAsyncJobResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_41"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WriteOffInvoiceAsyncJobResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOffInvoiceAsyncJobResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/writeoffinvoiceasync"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/write-off-async"},{"label":"Retrieve an invoice write-off async job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/retrieveinvoicewriteoffasyncjob","routeSlug":"/v1-api-reference/api/invoices/retrieveinvoicewriteoffasyncjob","metadata":{"seo":{"title":"Retrieve an invoice write-off async job","description":"Retrieves information about a specific asynchronous invoice write-off job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveInvoiceWriteOffAsyncJob","name":"Retrieve an invoice write-off async job","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an invoice write-off async job","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 information about a specific asynchronous invoice write-off job."},"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/adjust-invoice-amounts/invoice-settlement/get-started-with-invoice-settlement/invoice-settlement-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/adjust-invoice-amounts/invoice-settlement/invoice-settlement-migration-checklist-and-guide","target":"“_blank”"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"asyncJobId","in":"path","schemaId":"schema_5","description":"The unique ID of the invoice write-off async job. For example, 8a92ade496140e830196141f6cfa0001.","required":true}],"pointer":"/paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoices/write-off-async-jobs/{asyncJobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"asyncJobId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/write-off-async-jobs/{asyncJobId}","href":"invoices/retrieveinvoicewriteoffasyncjob","openApiOperationId":"retrieveInvoiceWriteOffAsyncJob","summary":"Retrieve an invoice write-off async job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOffInvoiceAsyncJobResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/WriteOffInvoiceAsyncJobResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonErrorResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonErrorResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_41"}],"pointer":"/paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WriteOffInvoiceAsyncJobResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOffInvoiceAsyncJobResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonErrorResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonErrorResponse","exampleIds":["paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/retrieveinvoicewriteoffasyncjob"}],"panels":[]}]},"httpPath":"/v1/invoices/write-off-async-jobs/{asyncJobId}"},{"label":"Write off an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/put_writeoffinvoice","routeSlug":"/v1-api-reference/api/invoices/put_writeoffinvoice","metadata":{"seo":{"title":"Write off an invoice","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_WriteOffInvoice","name":"Write off an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1write-off/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Write off 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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Writes off a posted invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By writing off an invoice, a credit memo is created and applied to the invoice. The generated credit memo items and credit memo taxation items are applied to invoice items and invoice taxation items based on the configured default application rule. If an invoice is written off, the balance of each invoice item and invoice taxation item must be zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create credit memos mirroring invoice items billing rule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can write off an invoice even if all its items have zero balance."},"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":"Restrictions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You cannot write off an invoice if any of the following restrictions is met:"},"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 balance of an invoice has been changed before Invoice Settlement is enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items."},"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://docs.zuora.com?resourceId=billing-write-off-invoices"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Write-off"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTWriteOffInvoiceRequest"}},"schemaId":"components/schemas/PUTWriteOffInvoiceRequest","pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoices/{invoiceKey}/write-off","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTWriteOffInvoiceRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/write-off","href":"invoices/put_writeoffinvoice","openApiOperationId":"PUT_WriteOffInvoice","summary":"Write off an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTWriteOffInvoiceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTWriteOffInvoiceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTWriteOffInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTWriteOffInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTWriteOffInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTWriteOffInvoiceResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/put_writeoffinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/write-off"},{"label":"Unpost an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoices/unpostinvoice","routeSlug":"/v1-api-reference/api/invoices/unpostinvoice","metadata":{"seo":{"title":"Unpost an invoice","description":"Unposts a posted invoice and changes its status to Draft."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unpostInvoice","name":"Unpost an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1unpost/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unpost 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":"Unposts a posted invoice and changes its status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For invoices with a large number of invoice items, Zuora might process this operation asynchronously. In this case, the response returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobStatus"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operations/get_operationjob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an operation job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to retrieve the job status until processing is complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the operation completed synchronously and the response includes the unposted invoice details."},"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":"When an invoice and a credit memo contain items generated from the same rate plan charge, posting or unposting either document automatically posts or unposts the other."},"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":"Restrictions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot unpost an invoice if any of the following restrictions is met:"},"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 invoice is not in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Posted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments or adjustments are applied to the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-cancelled memos have been created from the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit memos are applied to the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice does not satisfy other applicable unpost validations, such as e-invoicing validation."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoices/{invoiceKey}/unpost","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/unpost","href":"invoices/unpostinvoice","openApiOperationId":"unpostInvoice","summary":"Unpost an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnpostInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/synchronous","paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/asynchronous"]}},"schemaId":"components/schemas/UnpostInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/synchronous","paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/asynchronous"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UnpostInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/synchronous","paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/asynchronous"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnpostInvoiceResponseType","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/synchronous","paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/asynchronous"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/unpostinvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/unpost"}],"content":{"contentType":"group","meta":{"name":"Invoices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoices","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":"Invoices provides information about customers' accounts for invoices, for examples, dates, status, and amounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about invoices, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-management","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/invoices","summary":"Create a standalone invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/post_standaloneinvoice","deprecated":false},{"title":"/v1/invoices","summary":"Update invoices","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/put_batchupdateinvoices","deprecated":false},{"title":"/v1/invoices/batch","summary":"Create standalone invoices","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/post_standaloneinvoices","deprecated":false},{"title":"/v1/invoices/bulk-post","summary":"Post invoices","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/post_postinvoices","deprecated":false},{"title":"/v1/invoices/pdf-status","summary":"Retrieve the PDF file generation status of invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoicepdfstatus","deprecated":false},{"title":"/v1/invoices/{invoiceKey}","summary":"Delete an invoice","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoices/delete_deleteinvoice","deprecated":false},{"title":"/v1/invoices/{invoiceKey}","summary":"Retrieve an invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/get_getinvoice","deprecated":false},{"title":"/v1/invoices/{invoiceKey}","summary":"Update an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/put_updateinvoice","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/cancel","summary":"Cancel an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/cancelinvoice","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/application-parts","summary":"List all application parts of an invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/get_invoiceapplicationparts","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/emails","summary":"Email an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/post_emailinvoice","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/files","summary":"List all files of an invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/get_invoicefiles","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/files","summary":"Upload a file for an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/post_uploadfileforinvoice","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/items","summary":"List all items of an invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/get_invoiceitems","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/items/{itemId}/taxation-items","summary":"List all taxation items of an invoice item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/get_taxationitemsofinvoiceitem","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/reverse","summary":"Reverse an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/put_reverseinvoice","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/split","summary":"Split an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/splitinvoice","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/taxation-items","summary":"Create taxation items for an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/post_inv_taxationitems","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/write-off-async","summary":"Write off an invoice asynchronously","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/writeoffinvoiceasync","deprecated":false},{"title":"/v1/invoices/write-off-async-jobs/{asyncJobId}","summary":"Retrieve an invoice write-off async job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/retrieveinvoicewriteoffasyncjob","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/write-off","summary":"Write off an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/put_writeoffinvoice","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/unpost","summary":"Unpost an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/unpostinvoice","deprecated":false}]}]}]}]}},{"type":"group","label":"Credit Memos","link":"/v1-api-reference/api/credit-memos","routeSlug":"/v1-api-reference/api/credit-memos","items":[{"label":"List credit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemos","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemos","metadata":{"seo":{"title":"List credit memos","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CreditMemos","name":"List credit memos","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List credit memos","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all credit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a use case of this operation, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get credit memo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"credit-memos/get_creditmemos/request/filtering","deepLinkHash":"/credit-memos/get_creditmemos#credit-memos/get_creditmemos/request/filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body."},"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 a filterable field is string, you can set the corresponding query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when filtering. Then, you can get the response data with this field value being "},"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":"Examples:"},"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":"/v1/credit-memos?status=Posted"},"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":"/v1/credit-memos?referredInvoiceId=null&status=Draft"},"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":"/v1/credit-memos?status=Posted&type=External&sort=+number"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"accountId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"accountNumber","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"amount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"appliedAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appliedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"autoApplyUponPosting","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autoApplyUponPosting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdDate","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"creditMemoDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditMemoDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"currency","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"excludeFromAutoApplyRules","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeFromAutoApplyRules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"number","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"referredInvoiceId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referredInvoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"refundAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sourceId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"targetDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"taxAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"totalTaxExemptAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalTaxExemptAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"transferredToAccounting","in":"query","schemaId":"schema_76","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transferredToAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"unappliedAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unappliedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedDate","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the response data is displayed in descending order by credit memo number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field. The supported sortable fields of this operation are as below:"},"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":"accountId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"appliedAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditMemoDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referredInvoiceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refundAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"targetDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalTaxExemptAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transferredToAccounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unappliedAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedDate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"/v1/credit-memos?sort=+number"},"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":"/v1/credit-memos?status=Processed&sort=-number,+amount"},"children":[]}]}]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"accountId","in":"query","required":false,"schemaId":"schema_5"},{"name":"accountNumber","in":"query","required":false,"schemaId":"schema_5"},{"name":"amount","in":"query","required":false,"schemaId":"schema_74"},{"name":"appliedAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"autoApplyUponPosting","in":"query","required":false,"schemaId":"schema_27"},{"name":"createdById","in":"query","required":false,"schemaId":"schema_5"},{"name":"createdDate","in":"query","required":false,"schemaId":"schema_5"},{"name":"creditMemoDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"currency","in":"query","required":false,"schemaId":"schema_5"},{"name":"excludeFromAutoApplyRules","in":"query","required":false,"schemaId":"schema_27"},{"name":"number","in":"query","required":false,"schemaId":"schema_5"},{"name":"referredInvoiceId","in":"query","required":false,"schemaId":"schema_5"},{"name":"refundAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"sourceId","in":"query","required":false,"schemaId":"schema_5"},{"name":"status","in":"query","required":false,"schemaId":"schema_75"},{"name":"targetDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"taxAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"totalTaxExemptAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"transferredToAccounting","in":"query","required":false,"schemaId":"schema_76"},{"name":"unappliedAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"updatedById","in":"query","required":false,"schemaId":"schema_5"},{"name":"updatedDate","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos","href":"credit-memos/get_creditmemos","openApiOperationId":"GET_CreditMemos","summary":"List credit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoCollectionType","exampleIds":["paths/~1v1~1credit-memos/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoCollectionType","exampleIds":["paths/~1v1~1credit-memos/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoCollectionType","exampleIds":["paths/~1v1~1credit-memos/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoCollectionType","exampleIds":["paths/~1v1~1credit-memos/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/get_creditmemos"}],"panels":[]}]},"httpPath":"/v1/credit-memos"},{"label":"Create a credit memo from a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_creditmemofromprpc","routeSlug":"/v1-api-reference/api/credit-memos/post_creditmemofromprpc","metadata":{"seo":{"title":"Create a credit memo from a charge","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreditMemoFromPrpc","name":"Create a credit memo from a charge","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a credit memo from a charge","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an ad-hoc credit memo from a product rate plan charge. Zuora supports the creation of credit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When credit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a credit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoFromChargeRequest"}},"schemaId":"components/schemas/CreditMemoFromChargeRequest","pointer":"/paths/~1v1~1credit-memos/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/credit-memos","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemoFromChargeRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos","href":"credit-memos/post_creditmemofromprpc","openApiOperationId":"POST_CreditMemoFromPrpc","summary":"Create a credit memo from a charge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreditMemoFromChargeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoFromChargeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/post_creditmemofromprpc"}],"panels":[]}]},"httpPath":"/v1/credit-memos"},{"label":"Create credit memos","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_createcreditmemos","routeSlug":"/v1-api-reference/api/credit-memos/post_createcreditmemos","metadata":{"seo":{"title":"Create credit memos","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateCreditMemos","name":"Create credit memos","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create credit memos","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates multiple credit memos from invoices or product rate plan charges. You can create a maximum of 50 credit memos in one single request."},"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 you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple credit memos from invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple credit memos from product rate plan charges."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memos that are created are each in separate database transactions. If the creation of one credit memo fails, other credit memos can still be created successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create credit memos only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero-amount memo items are supported in the following scenarios:"},"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 you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTBulkCreditMemosRequestType"}},"schemaId":"components/schemas/POSTBulkCreditMemosRequestType","pointer":"/paths/~1v1~1credit-memos~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/credit-memos/bulk","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTBulkCreditMemosRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/bulk","href":"credit-memos/post_createcreditmemos","openApiOperationId":"POST_CreateCreditMemos","summary":"Create credit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTBulkCreditMemosRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTBulkCreditMemosRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkCreditMemosResponseType","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/BulkCreditMemosResponseType","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkCreditMemosResponseType","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkCreditMemosResponseType","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/post_createcreditmemos"}],"panels":[]}]},"httpPath":"/v1/credit-memos/bulk"},{"label":"Update credit memos","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_updatecreditmemos","routeSlug":"/v1-api-reference/api/credit-memos/put_updatecreditmemos","metadata":{"seo":{"title":"Update credit memos","description":"Notes:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateCreditMemos","name":"Update credit memos","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1bulk/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update credit memos","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update credit memos only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the basic and finance information about multiple credit memos. You can update a maximum of 50 credit memos in one single request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions:"},"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 memo is created from a product rate plan charge and you use Avalara to calculate the tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-edit-credit-and-debit-memos","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit credit and debit memos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tutorial demonstrates how to use this operation to add and delete memo items."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memos that are updated are each in separate database transactions. If the update of one credit memo fails, other credit memos can still be updated successfully."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1bulk/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTBulkCreditMemosRequestType"}},"schemaId":"components/schemas/PUTBulkCreditMemosRequestType","pointer":"/paths/~1v1~1credit-memos~1bulk/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/bulk","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTBulkCreditMemosRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/bulk","href":"credit-memos/put_updatecreditmemos","openApiOperationId":"PUT_UpdateCreditMemos","summary":"Update credit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTBulkCreditMemosRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTBulkCreditMemosRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkCreditMemosResponseType","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/BulkCreditMemosResponseType","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1bulk/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkCreditMemosResponseType","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkCreditMemosResponseType","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/put_updatecreditmemos"}],"panels":[]}]},"httpPath":"/v1/credit-memos/bulk"},{"label":"Retrieve the PDF file generation status of credit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemopdfstatus","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemopdfstatus","metadata":{"seo":{"title":"Retrieve the PDF file generation status of credit memos","description":"Retrieves the PDF generation statuses of a batch of credit memos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_CreditMemoPdfStatus","name":"Retrieve the PDF file generation status of credit memos","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1pdf-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the PDF file generation status of credit memos","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the PDF generation statuses of a batch of credit memos.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"creditMemoKeys","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs or numbers of the credit memos separated by commas. For example - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?creditMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,CM0000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A maximum of 50 keys can be entered in this field."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1credit-memos~1pdf-status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1pdf-status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/pdf-status","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"creditMemoKeys","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","500","4XX"],"pointer":"/v1/credit-memos/pdf-status","href":"credit-memos/get_creditmemopdfstatus","openApiOperationId":"Get_CreditMemoPdfStatus","summary":"Retrieve the PDF file generation status of credit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCreditMemoPdfStatusBatchResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetCreditMemoPdfStatusBatchResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/400/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/401/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"},"children":[]}]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}}},"headerSchemaId":"schema_71"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1pdf-status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCreditMemoPdfStatusBatchResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCreditMemoPdfStatusBatchResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/get_creditmemopdfstatus"}],"panels":[]}]},"httpPath":"/v1/credit-memos/pdf-status"},{"label":"List all taxation items of a credit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_taxationitemsofcreditmemoitem","routeSlug":"/v1-api-reference/api/credit-memos/get_taxationitemsofcreditmemoitem","metadata":{"seo":{"title":"List all taxation items of a credit memo item","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_TaxationItemsOfCreditMemoItem","name":"List all taxation items of a credit memo item","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all taxation items of a credit memo item","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves information about the taxation items of a specific credit memo item."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cmitemid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a credit memo item. You can get the credit memo item ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List credit memo items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"creditMemoId","in":"path","schemaId":"schema_5","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/{creditMemoId}/items/{cmitemid}/taxation-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"cmitemid","in":"path","required":true,"schemaId":"schema_5"},{"name":"creditMemoId","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoId}/items/{cmitemid}/taxation-items","href":"credit-memos/get_taxationitemsofcreditmemoitem","openApiOperationId":"GET_TaxationItemsOfCreditMemoItem","summary":"List all taxation items of a credit memo item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemsOfCreditMemoItemType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETTaxationItemsOfCreditMemoItemType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.        \n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_73"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETTaxationItemsOfCreditMemoItemType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemsOfCreditMemoItemType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/get_taxationitemsofcreditmemoitem"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoId}/items/{cmitemid}/taxation-items"},{"label":"Write off a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_writeoffcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_writeoffcreditmemo","metadata":{"seo":{"title":"Write off a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_WriteOffCreditMemo","name":"Write off a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Write off a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Write off a fully unapplied credit memo. When writing off a credit memo, a debit memo is automatically created, and then the credit memo to be written off is fully applied to the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this operation only supports writing off credit memos that are fully unapplied. Credit memos that are not fully unapplied cannot be written off by this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoId","in":"path","schemaId":"schema_5","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTCreditMemoWriteOff"}},"schemaId":"components/schemas/PUTCreditMemoWriteOff","pointer":"/paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoId}/write-off","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTCreditMemoWriteOff"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoId}/write-off","href":"credit-memos/put_writeoffcreditmemo","openApiOperationId":"PUT_WriteOffCreditMemo","summary":"Write off a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTCreditMemoWriteOff","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTCreditMemoWriteOff"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTCreditMemoWriteOffResponseType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTCreditMemoWriteOffResponseType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTCreditMemoWriteOffResponseType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTCreditMemoWriteOffResponseType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/put_writeoffcreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoId}/write-off"},{"label":"Delete a credit memo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/delete_creditmemo","routeSlug":"/v1-api-reference/api/credit-memos/delete_creditmemo","metadata":{"seo":{"title":"Delete a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_CreditMemo","name":"Delete a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a credit memo. Only credit memos with the Cancelled status can be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a credit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/credit-memos/{creditMemoKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}","href":"credit-memos/delete_creditmemo","openApiOperationId":"DELETE_CreditMemo","summary":"Delete a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/delete_creditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}"},{"label":"Retrieve a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemo","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemo","metadata":{"seo":{"title":"Retrieve a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CreditMemo","name":"Retrieve a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/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":[{"$$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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about a specific credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a use case of this operation, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get credit memo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/{creditMemoKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}","href":"credit-memos/get_creditmemo","openApiOperationId":"GET_CreditMemo","summary":"Retrieve a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/get_creditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}"},{"label":"Update a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_updatecreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_updatecreditmemo","metadata":{"seo":{"title":"Update a credit memo","description":"Notes:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateCreditMemo","name":"Update a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"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":[{"$$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":"Notes:"},"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":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update a credit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the basic and finance information about a credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions:"},"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 memo is created from a product rate plan charge and you use Avalara to calculate the tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-edit-credit-and-debit-memos"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit credit and debit memos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tutorial demonstrates how to use this operation to add and delete memo items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTCreditMemoType"}},"schemaId":"components/schemas/PUTCreditMemoType","pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTCreditMemoType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}","href":"credit-memos/put_updatecreditmemo","openApiOperationId":"PUT_UpdateCreditMemo","summary":"Update a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTCreditMemoType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTCreditMemoType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/put_updatecreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}"},{"label":"Apply a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_applycreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_applycreditmemo","metadata":{"seo":{"title":"Apply a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_ApplyCreditMemo","name":"Apply a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies a posted credit memo to one or more invoices and debit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can apply a credit memo to an invoice or a debit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 15,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the limit is hit, you can follow the following instructions:"},"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 you want to apply one credit memo to multiple invoices or debit memos, decrease the number of invoices or debit memos 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 want to apply one credit memo to a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(number of invoice items + number of debit memo items) * number of credit memo items"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the First In First Out rule will be used instead of the Proration rule."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyCreditMemoType"}},"schemaId":"components/schemas/ApplyCreditMemoType","pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}/apply","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyCreditMemoType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/apply","href":"credit-memos/put_applycreditmemo","openApiOperationId":"PUT_ApplyCreditMemo","summary":"Apply a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ApplyCreditMemoType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyCreditMemoType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/put_applycreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/apply"},{"label":"Cancel a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_cancelcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_cancelcreditmemo","metadata":{"seo":{"title":"Cancel a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CancelCreditMemo","name":"Cancel a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a credit memo. Only credit memos with the Draft status can be cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can cancel a credit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/cancel","href":"credit-memos/put_cancelcreditmemo","openApiOperationId":"PUT_CancelCreditMemo","summary":"Cancel a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/put_cancelcreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/cancel"},{"label":"Email a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_emailcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/post_emailcreditmemo","metadata":{"seo":{"title":"Email a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_EmailCreditMemo","name":"Email a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends a posted credit memo to the specified email addresses manually."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"credit-memos/post_emailcreditmemo/request/notes","deepLinkHash":"/credit-memos/post_emailcreditmemo#credit-memos/post_emailcreditmemo/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"You must activate the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Credit Memo | Manually email Credit Memo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notification before emailing credit memos. To include the credit memo PDF in the email, select the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include Credit Memo PDF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" check box in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-notification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and Edit Notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"Zuora sends the email messages based on the email template you set. You can set the email template to use in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" panel of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. By default, the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Email for Credit Memo Default Template"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" template is used. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-email-template"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and Edit Email Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"The credit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useEmailTemplateSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"The email addresses are not specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailAddresses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostCreditMemoEmailRequestType"}},"schemaId":"components/schemas/PostCreditMemoEmailRequestType","pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/credit-memos/{creditMemoKey}/emails","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostCreditMemoEmailRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/emails","href":"credit-memos/post_emailcreditmemo","openApiOperationId":"POST_EmailCreditMemo","summary":"Email a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostCreditMemoEmailRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostCreditMemoEmailRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/post_emailcreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/emails"},{"label":"Upload a file for a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_uploadfileforcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/post_uploadfileforcreditmemo","metadata":{"seo":{"title":"Upload a file for a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_UploadFileForCreditMemo","name":"Upload a file for a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a file for a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads an externally generated PDF file for a credit memo that is in Draft or Posted status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this operation, you must enable the Modify Modify Credit Memo permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation has the following restrictions:"},"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":"Only the PDF file format is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum size of the PDF file to upload is 4 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A maximum of 50 PDF files can be uploaded for one credit memo."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_77"}},"schemaId":"schema_77","pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/credit-memos/{creditMemoKey}/files","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_77"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/files","href":"credit-memos/post_uploadfileforcreditmemo","openApiOperationId":"POST_UploadFileForCreditMemo","summary":"Upload a file for a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_77","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_77"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/post_uploadfileforcreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/files"},{"label":"List all files of a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemofiles","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemofiles","metadata":{"seo":{"title":"List all files of a credit memo","description":"Retrieves the information about all PDF files of a specified credit memo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CreditMemoFiles","name":"List all files of a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all files of a credit memo","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 the information about all PDF files of a specified credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Memo PDF files are returned in reverse chronological order by the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"versionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of an credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/{creditMemoKey}/files","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/files","href":"credit-memos/get_creditmemofiles","openApiOperationId":"GET_CreditMemoFiles","summary":"List all files of a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoFilesResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoFilesResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoFilesResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoFilesResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/get_creditmemofiles"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/files"},{"label":"List credit memo items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemoitems","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemoitems","metadata":{"seo":{"title":"List credit memo items","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CreditMemoItems","name":"List credit memo items","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List credit memo items","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all items of a credit memo. A credit memo item is a single line item in a credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"credit-memos/get_creditmemoitems/request/filtering","deepLinkHash":"/credit-memos/get_creditmemoitems#credit-memos/get_creditmemoitems/request/filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body."},"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 a filterable field is string, you can set the corresponding query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when filtering. Then, you can get the response data with this field value being "},"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":"Examples:"},"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":"/v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100"},"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":"/v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"amount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"appliedAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appliedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdDate","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"refundAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"serviceEndDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"serviceStartDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sku","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"skuName","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skuName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sourceItemId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"subscriptionId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedDate","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the response data is displayed in descending order by updated date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field. The supported sortable fields of this operation are as below:"},"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":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"appliedAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refundAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceEndDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceStartDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sku"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"skuName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceItemId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedDate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"/v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate"},"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":"/v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate"},"children":[]}]}]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/{creditMemoKey}/items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"amount","in":"query","required":false,"schemaId":"schema_74"},{"name":"appliedAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"createdById","in":"query","required":false,"schemaId":"schema_5"},{"name":"createdDate","in":"query","required":false,"schemaId":"schema_23"},{"name":"id","in":"query","required":false,"schemaId":"schema_5"},{"name":"refundAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"serviceEndDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"serviceStartDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"sku","in":"query","required":false,"schemaId":"schema_5"},{"name":"skuName","in":"query","required":false,"schemaId":"schema_5"},{"name":"sourceItemId","in":"query","required":false,"schemaId":"schema_5"},{"name":"subscriptionId","in":"query","required":false,"schemaId":"schema_5"},{"name":"updatedById","in":"query","required":false,"schemaId":"schema_5"},{"name":"updatedDate","in":"query","required":false,"schemaId":"schema_23"},{"name":"sort","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/items","href":"credit-memos/get_creditmemoitems","openApiOperationId":"GET_CreditMemoItems","summary":"List credit memo items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoItemsListType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoItemsListType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoItemsListType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoItemsListType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/get_creditmemoitems"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/items"},{"label":"Retrieve a credit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemoitem","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemoitem","metadata":{"seo":{"title":"Retrieve a credit memo item","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CreditMemoItem","name":"Retrieve a credit memo item","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a credit memo item","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about a specific item of a credit memo. A credit memo item is a single line item in a credit memo."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cmitemid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a credit memo item. You can get the credit memo item ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List credit memo items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/{creditMemoKey}/items/{cmitemid}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"cmitemid","in":"path","required":true,"schemaId":"schema_5"},{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/items/{cmitemid}","href":"credit-memos/get_creditmemoitem","openApiOperationId":"GET_CreditMemoItem","summary":"Retrieve a credit memo item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoItemType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoItemType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoItemType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoItemType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/get_creditmemoitem"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/items/{cmitemid}"},{"label":"List all parts of a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemoparts","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemoparts","metadata":{"seo":{"title":"List all parts of a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CreditMemoParts","name":"List all parts of a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all parts of a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all parts of a credit memo. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a credit memo. Note that a fully refunded credit memo does not contain any credit memo part."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/{creditMemoKey}/parts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/parts","href":"credit-memos/get_creditmemoparts","openApiOperationId":"GET_CreditMemoParts","summary":"List all parts of a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoPartsCollectionType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoPartsCollectionType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoPartsCollectionType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoPartsCollectionType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/get_creditmemoparts"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/parts"},{"label":"Retrieve a credit memo part","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/get_creditmemopart","routeSlug":"/v1-api-reference/api/credit-memos/get_creditmemopart","metadata":{"seo":{"title":"Retrieve a credit memo part","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CreditMemoPart","name":"Retrieve a credit memo part","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a credit memo part","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about a specific credit memo part. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fully refunded credit memo does not contain any credit memo part."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_CreditMemoParts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all parts of a credit memo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/{creditMemoKey}/parts/{partid}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"partid","in":"path","required":true,"schemaId":"schema_5"},{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/parts/{partid}","href":"credit-memos/get_creditmemopart","openApiOperationId":"GET_CreditMemoPart","summary":"Retrieve a credit memo part"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoPartType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoPartType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoPartType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoPartType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/get_creditmemopart"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/parts/{partid}"},{"label":"Generate a credit memo PDF file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_creditmemopdf","routeSlug":"/v1-api-reference/api/credit-memos/post_creditmemopdf","metadata":{"seo":{"title":"Generate a credit memo PDF file","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreditMemoPDF","name":"Generate a credit memo PDF file","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a credit memo PDF 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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a PDF file for a specified credit memo. To access the generated PDF file, you can download it by clicking "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View PDF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the detailed credit memo page through the Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This REST API operation can be used only if you have the billing document file generation feature and the Billing user permission \"Regenerate PDF\" enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/credit-memos/{creditMemoKey}/pdfs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/pdfs","href":"credit-memos/post_creditmemopdf","openApiOperationId":"POST_CreditMemoPDF","summary":"Generate a credit memo PDF file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTMemoPdfResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTMemoPdfResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTMemoPdfResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTMemoPdfResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/post_creditmemopdf"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/pdfs"},{"label":"Post a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_postcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_postcreditmemo","metadata":{"seo":{"title":"Post a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PostCreditMemo","name":"Post a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Posts a credit memo to activate it. You can post credit memos only if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}/post","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/post","href":"credit-memos/put_postcreditmemo","openApiOperationId":"PUT_PostCreditMemo","summary":"Post a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/put_postcreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/post"},{"label":"Refund a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_refundcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/post_refundcreditmemo","metadata":{"seo":{"title":"Refund a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_RefundCreditMemo","name":"Refund a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post","hasSamples":true},"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":[{"$$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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunds a full or partial posted credit memo to your customers. Only the amount of unapplied part could be refunded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can refund a credit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you refund a credit memo, the total number of credit memo items to be refunded must be less than or equal to 15,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a use case of this operation, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/rest-api/general-concepts/authentication//#Refund-processing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostNonRefRefundType"}},"schemaId":"components/schemas/PostNonRefRefundType","pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/credit-memos/{creditMemoKey}/refund","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostNonRefRefundType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/refund","href":"credit-memos/post_refundcreditmemo","openApiOperationId":"POST_RefundCreditMemo","summary":"Refund a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostNonRefRefundType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostNonRefRefundType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRefundCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRefundCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/post_refundcreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/refund"},{"label":"Reverse a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_reversecreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_reversecreditmemo","metadata":{"seo":{"title":"Reverse a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_ReverseCreditMemo","name":"Reverse a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverse a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverses a posted credit memo. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-reversal-of-credit-memos"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverse credit memos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can reverse a credit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"Restrictions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot reverse credit memos if any of the following conditions is met:"},"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":"A credit memo's applied amount is not 0."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A credit memo is not in Posted status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A credit memo contains more than 2,000 items in total, including credit memo items, discount items, and taxation items."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutReverseCreditMemoType"}},"schemaId":"components/schemas/PutReverseCreditMemoType","pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}/reverse","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutReverseCreditMemoType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/reverse","href":"credit-memos/put_reversecreditmemo","openApiOperationId":"PUT_ReverseCreditMemo","summary":"Reverse a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutReverseCreditMemoType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutReverseCreditMemoType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutReverseCreditMemoResponseType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PutReverseCreditMemoResponseType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutReverseCreditMemoResponseType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutReverseCreditMemoResponseType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/put_reversecreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/reverse"},{"label":"Create taxation items for a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_cm_taxationitems","routeSlug":"/v1-api-reference/api/credit-memos/post_cm_taxationitems","metadata":{"seo":{"title":"Create taxation items for a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CM_TaxationItems","name":"Create taxation items for a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create taxation items for a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates taxation items for a credit memo."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTTaxationItemListForCMType"}},"schemaId":"components/schemas/POSTTaxationItemListForCMType","pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/credit-memos/{creditMemoKey}/taxation-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTTaxationItemListForCMType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/taxation-items","href":"credit-memos/post_cm_taxationitems","openApiOperationId":"POST_CM_TaxationItems","summary":"Create taxation items for a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTTaxationItemListForCMType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTTaxationItemListForCMType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/post_cm_taxationitems"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/taxation-items"},{"label":"Unapply a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_unapplycreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_unapplycreditmemo","metadata":{"seo":{"title":"Unapply a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UnapplyCreditMemo","name":"Unapply a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unapply a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unapplies an applied credit memo from one or more invoices and debit memos. The full applied amount from invoices and debit memos is transferred into the unapplied amount of the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can unapply a credit memo from an invoice or a debit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 15,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the limit is hit, you can follow the following instructions:"},"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 you want to unapply one credit memo without specifying invoices or debit memos and the limit is hit, you have to specify the invoice items or debit memo items in the request to decrease the number of items."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to unapply one credit memo from multiple specified invoices or debit memos, decrease the number of invoices or debit memos 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 want to unapply one credit memo from a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When unapplying a credit memo, the total number of the credit memo's item parts must be less than or equal to 1,000. Otherwise, the operation would fail and an error message would pop up. When you see this error, you can try using the Unapply a credit memo API as an alternative. Similarly, make sure that all the requirements listed in the API reference are met."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnapplyCreditMemoType"}},"schemaId":"components/schemas/UnapplyCreditMemoType","pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}/unapply","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UnapplyCreditMemoType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/unapply","href":"credit-memos/put_unapplycreditmemo","openApiOperationId":"PUT_UnapplyCreditMemo","summary":"Unapply a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UnapplyCreditMemoType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnapplyCreditMemoType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/put_unapplycreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/unapply"},{"label":"Unpost a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/put_unpostcreditmemo","routeSlug":"/v1-api-reference/api/credit-memos/put_unpostcreditmemo","metadata":{"seo":{"title":"Unpost a credit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UnpostCreditMemo","name":"Unpost a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unpost a credit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unposts a credit memo that is in Posted status. If a credit memo has been applied or refunded, you are not allowed to unpost it. After a credit memo is unposted, its status becomes Draft."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can unpost credit memos only if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing permissions"},"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":"You can prevent  an unpost operation by configuring the  'Do not allow unposting invoices and memos if their revenue is already recognized in a closed accounting period' accounting  rule. The default value of this rule is set to 'disabled.'"},"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://docs.zuora.com?resourceId=ar-configure-accounting-rules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Accounting Rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}/unpost","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/unpost","href":"credit-memos/put_unpostcreditmemo","openApiOperationId":"PUT_UnpostCreditMemo","summary":"Unpost a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/put_unpostcreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/unpost"},{"label":"Create a credit memo from an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/post_creditmemofrominvoice","routeSlug":"/v1-api-reference/api/credit-memos/post_creditmemofrominvoice","metadata":{"seo":{"title":"Create a credit memo from an invoice","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreditMemoFromInvoice","name":"Create a credit memo from an invoice","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a credit memo from 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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an ad-hoc credit memo from an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a credit memo from an invoice only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a use case of this operation, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/rest-api/general-concepts/authentication//#Create-credit-memo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create credit memo"},"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":"Zero-amount memo items are supported in the following scenarios:"},"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 you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoFromInvoiceRequest"}},"schemaId":"components/schemas/CreditMemoFromInvoiceRequest","pointer":"/paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/credit-memos/invoice/{invoiceKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemoFromInvoiceRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/invoice/{invoiceKey}","href":"credit-memos/post_creditmemofrominvoice","openApiOperationId":"POST_CreditMemoFromInvoice","summary":"Create a credit memo from an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreditMemoFromInvoiceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoFromInvoiceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCreditMemoType","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/post_creditmemofrominvoice"}],"panels":[]}]},"httpPath":"/v1/credit-memos/invoice/{invoiceKey}"},{"label":"Retrieve an async unapply credit memo job by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/getunapplycreditmemoasyncjob","routeSlug":"/v1-api-reference/api/credit-memos/getunapplycreditmemoasyncjob","metadata":{"seo":{"title":"Retrieve an async unapply credit memo job by ID","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.Retrieves information about a specific Async Credit Memo Unapply job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUnapplyCreditMemoAsyncJob","name":"Retrieve an async unapply credit memo job by ID","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an async unapply credit memo job by ID","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"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":"Retrieves information about a specific Async Credit Memo Unapply job."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"unapplyAsyncJobId","in":"path","schemaId":"schema_5","description":"The unique ID of a Credit Memo Async Unapply Job Id. For example, 8a92ade496140e830196148cd0af000a.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"unapplyAsyncJobId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}","href":"credit-memos/getunapplycreditmemoasyncjob","openApiOperationId":"getUnapplyCreditMemoAsyncJob","summary":"Retrieve an async unapply credit memo job by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.        \n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_73"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/getunapplycreditmemoasyncjob"}],"panels":[]}]},"httpPath":"/v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}"},{"label":"Retrieve an async unapply credit memo job by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/getapplycreditmemoasyncjob","routeSlug":"/v1-api-reference/api/credit-memos/getapplycreditmemoasyncjob","metadata":{"seo":{"title":"Retrieve an async unapply credit memo job by ID","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.Retrieves information about a specific Async Credit Memo Apply job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplyCreditMemoAsyncJob","name":"Retrieve an async unapply credit memo job by ID","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an async unapply credit memo job by ID","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"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":"Retrieves information about a specific Async Credit Memo Apply job."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"applyAsyncJobId","in":"path","schemaId":"schema_5","description":"The unique ID of a Credit Memo Async Apply Job Id. For example, 8a92ade496140e830196141f6cfa0001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/apply-async-jobs/{applyAsyncJobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"applyAsyncJobId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/v1/credit-memos/apply-async-jobs/{applyAsyncJobId}","href":"credit-memos/getapplycreditmemoasyncjob","openApiOperationId":"getApplyCreditMemoAsyncJob","summary":"Retrieve an async unapply credit memo job by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.        \n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_73"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/200/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/getapplycreditmemoasyncjob"}],"panels":[]}]},"httpPath":"/v1/credit-memos/apply-async-jobs/{applyAsyncJobId}"},{"label":"Apply a credit memo aysnchronously","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/applycreditmemoasync","routeSlug":"/v1-api-reference/api/credit-memos/applycreditmemoasync","metadata":{"seo":{"title":"Apply a credit memo aysnchronously","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"applyCreditMemoAsync","name":"Apply a credit memo aysnchronously","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a credit memo aysnchronously","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronously applies a posted credit memo to one or more invoices"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can apply a credit memo to an invoice only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"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":"When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 300,000."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of invoices that you can specify in the request is 1,000"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(number of invoice items) * number of credit memo items"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the First In First Out rule will be used instead of the Proration rule."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AsyncApplyCreditMemoRequest"}},"schemaId":"components/schemas/AsyncApplyCreditMemoRequest","pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}/apply-async","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AsyncApplyCreditMemoRequest"}},"responseCodes":["200","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/apply-async","href":"credit-memos/applycreditmemoasync","openApiOperationId":"applyCreditMemoAsync","summary":"Apply a credit memo aysnchronously"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/AsyncApplyCreditMemoRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AsyncApplyCreditMemoRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.        \n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_73"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/200/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/applycreditmemoasync"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/apply-async"},{"label":"Unapply a credit memo asynchronously","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/credit-memos/unapplycreditmemoasync","routeSlug":"/v1-api-reference/api/credit-memos/unapplycreditmemoasync","metadata":{"seo":{"title":"Unapply a credit memo asynchronously","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.Asynchronously Unapplies an applied credit memo from one or more invoices. The full applied amount from invoices is transferred into the unapplied amount of the credit memo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unapplyCreditMemoAsync","name":"Unapply a credit memo asynchronously","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unapply a credit memo asynchronously","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"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":"Asynchronously Unapplies an applied credit memo from one or more invoices. The full applied amount from invoices is transferred into the unapplied amount of the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can unapply a credit memo from an invoice only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 300,000."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of invoices that you can specify in the request is 1,000"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AsyncUnapplyCreditMemoRequest"}},"schemaId":"components/schemas/AsyncUnapplyCreditMemoRequest","pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}/unapply-async","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AsyncUnapplyCreditMemoRequest"}},"responseCodes":["200","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/unapply-async","href":"credit-memos/unapplycreditmemoasync","openApiOperationId":"unapplyCreditMemoAsync","summary":"Unapply a credit memo asynchronously"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/AsyncUnapplyCreditMemoRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AsyncUnapplyCreditMemoRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.        \n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_73"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceSettlementAsyncJobResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/200/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/unapplycreditmemoasync"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/unapply-async"}],"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":"Credit memos reduce invoice and account balances. By applying one or more credit memos to invoices with positive balances, you can reduce the invoice balances in the same way that applying a payment to an 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 about credit memos, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-credit-and-debit-memos","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit and debit memos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/credit-memos","summary":"List credit memos","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/get_creditmemos","deprecated":false},{"title":"/v1/credit-memos","summary":"Create a credit memo from a charge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/post_creditmemofromprpc","deprecated":false},{"title":"/v1/credit-memos/bulk","summary":"Create credit memos","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/post_createcreditmemos","deprecated":false},{"title":"/v1/credit-memos/bulk","summary":"Update credit memos","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/put_updatecreditmemos","deprecated":false},{"title":"/v1/credit-memos/pdf-status","summary":"Retrieve the PDF file generation status of credit memos","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/get_creditmemopdfstatus","deprecated":false},{"title":"/v1/credit-memos/{creditMemoId}/items/{cmitemid}/taxation-items","summary":"List all taxation items of a credit memo item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/get_taxationitemsofcreditmemoitem","deprecated":false},{"title":"/v1/credit-memos/{creditMemoId}/write-off","summary":"Write off a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/put_writeoffcreditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}","summary":"Delete a credit memo","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credit-memos/delete_creditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}","summary":"Retrieve a credit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/get_creditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}","summary":"Update a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/put_updatecreditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/apply","summary":"Apply a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/put_applycreditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/cancel","summary":"Cancel a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/put_cancelcreditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/emails","summary":"Email a credit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/post_emailcreditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/files","summary":"Upload a file for a credit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/post_uploadfileforcreditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/files","summary":"List all files of a credit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/get_creditmemofiles","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/items","summary":"List credit memo items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/get_creditmemoitems","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/items/{cmitemid}","summary":"Retrieve a credit memo item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/get_creditmemoitem","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/parts","summary":"List all parts of a credit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/get_creditmemoparts","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/parts/{partid}","summary":"Retrieve a credit memo part","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/get_creditmemopart","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/pdfs","summary":"Generate a credit memo PDF file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/post_creditmemopdf","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/post","summary":"Post a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/put_postcreditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/refund","summary":"Refund a credit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/post_refundcreditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/reverse","summary":"Reverse a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/put_reversecreditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/taxation-items","summary":"Create taxation items for a credit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/post_cm_taxationitems","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/unapply","summary":"Unapply a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/put_unapplycreditmemo","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/unpost","summary":"Unpost a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/put_unpostcreditmemo","deprecated":false},{"title":"/v1/credit-memos/invoice/{invoiceKey}","summary":"Create a credit memo from an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/post_creditmemofrominvoice","deprecated":false},{"title":"/v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}","summary":"Retrieve an async unapply credit memo job by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/getunapplycreditmemoasyncjob","deprecated":false},{"title":"/v1/credit-memos/apply-async-jobs/{applyAsyncJobId}","summary":"Retrieve an async unapply credit memo job by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/getapplycreditmemoasyncjob","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/apply-async","summary":"Apply a credit memo aysnchronously","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/applycreditmemoasync","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/unapply-async","summary":"Unapply a credit memo asynchronously","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/unapplycreditmemoasync","deprecated":false}]}]}]}]}},{"type":"group","label":"Debit Memos","link":"/v1-api-reference/api/debit-memos","routeSlug":"/v1-api-reference/api/debit-memos","items":[{"label":"List debit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemos","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemos","metadata":{"seo":{"title":"List debit memos","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DebitMemos","name":"List debit memos","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List debit memos","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all debit memos associated with all customer accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"debit-memos/get_debitmemos/request/filtering","deepLinkHash":"/debit-memos/get_debitmemos#debit-memos/get_debitmemos/request/filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body."},"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 a filterable field is string, you can set the corresponding query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when filtering. Then, you can get the response data with this field value being "},"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":"Examples:"},"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":"/v1/debit-memos?status=Posted"},"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":"/v1/debit-memos?referredInvoiceId=null&status=Draft"},"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":"/v1/debit-memos?status=Posted&type=External&sort=+number"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"accountId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"accountNumber","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"amount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"balance","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"beAppliedAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beAppliedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdDate","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"currency","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"debitMemoDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debitMemoDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"dueDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"number","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"referredInvoiceId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referredInvoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"targetDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"taxAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"totalTaxExemptAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalTaxExemptAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedDate","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the response data is displayed in descending order by debit memo number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field. The supported sortable fields of this operation are as below:"},"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":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitMemoDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"targetDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dueDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalTaxExemptAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"beAppliedAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referredInvoiceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedById"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"/v1/debit-memos?sort=+number"},"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":"/v1/debit-memos?status=Processed&sort=-number,+amount"},"children":[]}]}]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/debit-memos","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"accountId","in":"query","required":false,"schemaId":"schema_5"},{"name":"accountNumber","in":"query","required":false,"schemaId":"schema_5"},{"name":"amount","in":"query","required":false,"schemaId":"schema_74"},{"name":"balance","in":"query","required":false,"schemaId":"schema_74"},{"name":"beAppliedAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"createdById","in":"query","required":false,"schemaId":"schema_5"},{"name":"createdDate","in":"query","required":false,"schemaId":"schema_5"},{"name":"currency","in":"query","required":false,"schemaId":"schema_5"},{"name":"debitMemoDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"dueDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"number","in":"query","required":false,"schemaId":"schema_5"},{"name":"referredInvoiceId","in":"query","required":false,"schemaId":"schema_5"},{"name":"status","in":"query","required":false,"schemaId":"schema_75"},{"name":"targetDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"taxAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"totalTaxExemptAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"updatedById","in":"query","required":false,"schemaId":"schema_5"},{"name":"updatedDate","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos","href":"debit-memos/get_debitmemos","openApiOperationId":"GET_DebitMemos","summary":"List debit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoCollectionType","exampleIds":["paths/~1v1~1debit-memos/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoCollectionType","exampleIds":["paths/~1v1~1debit-memos/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoCollectionType","exampleIds":["paths/~1v1~1debit-memos/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoCollectionType","exampleIds":["paths/~1v1~1debit-memos/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/get_debitmemos"}],"panels":[]}]},"httpPath":"/v1/debit-memos"},{"label":"Create a debit memo from a charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_debitmemofromprpc","routeSlug":"/v1-api-reference/api/debit-memos/post_debitmemofromprpc","metadata":{"seo":{"title":"Create a debit memo from a charge","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_DebitMemoFromPrpc","name":"Create a debit memo from a charge","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a debit memo from a charge","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an ad-hoc debit memo from a product rate plan charge. Zuora supports the creation of debit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When debit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a debit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemoFromChargeRequest"}},"schemaId":"components/schemas/DebitMemoFromChargeRequest","pointer":"/paths/~1v1~1debit-memos/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/debit-memos","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DebitMemoFromChargeRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos","href":"debit-memos/post_debitmemofromprpc","openApiOperationId":"POST_DebitMemoFromPrpc","summary":"Create a debit memo from a charge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/DebitMemoFromChargeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemoFromChargeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/post_debitmemofromprpc"}],"panels":[]}]},"httpPath":"/v1/debit-memos"},{"label":"Update due dates for debit memos","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_updatedebitmemosduedates","routeSlug":"/v1-api-reference/api/debit-memos/put_updatedebitmemosduedates","metadata":{"seo":{"title":"Update due dates for debit memos","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateDebitMemosDueDates","name":"Update due dates for debit memos","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update due dates for debit memos","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the due date for multiple debit memos in one single request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API operation will be deprecated. You can use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_BulkUpdateDebitMemos"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update debit memos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead, which provides more flexible functionality."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTBatchDebitMemosRequest"}},"schemaId":"components/schemas/PUTBatchDebitMemosRequest","pointer":"/paths/~1v1~1debit-memos/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/debit-memos","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTBatchDebitMemosRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos","href":"debit-memos/put_updatedebitmemosduedates","openApiOperationId":"PUT_UpdateDebitMemosDueDates","summary":"Update due dates for debit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTBatchDebitMemosRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTBatchDebitMemosRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/put_updatedebitmemosduedates"}],"panels":[]}]},"httpPath":"/v1/debit-memos"},{"label":"Create debit memos","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_createdebitmemos","routeSlug":"/v1-api-reference/api/debit-memos/post_createdebitmemos","metadata":{"seo":{"title":"Create debit memos","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateDebitMemos","name":"Create debit memos","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create debit memos","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates multiple debit memos from invoices or product rate plan charges. You can create a maximum of 50 debit memos in one single request."},"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 you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple debit memos from invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple debit memos from product rate plan charges."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The debit memos that are created are each in separate database transactions. If the creation of one debit memo fails, other debit memos can still be created successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create  debit memos only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTBulkDebitMemosRequestType"}},"schemaId":"components/schemas/POSTBulkDebitMemosRequestType","pointer":"/paths/~1v1~1debit-memos~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/debit-memos/bulk","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTBulkDebitMemosRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/bulk","href":"debit-memos/post_createdebitmemos","openApiOperationId":"POST_CreateDebitMemos","summary":"Create debit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTBulkDebitMemosRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTBulkDebitMemosRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkDebitMemosResponseType","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/BulkDebitMemosResponseType","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkDebitMemosResponseType","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkDebitMemosResponseType","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/post_createdebitmemos"}],"panels":[]}]},"httpPath":"/v1/debit-memos/bulk"},{"label":"Update debit memos","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_updatedebitmemos","routeSlug":"/v1-api-reference/api/debit-memos/put_updatedebitmemos","metadata":{"seo":{"title":"Update debit memos","description":"Notes:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateDebitMemos","name":"Update debit memos","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1bulk/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update debit memos","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update debit memos only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the basic and finance information about multiple debit memos. You can update a maximum of 50 credit memos in one single request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions:"},"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 memo is created from a product rate plan charge and you use Avalara to calculate the tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-edit-credit-and-debit-memos"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit credit and debit memos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tutorial demonstrates how to use this operation to add and delete memo items."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memos that are updated are each in separate database transactions. If the update of one debit memo fails, other debit memos can still be updated successfully."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1bulk/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTBulkDebitMemosRequestType"}},"schemaId":"components/schemas/PUTBulkDebitMemosRequestType","pointer":"/paths/~1v1~1debit-memos~1bulk/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/debit-memos/bulk","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTBulkDebitMemosRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/bulk","href":"debit-memos/put_updatedebitmemos","openApiOperationId":"PUT_UpdateDebitMemos","summary":"Update debit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTBulkDebitMemosRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTBulkDebitMemosRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkDebitMemosResponseType","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/BulkDebitMemosResponseType","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1bulk/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkDebitMemosResponseType","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkDebitMemosResponseType","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/put_updatedebitmemos"}],"panels":[]}]},"httpPath":"/v1/debit-memos/bulk"},{"label":"Retrieve the PDF file generation status of debit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemopdfstatus","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemopdfstatus","metadata":{"seo":{"title":"Retrieve the PDF file generation status of debit memos","description":"Retrieves the PDF generation statuses of a batch of debit memos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_DebitMemoPdfStatus","name":"Retrieve the PDF file generation status of debit memos","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1pdf-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the PDF file generation status of debit memos","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the PDF generation statuses of a batch of debit memos.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"debitMemoKeys","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs or numbers of the debit memos separated by commas. For example - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?debitMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,DM0000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A maximum of 50 keys can be entered in this field."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1debit-memos~1pdf-status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1pdf-status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/debit-memos/pdf-status","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"debitMemoKeys","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","500","4XX"],"pointer":"/v1/debit-memos/pdf-status","href":"debit-memos/get_debitmemopdfstatus","openApiOperationId":"Get_DebitMemoPdfStatus","summary":"Retrieve the PDF file generation status of debit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDebitMemoPdfStatusBatchResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetDebitMemoPdfStatusBatchResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/400/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/401/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"},"children":[]}]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}}},"headerSchemaId":"schema_71"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1pdf-status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetDebitMemoPdfStatusBatchResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDebitMemoPdfStatusBatchResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/get_debitmemopdfstatus"}],"panels":[]}]},"httpPath":"/v1/debit-memos/pdf-status"},{"label":"List all application parts of a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemoapplicationparts","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemoapplicationparts","metadata":{"seo":{"title":"List all application parts of a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DebitMemoApplicationParts","name":"List all application parts of a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all application parts of a debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves information about the payments or credit memos that are applied to a specified debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use the Zuora version 341.0 or a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this operation will return only processed payments applied to the debit memos. For Zuora versions earlier than 341.0,  it returns all payments associated with the debit memo regardless of the payment status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoId","in":"path","schemaId":"schema_5","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/debit-memos/{debitMemoId}/application-parts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoId}/application-parts","href":"debit-memos/get_debitmemoapplicationparts","openApiOperationId":"GET_DebitMemoApplicationParts","summary":"List all application parts of a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDebitMemoApplicationPartCollectionType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetDebitMemoApplicationPartCollectionType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetDebitMemoApplicationPartCollectionType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDebitMemoApplicationPartCollectionType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/get_debitmemoapplicationparts"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoId}/application-parts"},{"label":"List all taxation items of a debit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_taxationitemsofdebitmemoitem","routeSlug":"/v1-api-reference/api/debit-memos/get_taxationitemsofdebitmemoitem","metadata":{"seo":{"title":"List all taxation items of a debit memo item","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_TaxationItemsOfDebitMemoItem","name":"List all taxation items of a debit memo item","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all taxation items of a debit memo item","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves information about the taxation items of a specific debit memo item."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dmitemid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List debit memo items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"debitMemoId","in":"path","schemaId":"schema_5","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/debit-memos/{debitMemoId}/items/{dmitemid}/taxation-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"dmitemid","in":"path","required":true,"schemaId":"schema_5"},{"name":"debitMemoId","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoId}/items/{dmitemid}/taxation-items","href":"debit-memos/get_taxationitemsofdebitmemoitem","openApiOperationId":"GET_TaxationItemsOfDebitMemoItem","summary":"List all taxation items of a debit memo item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemsOfDebitMemoItemType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETTaxationItemsOfDebitMemoItemType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.        \n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_73"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETTaxationItemsOfDebitMemoItemType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemsOfDebitMemoItemType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/get_taxationitemsofdebitmemoitem"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoId}/items/{dmitemid}/taxation-items"},{"label":"Delete a debit memo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/delete_debitmemo","routeSlug":"/v1-api-reference/api/debit-memos/delete_debitmemo","metadata":{"seo":{"title":"Delete a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_DebitMemo","name":"Delete a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a debit memo. Only debit memos with the Cancelled status can be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a debit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"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":"The Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/debit-memos/{debitMemoKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}","href":"debit-memos/delete_debitmemo","openApiOperationId":"DELETE_DebitMemo","summary":"Delete a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/delete_debitmemo"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}"},{"label":"Retrieve a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemo","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemo","metadata":{"seo":{"title":"Retrieve a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DebitMemo","name":"Retrieve a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about a specific debit memo."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/debit-memos/{debitMemoKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}","href":"debit-memos/get_debitmemo","openApiOperationId":"GET_DebitMemo","summary":"Retrieve a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/get_debitmemo"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}"},{"label":"Update a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_debitmemo","routeSlug":"/v1-api-reference/api/debit-memos/put_debitmemo","metadata":{"seo":{"title":"Update a debit memo","description":"Notes:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_DebitMemo","name":"Update a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a debit memo","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update a debit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the basic and finance information about a debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions:"},"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 memo is created from a product rate plan charge and you use Avalara to calculate the tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-edit-credit-and-debit-memos"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit credit and debit memos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tutorial demonstrates how to use this operation to add and delete memo items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTDebitMemoType"}},"schemaId":"components/schemas/PUTDebitMemoType","pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/debit-memos/{debitMemoKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTDebitMemoType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}","href":"debit-memos/put_debitmemo","openApiOperationId":"PUT_DebitMemo","summary":"Update a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTDebitMemoType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTDebitMemoType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/put_debitmemo"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}"},{"label":"Cancel a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_canceldebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/put_canceldebitmemo","metadata":{"seo":{"title":"Cancel a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CancelDebitMemo","name":"Cancel a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a debit memo. Only debit memos with the Draft status can be cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can cancel a debit memo only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/debit-memos/{debitMemoKey}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/cancel","href":"debit-memos/put_canceldebitmemo","openApiOperationId":"PUT_CancelDebitMemo","summary":"Cancel a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/put_canceldebitmemo"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/cancel"},{"label":"Collect a posted debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_debitmemocollect","routeSlug":"/v1-api-reference/api/debit-memos/post_debitmemocollect","metadata":{"seo":{"title":"Collect a posted debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_DebitMemoCollect","name":"Collect a posted debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collect a posted debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API operation provides an easy way to let the client-side to collect an existing posted debit memo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It supports the following steps:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply unapplied credit memos to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied credit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply unapplied payments to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process payment to the posted debit memo if there is an open-balance on it."},"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":"Restrictions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since this API will do lots of works, and some of them are resource consuming, we need to restrict the usage of this API by the following conditions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the target debit memo gets more than 10 debit memo items, the request will be rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicationOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when there are more than 25 credit memos will be used to apply to the debit memo, the request will be rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicationOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when there are more than 100 credit memo items will be used to apply to the debit memo, the request will be rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"UnappliedPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicationOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when there are more than 25 payments will be used to apply to the debit memo, the request will be rejected."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemoCollectRequest"}},"schemaId":"components/schemas/DebitMemoCollectRequest","pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/debit-memos/{debitMemoKey}/collect","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DebitMemoCollectRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/collect","href":"debit-memos/post_debitmemocollect","openApiOperationId":"POST_DebitMemoCollect","summary":"Collect a posted debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/DebitMemoCollectRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemoCollectRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemoCollectResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DebitMemoCollectResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DebitMemoCollectResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemoCollectResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/post_debitmemocollect"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/collect"},{"label":"Email a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_emaildebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/post_emaildebitmemo","metadata":{"seo":{"title":"Email a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_EmailDebitMemo","name":"Email a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email a debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends a posted debit memo to the specified email addresses manually."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"debit-memos/post_emaildebitmemo/request/notes","deepLinkHash":"/debit-memos/post_emaildebitmemo#debit-memos/post_emaildebitmemo/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"You must activate the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Debit Memo | Manually email Debit Memo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notification before emailing debit memos. To include the debit memo PDF in the email, select the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include Debit Memo PDF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" check box in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-notification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and Edit Notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"Zuora sends the email messages based on the email template you set. You can set the email template to use in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" panel of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. By default, the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Email for Debit Memo Default Template"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" template is used. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-email-template"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and Edit Email Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useEmailTemplateSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"The email addresses are not specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailAddresses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostDebitMemoEmailType"}},"schemaId":"components/schemas/PostDebitMemoEmailType","pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/debit-memos/{debitMemoKey}/emails","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostDebitMemoEmailType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/emails","href":"debit-memos/post_emaildebitmemo","openApiOperationId":"POST_EmailDebitMemo","summary":"Email a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostDebitMemoEmailType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostDebitMemoEmailType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/post_emaildebitmemo"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/emails"},{"label":"Upload a file for a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_uploadfilefordebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/post_uploadfilefordebitmemo","metadata":{"seo":{"title":"Upload a file for a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_UploadFileForDebitMemo","name":"Upload a file for a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a file for a debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads an externally generated PDF file for a debit memo that is in Draft or Posted status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this operation, you must enable the Modify Debit Memo permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation has the following restrictions:"},"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":"Only the PDF file format is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum size of the PDF file to upload is 4 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A maximum of 50 PDF files can be uploaded for one debit memo."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The ID or number of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_78"}},"schemaId":"schema_78","pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/debit-memos/{debitMemoKey}/files","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_78"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/files","href":"debit-memos/post_uploadfilefordebitmemo","openApiOperationId":"POST_UploadFileForDebitMemo","summary":"Upload a file for a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_78","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_78"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTUploadFileResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/post_uploadfilefordebitmemo"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/files"},{"label":"List all files of a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemofiles","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemofiles","metadata":{"seo":{"title":"List all files of a debit memo","description":"Retrieves the information about all PDF files of a specified debit memo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DebitMemoFiles","name":"List all files of a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all files of a debit memo","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 the information about all PDF files of a specified debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debit Memo PDF files are returned in reverse chronological order by the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"versionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of an debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/debit-memos/{debitMemoKey}/files","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/files","href":"debit-memos/get_debitmemofiles","openApiOperationId":"GET_DebitMemoFiles","summary":"List all files of a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoFilesResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoFilesResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoFilesResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoFilesResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/get_debitmemofiles"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/files"},{"label":"List debit memo items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemoitems","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemoitems","metadata":{"seo":{"title":"List debit memo items","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DebitMemoItems","name":"List debit memo items","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List debit memo items","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"debit-memos/get_debitmemoitems/request/filtering","deepLinkHash":"/debit-memos/get_debitmemoitems#debit-memos/get_debitmemoitems/request/filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body."},"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 a filterable field is string, you can set the corresponding query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when filtering. Then, you can get the response data with this field value being "},"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":"Examples:"},"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":"/v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100"},"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":"/v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"amount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"beAppliedAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beAppliedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdDate","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"serviceEndDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"serviceStartDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sku","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"skuName","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skuName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sourceItemId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"subscriptionId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedDate","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the response data is displayed in descending order by updated date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field. The supported sortable fields of this operation are as below:"},"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":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"beAppliedAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sku"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"skuName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceStartDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceEndDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceItemId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionId"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"/v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate"},"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":"/v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate"},"children":[]}]}]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/debit-memos/{debitMemoKey}/items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"amount","in":"query","required":false,"schemaId":"schema_74"},{"name":"beAppliedAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"createdById","in":"query","required":false,"schemaId":"schema_5"},{"name":"createdDate","in":"query","required":false,"schemaId":"schema_5"},{"name":"id","in":"query","required":false,"schemaId":"schema_5"},{"name":"serviceEndDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"serviceStartDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"sku","in":"query","required":false,"schemaId":"schema_5"},{"name":"skuName","in":"query","required":false,"schemaId":"schema_5"},{"name":"sourceItemId","in":"query","required":false,"schemaId":"schema_5"},{"name":"subscriptionId","in":"query","required":false,"schemaId":"schema_5"},{"name":"updatedById","in":"query","required":false,"schemaId":"schema_5"},{"name":"updatedDate","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/items","href":"debit-memos/get_debitmemoitems","openApiOperationId":"GET_DebitMemoItems","summary":"List debit memo items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoItemCollectionType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoItemCollectionType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoItemCollectionType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoItemCollectionType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/get_debitmemoitems"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/items"},{"label":"Retrieve a debit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/get_debitmemoitem","routeSlug":"/v1-api-reference/api/debit-memos/get_debitmemoitem","metadata":{"seo":{"title":"Retrieve a debit memo item","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DebitMemoItem","name":"Retrieve a debit memo item","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a debit memo item","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dmitemid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List debit memo items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/debit-memos/{debitMemoKey}/items/{dmitemid}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"dmitemid","in":"path","required":true,"schemaId":"schema_5"},{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/items/{dmitemid}","href":"debit-memos/get_debitmemoitem","openApiOperationId":"GET_DebitMemoItem","summary":"Retrieve a debit memo item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoItemType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoItemType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoItemType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoItemType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/get_debitmemoitem"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/items/{dmitemid}"},{"label":"Generate a debit memo PDF file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_debitmemopdf","routeSlug":"/v1-api-reference/api/debit-memos/post_debitmemopdf","metadata":{"seo":{"title":"Generate a debit memo PDF file","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_DebitMemoPDF","name":"Generate a debit memo PDF file","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a debit memo PDF 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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a PDF file for a specified debit memo. To access the generated PDF file, you can download it by clicking "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View PDF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the detailed debit memo page through the Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This REST API operation can be used only if you have the billing document file generation feature and the Billing user permission \"Regenerate PDF\" enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/debit-memos/{debitMemoKey}/pdfs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/pdfs","href":"debit-memos/post_debitmemopdf","openApiOperationId":"POST_DebitMemoPDF","summary":"Generate a debit memo PDF file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTMemoPdfResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTMemoPdfResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTMemoPdfResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTMemoPdfResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/post_debitmemopdf"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/pdfs"},{"label":"Post a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_postdebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/put_postdebitmemo","metadata":{"seo":{"title":"Post a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PostDebitMemo","name":"Post a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post a debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Posts a debit memo to activate it. You can post debit memos only if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/debit-memos/{debitMemoKey}/post","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/post","href":"debit-memos/put_postdebitmemo","openApiOperationId":"PUT_PostDebitMemo","summary":"Post a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/put_postdebitmemo"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/post"},{"label":"Create taxation items for a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_dm_taxationitems","routeSlug":"/v1-api-reference/api/debit-memos/post_dm_taxationitems","metadata":{"seo":{"title":"Create taxation items for a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_DM_TaxationItems","name":"Create taxation items for a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create taxation items for a debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates taxation items for a debit memo."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTTaxationItemListForDMType"}},"schemaId":"components/schemas/POSTTaxationItemListForDMType","pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/debit-memos/{debitMemoKey}/taxation-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTTaxationItemListForDMType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/taxation-items","href":"debit-memos/post_dm_taxationitems","openApiOperationId":"POST_DM_TaxationItems","summary":"Create taxation items for a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTTaxationItemListForDMType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTTaxationItemListForDMType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemListType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/post_dm_taxationitems"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/taxation-items"},{"label":"Unpost a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_unpostdebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/put_unpostdebitmemo","metadata":{"seo":{"title":"Unpost a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UnpostDebitMemo","name":"Unpost a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unpost a debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unposts a debit memo that is in Posted status. If any credit memo or payment has been applied to a debit memo, you are not allowed to unpost the debit memo. After a debit memo is unposted, its status becomes Draft."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can unpost debit memos only if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing permissions"},"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":"You can prevent  an unpost operation by configuring the  'Do not allow unposting invoices and memos if their revenue is already recognized in a closed accounting period' accounting  rule. The default value of this rule is set to 'disabled.'"},"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://docs.zuora.com?resourceId=ar-configure-accounting-rules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Accounting Rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/debit-memos/{debitMemoKey}/unpost","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/unpost","href":"debit-memos/put_unpostdebitmemo","openApiOperationId":"PUT_UnpostDebitMemo","summary":"Unpost a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/put_unpostdebitmemo"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/unpost"},{"label":"Create a debit memo from an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/post_debitmemofrominvoice","routeSlug":"/v1-api-reference/api/debit-memos/post_debitmemofrominvoice","metadata":{"seo":{"title":"Create a debit memo from an invoice","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_DebitMemoFromInvoice","name":"Create a debit memo from an invoice","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a debit memo from 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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an ad-hoc debit memo from an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a debit memo from an invoice only if you have the user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of an invoice that you want to create a debit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemoFromInvoiceRequest"}},"schemaId":"components/schemas/DebitMemoFromInvoiceRequest","pointer":"/paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/debit-memos/invoice/{invoiceKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DebitMemoFromInvoiceRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/invoice/{invoiceKey}","href":"debit-memos/post_debitmemofrominvoice","openApiOperationId":"POST_DebitMemoFromInvoice","summary":"Create a debit memo from an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/DebitMemoFromInvoiceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemoFromInvoiceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoType","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/post_debitmemofrominvoice"}],"panels":[]}]},"httpPath":"/v1/debit-memos/invoice/{invoiceKey}"},{"label":"Write off a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/debit-memos/put_writeoffdebitmemo","routeSlug":"/v1-api-reference/api/debit-memos/put_writeoffdebitmemo","metadata":{"seo":{"title":"Write off a debit memo","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_WriteOffDebitMemo","name":"Write off a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Write off a debit memo","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Writes off a debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By writing off a debit memo,  a credit memo is automatically created and applied to the debit memo. The generated  credit memo items and credit memo taxation items are applied to the corresponding  debit memo items and debit memo taxation items respectively."},"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":":"},"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":"This API operation  is available only if you have enabled the enhanced write-off permission for your tenant.  Contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  to enable this permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount must be equal to the amount entered at the invoice item level."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the non revenue impact value  is set to Yes, then the non revenue write off accounting code must be specified."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTWriteOffDebitMemoRequest"}},"schemaId":"components/schemas/PUTWriteOffDebitMemoRequest","pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/debit-memos/{debitMemoKey}/write-off","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTWriteOffDebitMemoRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/write-off","href":"debit-memos/put_writeoffdebitmemo","openApiOperationId":"PUT_WriteOffDebitMemo","summary":"Write off a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTWriteOffDebitMemoRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTWriteOffDebitMemoRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTWriteOffInvoiceResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTWriteOffInvoiceResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTWriteOffInvoiceResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTWriteOffInvoiceResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/put_writeoffdebitmemo"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/write-off"}],"content":{"contentType":"group","meta":{"name":"Debit Memos"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Debit 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":"Debit memos increase the amount a customer owes. It is a separate document from the invoice. Debit memos can be used to correct undercharging on an invoice or to levy ad hoc charges outside the context of a subscription. Just like an invoice, debit memo balances can be settled by applying either a payment or a credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about debit memos, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-credit-and-debit-memos","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit and debit memos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/debit-memos","summary":"List debit memos","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/get_debitmemos","deprecated":false},{"title":"/v1/debit-memos","summary":"Create a debit memo from a charge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/post_debitmemofromprpc","deprecated":false},{"title":"/v1/debit-memos","summary":"Update due dates for debit memos","prefix":{"name":"put","color":"put"},"badges":[],"link":"/debit-memos/put_updatedebitmemosduedates","deprecated":false},{"title":"/v1/debit-memos/bulk","summary":"Create debit memos","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/post_createdebitmemos","deprecated":false},{"title":"/v1/debit-memos/bulk","summary":"Update debit memos","prefix":{"name":"put","color":"put"},"badges":[],"link":"/debit-memos/put_updatedebitmemos","deprecated":false},{"title":"/v1/debit-memos/pdf-status","summary":"Retrieve the PDF file generation status of debit memos","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/get_debitmemopdfstatus","deprecated":false},{"title":"/v1/debit-memos/{debitMemoId}/application-parts","summary":"List all application parts of a debit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/get_debitmemoapplicationparts","deprecated":false},{"title":"/v1/debit-memos/{debitMemoId}/items/{dmitemid}/taxation-items","summary":"List all taxation items of a debit memo item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/get_taxationitemsofdebitmemoitem","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}","summary":"Delete a debit memo","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/debit-memos/delete_debitmemo","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}","summary":"Retrieve a debit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/get_debitmemo","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}","summary":"Update a debit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/debit-memos/put_debitmemo","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/cancel","summary":"Cancel a debit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/debit-memos/put_canceldebitmemo","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/collect","summary":"Collect a posted debit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/post_debitmemocollect","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/emails","summary":"Email a debit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/post_emaildebitmemo","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/files","summary":"Upload a file for a debit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/post_uploadfilefordebitmemo","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/files","summary":"List all files of a debit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/get_debitmemofiles","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/items","summary":"List debit memo items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/get_debitmemoitems","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/items/{dmitemid}","summary":"Retrieve a debit memo item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/get_debitmemoitem","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/pdfs","summary":"Generate a debit memo PDF file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/post_debitmemopdf","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/post","summary":"Post a debit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/debit-memos/put_postdebitmemo","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/taxation-items","summary":"Create taxation items for a debit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/post_dm_taxationitems","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/unpost","summary":"Unpost a debit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/debit-memos/put_unpostdebitmemo","deprecated":false},{"title":"/v1/debit-memos/invoice/{invoiceKey}","summary":"Create a debit memo from an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/post_debitmemofrominvoice","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/write-off","summary":"Write off a debit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/debit-memos/put_writeoffdebitmemo","deprecated":false}]}]}]}]}},{"type":"group","label":"E-Invoicing","link":"/v1-api-reference/api/e-invoicing","routeSlug":"/v1-api-reference/api/e-invoicing","items":[{"label":"List e-invoicing service providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicingserviceproviders","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicingserviceproviders","metadata":{"seo":{"title":"List e-invoicing service providers","description":"Lists information about e-invoicing service providers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_EInvoicingServiceProviders","name":"List e-invoicing service providers","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1service-providers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List e-invoicing service providers","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":"Lists information about e-invoicing service providers."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1service-providers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/einvoice/service-providers","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/service-providers","href":"e-invoicing/get_einvoicingserviceproviders","openApiOperationId":"GET_EInvoicingServiceProviders","summary":"List e-invoicing service providers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEInvoicingServiceProvidersResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListEInvoicingServiceProvidersResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1service-providers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEInvoicingServiceProvidersResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEInvoicingServiceProvidersResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/get_einvoicingserviceproviders"}],"panels":[]}]},"httpPath":"/v1/einvoice/service-providers"},{"label":"Create an e-invoicing service provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/post_einvoicingserviceprovider","routeSlug":"/v1-api-reference/api/e-invoicing/post_einvoicingserviceprovider","metadata":{"seo":{"title":"Create an e-invoicing service provider","description":"Creates an e-invoicing service provider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_EInvoicingServiceProvider","name":"Create an e-invoicing service provider","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1service-providers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an e-invoicing service provider","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 e-invoicing service provider."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1service-providers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEInvoicingServiceProviderRequest"}},"schemaId":"components/schemas/CreateEInvoicingServiceProviderRequest","pointer":"/paths/~1v1~1einvoice~1service-providers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/einvoice/service-providers","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEInvoicingServiceProviderRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/service-providers","href":"e-invoicing/post_einvoicingserviceprovider","openApiOperationId":"POST_EInvoicingServiceProvider","summary":"Create an e-invoicing service provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateEInvoicingServiceProviderRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEInvoicingServiceProviderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1service-providers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/post_einvoicingserviceprovider"}],"panels":[]}]},"httpPath":"/v1/einvoice/service-providers"},{"label":"Delete an e-invoicing service provider","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/delete_einvoicingserviceprovider","routeSlug":"/v1-api-reference/api/e-invoicing/delete_einvoicingserviceprovider","metadata":{"seo":{"title":"Delete an e-invoicing service provider","description":"Deletes an e-invoicing service privider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_EInvoicingServiceProvider","name":"Delete an e-invoicing service provider","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an e-invoicing service provider","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 an e-invoicing service privider."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique ID or number of the e-invoicing service provider that you want to \n","required":true}],"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/einvoice/service-providers/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/service-providers/{key}","href":"e-invoicing/delete_einvoicingserviceprovider","openApiOperationId":"DELETE_EInvoicingServiceProvider","summary":"Delete an e-invoicing service provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/delete_einvoicingserviceprovider"}],"panels":[]}]},"httpPath":"/v1/einvoice/service-providers/{key}"},{"label":"Retrieve an e-invoicing service provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicingserviceprovider","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicingserviceprovider","metadata":{"seo":{"title":"Retrieve an e-invoicing service provider","description":"Retrieves information about an e-invoicing service privider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_EInvoicingServiceProvider","name":"Retrieve an e-invoicing service provider","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an e-invoicing service provider","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 information about an e-invoicing service privider."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique ID or number of the e-invoicing service provider that you want to retrieve information about.\n","required":true}],"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/einvoice/service-providers/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/service-providers/{key}","href":"e-invoicing/get_einvoicingserviceprovider","openApiOperationId":"GET_EInvoicingServiceProvider","summary":"Retrieve an e-invoicing service provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/get_einvoicingserviceprovider"}],"panels":[]}]},"httpPath":"/v1/einvoice/service-providers/{key}"},{"label":"Update an e-invoicing service provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_updateeinvoicingserviceprovider","routeSlug":"/v1-api-reference/api/e-invoicing/put_updateeinvoicingserviceprovider","metadata":{"seo":{"title":"Update an e-invoicing service provider","description":"Updates information about an e-invoicing service privider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateEInvoicingServiceProvider","name":"Update an e-invoicing service provider","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an e-invoicing service provider","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 information about an e-invoicing service privider."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique ID or number of the e-invoicing service provider that you want to update.\n","required":true}],"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEInvoicingServiceProviderRequest"}},"schemaId":"components/schemas/UpdateEInvoicingServiceProviderRequest","pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/einvoice/service-providers/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEInvoicingServiceProviderRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/service-providers/{key}","href":"e-invoicing/put_updateeinvoicingserviceprovider","openApiOperationId":"PUT_UpdateEInvoicingServiceProvider","summary":"Update an e-invoicing service provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateEInvoicingServiceProviderRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEInvoicingServiceProviderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1service-providers~1{key}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingServiceProviderResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/put_updateeinvoicingserviceprovider"}],"panels":[]}]},"httpPath":"/v1/einvoice/service-providers/{key}"},{"label":"List e-invoicing business regions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicingbusinessregions","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicingbusinessregions","metadata":{"seo":{"title":"List e-invoicing business regions","description":"Lists information about e-invoicing business regions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_EInvoicingBusinessRegions","name":"List e-invoicing business regions","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1business-regions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List e-invoicing business regions","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":"Lists information about e-invoicing business regions."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1business-regions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/einvoice/business-regions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/business-regions","href":"e-invoicing/get_einvoicingbusinessregions","openApiOperationId":"GET_EInvoicingBusinessRegions","summary":"List e-invoicing business regions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEInvoicingBusinessRegionsResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListEInvoicingBusinessRegionsResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1business-regions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEInvoicingBusinessRegionsResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEInvoicingBusinessRegionsResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/get_einvoicingbusinessregions"}],"panels":[]}]},"httpPath":"/v1/einvoice/business-regions"},{"label":"Create an e-invoicing business region","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/post_createeinvoicingbusinessregion","routeSlug":"/v1-api-reference/api/e-invoicing/post_createeinvoicingbusinessregion","metadata":{"seo":{"title":"Create an e-invoicing business region","description":"Creates an e-invoicing business region."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateEInvoicingBusinessRegion","name":"Create an e-invoicing business region","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1business-regions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an e-invoicing business region","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 e-invoicing business region."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must create business regions to store the business detail information as a seller. If you have multiple GSTINs for different states, you can create multiple business region objects for India."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The business region objects can be looked up according to the country and state, and its related fields can be mapped accordingly within the e-invoice file template."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1business-regions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEInvoicingBusinessRegionRequest"}},"schemaId":"components/schemas/CreateEInvoicingBusinessRegionRequest","pointer":"/paths/~1v1~1einvoice~1business-regions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/einvoice/business-regions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEInvoicingBusinessRegionRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/business-regions","href":"e-invoicing/post_createeinvoicingbusinessregion","openApiOperationId":"POST_CreateEInvoicingBusinessRegion","summary":"Create an e-invoicing business region"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateEInvoicingBusinessRegionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEInvoicingBusinessRegionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1business-regions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/post_createeinvoicingbusinessregion"}],"panels":[]}]},"httpPath":"/v1/einvoice/business-regions"},{"label":"Delete an e-invoicing business region","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/delete_einvoicingbusinessregion","routeSlug":"/v1-api-reference/api/e-invoicing/delete_einvoicingbusinessregion","metadata":{"seo":{"title":"Delete an e-invoicing business region","description":"Deletes an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_EInvoicingBusinessRegion","name":"Delete an e-invoicing business region","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an e-invoicing business region","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 an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unqiue ID or number of the e-invoicing business region that you want to delete.\n","required":true}],"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/einvoice/business-regions/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/business-regions/{key}","href":"e-invoicing/delete_einvoicingbusinessregion","openApiOperationId":"DELETE_EInvoicingBusinessRegion","summary":"Delete an e-invoicing business region"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/delete_einvoicingbusinessregion"}],"panels":[]}]},"httpPath":"/v1/einvoice/business-regions/{key}"},{"label":"Retrieve an e-invoicing business region","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicingbusinessregion","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicingbusinessregion","metadata":{"seo":{"title":"Retrieve an e-invoicing business region","description":"Retrieves information about an e-invoicing business region."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_EInvoicingBusinessRegion","name":"Retrieve an e-invoicing business region","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an e-invoicing business region","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 information about an e-invoicing business region."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can search for an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unqiue ID or number of the e-invoicing business region that you want to retrieve information about.\n","required":true}],"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/einvoice/business-regions/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/business-regions/{key}","href":"e-invoicing/get_einvoicingbusinessregion","openApiOperationId":"GET_EInvoicingBusinessRegion","summary":"Retrieve an e-invoicing business region"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/get_einvoicingbusinessregion"}],"panels":[]}]},"httpPath":"/v1/einvoice/business-regions/{key}"},{"label":"Update an e-invoicing business region","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_updateeinvoicingbusinessregion","routeSlug":"/v1-api-reference/api/e-invoicing/put_updateeinvoicingbusinessregion","metadata":{"seo":{"title":"Update an e-invoicing business region","description":"Updates an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateEInvoicingBusinessRegion","name":"Update an e-invoicing business region","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an e-invoicing business region","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 an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unqiue ID or number of the e-invoicing business region that you want to update.\n","required":true}],"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEInvoicingBusinessRegionRequest"}},"schemaId":"components/schemas/UpdateEInvoicingBusinessRegionRequest","pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/einvoice/business-regions/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEInvoicingBusinessRegionRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/business-regions/{key}","href":"e-invoicing/put_updateeinvoicingbusinessregion","openApiOperationId":"PUT_UpdateEInvoicingBusinessRegion","summary":"Update an e-invoicing business region"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateEInvoicingBusinessRegionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEInvoicingBusinessRegionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1business-regions~1{key}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoicingBusinessRegionResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/put_updateeinvoicingbusinessregion"}],"panels":[]}]},"httpPath":"/v1/einvoice/business-regions/{key}"},{"label":"List mandates for downloading files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicemandates","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicemandates","metadata":{"seo":{"title":"List mandates for downloading files","description":"Fetches mandates for downloading files based on the country code, category, and process type selection.This API operation returns the the list of file formats in which the document can be downloaded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEinvoiceMandates","name":"List mandates for downloading files","isWebhook":false,"pointer":"/paths/~1v1~1e-invoice~1mandates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List mandates for downloading files","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":"Fetches mandates for downloading files based on the country code, category, and process type selection."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API operation returns the the list of file formats in which the document can be downloaded."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature for Avalara in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availabiltiy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countryCode","in":"query","schemaId":"schema_79","description":"2-digit country code.\n"},{"name":"processType","in":"query","schemaId":"schema_80","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The process type of the e-invoicing business region."},"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 service provider is Sovos, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ClearanceWithCancellation"},"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 service provider is Avalara, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEPPOLNetwork"},"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 service provider is PEPPOL, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"provider","in":"query","schemaId":"schema_81","description":"The service provider that is associated with the country and process type."}],"pointer":"/paths/~1v1~1e-invoice~1mandates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-invoice~1mandates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-invoice/mandates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"countryCode","in":"query","example":"AU","schemaId":"schema_79"},{"name":"processType","in":"query","example":"PEPPOLNetwork","schemaId":"schema_80"},{"name":"provider","in":"query","example":"8ad093788ea359ca018ea75fb12a6348","schemaId":"schema_81"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-invoice/mandates","href":"e-invoicing/geteinvoicemandates","openApiOperationId":"getEinvoiceMandates","summary":"List mandates for downloading files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EinvoiceFetchMandates","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Validation Error#1"]}},"schemaId":"components/schemas/EinvoiceFetchMandates","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Validation Error#1"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-invoice~1mandates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EinvoiceFetchMandates","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Validation Error#1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EinvoiceFetchMandates","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Validation Error#1"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-invoice~1mandates/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/geteinvoicemandates"}],"panels":[]}]},"httpPath":"/v1/e-invoice/mandates"},{"label":"Retrieve a mandate for downloading a file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicemandateoninvoice","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicemandateoninvoice","metadata":{"seo":{"title":"Retrieve a mandate for downloading a file","description":"Fetches mandates for downloading e-invoice based on the country code, category, and process type selection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEinvoiceMandateOnInvoice","name":"Retrieve a mandate for downloading a file","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a mandate for downloading 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":"Fetches mandates for downloading e-invoice based on the country code, category, and process type selection."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature for Avalara in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availabiltiy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The unique number or ID of the invoice.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoices/{invoiceKey}/e-invoice/mandate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/e-invoice/mandate","href":"e-invoicing/geteinvoicemandateoninvoice","openApiOperationId":"getEinvoiceMandateOnInvoice","summary":"Retrieve a mandate for downloading a file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EinvoiceInvoiceFetchMandate","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"]}},"schemaId":"components/schemas/EinvoiceInvoiceFetchMandate","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EinvoiceInvoiceFetchMandate","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EinvoiceInvoiceFetchMandate","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/geteinvoicemandateoninvoice"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/e-invoice/mandate"},{"label":"Retrieve a mandate for downloading a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicecreditmemomandate","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicecreditmemomandate","metadata":{"seo":{"title":"Retrieve a mandate for downloading a credit memo","description":"Fetches mandates for downloading a Credit Memo file based on the country code, category, and process type selection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEinvoiceCreditMemoMandate","name":"Retrieve a mandate for downloading a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a mandate for downloading a credit memo","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":"Fetches mandates for downloading a Credit Memo file based on the country code, category, and process type selection."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature for Avalara in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availabiltiy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique number or ID of the Credit Memo.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/{creditMemoKey}/e-invoice/mandate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/e-invoice/mandate","href":"e-invoicing/geteinvoicecreditmemomandate","openApiOperationId":"getEinvoiceCreditMemoMandate","summary":"Retrieve a mandate for downloading a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemosEinvoiceMandate","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"]}},"schemaId":"components/schemas/CreditMemosEinvoiceMandate","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemosEinvoiceMandate","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemosEinvoiceMandate","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/geteinvoicecreditmemomandate"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/e-invoice/mandate"},{"label":"Retrieve a mandate for downloading a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicedebitmemomandate","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicedebitmemomandate","metadata":{"seo":{"title":"Retrieve a mandate for downloading a debit memo","description":"Fetches mandates for downloading a Debit Memo file based on the country code, category, and process type selection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEinvoiceDebitMemoMandate","name":"Retrieve a mandate for downloading a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a mandate for downloading a debit memo","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":"Fetches mandates for downloading a Debit Memo file based on the country code, category, and process type selection."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature for Avalara in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availabiltiy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique number or ID of the Debit Memo.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/debit-memos/{debitMemoKey}/e-invoice/mandate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/e-invoice/mandate","href":"e-invoicing/geteinvoicedebitmemomandate","openApiOperationId":"getEinvoiceDebitMemoMandate","summary":"Retrieve a mandate for downloading a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemosEinvoiceMandate","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"]}},"schemaId":"components/schemas/DebitMemosEinvoiceMandate","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DebitMemosEinvoiceMandate","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemosEinvoiceMandate","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/geteinvoicedebitmemomandate"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/e-invoice/mandate"},{"label":"Download a file in the specified file format","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/downloadeinvoiceofspecifiedformat","routeSlug":"/v1-api-reference/api/e-invoicing/downloadeinvoiceofspecifiedformat","metadata":{"seo":{"title":"Download a file in the specified file format","description":"Downloads the e-invoice based on the selected file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadEinvoiceOfSpecifiedFormat","name":"Download a file in the specified file format","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a file in the specified file format","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Downloads the e-invoice based on the selected file format. \nThe system supports XML, UBL, PNG, or QR codes formats that each country requires or supports.  \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The unique number or ID of the e-invoice.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fileFormat","in":"query","schemaId":"schema_82","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter is exclusively accessible for documents submitted via the Avalara E-Invoice integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an invoice is processed through Sovos or PEPPOL, this parameter cannot be specified, and the document can only be downloaded in its default file format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following mapping will be used for user representation of file formats:"},"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":"XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OASIS_Universal_Business_Language_XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.oasis.ubl+xml"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoices/{invoiceKey}/e-invoice/download","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fileFormat","in":"query","schemaId":"schema_82"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/e-invoice/download","href":"e-invoicing/downloadeinvoiceofspecifiedformat","openApiOperationId":"downloadEinvoiceOfSpecifiedFormat","summary":"Download a file in the specified file format"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EinvoiceDownload","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"]}},"schemaId":"components/schemas/EinvoiceDownload","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EinvoiceDownload","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EinvoiceDownload","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/downloadeinvoiceofspecifiedformat"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/e-invoice/download"},{"label":"Download a credit memo in the specified file format","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/downloadcreditmemoeinvoice","routeSlug":"/v1-api-reference/api/e-invoicing/downloadcreditmemoeinvoice","metadata":{"seo":{"title":"Download a credit memo in the specified file format","description":"Downloads the credit memo based on the specified file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCreditMemoEinvoice","name":"Download a credit memo in the specified file format","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a credit memo in the specified file format","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Downloads the credit memo based on the specified file format. \nThe system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The unique number or ID of Credit Memo.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fileFormat","in":"query","schemaId":"schema_82","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter is exclusively accessible for documents submitted via the Avalara E-Invoice integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an invoice is processed through Sovos or PEPPOL, this parameter cannot be specified, and the document can only be downloaded in its default file format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following mapping will be used for user representation of file formats:"},"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":"XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OASIS_Universal_Business_Language_XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.oasis.ubl+xml"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/credit-memos/{creditMemoKey}/e-invoice/download","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fileFormat","in":"query","schemaId":"schema_82"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/e-invoice/download","href":"e-invoicing/downloadcreditmemoeinvoice","openApiOperationId":"downloadCreditMemoEinvoice","summary":"Download a credit memo in the specified file format"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemosEinvoiceDownload","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"]}},"schemaId":"components/schemas/CreditMemosEinvoiceDownload","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemosEinvoiceDownload","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemosEinvoiceDownload","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/downloadcreditmemoeinvoice"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/e-invoice/download"},{"label":"Download a debit memo in the specified file format","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/downloaddebitmemoeinvoice","routeSlug":"/v1-api-reference/api/e-invoicing/downloaddebitmemoeinvoice","metadata":{"seo":{"title":"Download a debit memo in the specified file format","description":"Downloads the debit memo based on the specified file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadDebitMemoEinvoice","name":"Download a debit memo in the specified file format","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a debit memo in the specified file format","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Downloads the debit memo based on the specified file format. \nThe system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The unique number or ID of Debit Memo.","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fileFormat","in":"query","schemaId":"schema_82","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter is exclusively accessible for documents submitted via the Avalara E-Invoice integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an invoice is processed through Sovos or PEPPOL, this parameter cannot be specified, and the document can only be downloaded in its default file format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following mapping will be used for user representation of file formats:"},"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":"XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OASIS_Universal_Business_Language_XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.oasis.ubl+xml"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/debit-memos/{debitMemoKey}/e-invoice/download","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fileFormat","in":"query","schemaId":"schema_82"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/e-invoice/download","href":"e-invoicing/downloaddebitmemoeinvoice","openApiOperationId":"downloadDebitMemoEinvoice","summary":"Download a debit memo in the specified file format"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemosEinvoiceDownload","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"]}},"schemaId":"components/schemas/DebitMemosEinvoiceDownload","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DebitMemosEinvoiceDownload","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemosEinvoiceDownload","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/downloaddebitmemoeinvoice"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/e-invoice/download"},{"label":"Cancel the e-invoice file for an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/canceleinvoicebyinvoicekey","routeSlug":"/v1-api-reference/api/e-invoicing/canceleinvoicebyinvoicekey","metadata":{"seo":{"title":"Cancel the e-invoice file for an invoice","description":"Cancels the E-Invoice for the given billing document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelEInvoiceByInvoiceKey","name":"Cancel the e-invoice file for an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel the e-invoice file for an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels the E-Invoice for the given billing document"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"Invoice Id or Number","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutCancelEInvoiceRequest"}},"schemaId":"components/schemas/PutCancelEInvoiceRequest","pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoices/{invoiceKey}/e-invoice/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutCancelEInvoiceRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/e-invoice/cancel","href":"e-invoicing/canceleinvoicebyinvoicekey","openApiOperationId":"cancelEInvoiceByInvoiceKey","summary":"Cancel the e-invoice file for an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutCancelEInvoiceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutCancelEInvoiceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/canceleinvoicebyinvoicekey"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/e-invoice/cancel"},{"label":"List e-invoice file templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicefiletemplates","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicefiletemplates","metadata":{"seo":{"title":"List e-invoice file templates","description":"Lists information about e-invoice file templates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_EInvoiceFileTemplates","name":"List e-invoice file templates","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List e-invoice file templates","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":"Lists information about e-invoice file templates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can query e-invoice file templates by conditions. For example, if your service provider is Sovos, you can use the following example URL to retrieve information about a list of e-invoice file templates for invoices in India:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/einvoice/templates?country=IN&documentType=Invoice&provider=Sovos"},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The short name of a country or region where you must comply with e-invoicing requirements. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for India. For the full list of country names and codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"documentType","in":"query","schemaId":"schema_83","description":"The type of billing documents for which the e-invoice file template is intended.\n","required":true},{"name":"provider","in":"query","schemaId":"schema_5","description":"The name of the e-invoicing service provider that assists in generating e-invoice files. \n","required":true}],"pointer":"/paths/~1v1~1einvoice~1templates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/einvoice/templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":true,"schemaId":"schema_5"},{"name":"documentType","in":"query","required":true,"schemaId":"schema_83"},{"name":"provider","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/templates","href":"e-invoicing/get_einvoicefiletemplates","openApiOperationId":"GET_EInvoiceFileTemplates","summary":"List e-invoice file templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEInvoiceFileTemplatesResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListEInvoiceFileTemplatesResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEInvoiceFileTemplatesResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEInvoiceFileTemplatesResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/get_einvoicefiletemplates"}],"panels":[]}]},"httpPath":"/v1/einvoice/templates"},{"label":"Create an e-invoice file template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/post_createeinvoicefiletemplate","routeSlug":"/v1-api-reference/api/e-invoicing/post_createeinvoicefiletemplate","metadata":{"seo":{"title":"Create an e-invoice file template","description":"Creates an e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateEInvoiceFileTemplate","name":"Create an e-invoice file template","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an e-invoice file template","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 e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora provides default e-invoice file templates, so you can just customize them as needed. For example, some country specific fields like HSN (Harmonized System of Nomenclature) might be stored on product rate plan charges."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEInvoiceFileTemplateRequest"}},"schemaId":"components/schemas/CreateEInvoiceFileTemplateRequest","pointer":"/paths/~1v1~1einvoice~1templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/einvoice/templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEInvoiceFileTemplateRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/templates","href":"e-invoicing/post_createeinvoicefiletemplate","openApiOperationId":"POST_CreateEInvoiceFileTemplate","summary":"Create an e-invoice file template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateEInvoiceFileTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEInvoiceFileTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/post_createeinvoicefiletemplate"}],"panels":[]}]},"httpPath":"/v1/einvoice/templates"},{"label":"Delete an e-invoice file template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/delete_einvoicefiletemplate","routeSlug":"/v1-api-reference/api/e-invoicing/delete_einvoicefiletemplate","metadata":{"seo":{"title":"Delete an e-invoice file template","description":"Deletes an e-invoice file template by key. The key can be the unique ID or number of an e-invoice file template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_EInvoiceFileTemplate","name":"Delete an e-invoice file template","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an e-invoice file template","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 an e-invoice file template by key. The key can be the unique ID or number of an e-invoice file template."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique ID or number of the e-invoice file template that you want to delete.\n","required":true}],"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/einvoice/templates/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/templates/{key}","href":"e-invoicing/delete_einvoicefiletemplate","openApiOperationId":"DELETE_EInvoiceFileTemplate","summary":"Delete an e-invoice file template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/delete_einvoicefiletemplate"}],"panels":[]}]},"httpPath":"/v1/einvoice/templates/{key}"},{"label":"Retrieve an e-invoice file template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/get_einvoicefiletemplate","routeSlug":"/v1-api-reference/api/e-invoicing/get_einvoicefiletemplate","metadata":{"seo":{"title":"Retrieve an e-invoice file template","description":"Retrieves information about an e-invoice file template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_EInvoiceFileTemplate","name":"Retrieve an e-invoice file template","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an e-invoice file template","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 information about an e-invoice file template."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique number or ID of the e-invoice file template that you want to retrieve information about.\n","required":true}],"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/einvoice/templates/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/templates/{key}","href":"e-invoicing/get_einvoicefiletemplate","openApiOperationId":"GET_EInvoiceFileTemplate","summary":"Retrieve an e-invoice file template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/get_einvoicefiletemplate"}],"panels":[]}]},"httpPath":"/v1/einvoice/templates/{key}"},{"label":"Update an e-invoice file template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_einvoicefiletemplate","routeSlug":"/v1-api-reference/api/e-invoicing/put_einvoicefiletemplate","metadata":{"seo":{"title":"Update an e-invoice file template","description":"Updates information about an e-invoice file template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_EInvoiceFileTemplate","name":"Update an e-invoice file template","isWebhook":false,"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an e-invoice file template","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 information about an e-invoice file template."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique number or ID of the e-invoice file template that you want to update.\n","required":true}],"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEInvoiceFileTemplateRequest"}},"schemaId":"components/schemas/UpdateEInvoiceFileTemplateRequest","pointer":"/paths/~1v1~1einvoice~1templates~1{key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/einvoice/templates/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEInvoiceFileTemplateRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/einvoice/templates/{key}","href":"e-invoicing/put_einvoicefiletemplate","openApiOperationId":"PUT_EInvoiceFileTemplate","summary":"Update an e-invoice file template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateEInvoiceFileTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEInvoiceFileTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1einvoice~1templates~1{key}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoiceFileTemplateResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1einvoice~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/put_einvoicefiletemplate"}],"panels":[]}]},"httpPath":"/v1/einvoice/templates/{key}"},{"label":"Sync the e-Invoice status of an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/updateinvoiceinvokesyncstatus","routeSlug":"/v1-api-reference/api/e-invoicing/updateinvoiceinvokesyncstatus","metadata":{"seo":{"title":"Sync the e-Invoice status of an invoice","description":"Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the e-Invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInvoiceInvokeSyncStatus","name":"Sync the e-Invoice status of an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync the e-Invoice status of 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":"Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the e-Invoice."},"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 API can only be invoked when the current e-Invoice status is one of:  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the status is different, the request will be rejected."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":" The e-Invoice ID or number. The system checks the latest notification response from the configured e-Invoicing provider and updates the e-Invoice status of an e-Invoice.","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"shouldIncludeAcknowledged","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how Zuora pulls e-invoice notifications from the e-invoicing service provider"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when resyncing the e-invoice status."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default), Zuora refreshes only the latest notifications that have not yet been"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"acknowledged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora performs a full re-sync and reprocesses all notifications from the beginning,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is useful if incremental requests return incomplete results (for example, after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recreating notifications in Sovos)."},"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 parameter is primarily applicable to Sovos. For other providers, Zuora may ignore this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameter and apply the provider’s default resync behavior."},"children":[]}]}]}]},{"name":"transactionId","in":"query","schemaId":"schema_5","description":[{"$$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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider Document ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the billing document in the e-invoicing service provider. If specified, Zuora uses this value when resyncing the e-invoice status."},"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 parameter is supported for both Sovos and Avalara."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoices/{invoiceKey}/e-invoice/sync-status","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"shouldIncludeAcknowledged","in":"query","required":false,"schemaId":"schema_22"},{"name":"transactionId","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/e-invoice/sync-status","href":"e-invoicing/updateinvoiceinvokesyncstatus","openApiOperationId":"updateInvoiceInvokeSyncStatus","summary":"Sync the e-Invoice status of an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"]}},"schemaId":"schema_84","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"},"children":[]}]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_85"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"schema_84","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/updateinvoiceinvokesyncstatus"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/e-invoice/sync-status"},{"label":"Sync the e-Invoice status of a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/updatedebitmemoinvokesyncstatus","routeSlug":"/v1-api-reference/api/e-invoicing/updatedebitmemoinvokesyncstatus","metadata":{"seo":{"title":"Sync the e-Invoice status of a debit memo","description":"Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the debit memo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDebitMemoInvokeSyncStatus","name":"Sync the e-Invoice status of a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync the e-Invoice status of a debit memo","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 a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the debit memo."},"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 API can only be invoked when the current e-Invoice status is one of:  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the status is different, the request will be rejected."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":" The debit memo ID or number. The system checks the latest notification response from the configured e-Invoicing provider and updates the e-Invoice status of the debit memo.","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"shouldIncludeAcknowledged","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how Zuora pulls e-invoice notifications from the e-invoicing service provider"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when resyncing the e-invoice status."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default), Zuora refreshes only the latest notifications that have not yet been"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"acknowledged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora performs a full re-sync and reprocesses all notifications from the beginning,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is useful if incremental requests return incomplete results (for example, after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recreating notifications in Sovos)."},"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 parameter is primarily applicable to Sovos. For other providers, Zuora may ignore this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameter and apply the provider’s default resync behavior."},"children":[]}]}]}]},{"name":"transactionId","in":"query","schemaId":"schema_5","description":[{"$$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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider Document ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the billing document in the e-invoicing service provider. If specified, Zuora uses this value when resyncing the e-invoice status."},"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 parameter is supported for both Sovos and Avalara."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/debit-memos/{debitMemoKey}/e-invoice/sync-status","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"shouldIncludeAcknowledged","in":"query","required":false,"schemaId":"schema_22"},{"name":"transactionId","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/e-invoice/sync-status","href":"e-invoicing/updatedebitmemoinvokesyncstatus","openApiOperationId":"updateDebitMemoInvokeSyncStatus","summary":"Sync the e-Invoice status of a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"]}},"schemaId":"schema_84","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"},"children":[]}]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_85"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"schema_84","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/updatedebitmemoinvokesyncstatus"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/e-invoice/sync-status"},{"label":"Sync the e-Invoice status of a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/updatecreditmemoinvokesyncstatus","routeSlug":"/v1-api-reference/api/e-invoicing/updatecreditmemoinvokesyncstatus","metadata":{"seo":{"title":"Sync the e-Invoice status of a credit memo","description":"Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the credit memo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCreditMemoInvokeSyncStatus","name":"Sync the e-Invoice status of a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync the e-Invoice status of a credit memo","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 a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the credit memo."},"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 API can only be invoked when the current e-Invoice status is one of:  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the status is different, the request will be rejected."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":" The credit memo ID or number. The system checks the latest notification response from the configured e-Invoicing provider and updates the e-Invoice status of the credit memo.","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"shouldIncludeAcknowledged","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how Zuora pulls e-invoice notifications from the e-invoicing service provider"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when resyncing the e-invoice status."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default), Zuora refreshes only the latest notifications that have not yet been"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"acknowledged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora performs a full re-sync and reprocesses all notifications from the beginning,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is useful if incremental requests return incomplete results (for example, after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recreating notifications in Sovos)."},"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 parameter is primarily applicable to Sovos. For other providers, Zuora may ignore this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameter and apply the provider’s default resync behavior."},"children":[]}]}]}]},{"name":"transactionId","in":"query","schemaId":"schema_5","description":[{"$$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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider Document ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the billing document in the e-invoicing service provider. If specified, Zuora uses this value when resyncing the e-invoice status."},"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 parameter is supported for both Sovos and Avalara."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}/e-invoice/sync-status","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"shouldIncludeAcknowledged","in":"query","required":false,"schemaId":"schema_22"},{"name":"transactionId","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/e-invoice/sync-status","href":"e-invoicing/updatecreditmemoinvokesyncstatus","openApiOperationId":"updateCreditMemoInvokeSyncStatus","summary":"Sync the e-Invoice status of a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"]}},"schemaId":"schema_84","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"},"children":[]}]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_85"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"schema_84","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample","paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/updatecreditmemoinvokesyncstatus"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/e-invoice/sync-status"},{"label":"Generate an e-invoice file for an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_generationeinvoicegenerationforinvoices","routeSlug":"/v1-api-reference/api/e-invoicing/put_generationeinvoicegenerationforinvoices","metadata":{"seo":{"title":"Generate an e-invoice file for an invoice","description":"Generates an e-invoice file for an invoice.If the invoice status is Failed during e-invoice generation, you can use Regenerate E-Invoice. Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to Processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_GenerationEInvoiceGenerationForInvoices","name":"Generate an e-invoice file for an invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate an e-invoice file for 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":"Generates an e-invoice file for an invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the invoice status is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" during e-invoice generation, you can use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regenerate E-Invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-sovos","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing with Sovos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-peppol-extract","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing with PEPPOL Extract"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are generally available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-avalara","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing with Avalara"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early availability users before releasing this feature as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://zuora.zendesk.com/auth/v2/login/signin?return_to=https%3A%2F%2Fsupport.zuora.com%2Fhc%2Fen-us&theme=hc&locale=en-us&brand_id=825826&auth_origin=825826%2Ctrue%2Ctrue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regenerate E-Invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action is available in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status for the PEPPOL service provider."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoiceKey","in":"path","schemaId":"schema_5","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoices/{invoiceKey}/einvoice/generate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"invoiceKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoices/{invoiceKey}/einvoice/generate","href":"e-invoicing/put_generationeinvoicegenerationforinvoices","openApiOperationId":"PUT_GenerationEInvoiceGenerationForInvoices","summary":"Generate an e-invoice file for an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/put_generationeinvoicegenerationforinvoices"}],"panels":[]}]},"httpPath":"/v1/invoices/{invoiceKey}/einvoice/generate"},{"label":"Generate an e-invoice file for a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_generateeinvoicefileforcreditmemo","routeSlug":"/v1-api-reference/api/e-invoicing/put_generateeinvoicefileforcreditmemo","metadata":{"seo":{"title":"Generate an e-invoice file for a credit memo","description":"Generates an e-invoice file for a credit memo. If the Credit Memo status is Failed during e-invoice generation, you can use Regenerate E-Invoice. Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to Processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_GenerateEInvoiceFileForCreditMemo","name":"Generate an e-invoice file for a credit memo","isWebhook":false,"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate an e-invoice file for a credit memo","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":"Generates an e-invoice file for a credit memo. If the Credit Memo status is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" during e-invoice generation, you can use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regenerate E-Invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-sovos","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing with Sovos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-peppol-extract","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing with PEPPOL Extract"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are generally available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-avalara","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing with Avalara"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early availability users before releasing this feature as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://zuora.zendesk.com/auth/v2/login/signin?return_to=https%3A%2F%2Fsupport.zuora.com%2Fhc%2Fen-us&theme=hc&locale=en-us&brand_id=825826&auth_origin=825826%2Ctrue%2Ctrue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regenerate E-Invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action is available in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status for the PEPPOL service provider."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"creditMemoKey","in":"path","schemaId":"schema_5","description":"The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM-0000001.\n","required":true}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/credit-memos/{creditMemoKey}/e-invoice/generate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"creditMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/credit-memos/{creditMemoKey}/e-invoice/generate","href":"e-invoicing/put_generateeinvoicefileforcreditmemo","openApiOperationId":"PUT_GenerateEInvoiceFileForCreditMemo","summary":"Generate an e-invoice file for a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/put_generateeinvoicefileforcreditmemo"}],"panels":[]}]},"httpPath":"/v1/credit-memos/{creditMemoKey}/e-invoice/generate"},{"label":"Generate an e-invoice file for a debit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/put_generateeinvoicefilefordebitmemo","routeSlug":"/v1-api-reference/api/e-invoicing/put_generateeinvoicefilefordebitmemo","metadata":{"seo":{"title":"Generate an e-invoice file for a debit memo","description":"Generates an e-invoice file for a debit memo. If the Credit Memo status is Failed during e-invoice generation, you can use Regenerate E-Invoice. Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to Processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_GenerateEInvoiceFileForDebitMemo","name":"Generate an e-invoice file for a debit memo","isWebhook":false,"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate an e-invoice file for a debit memo","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":"Generates an e-invoice file for a debit memo. If the Credit Memo status is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" during e-invoice generation, you can use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regenerate E-Invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-sovos","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing with Sovos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-peppol-extract","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing with PEPPOL Extract"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are generally available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-avalara","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing with Avalara"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early availability users before releasing this feature as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://zuora.zendesk.com/auth/v2/login/signin?return_to=https%3A%2F%2Fsupport.zuora.com%2Fhc%2Fen-us&theme=hc&locale=en-us&brand_id=825826&auth_origin=825826%2Ctrue%2Ctrue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regenerate E-Invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action is available in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status for the PEPPOL service provider."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debitMemoKey","in":"path","schemaId":"schema_5","description":"The ID or number of the debit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or DM-0000001.\n","required":true}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/debit-memos/{debitMemoKey}/e-invoice/generate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"debitMemoKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/debit-memos/{debitMemoKey}/e-invoice/generate","href":"e-invoicing/put_generateeinvoicefilefordebitmemo","openApiOperationId":"PUT_GenerateEInvoiceFileForDebitMemo","summary":"Generate an e-invoice file for a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/put_generateeinvoicefilefordebitmemo"}],"panels":[]}]},"httpPath":"/v1/debit-memos/{debitMemoKey}/e-invoice/generate"},{"label":"Create an e-invoice lifecycle status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/createeinvoicelifecyclestatusupdate","routeSlug":"/v1-api-reference/api/e-invoicing/createeinvoicelifecyclestatusupdate","metadata":{"seo":{"title":"Create an e-invoice lifecycle status update","description":"Creates a seller-initiated status update request for an e-invoice lifecycle. Use this operation to notify the tax authority when the business status of a source document changes, such as when payment is collected, the document is canceled, or the lifecycle is completed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEInvoiceLifecycleStatusUpdate","name":"Create an e-invoice lifecycle status update","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an e-invoice lifecycle status update","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 seller-initiated status update request for an e-invoice lifecycle. Use this operation to notify the tax authority when the business status of a source document changes, such as when payment is collected, the document is canceled, or the lifecycle is completed."},"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":": In the broader e-compliance workflow, this operation can work alongside the \"Reconcile an e-compliance request\" operation that is shared across e-reporting and e-invoice business lifecycle processing."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EInvoiceLifecycleStatusUpdateRequest"}},"schemaId":"components/schemas/EInvoiceLifecycleStatusUpdateRequest","pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/e-compliance/lifecycle/status-update","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EInvoiceLifecycleStatusUpdateRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/lifecycle/status-update","href":"e-invoicing/createeinvoicelifecyclestatusupdate","openApiOperationId":"createEInvoiceLifecycleStatusUpdate","summary":"Create an e-invoice lifecycle status update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/EInvoiceLifecycleStatusUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EInvoiceLifecycleStatusUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EInvoiceLifecycleStatusUpdateResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EInvoiceLifecycleStatusUpdateResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EInvoiceLifecycleStatusUpdateResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EInvoiceLifecycleStatusUpdateResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/createeinvoicelifecyclestatusupdate"}],"panels":[]}]},"httpPath":"/v1/e-compliance/lifecycle/status-update"},{"label":"List e-invoice business lifecycle status updates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicelifecyclestatusupdates","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicelifecyclestatusupdates","metadata":{"seo":{"title":"List e-invoice business lifecycle status updates","description":"Lists e-invoice business lifecycle status update audit records, optionally filtered by document, status, and requested action."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEInvoiceLifecycleStatusUpdates","name":"List e-invoice business lifecycle status updates","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-updates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List e-invoice business lifecycle status updates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists e-invoice business lifecycle status update audit records, optionally filtered by document, status, and requested action."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"documentId","in":"query","schemaId":"schema_5","description":"The ID of the document (e.g. invoice ID, credit memo ID, debit memo ID). Matches records where this ID is either the source object or the parent object."},{"name":"status","in":"query","schemaId":"schema_5","description":"Request lifecycle status of the status update record."},{"name":"userRequestedAction","in":"query","schemaId":"schema_5","description":"The action that triggered this status update record."},{"name":"page","in":"query","schemaId":"schema_28","description":"Page number (1-based)."},{"name":"pageSize","in":"query","schemaId":"schema_44","description":"Number of results per page."}],"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-compliance/lifecycle/status-updates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"documentId","in":"query","required":false,"schemaId":"schema_5"},{"name":"status","in":"query","required":false,"schemaId":"schema_5"},{"name":"userRequestedAction","in":"query","required":false,"schemaId":"schema_5"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/lifecycle/status-updates","href":"e-invoicing/geteinvoicelifecyclestatusupdates","openApiOperationId":"getEInvoiceLifecycleStatusUpdates","summary":"List e-invoice business lifecycle status updates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoiceLifecycleStatusUpdatesResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoiceLifecycleStatusUpdatesResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoiceLifecycleStatusUpdatesResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoiceLifecycleStatusUpdatesResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/geteinvoicelifecyclestatusupdates"}],"panels":[]}]},"httpPath":"/v1/e-compliance/lifecycle/status-updates"},{"label":"Retrieve an e-invoice business lifecycle status update by key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/geteinvoicelifecyclestatusupdate","routeSlug":"/v1-api-reference/api/e-invoicing/geteinvoicelifecyclestatusupdate","metadata":{"seo":{"title":"Retrieve an e-invoice business lifecycle status update by key","description":"Retrieves a single e-invoice business lifecycle status update audit record by its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEInvoiceLifecycleStatusUpdate","name":"Retrieve an e-invoice business lifecycle status update by key","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an e-invoice business lifecycle status update by key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single e-invoice business lifecycle status update audit record by its unique identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Unique identifier of the status update record (EInvoiceBusinessStatusUpdate.id).","required":true}],"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-compliance/lifecycle/status-updates/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/lifecycle/status-updates/{key}","href":"e-invoicing/geteinvoicelifecyclestatusupdate","openApiOperationId":"getEInvoiceLifecycleStatusUpdate","summary":"Retrieve an e-invoice business lifecycle status update by key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoiceLifecycleStatusUpdateResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEInvoiceLifecycleStatusUpdateResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEInvoiceLifecycleStatusUpdateResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEInvoiceLifecycleStatusUpdateResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/geteinvoicelifecyclestatusupdate"}],"panels":[]}]},"httpPath":"/v1/e-compliance/lifecycle/status-updates/{key}"},{"label":"Reconcile an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/reconcileecompliance","routeSlug":"/v1-api-reference/api/e-invoicing/reconcileecompliance","metadata":{"seo":{"title":"Reconcile an e-compliance request","description":"Reconciles an e-compliance request for the supplied source object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reconcileECompliance","name":"Reconcile an e-compliance request","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1reconcile/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reconcile an e-compliance 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":"Reconciles an e-compliance request for the supplied source object."},"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":": In the broader e-compliance workflow, this operation can work alongside the \"Create an e-invoice lifecycle status update\" operation that is shared across e-reporting and e-invoice business lifecycle processing."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1reconcile/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceReconcileRequest"}},"schemaId":"components/schemas/EComplianceReconcileRequest","pointer":"/paths/~1v1~1e-compliance~1reconcile/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/e-compliance/reconcile","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EComplianceReconcileRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/reconcile","href":"e-invoicing/reconcileecompliance","openApiOperationId":"reconcileECompliance","summary":"Reconcile an e-compliance request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/EComplianceReconcileRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceReconcileRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-compliance~1reconcile/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/reconcileecompliance"}],"panels":[]}]},"httpPath":"/v1/e-compliance/reconcile"},{"label":"Trigger an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/triggerecompliancerequest","routeSlug":"/v1-api-reference/api/e-invoicing/triggerecompliancerequest","metadata":{"seo":{"title":"Trigger an e-compliance request","description":"Creates an e-compliance request for the supplied source object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerEComplianceRequest","name":"Trigger an e-compliance request","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1trigger/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger an e-compliance request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an e-compliance request for the supplied source object."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1trigger/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceTriggerRequest"}},"schemaId":"components/schemas/EComplianceTriggerRequest","pointer":"/paths/~1v1~1e-compliance~1trigger/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/e-compliance/trigger","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EComplianceTriggerRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/trigger","href":"e-invoicing/triggerecompliancerequest","openApiOperationId":"triggerEComplianceRequest","summary":"Trigger an e-compliance request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/EComplianceTriggerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceTriggerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-compliance~1trigger/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/triggerecompliancerequest"}],"panels":[]}]},"httpPath":"/v1/e-compliance/trigger"},{"label":"Regenerate an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-invoicing/regenerateecompliancerequest","routeSlug":"/v1-api-reference/api/e-invoicing/regenerateecompliancerequest","metadata":{"seo":{"title":"Regenerate an e-compliance request","description":"Regenerates a failed or rejected e-compliance request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"regenerateEComplianceRequest","name":"Regenerate an e-compliance request","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1regenerate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate an e-compliance request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Regenerates a failed or rejected e-compliance request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1regenerate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceRegenerateRequest"}},"schemaId":"components/schemas/EComplianceRegenerateRequest","pointer":"/paths/~1v1~1e-compliance~1regenerate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/e-compliance/regenerate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EComplianceRegenerateRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/regenerate","href":"e-invoicing/regenerateecompliancerequest","openApiOperationId":"regenerateEComplianceRequest","summary":"Regenerate an e-compliance request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/EComplianceRegenerateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceRegenerateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-compliance~1regenerate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-invoicing/regenerateecompliancerequest"}],"panels":[]}]},"httpPath":"/v1/e-compliance/regenerate"}],"content":{"contentType":"group","meta":{"name":"E-Invoicing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"E-Invoicing","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":"With the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, Zuora supports electronic invoices through an integration with partners that have a local presence, where required, which guarantees compliance with local invoice regulations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the operations in this section are available only if you have the E-Invoicing feature enabled."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/einvoice/service-providers","summary":"List e-invoicing service providers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/get_einvoicingserviceproviders","deprecated":false},{"title":"/v1/einvoice/service-providers","summary":"Create an e-invoicing service provider","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-invoicing/post_einvoicingserviceprovider","deprecated":false},{"title":"/v1/einvoice/service-providers/{key}","summary":"Delete an e-invoicing service provider","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/e-invoicing/delete_einvoicingserviceprovider","deprecated":false},{"title":"/v1/einvoice/service-providers/{key}","summary":"Retrieve an e-invoicing service provider","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/get_einvoicingserviceprovider","deprecated":false},{"title":"/v1/einvoice/service-providers/{key}","summary":"Update an e-invoicing service provider","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-invoicing/put_updateeinvoicingserviceprovider","deprecated":false},{"title":"/v1/einvoice/business-regions","summary":"List e-invoicing business regions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/get_einvoicingbusinessregions","deprecated":false},{"title":"/v1/einvoice/business-regions","summary":"Create an e-invoicing business region","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-invoicing/post_createeinvoicingbusinessregion","deprecated":false},{"title":"/v1/einvoice/business-regions/{key}","summary":"Delete an e-invoicing business region","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/e-invoicing/delete_einvoicingbusinessregion","deprecated":false},{"title":"/v1/einvoice/business-regions/{key}","summary":"Retrieve an e-invoicing business region","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/get_einvoicingbusinessregion","deprecated":false},{"title":"/v1/einvoice/business-regions/{key}","summary":"Update an e-invoicing business region","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-invoicing/put_updateeinvoicingbusinessregion","deprecated":false},{"title":"/v1/e-invoice/mandates","summary":"List mandates for downloading files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/geteinvoicemandates","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/e-invoice/mandate","summary":"Retrieve a mandate for downloading a file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/geteinvoicemandateoninvoice","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/e-invoice/mandate","summary":"Retrieve a mandate for downloading a credit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/geteinvoicecreditmemomandate","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/e-invoice/mandate","summary":"Retrieve a mandate for downloading a debit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/geteinvoicedebitmemomandate","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/e-invoice/download","summary":"Download a file in the specified file format","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/downloadeinvoiceofspecifiedformat","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/e-invoice/download","summary":"Download a credit memo in the specified file format","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/downloadcreditmemoeinvoice","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/e-invoice/download","summary":"Download a debit memo in the specified file format","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/downloaddebitmemoeinvoice","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/e-invoice/cancel","summary":"Cancel the e-invoice file for an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-invoicing/canceleinvoicebyinvoicekey","deprecated":false},{"title":"/v1/einvoice/templates","summary":"List e-invoice file templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/get_einvoicefiletemplates","deprecated":false},{"title":"/v1/einvoice/templates","summary":"Create an e-invoice file template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-invoicing/post_createeinvoicefiletemplate","deprecated":false},{"title":"/v1/einvoice/templates/{key}","summary":"Delete an e-invoice file template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/e-invoicing/delete_einvoicefiletemplate","deprecated":false},{"title":"/v1/einvoice/templates/{key}","summary":"Retrieve an e-invoice file template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/get_einvoicefiletemplate","deprecated":false},{"title":"/v1/einvoice/templates/{key}","summary":"Update an e-invoice file template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-invoicing/put_einvoicefiletemplate","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/e-invoice/sync-status","summary":"Sync the e-Invoice status of an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-invoicing/updateinvoiceinvokesyncstatus","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/e-invoice/sync-status","summary":"Sync the e-Invoice status of a debit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-invoicing/updatedebitmemoinvokesyncstatus","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/e-invoice/sync-status","summary":"Sync the e-Invoice status of a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-invoicing/updatecreditmemoinvokesyncstatus","deprecated":false},{"title":"/v1/invoices/{invoiceKey}/einvoice/generate","summary":"Generate an e-invoice file for an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-invoicing/put_generationeinvoicegenerationforinvoices","deprecated":false},{"title":"/v1/credit-memos/{creditMemoKey}/e-invoice/generate","summary":"Generate an e-invoice file for a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-invoicing/put_generateeinvoicefileforcreditmemo","deprecated":false},{"title":"/v1/debit-memos/{debitMemoKey}/e-invoice/generate","summary":"Generate an e-invoice file for a debit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-invoicing/put_generateeinvoicefilefordebitmemo","deprecated":false},{"title":"/v1/e-compliance/lifecycle/status-update","summary":"Create an e-invoice lifecycle status update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-invoicing/createeinvoicelifecyclestatusupdate","deprecated":false},{"title":"/v1/e-compliance/lifecycle/status-updates","summary":"List e-invoice business lifecycle status updates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/geteinvoicelifecyclestatusupdates","deprecated":false},{"title":"/v1/e-compliance/lifecycle/status-updates/{key}","summary":"Retrieve an e-invoice business lifecycle status update by key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-invoicing/geteinvoicelifecyclestatusupdate","deprecated":false},{"title":"/v1/e-compliance/reconcile","summary":"Reconcile an e-compliance request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-invoicing/reconcileecompliance","deprecated":false},{"title":"/v1/e-compliance/trigger","summary":"Trigger an e-compliance request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-invoicing/triggerecompliancerequest","deprecated":false},{"title":"/v1/e-compliance/regenerate","summary":"Regenerate an e-compliance request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-invoicing/regenerateecompliancerequest","deprecated":false}]}]}]}]}},{"type":"group","label":"E-Reporting","link":"/v1-api-reference/api/e-reporting","routeSlug":"/v1-api-reference/api/e-reporting","items":[{"label":"Reconcile an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/reconcileecompliance","routeSlug":"/v1-api-reference/api/e-reporting/reconcileecompliance","metadata":{"seo":{"title":"Reconcile an e-compliance request","description":"Reconciles an e-compliance request for the supplied source object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reconcileECompliance","name":"Reconcile an e-compliance request","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1reconcile/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reconcile an e-compliance 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":"Reconciles an e-compliance request for the supplied source object."},"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":": In the broader e-compliance workflow, this operation can work alongside the \"Create an e-invoice lifecycle status update\" operation that is shared across e-reporting and e-invoice business lifecycle processing."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1reconcile/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceReconcileRequest"}},"schemaId":"components/schemas/EComplianceReconcileRequest","pointer":"/paths/~1v1~1e-compliance~1reconcile/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/e-compliance/reconcile","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EComplianceReconcileRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/reconcile","href":"e-reporting/reconcileecompliance","openApiOperationId":"reconcileECompliance","summary":"Reconcile an e-compliance request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/EComplianceReconcileRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceReconcileRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-compliance~1reconcile/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1reconcile/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/reconcileecompliance"}],"panels":[]}]},"httpPath":"/v1/e-compliance/reconcile"},{"label":"List all e-reporting templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/getereportingtemplates","routeSlug":"/v1-api-reference/api/e-reporting/getereportingtemplates","metadata":{"seo":{"title":"List all e-reporting templates","description":"Lists information about e-reporting templates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEReportingTemplates","name":"List all e-reporting templates","isWebhook":false,"pointer":"/paths/~1v1~1e-reporting~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all e-reporting templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists information about e-reporting templates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-reporting~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-reporting/templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-reporting/templates","href":"e-reporting/getereportingtemplates","openApiOperationId":"getEReportingTemplates","summary":"List all e-reporting templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingTemplatesResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EReportingTemplatesResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v1~1e-reporting~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EReportingTemplatesResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingTemplatesResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/getereportingtemplates"}],"panels":[]}]},"httpPath":"/v1/e-reporting/templates"},{"label":"Create an e-reporting template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/createereportingtemplate","routeSlug":"/v1-api-reference/api/e-reporting/createereportingtemplate","metadata":{"seo":{"title":"Create an e-reporting template","description":"Creates an e-reporting template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEReportingTemplate","name":"Create an e-reporting template","isWebhook":false,"pointer":"/paths/~1v1~1e-reporting~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an e-reporting template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an e-reporting template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-reporting~1templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostEReportingTemplateRequest"}},"schemaId":"components/schemas/PostEReportingTemplateRequest","pointer":"/paths/~1v1~1e-reporting~1templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/e-reporting/templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostEReportingTemplateRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-reporting/templates","href":"e-reporting/createereportingtemplate","openApiOperationId":"createEReportingTemplate","summary":"Create an e-reporting template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostEReportingTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostEReportingTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-reporting~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/createereportingtemplate"}],"panels":[]}]},"httpPath":"/v1/e-reporting/templates"},{"label":"Delete an e-reporting template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/deleteereportingtemplate","routeSlug":"/v1-api-reference/api/e-reporting/deleteereportingtemplate","metadata":{"seo":{"title":"Delete an e-reporting template","description":"Deletes an e-reporting template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEReportingTemplate","name":"Delete an e-reporting template","isWebhook":false,"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an e-reporting template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an e-reporting template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique ID of an E-Reporting template.","required":true}],"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/e-reporting/templates/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-reporting/templates/{key}","href":"e-reporting/deleteereportingtemplate","openApiOperationId":"deleteEReportingTemplate","summary":"Delete an e-reporting template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/deleteereportingtemplate"}],"panels":[]}]},"httpPath":"/v1/e-reporting/templates/{key}"},{"label":"Retrieve an e-reporting template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/getereportingtemplate","routeSlug":"/v1-api-reference/api/e-reporting/getereportingtemplate","metadata":{"seo":{"title":"Retrieve an e-reporting template","description":"Retrieves an e-reporting template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEReportingTemplate","name":"Retrieve an e-reporting template","isWebhook":false,"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an e-reporting template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an e-reporting template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique ID of an E-Reporting template.","required":true}],"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-reporting/templates/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-reporting/templates/{key}","href":"e-reporting/getereportingtemplate","openApiOperationId":"getEReportingTemplate","summary":"Retrieve an e-reporting template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/getereportingtemplate"}],"panels":[]}]},"httpPath":"/v1/e-reporting/templates/{key}"},{"label":"Update an e-reporting template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/updateereportingtemplate","routeSlug":"/v1-api-reference/api/e-reporting/updateereportingtemplate","metadata":{"seo":{"title":"Update an e-reporting template","description":"Updates an e-reporting template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEReportingTemplate","name":"Update an e-reporting template","isWebhook":false,"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an e-reporting template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an e-reporting template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique ID of an E-Reporting template.","required":true}],"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutEReportingTemplateRequest"}},"schemaId":"components/schemas/PutEReportingTemplateRequest","pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/e-reporting/templates/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutEReportingTemplateRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-reporting/templates/{key}","href":"e-reporting/updateereportingtemplate","openApiOperationId":"updateEReportingTemplate","summary":"Update an e-reporting template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutEReportingTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutEReportingTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-reporting~1templates~1{key}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingTemplateResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/updateereportingtemplate"}],"panels":[]}]},"httpPath":"/v1/e-reporting/templates/{key}"},{"label":"List e-reporting business regions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/listereportingbusinessregions","routeSlug":"/v1-api-reference/api/e-reporting/listereportingbusinessregions","metadata":{"seo":{"title":"List e-reporting business regions","description":"Lists e-reporting business regions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEReportingBusinessRegions","name":"List e-reporting business regions","isWebhook":false,"pointer":"/paths/~1v1~1e-reporting~1business-regions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List e-reporting business regions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists e-reporting business regions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-reporting~1business-regions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-reporting/business-regions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-reporting/business-regions","href":"e-reporting/listereportingbusinessregions","openApiOperationId":"listEReportingBusinessRegions","summary":"List e-reporting business regions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingBusinessRegionResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EReportingBusinessRegionResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v1~1e-reporting~1business-regions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EReportingBusinessRegionResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingBusinessRegionResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/listereportingbusinessregions"}],"panels":[]}]},"httpPath":"/v1/e-reporting/business-regions"},{"label":"Create an e-reporting business region","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/createereportingbusinessregion","routeSlug":"/v1-api-reference/api/e-reporting/createereportingbusinessregion","metadata":{"seo":{"title":"Create an e-reporting business region","description":"Creates an e-reporting business region."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEReportingBusinessRegion","name":"Create an e-reporting business region","isWebhook":false,"pointer":"/paths/~1v1~1e-reporting~1business-regions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an e-reporting business region","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an e-reporting business region."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-reporting~1business-regions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostEReportingBusinessRegionRequest"}},"schemaId":"components/schemas/PostEReportingBusinessRegionRequest","pointer":"/paths/~1v1~1e-reporting~1business-regions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/e-reporting/business-regions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostEReportingBusinessRegionRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-reporting/business-regions","href":"e-reporting/createereportingbusinessregion","openApiOperationId":"createEReportingBusinessRegion","summary":"Create an e-reporting business region"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostEReportingBusinessRegionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostEReportingBusinessRegionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-reporting~1business-regions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/createereportingbusinessregion"}],"panels":[]}]},"httpPath":"/v1/e-reporting/business-regions"},{"label":"Delete an e-reporting business region","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/deleteereportingbusinessregion","routeSlug":"/v1-api-reference/api/e-reporting/deleteereportingbusinessregion","metadata":{"seo":{"title":"Delete an e-reporting business region","description":"Deletes an e-reporting business region."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEReportingBusinessRegion","name":"Delete an e-reporting business region","isWebhook":false,"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an e-reporting business region","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an e-reporting business region."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique ID or natural key of an e-reporting business region.","required":true}],"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/e-reporting/business-regions/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-reporting/business-regions/{key}","href":"e-reporting/deleteereportingbusinessregion","openApiOperationId":"deleteEReportingBusinessRegion","summary":"Delete an e-reporting business region"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/deleteereportingbusinessregion"}],"panels":[]}]},"httpPath":"/v1/e-reporting/business-regions/{key}"},{"label":"Retrieve an e-reporting business region","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/getereportingbusinessregion","routeSlug":"/v1-api-reference/api/e-reporting/getereportingbusinessregion","metadata":{"seo":{"title":"Retrieve an e-reporting business region","description":"Retrieves an e-reporting business region."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEReportingBusinessRegion","name":"Retrieve an e-reporting business region","isWebhook":false,"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an e-reporting business region","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an e-reporting business region."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique ID or natural key of an e-reporting business region.","required":true}],"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-reporting/business-regions/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-reporting/business-regions/{key}","href":"e-reporting/getereportingbusinessregion","openApiOperationId":"getEReportingBusinessRegion","summary":"Retrieve an e-reporting business region"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response"]},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response"]}],"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/getereportingbusinessregion"}],"panels":[]}]},"httpPath":"/v1/e-reporting/business-regions/{key}"},{"label":"Update an e-reporting business region","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/updateereportingbusinessregion","routeSlug":"/v1-api-reference/api/e-reporting/updateereportingbusinessregion","metadata":{"seo":{"title":"Update an e-reporting business region","description":"Updates an e-reporting business region."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEReportingBusinessRegion","name":"Update an e-reporting business region","isWebhook":false,"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an e-reporting business region","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an e-reporting business region."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique ID or natural key of an e-reporting business region.","required":true}],"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutEReportingBusinessRegionRequest"}},"schemaId":"components/schemas/PutEReportingBusinessRegionRequest","pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/e-reporting/business-regions/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutEReportingBusinessRegionRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-reporting/business-regions/{key}","href":"e-reporting/updateereportingbusinessregion","openApiOperationId":"updateEReportingBusinessRegion","summary":"Update an e-reporting business region"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutEReportingBusinessRegionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutEReportingBusinessRegionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EReportingBusinessRegionsResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/updateereportingbusinessregion"}],"panels":[]}]},"httpPath":"/v1/e-reporting/business-regions/{key}"},{"label":"List e-reporting requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/getereportingrequests","routeSlug":"/v1-api-reference/api/e-reporting/getereportingrequests","metadata":{"seo":{"title":"List e-reporting requests","description":"Lists e-reporting requests, optionally filtered by source object and status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEReportingRequests","name":"List e-reporting requests","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1e-reporting~1requests/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List e-reporting requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists e-reporting requests, optionally filtered by source object and status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sourceObjectId","in":"query","schemaId":"schema_5","description":"The ID of the source object (e.g. invoice ID, credit memo ID, debit memo ID, payment application ID, refund application ID, credit memo application ID)."},{"name":"sourceObjectType","in":"query","schemaId":"schema_87","description":"Type of the source object. Can only be specified when sourceObjectId is also provided."},{"name":"status","in":"query","schemaId":"schema_5","description":"Status of the e-compliance request."},{"name":"page","in":"query","schemaId":"schema_28","description":"Page number (1-based)."},{"name":"pageSize","in":"query","schemaId":"schema_44","description":"Number of results per page."}],"pointer":"/paths/~1v1~1e-compliance~1e-reporting~1requests/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1e-reporting~1requests/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-compliance/e-reporting/requests","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"sourceObjectId","in":"query","required":false,"schemaId":"schema_5"},{"name":"sourceObjectType","in":"query","required":false,"schemaId":"components/schemas/EComplianceSourceObjectType"},{"name":"status","in":"query","required":false,"schemaId":"schema_5"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/e-reporting/requests","href":"e-reporting/getereportingrequests","openApiOperationId":"getEReportingRequests","summary":"List e-reporting requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEReportingRequestsResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEReportingRequestsResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests/get/responses/200/content/application~1json/examples/response"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"}],"pointer":"/paths/~1v1~1e-compliance~1e-reporting~1requests/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEReportingRequestsResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEReportingRequestsResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/getereportingrequests"}],"panels":[]}]},"httpPath":"/v1/e-compliance/e-reporting/requests"},{"label":"Retrieve an e-reporting request by key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/getereportingrequest","routeSlug":"/v1-api-reference/api/e-reporting/getereportingrequest","metadata":{"seo":{"title":"Retrieve an e-reporting request by key","description":"Retrieves a single e-reporting request by its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEReportingRequest","name":"Retrieve an e-reporting request by key","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an e-reporting request by key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single e-reporting request by its unique identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Unique identifier of the e-compliance request (EReportingRequest.id).","required":true}],"pointer":"/paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-compliance/e-reporting/requests/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/e-reporting/requests/{key}","href":"e-reporting/getereportingrequest","openApiOperationId":"getEReportingRequest","summary":"Retrieve an e-reporting request by key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEReportingRequestsResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetEReportingRequestsResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEReportingRequestsResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEReportingRequestsResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/getereportingrequest"}],"panels":[]}]},"httpPath":"/v1/e-compliance/e-reporting/requests/{key}"},{"label":"Download the e-compliance file for a source object","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/downloadecompliancefile","routeSlug":"/v1-api-reference/api/e-reporting/downloadecompliancefile","metadata":{"seo":{"title":"Download the e-compliance file for a source object","description":"Downloads the provider-certified compliance document for the given source object. The response Content-Type depends on the format returned by the provider (e.g. application/xml or application/pdf)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadEComplianceFile","name":"Download the e-compliance file for a source object","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download the e-compliance file for a source object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Downloads the provider-certified compliance document for the given source object. The response Content-Type depends on the format returned by the provider (e.g. application/xml or application/pdf)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"complianceType","in":"path","schemaId":"schema_88","description":"The e-compliance type.","required":true},{"name":"sourceObjectType","in":"path","schemaId":"schema_89","description":"The type of the source object.","required":true},{"name":"sourceObjectId","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the source object. For INVOICE, CREDIT_MEMO, and DEBIT_MEMO, pass the document ID. For PAYMENT and REFUND, pass the payment ID or refund ID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fileFormat","in":"query","schemaId":"schema_5","description":"Requested MIME type for the compliance document (e.g. application/xml, application/pdf). Defaults to the supplier-configured format."}],"pointer":"/paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-compliance/{complianceType}/files/{sourceObjectType}/{sourceObjectId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"complianceType","in":"path","required":true,"schemaId":"schema_88"},{"name":"sourceObjectType","in":"path","required":true,"schemaId":"schema_89"},{"name":"sourceObjectId","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fileFormat","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/{complianceType}/files/{sourceObjectType}/{sourceObjectId}","href":"e-reporting/downloadecompliancefile","openApiOperationId":"downloadEComplianceFile","summary":"Download the e-compliance file for a source object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response"]}},"exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/downloadecompliancefile"}],"panels":[]}]},"httpPath":"/v1/e-compliance/{complianceType}/files/{sourceObjectType}/{sourceObjectId}"},{"label":"Download the e-compliance snapshot for a source object","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/downloadecompliancesnapshot","routeSlug":"/v1-api-reference/api/e-reporting/downloadecompliancesnapshot","metadata":{"seo":{"title":"Download the e-compliance snapshot for a source object","description":"Downloads the provider-certified compliance snapshot for the given source object. The snapshot contains the raw payload submitted to the compliance provider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadEComplianceSnapshot","name":"Download the e-compliance snapshot for a source object","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download the e-compliance snapshot for a source object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Downloads the provider-certified compliance snapshot for the given source object. The snapshot contains the raw payload submitted to the compliance provider."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"complianceType","in":"path","schemaId":"schema_88","description":"The e-compliance type.","required":true},{"name":"sourceObjectType","in":"path","schemaId":"schema_89","description":"The type of the source object.","required":true},{"name":"sourceObjectId","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the source object. For INVOICE, CREDIT_MEMO, and DEBIT_MEMO, pass the document ID. For PAYMENT and REFUND, pass the payment ID or refund ID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/e-compliance/{complianceType}/snapshots/{sourceObjectType}/{sourceObjectId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"complianceType","in":"path","required":true,"schemaId":"schema_88"},{"name":"sourceObjectType","in":"path","required":true,"schemaId":"schema_89"},{"name":"sourceObjectId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/{complianceType}/snapshots/{sourceObjectType}/{sourceObjectId}","href":"e-reporting/downloadecompliancesnapshot","openApiOperationId":"downloadEComplianceSnapshot","summary":"Download the e-compliance snapshot for a source object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response"]}},"exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/downloadecompliancesnapshot"}],"panels":[]}]},"httpPath":"/v1/e-compliance/{complianceType}/snapshots/{sourceObjectType}/{sourceObjectId}"},{"label":"Trigger an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/triggerecompliancerequest","routeSlug":"/v1-api-reference/api/e-reporting/triggerecompliancerequest","metadata":{"seo":{"title":"Trigger an e-compliance request","description":"Creates an e-compliance request for the supplied source object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerEComplianceRequest","name":"Trigger an e-compliance request","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1trigger/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger an e-compliance request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an e-compliance request for the supplied source object."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1trigger/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceTriggerRequest"}},"schemaId":"components/schemas/EComplianceTriggerRequest","pointer":"/paths/~1v1~1e-compliance~1trigger/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/e-compliance/trigger","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EComplianceTriggerRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/trigger","href":"e-reporting/triggerecompliancerequest","openApiOperationId":"triggerEComplianceRequest","summary":"Trigger an e-compliance request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/EComplianceTriggerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceTriggerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-compliance~1trigger/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1trigger/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/triggerecompliancerequest"}],"panels":[]}]},"httpPath":"/v1/e-compliance/trigger"},{"label":"Regenerate an e-compliance request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/e-reporting/regenerateecompliancerequest","routeSlug":"/v1-api-reference/api/e-reporting/regenerateecompliancerequest","metadata":{"seo":{"title":"Regenerate an e-compliance request","description":"Regenerates a failed or rejected e-compliance request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"regenerateEComplianceRequest","name":"Regenerate an e-compliance request","isWebhook":false,"pointer":"/paths/~1v1~1e-compliance~1regenerate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate an e-compliance request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Regenerates a failed or rejected e-compliance request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1e-compliance~1regenerate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceRegenerateRequest"}},"schemaId":"components/schemas/EComplianceRegenerateRequest","pointer":"/paths/~1v1~1e-compliance~1regenerate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/e-compliance/regenerate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EComplianceRegenerateRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/e-compliance/regenerate","href":"e-reporting/regenerateecompliancerequest","openApiOperationId":"regenerateEComplianceRequest","summary":"Regenerate an e-compliance request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/EComplianceRegenerateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EComplianceRegenerateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1e-compliance~1regenerate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EComplianceActionResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1e-compliance~1regenerate/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-reporting/regenerateecompliancerequest"}],"panels":[]}]},"httpPath":"/v1/e-compliance/regenerate"}],"content":{"contentType":"group","meta":{"name":"E-Reporting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"E-Reporting","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":"With "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-reporting","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Reporting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you can submit financial documents such as invoices, credit memos, debit memos, payments, and refunds to tax authorities for compliance reporting. You can configure business regions and associate them with service providers to manage e-reporting requirements across different jurisdictions."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/e-compliance/reconcile","summary":"Reconcile an e-compliance request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-reporting/reconcileecompliance","deprecated":false},{"title":"/v1/e-reporting/templates","summary":"List all e-reporting templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-reporting/getereportingtemplates","deprecated":false},{"title":"/v1/e-reporting/templates","summary":"Create an e-reporting template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-reporting/createereportingtemplate","deprecated":false},{"title":"/v1/e-reporting/templates/{key}","summary":"Delete an e-reporting template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/e-reporting/deleteereportingtemplate","deprecated":false},{"title":"/v1/e-reporting/templates/{key}","summary":"Retrieve an e-reporting template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-reporting/getereportingtemplate","deprecated":false},{"title":"/v1/e-reporting/templates/{key}","summary":"Update an e-reporting template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-reporting/updateereportingtemplate","deprecated":false},{"title":"/v1/e-reporting/business-regions","summary":"List e-reporting business regions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-reporting/listereportingbusinessregions","deprecated":false},{"title":"/v1/e-reporting/business-regions","summary":"Create an e-reporting business region","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-reporting/createereportingbusinessregion","deprecated":false},{"title":"/v1/e-reporting/business-regions/{key}","summary":"Delete an e-reporting business region","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/e-reporting/deleteereportingbusinessregion","deprecated":false},{"title":"/v1/e-reporting/business-regions/{key}","summary":"Retrieve an e-reporting business region","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-reporting/getereportingbusinessregion","deprecated":false},{"title":"/v1/e-reporting/business-regions/{key}","summary":"Update an e-reporting business region","prefix":{"name":"put","color":"put"},"badges":[],"link":"/e-reporting/updateereportingbusinessregion","deprecated":false},{"title":"/v1/e-compliance/e-reporting/requests","summary":"List e-reporting requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-reporting/getereportingrequests","deprecated":false},{"title":"/v1/e-compliance/e-reporting/requests/{key}","summary":"Retrieve an e-reporting request by key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-reporting/getereportingrequest","deprecated":false},{"title":"/v1/e-compliance/{complianceType}/files/{sourceObjectType}/{sourceObjectId}","summary":"Download the e-compliance file for a source object","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-reporting/downloadecompliancefile","deprecated":false},{"title":"/v1/e-compliance/{complianceType}/snapshots/{sourceObjectType}/{sourceObjectId}","summary":"Download the e-compliance snapshot for a source object","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-reporting/downloadecompliancesnapshot","deprecated":false},{"title":"/v1/e-compliance/trigger","summary":"Trigger an e-compliance request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-reporting/triggerecompliancerequest","deprecated":false},{"title":"/v1/e-compliance/regenerate","summary":"Regenerate an e-compliance request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-reporting/regenerateecompliancerequest","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoice Schedules","link":"/v1-api-reference/api/invoice-schedules","routeSlug":"/v1-api-reference/api/invoice-schedules","items":[{"label":"Create an invoice schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/post_createinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/post_createinvoiceschedule","metadata":{"seo":{"title":"Create an invoice schedule","description":"Creates an invoice schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateInvoiceSchedule","name":"Create an invoice schedule","isWebhook":false,"pointer":"/paths/~1v1~1invoice-schedules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an invoice schedule","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 invoice schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"invoice-schedules/post_createinvoiceschedule/request/limitations","deepLinkHash":"/invoice-schedules/post_createinvoiceschedule#invoice-schedules/post_createinvoiceschedule/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API operation has the following limitations:"},"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":"You can create at most 50 invoice schedule items in one request."},"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":"You can associate at most 10 orders with an invoice schedule in one request."},"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":"You can associate at most 300 subscriptions with an invoice schedule in one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request, including those contained in orders and separate subscriptions."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoice-schedules/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateInvoiceScheduleRequest"}},"schemaId":"components/schemas/POSTCreateInvoiceScheduleRequest","pointer":"/paths/~1v1~1invoice-schedules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoice-schedules","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTCreateInvoiceScheduleRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoice-schedules","href":"invoice-schedules/post_createinvoiceschedule","openApiOperationId":"POST_CreateInvoiceSchedule","summary":"Create an invoice schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTCreateInvoiceScheduleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateInvoiceScheduleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoice-schedules/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-schedules/post_createinvoiceschedule"}],"panels":[]}]},"httpPath":"/v1/invoice-schedules"},{"label":"Delete an invoice schedule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/delete_invoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/delete_invoiceschedule","metadata":{"seo":{"title":"Delete an invoice schedule","description":"Deletes an invoice schedule in Pending status. The status of the invoiceschedule to be deleted must be Pending."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_InvoiceSchedule","name":"Delete an invoice schedule","isWebhook":false,"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an invoice schedule","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 an invoice schedule in Pending status. The status of the invoice"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule to be deleted must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"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":"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/invoice-schedules/{scheduleKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"scheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoice-schedules/{scheduleKey}","href":"invoice-schedules/delete_invoiceschedule","openApiOperationId":"DELETE_InvoiceSchedule","summary":"Delete an invoice schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-schedules/delete_invoiceschedule"}],"panels":[]}]},"httpPath":"/v1/invoice-schedules/{scheduleKey}"},{"label":"Retrieve an invoice schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/get_invoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/get_invoiceschedule","metadata":{"seo":{"title":"Retrieve an invoice schedule","description":"Retrieves detailed information about an invoice schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_InvoiceSchedule","name":"Retrieve an invoice schedule","isWebhook":false,"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an invoice schedule","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 detailed information about an invoice schedule."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoice-schedules/{scheduleKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"scheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoice-schedules/{scheduleKey}","href":"invoice-schedules/get_invoiceschedule","openApiOperationId":"GET_InvoiceSchedule","summary":"Retrieve an invoice schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-schedules/get_invoiceschedule"}],"panels":[]}]},"httpPath":"/v1/invoice-schedules/{scheduleKey}"},{"label":"Update an invoice schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/put_updateinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/put_updateinvoiceschedule","metadata":{"seo":{"title":"Update an invoice schedule","description":"Updates a pending invoice schedule. You can use this API operation to update invoice schedules in the following aspects:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateInvoiceSchedule","name":"Update an invoice schedule","isWebhook":false,"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an invoice schedule","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 pending invoice schedule. You can use this API operation to update invoice schedules in the following aspects:"},"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":"Update notes and pending invoice schedule items"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update orders associated with invoice schedules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove or add invoice schedule items"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more samples, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/billing-schedule/billing-schedule-tutorials/edit-invoice-schedules/overview-of-edit-invoice-schedules","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit invoice schedules"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"invoice-schedules/put_updateinvoiceschedule/request/restrictions-and-limitations","deepLinkHash":"/invoice-schedules/put_updateinvoiceschedule#invoice-schedules/put_updateinvoiceschedule/request/restrictions-and-limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrictions and limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When updating invoice schedules through the REST API, keep the following restrictions and limitations in mind:"},"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":"You can only update invoice schedule items 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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only add orders or specific subscriptions to pending invoice schedules, and remove orders or specific subscriptions from pending invoice schedules."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the invoice schedule items that you want to update, you must include the new values for these items in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the invoice schedule items that you want to keep unchanged, you must include all the existing information about these items in the request. Otherwise, the existing invoice schedule items that you do not include in the request are deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the orders that you want to keep unchanged for an invoice schedule, you must include all the existing order numbers associated with the invoice schedule in the request. Otherwise, the existing orders that you do not include in the request are removed."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTUpdateInvoiceScheduleRequest"}},"schemaId":"components/schemas/PUTUpdateInvoiceScheduleRequest","pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoice-schedules/{scheduleKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"scheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTUpdateInvoiceScheduleRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoice-schedules/{scheduleKey}","href":"invoice-schedules/put_updateinvoiceschedule","openApiOperationId":"PUT_UpdateInvoiceSchedule","summary":"Update an invoice schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTUpdateInvoiceScheduleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTUpdateInvoiceScheduleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-schedules/put_updateinvoiceschedule"}],"panels":[]}]},"httpPath":"/v1/invoice-schedules/{scheduleKey}"},{"label":"Execute an invoice schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/post_executeinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/post_executeinvoiceschedule","metadata":{"seo":{"title":"Execute an invoice schedule","description":"Executes an invoice schedule immediately. During the execution, a bill run is created and generates an invoice or a credit memo asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_ExecuteInvoiceSchedule","name":"Execute an invoice schedule","isWebhook":false,"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute an invoice schedule","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":"Executes an invoice schedule immediately. During the execution, a bill run is created and generates an invoice or a credit memo asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you use this API operation to execute an invoice schedule item, you have the flexibility to decide whether to specify a specific item ID."},"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 you specify the unique ID of an invoice schedule item to be executed in the request, the corresponding invoice schedule item is executed."},"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 specify the ID of any invoice schedule item in the request, the subscription end date is used as the target date to determine the next pending schedule item to be executed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A paused invoice schedule and charges inside cannot be automatically executed by Zuora Scheduler or by this \"Execute an invoice schedule\" API operation. In this case, you can do 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 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/POST_GenerateBillingDocuments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate billing documents by account ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more samples, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-execute-invoice-schedules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute invoice schedules"},"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":"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTExecuteInvoiceScheduleRequest"}},"schemaId":"components/schemas/POSTExecuteInvoiceScheduleRequest","pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoice-schedules/{scheduleKey}/execute","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"scheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTExecuteInvoiceScheduleRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoice-schedules/{scheduleKey}/execute","href":"invoice-schedules/post_executeinvoiceschedule","openApiOperationId":"POST_ExecuteInvoiceSchedule","summary":"Execute an invoice schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTExecuteInvoiceScheduleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTExecuteInvoiceScheduleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json","autoEmail","autoPost","autoRenewal","billRunFilters","billRunNumber","createdById","createdDate","id","invoiceDate","noEmailForZeroAmountInvoice","status","success","targetDate","updatedById","updatedDate"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExecuteInvoiceScheduleBillRunResponse"},"autoEmail":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoEmail/examples/response"]},"autoPost":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoPost/examples/response"]},"autoRenewal":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoRenewal/examples/response"]},"billRunFilters":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/billRunFilters/examples/response"]},"billRunNumber":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/billRunNumber/examples/response"]},"createdById":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/createdById/examples/response"]},"createdDate":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/createdDate/examples/response"]},"id":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/id/examples/response"]},"invoiceDate":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/invoiceDate/examples/response"]},"noEmailForZeroAmountInvoice":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/noEmailForZeroAmountInvoice/examples/response"]},"status":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/status/examples/response"]},"success":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/success/examples/response"]},"targetDate":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/targetDate/examples/response"]},"updatedById":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/updatedById/examples/response"]},"updatedDate":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/updatedDate/examples/response"]}},"schemaId":"components/schemas/ExecuteInvoiceScheduleBillRunResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExecuteInvoiceScheduleBillRunResponse","mediaTypes":["application/json","autoEmail","autoPost","autoRenewal","billRunFilters","billRunNumber","createdById","createdDate","id","invoiceDate","noEmailForZeroAmountInvoice","status","success","targetDate","updatedById","updatedDate"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExecuteInvoiceScheduleBillRunResponse"},"autoEmail":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoEmail/examples/response"]},"autoPost":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoPost/examples/response"]},"autoRenewal":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoRenewal/examples/response"]},"billRunFilters":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/billRunFilters/examples/response"]},"billRunNumber":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/billRunNumber/examples/response"]},"createdById":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/createdById/examples/response"]},"createdDate":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/createdDate/examples/response"]},"id":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/id/examples/response"]},"invoiceDate":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/invoiceDate/examples/response"]},"noEmailForZeroAmountInvoice":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/noEmailForZeroAmountInvoice/examples/response"]},"status":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/status/examples/response"]},"success":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/success/examples/response"]},"targetDate":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/targetDate/examples/response"]},"updatedById":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/updatedById/examples/response"]},"updatedDate":{"exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/updatedDate/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-schedules/post_executeinvoiceschedule"}],"panels":[]}]},"httpPath":"/v1/invoice-schedules/{scheduleKey}/execute"},{"label":"Pause an invoice schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/put_pauseinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/put_pauseinvoiceschedule","metadata":{"seo":{"title":"Pause an invoice schedule","description":"Pauses an invoice schedule immediately."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PauseInvoiceSchedule","name":"Pause an invoice schedule","isWebhook":false,"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pause an invoice schedule","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":"Pauses an invoice schedule immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A paused invoice schedule and charges inside cannot be automatically executed by Zuora"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduler or by the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/api-references/api/operation/POST_ExecuteInvoiceSchedule/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute an invoice schedule"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API operation. In this case, you can do 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 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/POST_GenerateBillingDocuments/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate billing documents by account ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API"},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoice-schedules/{scheduleKey}/pause","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"scheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoice-schedules/{scheduleKey}/pause","href":"invoice-schedules/put_pauseinvoiceschedule","openApiOperationId":"PUT_PauseInvoiceSchedule","summary":"Pause an invoice schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-schedules/put_pauseinvoiceschedule"}],"panels":[]}]},"httpPath":"/v1/invoice-schedules/{scheduleKey}/pause"},{"label":"Resume an invoice schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/put_resumeinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/put_resumeinvoiceschedule","metadata":{"seo":{"title":"Resume an invoice schedule","description":"Resumes an invoice schedule in Paused status immediately."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_ResumeInvoiceSchedule","name":"Resume an invoice schedule","isWebhook":false,"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resume an invoice schedule","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":"Resumes an invoice schedule in Paused status immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After an invoice schedule is resumed, it can continue to be automatically executed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by Zuora Scheduler or by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_ExecuteInvoiceSchedule/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute an invoice schedule"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API operation."},"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 is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoice-schedules/{scheduleKey}/resume","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"scheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/invoice-schedules/{scheduleKey}/resume","href":"invoice-schedules/put_resumeinvoiceschedule","openApiOperationId":"PUT_ResumeInvoiceSchedule","summary":"Resume an invoice schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceScheduleResponses","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-schedules/put_resumeinvoiceschedule"}],"panels":[]}]},"httpPath":"/v1/invoice-schedules/{scheduleKey}/resume"},{"label":"Detach charges from an invoice schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/detachchargesfrominvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/detachchargesfrominvoiceschedule","metadata":{"seo":{"title":"Detach charges from an invoice schedule","description":"Detaches charges from an invoice schedule. The invoice schedules you want to detach charges from must be in Fully Processed or Partially Processed status. Invoice schedules do not bill detached charges."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachChargesFromInvoiceSchedule","name":"Detach charges from an invoice schedule","isWebhook":false,"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detach charges from an invoice schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Detaches charges from an invoice schedule. The invoice schedules you want to detach charges from must be in Fully Processed or Partially Processed status. Invoice schedules do not bill detached charges.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of the invoice schedule to detach charges from. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DetachInvoiceScheduleRequest"}},"schemaId":"components/schemas/DetachInvoiceScheduleRequest","pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoice-schedules/{scheduleKey}/detach","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"scheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DetachInvoiceScheduleRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoice-schedules/{scheduleKey}/detach","href":"invoice-schedules/detachchargesfrominvoiceschedule","openApiOperationId":"detachChargesFromInvoiceSchedule","summary":"Detach charges from an invoice schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/DetachInvoiceScheduleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DetachInvoiceScheduleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-schedules/detachchargesfrominvoiceschedule"}],"panels":[]}]},"httpPath":"/v1/invoice-schedules/{scheduleKey}/detach"},{"label":"Attach charges to an invoice schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/invoice-schedules/attachchargestoinvoiceschedule","routeSlug":"/v1-api-reference/api/invoice-schedules/attachchargestoinvoiceschedule","metadata":{"seo":{"title":"Attach charges to an invoice schedule","description":"Attaches charges to an invoice schedule. The invoice schedules you want to attach charges to must be in Fully Processed or Partially Processed status. You can attach charges only if they were previously detached from the same invoice schedule. Invoice schedules will automatically bill re-attached charges in the upcoming planned invoice schedule items."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachChargesToInvoiceSchedule","name":"Attach charges to an invoice schedule","isWebhook":false,"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach charges to an invoice schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Attaches charges to an invoice schedule. The invoice schedules you want to attach charges to must be in Fully Processed or Partially Processed status. \nYou can attach charges only if they were previously detached from the same invoice schedule. Invoice schedules will automatically bill re-attached charges in the upcoming planned invoice schedule items.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleKey","in":"path","schemaId":"schema_5","description":"The unique ID or number of the invoice schedule to attach charges to. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AttachInvoiceScheduleRequest"}},"schemaId":"components/schemas/AttachInvoiceScheduleRequest","pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/invoice-schedules/{scheduleKey}/attach","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"scheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AttachInvoiceScheduleRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/invoice-schedules/{scheduleKey}/attach","href":"invoice-schedules/attachchargestoinvoiceschedule","openApiOperationId":"attachChargesToInvoiceSchedule","summary":"Attach charges to an invoice schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/AttachInvoiceScheduleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AttachInvoiceScheduleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-schedules/attachchargestoinvoiceschedule"}],"panels":[]}]},"httpPath":"/v1/invoice-schedules/{scheduleKey}/attach"}],"content":{"contentType":"group","meta":{"name":"Invoice Schedules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice Schedules","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 invoice schedules to trigger invoice generation processes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about invoice schedules, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule overview"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/invoice-schedules","summary":"Create an invoice schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoice-schedules/post_createinvoiceschedule","deprecated":false},{"title":"/v1/invoice-schedules/{scheduleKey}","summary":"Delete an invoice schedule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoice-schedules/delete_invoiceschedule","deprecated":false},{"title":"/v1/invoice-schedules/{scheduleKey}","summary":"Retrieve an invoice schedule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoice-schedules/get_invoiceschedule","deprecated":false},{"title":"/v1/invoice-schedules/{scheduleKey}","summary":"Update an invoice schedule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoice-schedules/put_updateinvoiceschedule","deprecated":false},{"title":"/v1/invoice-schedules/{scheduleKey}/execute","summary":"Execute an invoice schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoice-schedules/post_executeinvoiceschedule","deprecated":false},{"title":"/v1/invoice-schedules/{scheduleKey}/pause","summary":"Pause an invoice schedule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoice-schedules/put_pauseinvoiceschedule","deprecated":false},{"title":"/v1/invoice-schedules/{scheduleKey}/resume","summary":"Resume an invoice schedule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoice-schedules/put_resumeinvoiceschedule","deprecated":false},{"title":"/v1/invoice-schedules/{scheduleKey}/detach","summary":"Detach charges from an invoice schedule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoice-schedules/detachchargesfrominvoiceschedule","deprecated":false},{"title":"/v1/invoice-schedules/{scheduleKey}/attach","summary":"Attach charges to an invoice schedule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoice-schedules/attachchargestoinvoiceschedule","deprecated":false}]}]}]}]}},{"type":"group","label":"Taxation Items","link":"/v1-api-reference/api/taxation-items","routeSlug":"/v1-api-reference/api/taxation-items","items":[{"label":"CRUD: Create a taxation item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/taxation-items/object_posttaxationitem","routeSlug":"/v1-api-reference/api/taxation-items/object_posttaxationitem","metadata":{"seo":{"title":"CRUD: Create a taxation item","description":"Creates a Taxation Item object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_POSTTaxationItem","name":"CRUD: Create a taxation item","isWebhook":false,"pointer":"/paths/~1v1~1object~1taxation-item/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Create a taxation item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Taxation Item object."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1taxation-item/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1taxation-item/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyCreateTaxationItem"}},"schemaId":"components/schemas/ProxyCreateTaxationItem","pointer":"/paths/~1v1~1object~1taxation-item/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/object/taxation-item","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyCreateTaxationItem"}},"responseCodes":["200","400","401"],"pointer":"/v1/object/taxation-item","href":"taxation-items/object_posttaxationitem","openApiOperationId":"Object_POSTTaxationItem","summary":"CRUD: Create a taxation item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyCreateTaxationItem","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyCreateTaxationItem"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1taxation-item/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1taxation-item/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxation-items/object_posttaxationitem"}],"panels":[]}]},"httpPath":"/v1/object/taxation-item"},{"label":"Delete a taxation item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/taxation-items/delete_taxationitem","routeSlug":"/v1-api-reference/api/taxation-items/delete_taxationitem","metadata":{"seo":{"title":"Delete a taxation item","description":"Deletes a specific taxation item by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_TaxationItem","name":"Delete a taxation item","isWebhook":false,"pointer":"/paths/~1v1~1taxation-items~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a taxation item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific taxation item by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The unique ID of a taxation item.\n","required":true}],"pointer":"/paths/~1v1~1taxation-items~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1taxation-items~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/taxation-items/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/taxation-items/{id}","href":"taxation-items/delete_taxationitem","openApiOperationId":"DELETE_TaxationItem","summary":"Delete a taxation item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1taxation-items~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxation-items/delete_taxationitem"}],"panels":[]}]},"httpPath":"/v1/taxation-items/{id}"},{"label":"Retrieve a taxation item\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/taxation-items/get_taxationitem","routeSlug":"/v1-api-reference/api/taxation-items/get_taxationitem","metadata":{"seo":{"title":"Retrieve a taxation item\n","description":"Retrieves the information about a specific taxation item by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_TaxationItem","name":"Retrieve a taxation item\n","isWebhook":false,"pointer":"/paths/~1v1~1taxation-items~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a taxation item\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the information about a specific taxation item by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The unique ID of a taxation item.\n","required":true}],"pointer":"/paths/~1v1~1taxation-items~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1taxation-items~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/taxation-items/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/taxation-items/{id}","href":"taxation-items/get_taxationitem","openApiOperationId":"GET_TaxationItem","summary":"Retrieve a taxation item\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemType","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETTaxationItemType","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1taxation-items~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETTaxationItemType","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemType","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxation-items/get_taxationitem"}],"panels":[]}]},"httpPath":"/v1/taxation-items/{id}"},{"label":"Update a taxation item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/taxation-items/put_taxationitem","routeSlug":"/v1-api-reference/api/taxation-items/put_taxationitem","metadata":{"seo":{"title":"Update a taxation item","description":"Updates a specific taxation item by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_TaxationItem","name":"Update a taxation item","isWebhook":false,"pointer":"/paths/~1v1~1taxation-items~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a taxation item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific taxation item by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The unique ID of a taxation item.\n","required":true}],"pointer":"/paths/~1v1~1taxation-items~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1taxation-items~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/PUTTaxationItemType"}},"schemaId":"components/schemas/PUTTaxationItemType","pointer":"/paths/~1v1~1taxation-items~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/taxation-items/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTTaxationItemType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/taxation-items/{id}","href":"taxation-items/put_taxationitem","openApiOperationId":"PUT_TaxationItem","summary":"Update a taxation item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTTaxationItemType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTTaxationItemType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemType","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETTaxationItemType","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1taxation-items~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETTaxationItemType","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETTaxationItemType","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1taxation-items~1{id}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxation-items/put_taxationitem"}],"panels":[]}]},"httpPath":"/v1/taxation-items/{id}"}],"content":{"contentType":"group","meta":{"name":"Taxation Items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Taxation Items","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":"The TaxationItem object is used to add a tax amount to an invoice item. In the typical use case, the tax amount that you specify in the object is calculated by "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-zuora-tax-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z-Tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a third-party tax engine such as "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-direct-avalara-integration-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Avalara"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-connect-tax-engines","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect tax engine"},"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":"Changes that you make with this object affect the product charges in your product catalog, but not the charges in existing subscriptions."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/object/taxation-item","summary":"CRUD: Create a taxation item","prefix":{"name":"post","color":"post"},"badges":[],"link":"/taxation-items/object_posttaxationitem","deprecated":false},{"title":"/v1/taxation-items/{id}","summary":"Delete a taxation item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/taxation-items/delete_taxationitem","deprecated":false},{"title":"/v1/taxation-items/{id}","summary":"Retrieve a taxation item\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/taxation-items/get_taxationitem","deprecated":false},{"title":"/v1/taxation-items/{id}","summary":"Update a taxation item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/taxation-items/put_taxationitem","deprecated":false}]}]}]}]}},{"type":"group","label":"Sequence Sets","link":"/v1-api-reference/api/sequence-sets","routeSlug":"/v1-api-reference/api/sequence-sets","items":[{"label":"List sequence sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sequence-sets/get_sequencesets","routeSlug":"/v1-api-reference/api/sequence-sets/get_sequencesets","metadata":{"seo":{"title":"List sequence sets","description":"Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_SequenceSets","name":"List sequence sets","isWebhook":false,"pointer":"/paths/~1v1~1sequence-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List sequence sets","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 information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use query parameters to restrict the data returned in the response."},"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 Credit and Debit Memos feature is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_90","description":"The number of records returned per page in the response.\n"},{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"name","in":"query","schemaId":"schema_5","description":"The name or number of a specific sequence set.\n"}],"pointer":"/paths/~1v1~1sequence-sets/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1sequence-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/sequence-sets","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_90"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"name","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/sequence-sets","href":"sequence-sets/get_sequencesets","openApiOperationId":"GET_SequenceSets","summary":"List sequence sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETSequenceSetsResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETSequenceSetsResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1sequence-sets/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETSequenceSetsResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETSequenceSetsResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sequence-sets/get_sequencesets"}],"panels":[]}]},"httpPath":"/v1/sequence-sets"},{"label":"Create sequence sets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sequence-sets/post_sequencesets","routeSlug":"/v1-api-reference/api/sequence-sets/post_sequencesets","metadata":{"seo":{"title":"Create sequence sets","description":"Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_SequenceSets","name":"Create sequence sets","isWebhook":false,"pointer":"/paths/~1v1~1sequence-sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create sequence sets","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 sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a maximum of 100 sequence sets in one single request. A sequence set comprises a set of custom prefixes and starting numbers that are used for billing documents to generate, and payments and refunds to create."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-config-of-prefix-and-number-for-billing-docs"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix and Numbering Configuration for Billing Documents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about limitations."},"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 Credit and Debit Memos feature is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1sequence-sets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTSequenceSetsRequest"}},"schemaId":"components/schemas/POSTSequenceSetsRequest","pointer":"/paths/~1v1~1sequence-sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/sequence-sets","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTSequenceSetsRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/sequence-sets","href":"sequence-sets/post_sequencesets","openApiOperationId":"POST_SequenceSets","summary":"Create sequence sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTSequenceSetsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTSequenceSetsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTSequenceSetsResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTSequenceSetsResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1sequence-sets/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTSequenceSetsResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTSequenceSetsResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sequence-sets/post_sequencesets"}],"panels":[]}]},"httpPath":"/v1/sequence-sets"},{"label":"Delete a sequence set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sequence-sets/delete_sequenceset","routeSlug":"/v1-api-reference/api/sequence-sets/delete_sequenceset","metadata":{"seo":{"title":"Delete a sequence set","description":"Deletes a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_SequenceSet","name":"Delete a sequence set","isWebhook":false,"pointer":"/paths/~1v1~1sequence-sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a sequence set","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 specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."},"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 Credit and Debit Memos feature is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID or number of the sequence set to delete.\n","required":true}],"pointer":"/paths/~1v1~1sequence-sets~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1sequence-sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/sequence-sets/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/sequence-sets/{id}","href":"sequence-sets/delete_sequenceset","openApiOperationId":"DELETE_SequenceSet","summary":"Delete a sequence set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1sequence-sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sequence-sets/delete_sequenceset"}],"panels":[]}]},"httpPath":"/v1/sequence-sets/{id}"},{"label":"Retrieve a sequence set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sequence-sets/get_sequenceset","routeSlug":"/v1-api-reference/api/sequence-sets/get_sequenceset","metadata":{"seo":{"title":"Retrieve a sequence set","description":"Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_SequenceSet","name":"Retrieve a sequence set","isWebhook":false,"pointer":"/paths/~1v1~1sequence-sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a sequence set","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 information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos"},"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 Credit and Debit Memos feature is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID or number of the sequence set to retrieve information about.\n","required":true}],"pointer":"/paths/~1v1~1sequence-sets~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1sequence-sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/sequence-sets/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/sequence-sets/{id}","href":"sequence-sets/get_sequenceset","openApiOperationId":"GET_SequenceSet","summary":"Retrieve a sequence set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETSequenceSetResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETSequenceSetResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1sequence-sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETSequenceSetResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETSequenceSetResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sequence-sets/get_sequenceset"}],"panels":[]}]},"httpPath":"/v1/sequence-sets/{id}"},{"label":"Update a sequence set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/sequence-sets/put_sequenceset","routeSlug":"/v1-api-reference/api/sequence-sets/put_sequenceset","metadata":{"seo":{"title":"Update a sequence set","description":"Updates a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_SequenceSet","name":"Update a sequence set","isWebhook":false,"pointer":"/paths/~1v1~1sequence-sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a sequence set","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 specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos."},"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 Credit and Debit Memos feature is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID or number of the sequence set to update.\n","required":true}],"pointer":"/paths/~1v1~1sequence-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1sequence-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSequenceSetRequest"}},"schemaId":"components/schemas/PUTSequenceSetRequest","pointer":"/paths/~1v1~1sequence-sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/sequence-sets/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTSequenceSetRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/sequence-sets/{id}","href":"sequence-sets/put_sequenceset","openApiOperationId":"PUT_SequenceSet","summary":"Update a sequence set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTSequenceSetRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTSequenceSetRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTSequenceSetResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTSequenceSetResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1sequence-sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTSequenceSetResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTSequenceSetResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1sequence-sets~1{id}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sequence-sets/put_sequenceset"}],"panels":[]}]},"httpPath":"/v1/sequence-sets/{id}"}],"content":{"contentType":"group","meta":{"name":"Sequence Sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sequence Sets","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":"You can create billing document sequence sets through the REST API or the Zuora UI, allowing distinct numbering sequences for billing documents, payments, and refunds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a billing document sequence set through the Zuora UI, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/billing-settings-configuration/billing-document-settings/configuration-of-prefix-and-numbering-for-billing-documents/create-billing-document-sequence-sets","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Billing Document Sequence Sets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/sequence-sets","summary":"List sequence sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sequence-sets/get_sequencesets","deprecated":false},{"title":"/v1/sequence-sets","summary":"Create sequence sets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sequence-sets/post_sequencesets","deprecated":false},{"title":"/v1/sequence-sets/{id}","summary":"Delete a sequence set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sequence-sets/delete_sequenceset","deprecated":false},{"title":"/v1/sequence-sets/{id}","summary":"Retrieve a sequence set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sequence-sets/get_sequenceset","deprecated":false},{"title":"/v1/sequence-sets/{id}","summary":"Update a sequence set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sequence-sets/put_sequenceset","deprecated":false}]}]}]}]}},{"type":"group","label":"Operations","link":"/v1-api-reference/api/operations","routeSlug":"/v1-api-reference/api/operations","items":[{"label":"Generate a billing preview","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/operations/post_billingpreview","routeSlug":"/v1-api-reference/api/operations/post_billingpreview","metadata":{"seo":{"title":"Generate a billing preview","description":"Generates a preview of future invoice items for one customer account. Use the BillingPreview call to calculate how much a single customer will be invoiced from the most recent invoice to a specific end of term date in the future."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_BillingPreview","name":"Generate a billing preview","isWebhook":false,"pointer":"/paths/~1v1~1operations~1billing-preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a billing preview","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":"Generates a preview of future invoice items for one customer account. Use the BillingPreview call to calculate how much a single customer will be invoiced from the most recent invoice to a specific end of term date in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, you can use the BillingPreview service to access real-time data on an individual customer's usage consumption."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The BillingPreview call only calculates taxes for charges in the subscription if you use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-zuora-tax-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the product rate plan charge associated with the invoice item uses the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-tax-code-and-set-tax-mode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax inclusive mode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; otherwise, this call does not calculate taxes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Invoice Settlement feature enabled, you can also generate a preview of future credit memo items for one customer account. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1operations~1billing-preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBillingPreviewParam"}},"schemaId":"components/schemas/PostBillingPreviewParam","pointer":"/paths/~1v1~1operations~1billing-preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/operations/billing-preview","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostBillingPreviewParam"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/operations/billing-preview","href":"operations/post_billingpreview","openApiOperationId":"POST_BillingPreview","summary":"Generate a billing preview"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostBillingPreviewParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBillingPreviewParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingPreviewResult","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/BillingPreviewResult","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1operations~1billing-preview/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingPreviewResult","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingPreviewResult","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1billing-preview/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/post_billingpreview"}],"panels":[]}]},"httpPath":"/v1/operations/billing-preview"},{"label":"Invoice and collect","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/operations/post_transactioninvoicepayment","routeSlug":"/v1-api-reference/api/operations/post_transactioninvoicepayment","metadata":{"seo":{"title":"Invoice and collect","description":"Generates and posts invoices and credit memos, and collects payments for posted invoices. Credit memos are only available if you have the InvoiceSettlement feature enabled and negative charges exist. Credit memos will not be applied to invoices. If draft invoices and credit memos exist when you runthis operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan chargewill not be posted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_TransactionInvoicePayment","name":"Invoice and collect","isWebhook":false,"pointer":"/paths/~1v1~1operations~1invoice-collect/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice and collect","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":"Generates and posts invoices and credit memos, and collects payments for posted invoices. Credit memos are only available if you have the Invoice"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices. If draft invoices and credit memos exist when you run"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will not be posted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this operation to generate invoices and collect payments on the posted invoices, or else simply collect payment on a specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"existing invoice. The customer's default payment method is used, and the full amount due is collected. The operation depends on the parameters you specify."},"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 generate one or more new invoices for that customer and collect payment on the generated and other unpaid invoice(s), leave the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To collect payment on an existing invoice, specify the invoice ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation is atomic; if any part is unsuccessful, the entire operation is rolled back."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an error occurs, gateway reason codes and error messages are returned the error response of this operation. The following items are some gateway response code examples."},"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":"Orbital: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05 Do Not Honor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14 Invalid Credit Card Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vantiv: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"301 Invalid Account Number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"304 Lost/Stolen Card"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CyberSource2: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Expired card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"231 Invalid account number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more reason code information, see the corresponding payment gateway documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"operations/post_transactioninvoicepayment/request/notes","deepLinkHash":"/operations/post_transactioninvoicepayment#operations/post_transactioninvoicepayment/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeouts may occur when using this method on an account that has an extremely high number of subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"operations/post_transactioninvoicepayment/request/multiple-currencies-limitation","deepLinkHash":"/operations/post_transactioninvoicepayment#operations/post_transactioninvoicepayment/request/multiple-currencies-limitation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies limitation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified in the request, the \"Invoice and collect\" operation generates invoices and then attempts to collect payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the account has the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/multiple-currencies/multiple-currencies-overview/enable-multiple-currencies","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled and has subscriptions in currencies that differ from the account's default currency,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the operation returns a validation error. This occurs because the payment is created using the account's default currency, which may not match the currency of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all generated invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"operations/post_transactioninvoicepayment/request/workaround","deepLinkHash":"/operations/post_transactioninvoicepayment#operations/post_transactioninvoicepayment/request/workaround"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workaround"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To collect invoices with currencies that differ from the account currency, specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the invoice already exists, pass the specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body. The API correctly handles collection for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific invoice regardless of its currency."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1operations~1invoice-collect/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTInvoiceCollectType"}},"schemaId":"components/schemas/POSTInvoiceCollectType","pointer":"/paths/~1v1~1operations~1invoice-collect/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/operations/invoice-collect","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTInvoiceCollectType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/operations/invoice-collect","href":"operations/post_transactioninvoicepayment","openApiOperationId":"POST_TransactionInvoicePayment","summary":"Invoice and collect"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTInvoiceCollectType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTInvoiceCollectType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTInvoiceCollectResponseType","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTInvoiceCollectResponseType","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1operations~1invoice-collect/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTInvoiceCollectResponseType","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTInvoiceCollectResponseType","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1invoice-collect/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/post_transactioninvoicepayment"}],"panels":[]}]},"httpPath":"/v1/operations/invoice-collect"},{"label":"Retrieve an operation job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/operations/get_operationjob","routeSlug":"/v1-api-reference/api/operations/get_operationjob","metadata":{"seo":{"title":"Retrieve an operation job","description":"Retrieves information about a specific operation job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_OperationJob","name":"Retrieve an operation job","isWebhook":false,"pointer":"/paths/~1v1~1operations~1jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an operation job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves information about a specific operation job.\n\nCurrently, you can only use this API operation to retrieve the status information about invoice deletion and reversal operation jobs.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_5","description":"The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab.\n","required":true}],"pointer":"/paths/~1v1~1operations~1jobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1operations~1jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/operations/jobs/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/operations/jobs/{jobId}","href":"operations/get_operationjob","openApiOperationId":"GET_OperationJob","summary":"Retrieve an operation job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOperationJobResponseType","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetOperationJobResponseType","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1operations~1jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOperationJobResponseType","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOperationJobResponseType","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/get_operationjob"}],"panels":[]}]},"httpPath":"/v1/operations/jobs/{jobId}"},{"label":"Export bulk PDF files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/operations/create_bulkpdftozipgeneration","routeSlug":"/v1-api-reference/api/operations/create_bulkpdftozipgeneration","metadata":{"seo":{"title":"Export bulk PDF files","description":"The background job that compresses large number of PDF(s) into ZIP files. For answers to frequently asked questions regarding exporting bulk PDF files, see Export Bulk PDF Files FAQs.Note: Do not include multiple objectIds with the same PDF file names in a single bulk PDF upload request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_BulkPDFToZIPGeneration","name":"Export bulk PDF files","isWebhook":false,"pointer":"/paths/~1v1~1operations~1bulk-pdf/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export bulk PDF files","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":"The background job that compresses large number of PDF(s) into ZIP files. For answers to frequently asked questions regarding exporting bulk PDF files, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/export-bulk-pdf-files/faqs","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export Bulk PDF Files FAQs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":": Do not include multiple objectIds with the same PDF file names in a single bulk PDF upload request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1operations~1bulk-pdf/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTBulkPdfGenerationJobRequestType"}},"schemaId":"components/schemas/POSTBulkPdfGenerationJobRequestType","pointer":"/paths/~1v1~1operations~1bulk-pdf/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/operations/bulk-pdf","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTBulkPdfGenerationJobRequestType"}},"responseCodes":["200","400","500","4XX"],"pointer":"/v1/operations/bulk-pdf","href":"operations/create_bulkpdftozipgeneration","openApiOperationId":"Create_BulkPDFToZIPGeneration","summary":"Export bulk PDF files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTBulkPdfGenerationJobRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTBulkPdfGenerationJobRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTBulkPdfGenerationJobResponseType","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/POSTBulkPdfGenerationJobResponseType","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/400/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1operations~1bulk-pdf/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTBulkPdfGenerationJobResponseType","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTBulkPdfGenerationJobResponseType","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/create_bulkpdftozipgeneration"}],"panels":[]}]},"httpPath":"/v1/operations/bulk-pdf"},{"label":"Retrieve information of a bulk PDF file generation job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/operations/get_bulkpdftozipgeneration","routeSlug":"/v1-api-reference/api/operations/get_bulkpdftozipgeneration","metadata":{"seo":{"title":"Retrieve information of a bulk PDF file generation job","description":"Retrieves information about the job which includes its status, message, and downloadable ZIP file URL link."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_BulkPDFToZIPGeneration","name":"Retrieve information of a bulk PDF file generation job","isWebhook":false,"pointer":"/paths/~1v1~1operations~1bulk-pdf~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve information of a bulk PDF file generation job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves information about the job which includes its status, message, and downloadable ZIP file URL link."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_5","description":"The ID of the job for which information needs to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab","required":true}],"pointer":"/paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/operations/bulk-pdf/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/operations/bulk-pdf/{jobId}","href":"operations/get_bulkpdftozipgeneration","openApiOperationId":"Get_BulkPDFToZIPGeneration","summary":"Retrieve information of a bulk PDF file generation job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETBulkpdfGenerationJobResponseType","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GETBulkpdfGenerationJobResponseType","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETBulkpdfGenerationJobResponseType","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETBulkpdfGenerationJobResponseType","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/get_bulkpdftozipgeneration"}],"panels":[]}]},"httpPath":"/v1/operations/bulk-pdf/{jobId}"}],"content":{"contentType":"group","meta":{"name":"Operations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operations","showPageActions":true},{"nodeType":"markdoc","content":"Use operations to generate invoices and credit memos, collect payments for posted invoices, and generate previews of future invoice items for customer accounts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/operations/billing-preview","summary":"Generate a billing preview","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/post_billingpreview","deprecated":false},{"title":"/v1/operations/invoice-collect","summary":"Invoice and collect","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/post_transactioninvoicepayment","deprecated":false},{"title":"/v1/operations/jobs/{jobId}","summary":"Retrieve an operation job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/operations/get_operationjob","deprecated":false},{"title":"/v1/operations/bulk-pdf","summary":"Export bulk PDF files","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/create_bulkpdftozipgeneration","deprecated":false},{"title":"/v1/operations/bulk-pdf/{jobId}","summary":"Retrieve information of a bulk PDF file generation job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/operations/get_bulkpdftozipgeneration","deprecated":false}]}]}]}]}},{"type":"group","label":"Summary Statements","link":"/v1-api-reference/api/summary-statements","routeSlug":"/v1-api-reference/api/summary-statements","items":[{"label":"Create a summary statement run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-statements/createsummarystatementrun","routeSlug":"/v1-api-reference/api/summary-statements/createsummarystatementrun","metadata":{"seo":{"title":"Create a summary statement run","description":"Allows you to initiate the generation of a summary statement run. You can specify parameters such as the run type (AdHoc or scheduled) and the target account categories (single or multiple accounts)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSummaryStatementRun","name":"Create a summary statement run","isWebhook":false,"pointer":"/paths/~1v1~1summary-statement-runs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a summary statement run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows you to initiate the generation of a summary statement run.\nYou can specify parameters such as the run type (AdHoc or scheduled) and the target account categories (single or multiple accounts).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1summary-statement-runs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SummaryStatementRunRequestType","exampleIds":["paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example1","paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example2","paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example3"]}},"schemaId":"components/schemas/SummaryStatementRunRequestType","exampleIds":["paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example1","paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example2","paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example3"],"pointer":"/paths/~1v1~1summary-statement-runs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/summary-statement-runs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SummaryStatementRunRequestType","exampleIds":["paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example1","paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example2","paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example3"]}},"responseCodes":["200","500","4XX"],"pointer":"/v1/summary-statement-runs","href":"summary-statements/createsummarystatementrun","openApiOperationId":"createSummaryStatementRun","summary":"Create a summary statement run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/SummaryStatementRunRequestType","exampleIds":["paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example1","paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example2","paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example3"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SummaryStatementRunRequestType","exampleIds":["paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example1","paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example2","paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example3"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SummaryStatementRunResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SummaryStatementRunResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_91"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding:\\ \\ gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data.\\n\\ \\nNote that only the following MIME types support gzipped responses:\\n\\ \\  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n\\ \\  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n\""},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_92"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"}],"pointer":"/paths/~1v1~1summary-statement-runs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SummaryStatementRunResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SummaryStatementRunResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statement-runs/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/summary-statements/createsummarystatementrun"}],"panels":[]}]},"httpPath":"/v1/summary-statement-runs"},{"label":"Delete a summary statement","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-statements/deletesummarystatement","routeSlug":"/v1-api-reference/api/summary-statements/deletesummarystatement","metadata":{"seo":{"title":"Delete a summary statement","description":"Deletes a specific summary statement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSummaryStatement","name":"Delete a summary statement","isWebhook":false,"pointer":"/paths/~1v1~1summary-statements~1{summaryStatementKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a summary statement","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 specific summary statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a summary statement only when both the summary statement and its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parent summary statement run are in terminal states."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed summary statement statuses:"},"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":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Previewing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for temporary preview statements)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed parent summary statement run statuses:"},"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":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Terminated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error scenarios:"},"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":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the summary statement status is "},"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":"Processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the parent summary statement run status is "},"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":"Processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the summary statement does not exist"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"summaryStatementKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID or number of the summary statement to delete."},"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":"2c92c8955bd63cc1015bd7c151af02ab"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/summary-statements/{summaryStatementKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"summaryStatementKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/summary-statements/{summaryStatementKey}","href":"summary-statements/deletesummarystatement","openApiOperationId":"deleteSummaryStatement","summary":"Delete a summary statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidStatementStatus","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidRunStatus","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/authenticationError","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidStatementStatus","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidRunStatus","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/authenticationError","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/notFound"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"}],"pointer":"/paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidStatementStatus","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidRunStatus","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/authenticationError","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidStatementStatus","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidRunStatus","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/authenticationError","paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/notFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/summary-statements/deletesummarystatement"}],"panels":[]}]},"httpPath":"/v1/summary-statements/{summaryStatementKey}"}],"content":{"contentType":"group","meta":{"name":"Summary Statements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Summary Statements","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":"The Summary Statement feature provides a comprehensive overview of billing activities for each account using HTML templates that compile data like invoices, credit memos, payments, and more. The associated APIs help automate the creation and management of these statements. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-account-summary-stmt","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Summary Statements "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/summary-statement-runs","summary":"Create a summary statement run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/summary-statements/createsummarystatementrun","deprecated":false},{"title":"/v1/summary-statements/{summaryStatementKey}","summary":"Delete a summary statement","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/summary-statements/deletesummarystatement","deprecated":false}]}]}]}]}},{"type":"separator","label":"Bill Runs","content":null},{"type":"group","label":"Bill Run","link":"/v1-api-reference/api/bill-run","routeSlug":"/v1-api-reference/api/bill-run","items":[{"label":"Create a bill run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/post_createbillrun","routeSlug":"/v1-api-reference/api/bill-run/post_createbillrun","metadata":{"seo":{"title":"Create a bill run","description":"Creates an ad-hoc bill run or a scheduled bill run. Support the following:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateBillRun","name":"Create a bill run","isWebhook":false,"pointer":"/paths/~1v1~1bill-runs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a bill run","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 ad-hoc bill run or a scheduled bill run. Support 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":"Create ad-hoc or scheduled bill runs by batch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create ad-hoc or scheduled bill runs by account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a bill run by subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create ad-hoc or scheduled bill runs by custom filter combining the Account, Subscription, and Rate Plan objects."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this operation, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Bill Runs billing permission"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using this operation to create bill runs, keep the following notes in mind:"},"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":"When creating bill runs by batch, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and do not specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billRunFilters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. When creating bill runs by account, subscription, or custom filter, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billRunFilters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batches"},"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":"text","inline":true,"attributes":{"content":"When creating bill runs by account, only one single account is allowed. All subscription under the account are picked up."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a bill run by subscription, all subscriptions must belong to the same account. At most 50 subscriptions are allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If more than 500 bill runs created through this operation are in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, you cannot use this operation to create any more bill runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator in an Account, Subscription, or Charge filter in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billRunFilters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can specify a maximum of 500 values in the list. If any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" condition contains more than 500 values, the request fails validation,   an error is returned, and the Bill Run is not started. This limit applies only to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator   in Advanced Filters and does not limit the total number of accounts, subscriptions, or charges that   the Bill Run can process."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1bill-runs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateBillRunRequestType"}},"schemaId":"components/schemas/POSTCreateBillRunRequestType","pointer":"/paths/~1v1~1bill-runs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/bill-runs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTCreateBillRunRequestType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/bill-runs","href":"bill-run/post_createbillrun","openApiOperationId":"POST_CreateBillRun","summary":"Create a bill run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTCreateBillRunRequestType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateBillRunRequestType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillRunResponseType"}},"schemaId":"components/schemas/GetBillRunResponseType","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1bill-runs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBillRunResponseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillRunResponseType"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bill-run/post_createbillrun"}],"panels":[]}]},"httpPath":"/v1/bill-runs"},{"label":"Delete a bill run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/delete_deletebillrun","routeSlug":"/v1-api-reference/api/bill-run/delete_deletebillrun","metadata":{"seo":{"title":"Delete a bill run","description":"Deletes a bill run. You can only delete bill runs in Canceled or Error status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_DeleteBillRun","name":"Delete a bill run","isWebhook":false,"pointer":"/paths/~1v1~1bill-runs~1{billRunId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a bill run","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 bill run. You can only delete bill runs in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"billRunId","in":"path","schemaId":"schema_5","description":"The unique ID of a bill run.\n","required":true}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/bill-runs/{billRunId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"billRunId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/bill-runs/{billRunId}","href":"bill-run/delete_deletebillrun","openApiOperationId":"DELETE_DeleteBillRun","summary":"Delete a bill run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillRunResponseType"}},"schemaId":"components/schemas/GetBillRunResponseType","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBillRunResponseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillRunResponseType"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bill-run/delete_deletebillrun"}],"panels":[]}]},"httpPath":"/v1/bill-runs/{billRunId}"},{"label":"Retrieve a bill run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/get_billrun","routeSlug":"/v1-api-reference/api/bill-run/get_billrun","metadata":{"seo":{"title":"Retrieve a bill run","description":"Retrieves the information about a specific bill run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_BillRun","name":"Retrieve a bill run","isWebhook":false,"pointer":"/paths/~1v1~1bill-runs~1{billRunId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a bill run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the information about a specific bill run.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"billRunId","in":"path","schemaId":"schema_5","description":"The unique ID of a bill run.\n","required":true}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bill-runs/{billRunId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"billRunId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/bill-runs/{billRunId}","href":"bill-run/get_billrun","openApiOperationId":"GET_BillRun","summary":"Retrieve a bill run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillRunResponseType"}},"schemaId":"components/schemas/GetBillRunResponseType","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBillRunResponseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillRunResponseType"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bill-run/get_billrun"}],"panels":[]}]},"httpPath":"/v1/bill-runs/{billRunId}"},{"label":"Cancel a bill run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/put_cancelbillrun","routeSlug":"/v1-api-reference/api/bill-run/put_cancelbillrun","metadata":{"seo":{"title":"Cancel a bill run","description":"Cancels a bill run in Draft status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CancelBillRun","name":"Cancel a bill run","isWebhook":false,"pointer":"/paths/~1v1~1bill-runs~1{billRunId}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a bill run","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":"Cancels a bill run in Draft status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When cancelling a scheduled bill run, keep the following information in mind:"},"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 you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelOnce"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only the current bill run is cancelled. The other future scheduled bill runs will be automatically executed based on the schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelOnce"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all future recurring bill runs are cancelled."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"billRunId","in":"path","schemaId":"schema_5","description":"The unique ID of a bill run.\n","required":true}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_93"}},"schemaId":"schema_93","pointer":"/paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/bill-runs/{billRunId}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"billRunId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_93"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/bill-runs/{billRunId}/cancel","href":"bill-run/put_cancelbillrun","openApiOperationId":"PUT_CancelBillRun","summary":"Cancel a bill run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_93","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_93"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancelBillRunResponseType"}},"schemaId":"components/schemas/CancelBillRunResponseType","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CancelBillRunResponseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancelBillRunResponseType"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bill-run/put_cancelbillrun"}],"panels":[]}]},"httpPath":"/v1/bill-runs/{billRunId}/cancel"},{"label":"Post a bill run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/put_postbillrun","routeSlug":"/v1-api-reference/api/bill-run/put_postbillrun","metadata":{"seo":{"title":"Post a bill run","description":"Posts a bill run asynchronously. To post a bill run, the current bill run must be in Completed status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PostBillRun","name":"Post a bill run","isWebhook":false,"pointer":"/paths/~1v1~1bill-runs~1{billRunId}~1post/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post a bill run","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":"Posts a bill run asynchronously. To post a bill run, the current bill run must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"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":"When a bill run is being posted, its status is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PostInProgress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". After all invoices for this bill run are posted, its status is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Posted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"billRunId","in":"path","schemaId":"schema_5","description":"The unique ID of a bill run.\n","required":true}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}~1post/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}~1post/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94","pointer":"/paths/~1v1~1bill-runs~1{billRunId}~1post/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/bill-runs/{billRunId}/post","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"billRunId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_94"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/bill-runs/{billRunId}/post","href":"bill-run/put_postbillrun","openApiOperationId":"PUT_PostBillRun","summary":"Post a bill run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_94"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillRunResponseType"}},"schemaId":"components/schemas/GetBillRunResponseType","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBillRunResponseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillRunResponseType"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bill-run/put_postbillrun"}],"panels":[]}]},"httpPath":"/v1/bill-runs/{billRunId}/post"},{"label":"Email billing documents generated from a bill run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run/post_emailbillingdocumentsfrombillrun","routeSlug":"/v1-api-reference/api/bill-run/post_emailbillingdocumentsfrombillrun","metadata":{"seo":{"title":"Email billing documents generated from a bill run","description":"Manually emails all the billing documents that are generated from a specified bill run to your customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_EmailBillingDocumentsfromBillRun","name":"Email billing documents generated from a bill run","isWebhook":false,"pointer":"/paths/~1v1~1bill-runs~1{billRunKey}~1emails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email billing documents generated from a bill run","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":"Manually emails all the billing documents that are generated from a specified bill run to your customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill runs can generate invoices and credit memos based on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-and-credit-memo-generation-rule"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice and credit memo generation rule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Credit memos are only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this API operation, the billing documents are sent to the email addresses specified in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To Email"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the email templates. The email template used for each billing document is set in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" panel of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-email-template"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit Email Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about how to edit the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To Email"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the email template."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"bill-run/post_emailbillingdocumentsfrombillrun/request/notes","deepLinkHash":"/bill-run/post_emailbillingdocumentsfrombillrun#bill-run/post_emailbillingdocumentsfrombillrun/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"Even though no field is required in the Request body, you still need to specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request. Otherwise, an error will be returned."},"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":"You can only email posted billing documents."},"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":"You must activate the following notifications before emailing invoices and credit memos:"},"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":"Manual Email For Invoice | Manual Email For Invoice"},"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":"Email Credit Memo | Manually email Credit Memo"},"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":"To include the invoice PDF in the email, select the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include Invoice PDF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" check box in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. To include the credit memo PDF in the email, select the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include Credit Memo PDF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" check box in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-notification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and Edit Notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"Zuora sends the email messages based on the email template you set. You can set the email template to use in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" panel of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. By default, the following templates are used for billing documents:"},"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":"Invoices: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Posted Default Email Template"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit memos: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Email for Credit Memo Default Template"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-email-template"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and Edit Email Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"billRunKey","in":"path","schemaId":"schema_5","description":"The ID or number of the bill run. For example, 2c92c8f95d0c886e015d11287a8f0f8b or BR-00000001.\n","required":true}],"pointer":"/paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTEmailBillingDocfromBillRunType"}},"schemaId":"components/schemas/POSTEmailBillingDocfromBillRunType","pointer":"/paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/bill-runs/{billRunKey}/emails","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"billRunKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTEmailBillingDocfromBillRunType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/bill-runs/{billRunKey}/emails","href":"bill-run/post_emailbillingdocumentsfrombillrun","openApiOperationId":"POST_EmailBillingDocumentsfromBillRun","summary":"Email billing documents generated from a bill run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTEmailBillingDocfromBillRunType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTEmailBillingDocfromBillRunType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bill-run/post_emailbillingdocumentsfrombillrun"}],"panels":[]}]},"httpPath":"/v1/bill-runs/{billRunKey}/emails"}],"content":{"contentType":"group","meta":{"name":"Bill Run"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bill Run","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 Bill Run call to create ad hoc bill runs and Post, Cancel, Query, and Delete bill runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about bill runs, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-bill-runs-creation","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill runs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/bill-runs","summary":"Create a bill run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bill-run/post_createbillrun","deprecated":false},{"title":"/v1/bill-runs/{billRunId}","summary":"Delete a bill run","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bill-run/delete_deletebillrun","deprecated":false},{"title":"/v1/bill-runs/{billRunId}","summary":"Retrieve a bill run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bill-run/get_billrun","deprecated":false},{"title":"/v1/bill-runs/{billRunId}/cancel","summary":"Cancel a bill run","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bill-run/put_cancelbillrun","deprecated":false},{"title":"/v1/bill-runs/{billRunId}/post","summary":"Post a bill run","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bill-run/put_postbillrun","deprecated":false},{"title":"/v1/bill-runs/{billRunKey}/emails","summary":"Email billing documents generated from a bill run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bill-run/post_emailbillingdocumentsfrombillrun","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Preview Run","link":"/v1-api-reference/api/billing-preview-run","routeSlug":"/v1-api-reference/api/billing-preview-run","items":[{"label":"Create a billing preview run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-preview-run/post_billingpreviewrun","routeSlug":"/v1-api-reference/api/billing-preview-run/post_billingpreviewrun","metadata":{"seo":{"title":"Create a billing preview run","description":"Creates a billing preview run for single and multiple customer accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_BillingPreviewRun","name":"Create a billing preview run","isWebhook":false,"pointer":"/paths/~1v1~1billing-preview-runs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a billing preview run","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 billing preview run for single and multiple customer accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum supported preview duration is 20 years, calculated from the current date to the target date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can run up to 20 billing preview runs in batches concurrently. A single batch of customer accounts can only have one billing preview run at a time. So you can have up to 20 batches running at the same time. If you create a billing preview run for all customer batches, you cannot create another billing preview run until this preview run is completed."},"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 preview results for each billing preview run will be stored in the system for 180 days; after that they will be purged."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1billing-preview-runs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBillingPreviewRunParam"}},"schemaId":"components/schemas/PostBillingPreviewRunParam","pointer":"/paths/~1v1~1billing-preview-runs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/billing-preview-runs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostBillingPreviewRunParam"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/billing-preview-runs","href":"billing-preview-run/post_billingpreviewrun","openApiOperationId":"POST_BillingPreviewRun","summary":"Create a billing preview run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostBillingPreviewRunParam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBillingPreviewRunParam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_95","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_95","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1billing-preview-runs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_95","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_95","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-preview-runs/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-preview-run/post_billingpreviewrun"}],"panels":[]}]},"httpPath":"/v1/billing-preview-runs"},{"label":"Retrieve a billing preview run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/billing-preview-run/get_billingpreviewrun","routeSlug":"/v1-api-reference/api/billing-preview-run/get_billingpreviewrun","metadata":{"seo":{"title":"Retrieve a billing preview run","description":"Retrieves a preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Invoice Settlement feature enabled,  you can also retrieve a preview of future credit memo items. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_BillingPreviewRun","name":"Retrieve a billing preview run","isWebhook":false,"pointer":"/paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a billing preview run","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 preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Invoice Settlement feature enabled,  you can also retrieve a preview of future credit memo items. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A billing preview run asynchronously generates a downloadable CSV file containing a preview of invoice item data and credit memo item data for a batch of customer accounts. Note that if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storageOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Database"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no CSV file is generate; instead, you can have a record in the billing preview result. You can use data source to query "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-billing-preview-run-result-data-source","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Preview Run Result"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"billingPreviewRunId","in":"path","schemaId":"schema_5","description":"Id of the billing preview run.\n","required":true}],"pointer":"/paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/billing-preview-runs/{billingPreviewRunId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"billingPreviewRunId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/billing-preview-runs/{billingPreviewRunId}","href":"billing-preview-run/get_billingpreviewrun","openApiOperationId":"GET_BillingPreviewRun","summary":"Retrieve a billing preview run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillingPreviewRunResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetBillingPreviewRunResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBillingPreviewRunResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillingPreviewRunResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-preview-run/get_billingpreviewrun"}],"panels":[]}]},"httpPath":"/v1/billing-preview-runs/{billingPreviewRunId}"}],"content":{"contentType":"group","meta":{"name":"Billing Preview Run"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Preview Run","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":"A billing preview run asynchronously generates a downloadable CSV file containing a preview of future invoice item data and credit memo item data for a batch of customer accounts."},"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":": Credit memo item data is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/billing-preview-runs","summary":"Create a billing preview run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-preview-run/post_billingpreviewrun","deprecated":false},{"title":"/v1/billing-preview-runs/{billingPreviewRunId}","summary":"Retrieve a billing preview run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-preview-run/get_billingpreviewrun","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payment Methods","content":null},{"type":"group","label":"Payment Methods","link":"/v1-api-reference/api/payment-methods","routeSlug":"/v1-api-reference/api/payment-methods","items":[{"label":"Create a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_paymentmethods","routeSlug":"/v1-api-reference/api/payment-methods/post_paymentmethods","metadata":{"seo":{"title":"Create a payment method","description":"You can use this operation to create either a payment method associatedwith a specific customer account, or an orphan payment method that is not associatedwith any customer account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_PaymentMethods","name":"Create a payment method","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment method","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":"You can use this operation to create either a payment method associated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a specific customer account, or an orphan payment method that is not associated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with any customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the applicable fields for each payment method type, select the payment method type from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following types of the payment methods are supported:"},"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":"code","inline":true,"attributes":{"content":"CreditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Credit card payment method."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditCardReferenceTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Credit Card Reference"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"methods"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for payment gateways that support this type of payment method."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ACH payment method."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Single Euro Payments Area."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Betalingsservice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Direct Debit DK."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Autogiro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Direct Debit SE."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bacs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Direct Debit UK."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Becs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Direct Entry AU."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Becsnz"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Direct Debit NZ."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Pre-Authorized Debit."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayPalCP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - PayPal Commerce Platform payment method. Use this type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if you are using a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-paypal-complete-payments-gateway-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal Commerce Platform"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instance."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayPalEC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - PayPal Express Checkout payment method. Use this type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if you are using a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-paypal-payflow-pro"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal Payflow Pro"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instance."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayPalNativeEC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - PayPal Native Express Checkout payment method."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this type if you are using a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-paypal-express-checkout-gateway"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal Express Checkout"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instance."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayPalAdaptive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - PayPal Adaptive payment method. Use this type if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you are using a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-paypal-adaptive-payments-gateway"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal Adaptive Payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instance."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdyenApplePay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Apple Pay on Adyen Integration v2.0. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-create-apply-pay-using-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set up"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adyen Apple"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for details."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdyenGooglePay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Google Pay on Adyen Integration v2.0. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-setup-adyen-googlepay-using-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set up"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adyen Google"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for details."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GooglePay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Google Pay on Chase Paymentech Orbital gateway"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integration. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-setup-chase-googlepay-using-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set up Google Pay on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chase"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for details."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Amazon Pay integration."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be specified when creating non-tokenized payment methods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about the required fields for the tokenization of payment methods, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create tokenized payment methods with existing tokens or account information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodRequest"}},"schemaId":"components/schemas/POSTPaymentMethodRequest","pointer":"/paths/~1v1~1payment-methods/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-methods","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods","href":"payment-methods/post_paymentmethods","openApiOperationId":"POST_PaymentMethods","summary":"Create a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTPaymentMethodRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/post_paymentmethods"}],"panels":[]}]},"httpPath":"/v1/payment-methods"},{"label":"Create an Apple Pay payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_paymentmethodsdecryption","routeSlug":"/v1-api-reference/api/payment-methods/post_paymentmethodsdecryption","metadata":{"seo":{"title":"Create an Apple Pay payment method","description":"The decryption API endpoint can conditionally perform 4 tasks in one atomic call:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_PaymentMethodsDecryption","name":"Create an Apple Pay payment method","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1decryption/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Apple Pay payment method","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":"The decryption API endpoint can conditionally perform 4 tasks in one atomic call:"},"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":"Decrypt Apple Pay Payment token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Credit Card Payment Method in Zuora with decrypted Apple Pay information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a stored credential profile within the Apple Pay payment method"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process Payment on a specified Invoice (optional)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1decryption/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodDecryption"}},"schemaId":"components/schemas/POSTPaymentMethodDecryption","pointer":"/paths/~1v1~1payment-methods~1decryption/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-methods/decryption","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodDecryption"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/decryption","href":"payment-methods/post_paymentmethodsdecryption","openApiOperationId":"POST_PaymentMethodsDecryption","summary":"Create an Apple Pay payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTPaymentMethodDecryption","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodDecryption"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodResponseDecryption","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTPaymentMethodResponseDecryption","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1decryption/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTPaymentMethodResponseDecryption","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodResponseDecryption","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1decryption/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/post_paymentmethodsdecryption"}],"panels":[]}]},"httpPath":"/v1/payment-methods/decryption"},{"label":"Delete a payment method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/delete_paymentmethods","routeSlug":"/v1-api-reference/api/payment-methods/delete_paymentmethods","metadata":{"seo":{"title":"Delete a payment method","description":"Deletes a credit card payment method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_PaymentMethods","name":"Delete a payment method","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a credit card payment method.\n\nIf the specified payment method is the account's default payment\nmethod, the request will fail.  In that case, you must first designate a\ndifferent payment method for that customer to be the default.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/payment-methods/{payment-method-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}","href":"payment-methods/delete_paymentmethods","openApiOperationId":"DELETE_PaymentMethods","summary":"Delete a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/delete_paymentmethods"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}"},{"label":"Retrieve a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/get_paymentmethod","routeSlug":"/v1-api-reference/api/payment-methods/get_paymentmethod","metadata":{"seo":{"title":"Retrieve a payment method","description":"Use this operation to get the detailed information of an electronic payment method. To retrieve information of both electronic and non-electronic payment methods, use the Object Query operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentMethod","name":"Retrieve a payment method","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment method","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":"Use this operation to get the detailed information of an electronic payment method. To retrieve information of both electronic and non-electronic payment methods, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/queryPaymentMethodByKey/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object Query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"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 also supports retrieving the custom payment method created through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-specialized-payment-connections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open Payment Method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" service."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"Unique ID of the payment method to update.","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-methods/{payment-method-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}","href":"payment-methods/get_paymentmethod","openApiOperationId":"GET_PaymentMethod","summary":"Retrieve a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/get_paymentmethod"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}"},{"label":"Update a payment method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/put_paymentmethod","routeSlug":"/v1-api-reference/api/payment-methods/put_paymentmethod","metadata":{"seo":{"title":"Update a payment method","description":"This operation allows you to update an existing payment method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PaymentMethod","name":"Update a payment method","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a payment method","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":"This operation allows you to update an existing payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following fields in the request body can be updated for any payment method 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":"maxConsecutivePaymentFailures"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentRetryWindow"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useDefaultRetryRule"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following fields in the request body can be updated for any payment method types"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"except for Credit Card Reference Transaction payment methods:"},"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":"authGateway"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderInfo"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewayOptions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ipAddress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following fields in the request body can be updated only for Credit Card payment methods:"},"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":"expirationMonth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expirationYear"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"securityCode"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following field in the request body can be updated for Credit Card, Credit Card Reference Transaction, ACH, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Transfer payment methods:"},"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":"mandateInfo"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"Unique ID of the payment method to update.","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPaymentMethodRequest"}},"schemaId":"components/schemas/PUTPaymentMethodRequest","pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-methods/{payment-method-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTPaymentMethodRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}","href":"payment-methods/put_paymentmethod","openApiOperationId":"PUT_PaymentMethod","summary":"Update a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTPaymentMethodRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPaymentMethodRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTPaymentMethodResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/put_paymentmethod"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}"},{"label":"Verify a payment method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/put_verifypaymentmethods","routeSlug":"/v1-api-reference/api/payment-methods/put_verifypaymentmethods","metadata":{"seo":{"title":"Verify a payment method","description":"Sends an authorization request to the corresponding payment gateway to verify the payment method, even though no changes are made for the payment method. Supported payment methods are Credit Cards and Paypal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_VerifyPaymentMethods","name":"Verify a payment method","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends an authorization request to the corresponding payment gateway to verify the payment method, even though no changes are made for the payment method. Supported payment methods are Credit Cards and Paypal.\n\nZuora now supports performing a standalone zero dollar verification or one dollar authorization for credit cards. It also supports a billing agreement status check on PayPal payment methods.\n\nIf a payment method is created by Hosted Payment Pages and is not assigned to any billing account, the payment method cannot be verified through this operation.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"The ID of the payment method to be verified.\n","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTVerifyPaymentMethodType"}},"schemaId":"components/schemas/PUTVerifyPaymentMethodType","pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-methods/{payment-method-id}/verify","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTVerifyPaymentMethodType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}/verify","href":"payment-methods/put_verifypaymentmethods","openApiOperationId":"PUT_VerifyPaymentMethods","summary":"Verify a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTVerifyPaymentMethodType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTVerifyPaymentMethodType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTVerifyPaymentMethodResponseType","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTVerifyPaymentMethodResponseType","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTVerifyPaymentMethodResponseType","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTVerifyPaymentMethodResponseType","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/put_verifypaymentmethods"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}/verify"},{"label":"Scrub a payment method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/put_scrubpaymentmethods","routeSlug":"/v1-api-reference/api/payment-methods/put_scrubpaymentmethods","metadata":{"seo":{"title":"Scrub a payment method","description":"This operation enables you to replace all sensitive data in a payment method, related payment method snapshot table, and four related log tables with dummy values that will be stored in Zuora databases."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_ScrubPaymentMethods","name":"Scrub a payment method","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scrub a payment method","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":"This operation enables you to replace all sensitive data in a payment method, related payment method snapshot table, and four related log tables with dummy values that will be stored in Zuora databases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation will scrub the sensitive data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to delete or anonymize personal data in Zuora, you must scrub the payment method before anonymizing the associated account and contact. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=edit-and-correct-personal-data"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete or anonymize personal data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":" In order to use this operation, you must ensure that the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scrub Sensitive Data of Specific Payment Method payments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission is enabled in your user role. Contact your tenant administrator if you want to enable this permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-scrub-payment-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scrub Payment Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"The ID of the payment method where you want to scrub the sensitive data.\n","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-methods/{payment-method-id}/scrub","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}/scrub","href":"payment-methods/put_scrubpaymentmethods","openApiOperationId":"PUT_ScrubPaymentMethods","summary":"Scrub a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/put_scrubpaymentmethods"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}/scrub"},{"label":"Retrieve the balance of a bank account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/getbankaccountbalance","routeSlug":"/v1-api-reference/api/payment-methods/getbankaccountbalance","metadata":{"seo":{"title":"Retrieve the balance of a bank account","description":"Zuora supports Plaid's Auth and Balance products for ACH transactions.Auth authenticates account details before sending requests to the gateway,while Balance checks the real-time account balance before transactions.Use this API operation to implement the integration with Plaid Balance manually."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBankAccountBalance","name":"Retrieve the balance of a bank account","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the balance of a bank account","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":"Zuora supports Plaid's Auth and Balance products for ACH transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auth authenticates account details before sending requests to the gateway,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"while Balance checks the real-time account balance before transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this API operation to implement the integration with Plaid Balance manually."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before you use this API operation, ensure that the support for Plaid Auth and Balance is enabled."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/define-and-set-up-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable the support for Plaid account validation solution"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the payment method, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"40289f3291d2587b0191d280fa20012g"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-methods/{payment-method-id}/balance","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}/balance","href":"payment-methods/getbankaccountbalance","openApiOperationId":"getBankAccountBalance","summary":"Retrieve the balance of a bank account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBankAccountBalanceResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetBankAccountBalanceResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBankAccountBalanceResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBankAccountBalanceResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/getbankaccountbalance"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}/balance"},{"label":"List stored credential profiles of a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/get_storedcredentialprofiles","routeSlug":"/v1-api-reference/api/payment-methods/get_storedcredentialprofiles","metadata":{"seo":{"title":"List stored credential profiles of a payment method","description":"Retrieves the stored credential profiles within a payment method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_StoredCredentialProfiles","name":"List stored credential profiles of a payment method","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List stored credential profiles of a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the stored credential profiles within a payment method.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"ID of a payment method.\n","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeAll","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to retrieve all the stored credential profiles within the payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora returns only the stored credential profiles with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Agreed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. If you set this parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns all the stored credential profiles."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-methods/{payment-method-id}/profiles","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"includeAll","in":"query","schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}/profiles","href":"payment-methods/get_storedcredentialprofiles","openApiOperationId":"GET_StoredCredentialProfiles","summary":"List stored credential profiles of a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetStoredCredentialProfilesResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetStoredCredentialProfilesResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetStoredCredentialProfilesResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetStoredCredentialProfilesResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/get_storedcredentialprofiles"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}/profiles"},{"label":"Create a stored credential profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_createstoredcredentialprofile","routeSlug":"/v1-api-reference/api/payment-methods/post_createstoredcredentialprofile","metadata":{"seo":{"title":"Create a stored credential profile","description":"Creates a stored credential profile within a payment method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateStoredCredentialProfile","name":"Create a stored credential profile","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a stored credential profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a stored credential profile within a payment method.\n\nThe stored credential profile represents a consent agreement that you have established with a customer. When you use the payment method in a transaction, Zuora may include information from the stored credential profile to inform the payment processor that the transaction is related to your pre-existing consent agreement with the customer.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"ID of a payment method.\n","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateStoredCredentialProfileRequest"}},"schemaId":"components/schemas/CreateStoredCredentialProfileRequest","pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-methods/{payment-method-id}/profiles","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateStoredCredentialProfileRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}/profiles","href":"payment-methods/post_createstoredcredentialprofile","openApiOperationId":"POST_CreateStoredCredentialProfile","summary":"Create a stored credential profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateStoredCredentialProfileRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateStoredCredentialProfileRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/post_createstoredcredentialprofile"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}/profiles"},{"label":"Cancel a stored credential profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_cancelstoredcredentialprofile","routeSlug":"/v1-api-reference/api/payment-methods/post_cancelstoredcredentialprofile","metadata":{"seo":{"title":"Cancel a stored credential profile","description":"Cancels a stored credential profile within a payment method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CancelStoredCredentialProfile","name":"Cancel a stored credential profile","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a stored credential profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a stored credential profile within a payment method.\n\nCancelling the stored credential profile indicates that the stored credentials are no longer valid, per a customer request. You cannot reactivate the stored credential profile after you have cancelled it.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"ID of a payment method.\n","required":true},{"name":"profile-number","in":"path","schemaId":"schema_50","description":"Number that identifies a stored credential profile within the payment method.\n","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"},{"name":"profile-number","in":"path","required":true,"schemaId":"schema_50"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel","href":"payment-methods/post_cancelstoredcredentialprofile","openApiOperationId":"POST_CancelStoredCredentialProfile","summary":"Cancel a stored credential profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/post_cancelstoredcredentialprofile"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel"},{"label":"Expire a stored credential profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_expirestoredcredentialprofile","routeSlug":"/v1-api-reference/api/payment-methods/post_expirestoredcredentialprofile","metadata":{"seo":{"title":"Expire a stored credential profile","description":"Expires a stored credential profile within a payment method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_ExpireStoredCredentialProfile","name":"Expire a stored credential profile","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expire a stored credential profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Expires a stored credential profile within a payment method.\n\nExpiring the stored credential profile indicates that the stored credentials are no longer valid, per an expiration policy in the stored credential transaction framework. You cannot reactivate the stored credential profile after you have expired it.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"ID of a payment method.\n","required":true},{"name":"profile-number","in":"path","schemaId":"schema_50","description":"Number that identifies a stored credential profile within the payment method.\n","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"},{"name":"profile-number","in":"path","required":true,"schemaId":"schema_50"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire","href":"payment-methods/post_expirestoredcredentialprofile","openApiOperationId":"POST_ExpireStoredCredentialProfile","summary":"Expire a stored credential profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModifiedStoredCredentialProfileResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/post_expirestoredcredentialprofile"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire"},{"label":"Add gateway profile data to a stored credential profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/addgatewayprofiledata","routeSlug":"/v1-api-reference/api/payment-methods/addgatewayprofiledata","metadata":{"seo":{"title":"Add gateway profile data to a stored credential profile","description":"Adds gateway profile data to an existing stored credential profile within a payment method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addGatewayProfileData","name":"Add gateway profile data to a stored credential profile","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add gateway profile data to a stored credential profile","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 gateway profile data to an existing stored credential profile within a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this operation to seed or backfill gateway-specific data, such as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authGateway"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"networkTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, on a stored credential profile that was created without it. This is typically used when migrating a stored credential profile to be processed through a different payment gateway."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"ID of a payment method.\n","required":true},{"name":"profile-number","in":"path","schemaId":"schema_50","description":"Number that identifies a stored credential profile within the payment method.\n","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddGatewayProfileDataRequest"}},"schemaId":"components/schemas/AddGatewayProfileDataRequest","pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/profile-data","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"},{"name":"profile-number","in":"path","required":true,"schemaId":"schema_50"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddGatewayProfileDataRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/profile-data","href":"payment-methods/addgatewayprofiledata","openApiOperationId":"addGatewayProfileData","summary":"Add gateway profile data to a stored credential profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/AddGatewayProfileDataRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddGatewayProfileDataRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":" ","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddGatewayProfileDataResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AddGatewayProfileDataResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddGatewayProfileDataResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddGatewayProfileDataResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/addgatewayprofiledata"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/profile-data"},{"label":"List registered domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/getwalletdomains","routeSlug":"/v1-api-reference/api/payment-methods/getwalletdomains","metadata":{"seo":{"title":"List registered domains","description":"Use this operation to retreive list of registered domains."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWalletDomains","name":"List registered domains","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List registered domains","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":"Use this operation to retreive list of registered domains."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domainName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the query parameter to restrict domains returned in the response. Specify a domain name and the registered domains containing the specified domain name will be returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"domainName","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a domain name such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the registered domains containing the specified domain name will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test1.zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test2.zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are two registered domains, but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not registered. If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this query field, the data of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test1.zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test2.zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}]},{"name":"walletType","in":"query","schemaId":"schema_97","description":"The type of digital wallet for the domain registration. This field is required and determines which wallet-specific domain management flow is executed.","required":true}],"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-methods/wallet/domains","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"domainName","in":"query","schemaId":"schema_5"},{"name":"walletType","in":"query","required":true,"schemaId":"schema_97"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/wallet/domains","href":"payment-methods/getwalletdomains","openApiOperationId":"getWalletDomains","summary":"List registered domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETListApplePayDomainsResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETListApplePayDomainsResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETListApplePayDomainsResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETListApplePayDomainsResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/getwalletdomains"}],"panels":[]}]},"httpPath":"/v1/payment-methods/wallet/domains"},{"label":"Register a wallet domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/registerwalletdomain","routeSlug":"/v1-api-reference/api/payment-methods/registerwalletdomain","metadata":{"seo":{"title":"Register a wallet domain","description":"Before adding Apple Pay to your checkout flow by integrating with the JavaScript SDK provided by Zuora, your domains that will show the Apple Pay button must be registered with Apple. Use this operation to register a domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"registerWalletDomain","name":"Register a wallet domain","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a wallet domain","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":"Before adding Apple Pay to your checkout flow by integrating with the JavaScript SDK provided by Zuora, your domains that will show the Apple Pay button must be registered with Apple. Use this operation to register a domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about Zuora's JavaScript SDK for Apple Pay integration, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-setup-applepay-through-javascript","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set up Apple Pay through the JavaScript SDK approach"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTRegisterApplePayDomainRequest"}},"schemaId":"components/schemas/POSTRegisterApplePayDomainRequest","pointer":"/paths/~1v1~1payment-methods~1wallet~1domains/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-methods/wallet/domains","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTRegisterApplePayDomainRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/wallet/domains","href":"payment-methods/registerwalletdomain","openApiOperationId":"registerWalletDomain","summary":"Register a wallet domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTRegisterApplePayDomainRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTRegisterApplePayDomainRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTRegisterApplePayDomainResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTRegisterApplePayDomainResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTRegisterApplePayDomainResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTRegisterApplePayDomainResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/registerwalletdomain"}],"panels":[]}]},"httpPath":"/v1/payment-methods/wallet/domains"},{"label":"Unregister a wallet domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/deleteunregisterwalletdomain","routeSlug":"/v1-api-reference/api/payment-methods/deleteunregisterwalletdomain","metadata":{"seo":{"title":"Unregister a wallet domain","description":"Use this operation to unregister a wallet domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUnregisterWalletDomain","name":"Unregister a wallet domain","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unregister a wallet domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this operation to unregister a wallet domain.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the domain, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402881a38924ff1001892502da090021"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/payment-methods/wallet/domains/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/wallet/domains/{id}","href":"payment-methods/deleteunregisterwalletdomain","openApiOperationId":"deleteUnregisterWalletDomain","summary":"Unregister a wallet domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DELETEUnresigerApplePayDomainResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DELETEUnresigerApplePayDomainResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DELETEUnresigerApplePayDomainResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DELETEUnresigerApplePayDomainResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/deleteunregisterwalletdomain"}],"panels":[]}]},"httpPath":"/v1/payment-methods/wallet/domains/{id}"},{"label":"Create a payment session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-methods/post_createpaymentsession","routeSlug":"/v1-api-reference/api/payment-methods/post_createpaymentsession","metadata":{"seo":{"title":"Create a payment session","description":"Use this operation to create a payment session on your server side.The response contains a token for the payment session data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreatePaymentSession","name":"Create a payment session","isWebhook":false,"pointer":"/paths/~1web-payments~1sessions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment 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":"Use this operation to create a payment session on your server side."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response contains a token for the payment session data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition to the required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, you can specify the following fields"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to define the payment flow mode as 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":"Create and save a payment method:"},"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":"processPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storePaymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process a one-time payment without saving the payment method:"},"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":"processPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storePaymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process the first payment and save the payment method for subsequent recurring payments:"},"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":"processPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storePaymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"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 following articles:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/docs/get-started/tutorials/payment-form/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Form Implementation Guide"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-payments/process-payments/implement-payment-flows-through-javascript-sdk-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set up a payment method through JavaScript SDK integration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/set-up-payment-gateway-integrations/alipay-payment-gateway/set-up-alipay-payment-methods-with-zuora-javascript-sdk","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set up Alipay payment methods with Zuora JavaScript SDK"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1web-payments~1sessions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreatePaymentSessionRequest"}},"schemaId":"components/schemas/POSTCreatePaymentSessionRequest","pointer":"/paths/~1web-payments~1sessions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/web-payments/sessions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTCreatePaymentSessionRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/web-payments/sessions","href":"payment-methods/post_createpaymentsession","openApiOperationId":"POST_CreatePaymentSession","summary":"Create a payment session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTCreatePaymentSessionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreatePaymentSessionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTCreatePaymentSessionResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTCreatePaymentSessionResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1web-payments~1sessions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTCreatePaymentSessionResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTCreatePaymentSessionResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1web-payments~1sessions/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/post_createpaymentsession"}],"panels":[]}]},"httpPath":"/web-payments/sessions"}],"content":{"contentType":"group","meta":{"name":"Payment Methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Methods","showPageActions":true},{"nodeType":"markdoc","content":"Payment methods represents payment method details associated with a customer account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/payment-methods","summary":"Create a payment method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/post_paymentmethods","deprecated":false},{"title":"/v1/payment-methods/decryption","summary":"Create an Apple Pay payment method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/post_paymentmethodsdecryption","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}","summary":"Delete a payment method","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-methods/delete_paymentmethods","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}","summary":"Retrieve a payment method","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/get_paymentmethod","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}","summary":"Update a payment method","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-methods/put_paymentmethod","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}/verify","summary":"Verify a payment method","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-methods/put_verifypaymentmethods","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}/scrub","summary":"Scrub a payment method","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-methods/put_scrubpaymentmethods","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}/balance","summary":"Retrieve the balance of a bank account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/getbankaccountbalance","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}/profiles","summary":"List stored credential profiles of a payment method","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/get_storedcredentialprofiles","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}/profiles","summary":"Create a stored credential profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/post_createstoredcredentialprofile","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel","summary":"Cancel a stored credential profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/post_cancelstoredcredentialprofile","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire","summary":"Expire a stored credential profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/post_expirestoredcredentialprofile","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/profile-data","summary":"Add gateway profile data to a stored credential profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/addgatewayprofiledata","deprecated":false},{"title":"/v1/payment-methods/wallet/domains","summary":"List registered domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/getwalletdomains","deprecated":false},{"title":"/v1/payment-methods/wallet/domains","summary":"Register a wallet domain","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/registerwalletdomain","deprecated":false},{"title":"/v1/payment-methods/wallet/domains/{id}","summary":"Unregister a wallet domain","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-methods/deleteunregisterwalletdomain","deprecated":false},{"title":"/web-payments/sessions","summary":"Create a payment session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/post_createpaymentsession","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Payment Method Types","link":"/v1-api-reference/api/custom-payment-method-types","routeSlug":"/v1-api-reference/api/custom-payment-method-types","items":[{"label":"Create a draft custom payment method type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-payment-method-types/post_createdraftopenpaymentmethodtype","routeSlug":"/v1-api-reference/api/custom-payment-method-types/post_createdraftopenpaymentmethodtype","metadata":{"seo":{"title":"Create a draft custom payment method type","description":"Creates a draft version of a custom payment method type. Revision number 1 is assigned to this version. You can update your draft version through the Update a custom payment method type operation. You must publish your draft version through the Publish a custom payment method type operation before your custom payment method type goes live."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateDraftOpenPaymentMethodType","name":"Create a draft custom payment method type","isWebhook":false,"pointer":"/paths/~1open-payment-method-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a draft custom payment method type","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 draft version of a custom payment method type. Revision number 1 is assigned to this version. You can update your draft version through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_UpdateOpenPaymentMethodType/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a custom payment method type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. You must publish your draft version through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_PublishOpenPaymentMethodType/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publish a custom payment method type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation before your custom payment method type goes live."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1open-payment-method-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateOpenPaymentMethodTypeRequest"}},"schemaId":"components/schemas/POSTCreateOpenPaymentMethodTypeRequest","pointer":"/paths/~1open-payment-method-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/open-payment-method-types","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTCreateOpenPaymentMethodTypeRequest"}},"responseCodes":["200"],"pointer":"/open-payment-method-types","href":"custom-payment-method-types/post_createdraftopenpaymentmethodtype","openApiOperationId":"POST_CreateDraftOpenPaymentMethodType","summary":"Create a draft custom payment method type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTCreateOpenPaymentMethodTypeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateOpenPaymentMethodTypeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTCreateOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTCreateOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1open-payment-method-types/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTCreateOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTCreateOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-payment-method-types/post_createdraftopenpaymentmethodtype"}],"panels":[]}]},"httpPath":"/open-payment-method-types"},{"label":"Publish a custom payment method type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-payment-method-types/put_publishopenpaymentmethodtype","routeSlug":"/v1-api-reference/api/custom-payment-method-types/put_publishopenpaymentmethodtype","metadata":{"seo":{"title":"Publish a custom payment method type","description":"Publish the latest draft revision of a specific custom payment method type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PublishOpenPaymentMethodType","name":"Publish a custom payment method type","isWebhook":false,"pointer":"/paths/~1open-payment-method-types~1publish~1{paymentMethodTypeName}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish a custom payment method type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Publish the latest draft revision of a specific custom payment method type.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentMethodTypeName","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API name of the custom payment method type, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay__c_12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1open-payment-method-types~1publish~1{paymentMethodTypeName}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1open-payment-method-types~1publish~1{paymentMethodTypeName}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/open-payment-method-types/publish/{paymentMethodTypeName}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentMethodTypeName","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/open-payment-method-types/publish/{paymentMethodTypeName}","href":"custom-payment-method-types/put_publishopenpaymentmethodtype","openApiOperationId":"PUT_PublishOpenPaymentMethodType","summary":"Publish a custom payment method type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTPublishOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types~1publish~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTPublishOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types~1publish~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1open-payment-method-types~1publish~1{paymentMethodTypeName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTPublishOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types~1publish~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTPublishOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types~1publish~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-payment-method-types/put_publishopenpaymentmethodtype"}],"panels":[]}]},"httpPath":"/open-payment-method-types/publish/{paymentMethodTypeName}"},{"label":"Update a custom payment method type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-payment-method-types/put_updateopenpaymentmethodtype","routeSlug":"/v1-api-reference/api/custom-payment-method-types/put_updateopenpaymentmethodtype","metadata":{"seo":{"title":"Update a custom payment method type","description":"Update the latest draft version of your custom payment method type. If the latest draft version has been published, the revision number is increased by 1 after the draft version is updated. You must publish your latest revision again through the Publish a custom payment method type operation before your updated custom payment method type goes live."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateOpenPaymentMethodType","name":"Update a custom payment method type","isWebhook":false,"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a custom payment method type","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":"Update the latest draft version of your custom payment method type. If the latest draft version has been published, the revision number is increased by 1 after the draft version is updated. You must publish your latest revision again through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_PublishOpenPaymentMethodType/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publish a custom payment method type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation before your updated custom payment method type goes live."},"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":": In the request body, provide all the fields that define this custom payment method type including fields to be updated and the unchanged fields."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentMethodTypeName","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API name of the custom payment method type, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay__c_12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTUpdateOpenPaymentMethodTypeRequest"}},"schemaId":"components/schemas/PUTUpdateOpenPaymentMethodTypeRequest","pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/open-payment-method-types/{paymentMethodTypeName}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentMethodTypeName","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTUpdateOpenPaymentMethodTypeRequest"}},"responseCodes":["200"],"pointer":"/open-payment-method-types/{paymentMethodTypeName}","href":"custom-payment-method-types/put_updateopenpaymentmethodtype","openApiOperationId":"PUT_UpdateOpenPaymentMethodType","summary":"Update a custom payment method type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTUpdateOpenPaymentMethodTypeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTUpdateOpenPaymentMethodTypeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTUpdateOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTUpdateOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTUpdateOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTUpdateOpenPaymentMethodTypeResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-payment-method-types/put_updateopenpaymentmethodtype"}],"panels":[]}]},"httpPath":"/open-payment-method-types/{paymentMethodTypeName}"},{"label":"Retrieve a specific draft revision of a custom payment method type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-payment-method-types/get_openpaymentmethodtyperevision","routeSlug":"/v1-api-reference/api/custom-payment-method-types/get_openpaymentmethodtyperevision","metadata":{"seo":{"title":"Retrieve a specific draft revision of a custom payment method type","description":"Retrieves a specific draft revision of a custom payment method type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_OpenPaymentMethodTypeRevision","name":"Retrieve a specific draft revision of a custom payment method type","isWebhook":false,"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}~1draft~1{revisionNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a specific draft revision of a custom payment method type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific draft revision of a custom payment method type.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentMethodTypeName","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API name of the custom payment method type, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay__c_12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"revisionNumber","in":"path","schemaId":"schema_50","description":"The revision number of the draft revision to be retrieved.\n","required":true}],"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}~1draft~1{revisionNumber}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}~1draft~1{revisionNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentMethodTypeName","in":"path","required":true,"schemaId":"schema_5"},{"name":"revisionNumber","in":"path","required":true,"schemaId":"schema_50"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}","href":"custom-payment-method-types/get_openpaymentmethodtyperevision","openApiOperationId":"GET_OpenPaymentMethodTypeRevision","summary":"Retrieve a specific draft revision of a custom payment method type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETOpenPaymentMethodTypeRevisionResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}~1draft~1{revisionNumber}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETOpenPaymentMethodTypeRevisionResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}~1draft~1{revisionNumber}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}~1draft~1{revisionNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETOpenPaymentMethodTypeRevisionResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}~1draft~1{revisionNumber}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETOpenPaymentMethodTypeRevisionResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}~1draft~1{revisionNumber}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-payment-method-types/get_openpaymentmethodtyperevision"}],"panels":[]}]},"httpPath":"/open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}"},{"label":"Retrieve a published custom payment method type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-payment-method-types/get_openpaymentmethodtypepublish","routeSlug":"/v1-api-reference/api/custom-payment-method-types/get_openpaymentmethodtypepublish","metadata":{"seo":{"title":"Retrieve a published custom payment method type","description":"Retrieves a published custom payment method type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_OpenPaymentMethodTypePublish","name":"Retrieve a published custom payment method type","isWebhook":false,"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}~1published/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a published custom payment method type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a published custom payment method type.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentMethodTypeName","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API name of the custom payment method type, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay__c_12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}~1published/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}~1published/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/open-payment-method-types/{paymentMethodTypeName}/published","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentMethodTypeName","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/open-payment-method-types/{paymentMethodTypeName}/published","href":"custom-payment-method-types/get_openpaymentmethodtypepublish","openApiOperationId":"GET_OpenPaymentMethodTypePublish","summary":"Retrieve a published custom payment method type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETOpenPaymentMethodTypeRevisionResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}~1published/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETOpenPaymentMethodTypeRevisionResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}~1published/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1open-payment-method-types~1{paymentMethodTypeName}~1published/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETOpenPaymentMethodTypeRevisionResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}~1published/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETOpenPaymentMethodTypeRevisionResponse","exampleIds":["paths/~1open-payment-method-types~1{paymentMethodTypeName}~1published/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-payment-method-types/get_openpaymentmethodtypepublish"}],"panels":[]}]},"httpPath":"/open-payment-method-types/{paymentMethodTypeName}/published"}],"content":{"contentType":"group","meta":{"name":"Custom Payment Method Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Payment Method Types","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":"Open Payment Method (OPM) service is a framework developed by Zuora, which allows you to integrate your custom payment method to Zuora subscription, billing, and revenue management in a dynamic and flexible manner. With the support of the OPM service, you are able to define your custom payment method types and create custom payment methods of the defined types. The custom payment method of the defined type can only be used with the custom payment gateway that you set up through the Universal Payment Connector (UPC) service. It cannot be used with the Zuora out-of-box gateway integrations such as GoCardless, Stripe, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can define up to 20 custom payment method types for one tenant. Do not define your fields with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/universal-payment-connector/configure-and-manage-your-custom-payment-method-types-through-zuora-rest-apis/zuora-reserved-fields"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora-reserved fields"},"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":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-specialized-payment-connections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set up custom payment gateways and payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about the OPM and UPC services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: You can only use the bearer token to access the \"Custom Payment Method Types\" API operations. Access with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiAccessKeyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiSecretAccessKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not supported."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/open-payment-method-types","summary":"Create a draft custom payment method type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-payment-method-types/post_createdraftopenpaymentmethodtype","deprecated":false},{"title":"/open-payment-method-types/publish/{paymentMethodTypeName}","summary":"Publish a custom payment method type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-payment-method-types/put_publishopenpaymentmethodtype","deprecated":false},{"title":"/open-payment-method-types/{paymentMethodTypeName}","summary":"Update a custom payment method type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-payment-method-types/put_updateopenpaymentmethodtype","deprecated":false},{"title":"/open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}","summary":"Retrieve a specific draft revision of a custom payment method type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-payment-method-types/get_openpaymentmethodtyperevision","deprecated":false},{"title":"/open-payment-method-types/{paymentMethodTypeName}/published","summary":"Retrieve a published custom payment method type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-payment-method-types/get_openpaymentmethodtypepublish","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Method Updater","link":"/v1-api-reference/api/payment-method-updater","routeSlug":"/v1-api-reference/api/payment-method-updater","items":[{"label":"List Payment Method Updater instances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-method-updater/get_paymentmethodupdaterinstances","routeSlug":"/v1-api-reference/api/payment-method-updater/get_paymentmethodupdaterinstances","metadata":{"seo":{"title":"List Payment Method Updater instances","description":"Retrieves the detailed information of all Payment Method Updater (PMU) instances on your tenant, except for American Express (AMEX)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentMethodUpdaterInstances","name":"List Payment Method Updater instances","isWebhook":false,"pointer":"/paths/~1v1~1payment-method-updaters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Payment Method Updater instances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the detailed information of all Payment Method Updater (PMU) instances on your tenant, except for American Express (AMEX).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-method-updaters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-method-updaters","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-method-updaters","href":"payment-method-updater/get_paymentmethodupdaterinstances","openApiOperationId":"GET_PaymentMethodUpdaterInstances","summary":"List Payment Method Updater instances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentMethodUpdaterInstancesResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentMethodUpdaterInstancesResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-method-updaters/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentMethodUpdaterInstancesResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentMethodUpdaterInstancesResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-method-updaters/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-method-updater/get_paymentmethodupdaterinstances"}],"panels":[]}]},"httpPath":"/v1/payment-method-updaters"},{"label":"Create a Payment Method Updater batch asynchronously","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-method-updater/post_paymentmethodupdaterbatch","routeSlug":"/v1-api-reference/api/payment-method-updater/post_paymentmethodupdaterbatch","metadata":{"seo":{"title":"Create a Payment Method Updater batch asynchronously","description":"Creates a Payment Method Updater (PMU) batch asynchronously. PMU for American Express (AMEX) is not supported."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_PaymentMethodUpdaterBatch","name":"Create a Payment Method Updater batch asynchronously","isWebhook":false,"pointer":"/paths/~1v1~1payment-method-updaters~1batches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Payment Method Updater batch asynchronously","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Payment Method Updater (PMU) batch asynchronously. PMU for American Express (AMEX) is not supported.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-method-updaters~1batches/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodUpdaterBatchRequest"}},"schemaId":"components/schemas/POSTPaymentMethodUpdaterBatchRequest","pointer":"/paths/~1v1~1payment-method-updaters~1batches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-method-updaters/batches","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodUpdaterBatchRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-method-updaters/batches","href":"payment-method-updater/post_paymentmethodupdaterbatch","openApiOperationId":"POST_PaymentMethodUpdaterBatch","summary":"Create a Payment Method Updater batch asynchronously"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTPaymentMethodUpdaterBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodUpdaterBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodUpdaterResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTPaymentMethodUpdaterResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-method-updaters~1batches/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTPaymentMethodUpdaterResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTPaymentMethodUpdaterResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-method-updaters~1batches/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-method-updater/post_paymentmethodupdaterbatch"}],"panels":[]}]},"httpPath":"/v1/payment-method-updaters/batches"}],"content":{"contentType":"group","meta":{"name":"Payment Method Updater"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Method Updater","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":"Zuora Payment Method Updater (PMU) enables merchants to automatically incorporate changes made to a customer's credit cards. For more information about Zuora PMU, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-payment-method-updater","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Method Updater"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/payment-method-updaters","summary":"List Payment Method Updater instances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-method-updater/get_paymentmethodupdaterinstances","deprecated":false},{"title":"/v1/payment-method-updaters/batches","summary":"Create a Payment Method Updater batch asynchronously","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-method-updater/post_paymentmethodupdaterbatch","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Method Snapshots","link":"/v1-api-reference/api/payment-method-snapshots","routeSlug":"/v1-api-reference/api/payment-method-snapshots","items":[{"label":"CRUD: Retrieve a payment method snapshot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-method-snapshots/object_getpaymentmethodsnapshot","routeSlug":"/v1-api-reference/api/payment-method-snapshots/object_getpaymentmethodsnapshot","metadata":{"seo":{"title":"CRUD: Retrieve a payment method snapshot","description":"This REST API reference describes how to retrieve a Payment Method Snapshot."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_GETPaymentMethodSnapshot","name":"CRUD: Retrieve a payment method snapshot","isWebhook":false,"pointer":"/paths/~1v1~1object~1payment-method-snapshot~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Retrieve a payment method snapshot","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":"This REST API reference describes how to retrieve a Payment Method Snapshot."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Payment Method Snapshot continues to retain the data used in each of the past transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"payment-method-snapshots/object_getpaymentmethodsnapshot/request/notes","deepLinkHash":"/payment-method-snapshots/object_getpaymentmethodsnapshot#payment-method-snapshots/object_getpaymentmethodsnapshot/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following Payment Method fields are not available in Payment Method Snapshots:"},"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":"Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AchAddress1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AchAddress2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreatedById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreatedDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedDate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Payment Method Snapshot field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not available in Payment Methods."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1payment-method-snapshot~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_5","description":"Object fields to return"}],"pointer":"/paths/~1v1~1object~1payment-method-snapshot~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1payment-method-snapshot~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/object/payment-method-snapshot/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v1/object/payment-method-snapshot/{id}","href":"payment-method-snapshots/object_getpaymentmethodsnapshot","openApiOperationId":"Object_GETPaymentMethodSnapshot","summary":"CRUD: Retrieve a payment method snapshot"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetPaymentMethodSnapshot","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyGetPaymentMethodSnapshot","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyGetPaymentMethodSnapshot","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetPaymentMethodSnapshot","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-method-snapshots/object_getpaymentmethodsnapshot"}],"panels":[]}]},"httpPath":"/v1/object/payment-method-snapshot/{id}"}],"content":{"contentType":"group","meta":{"name":"Payment Method Snapshots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Method Snapshots","showPageActions":true},{"nodeType":"markdoc","content":"A Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Snapshot continues to retain the data used in each of the past transactions. \nAs such, the Snapshot helps with display of historical transactions, integrations to external systems, and reporting."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/object/payment-method-snapshot/{id}","summary":"CRUD: Retrieve a payment method snapshot","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-method-snapshots/object_getpaymentmethodsnapshot","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Method Transaction Logs","link":"/v1-api-reference/api/payment-method-transaction-logs","routeSlug":"/v1-api-reference/api/payment-method-transaction-logs","items":[{"label":"CRUD: Retrieve a payment method transaction log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-method-transaction-logs/object_getpaymentmethodtransactionlog","routeSlug":"/v1-api-reference/api/payment-method-transaction-logs/object_getpaymentmethodtransactionlog","metadata":{"seo":{"title":"CRUD: Retrieve a payment method transaction log","description":"Retrieves a Payment Method Transaction Log object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_GETPaymentMethodTransactionLog","name":"CRUD: Retrieve a payment method transaction log","isWebhook":false,"pointer":"/paths/~1v1~1object~1payment-method-transaction-log~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Retrieve a payment method transaction log","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a Payment Method Transaction Log object."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_5","description":"Object fields to return"}],"pointer":"/paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/object/payment-method-transaction-log/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v1/object/payment-method-transaction-log/{id}","href":"payment-method-transaction-logs/object_getpaymentmethodtransactionlog","openApiOperationId":"Object_GETPaymentMethodTransactionLog","summary":"CRUD: Retrieve a payment method transaction log"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetPaymentMethodTransactionLog"}},"schemaId":"components/schemas/ProxyGetPaymentMethodTransactionLog","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyGetPaymentMethodTransactionLog","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetPaymentMethodTransactionLog"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-method-transaction-logs/object_getpaymentmethodtransactionlog"}],"panels":[]}]},"httpPath":"/v1/object/payment-method-transaction-log/{id}"}],"content":{"contentType":"group","meta":{"name":"Payment Method Transaction Logs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Method Transaction Logs","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":"The PaymentMethodTransactionLog object contains payment method transaction log data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/Object_GETPaymentMethodTransactionLog/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRUD: Retrieve a payment method transaction log"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to export such data."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/object/payment-method-transaction-log/{id}","summary":"CRUD: Retrieve a payment method transaction log","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-method-transaction-logs/object_getpaymentmethodtransactionlog","deprecated":false}]}]}]}]}},{"type":"group","label":"Hosted Pages","link":"/v1-api-reference/api/hosted-pages","routeSlug":"/v1-api-reference/api/hosted-pages","items":[{"label":"List hosted pages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/hosted-pages/get_hostedpages","routeSlug":"/v1-api-reference/api/hosted-pages/get_hostedpages","metadata":{"seo":{"title":"List hosted pages","description":"Returns the Payment Pages configuration metadata,specifically, page ID, page version, payment method type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_HostedPages","name":"List hosted pages","isWebhook":false,"pointer":"/paths/~1v1~1hostedpages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List hosted pages","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":"Returns the Payment Pages configuration metadata,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specifically, page ID, page version, payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following are the version-specific and general REST requests for Payment Pages:"},"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 request for Payment Pages 2.0 configuration information: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET <BaseURL>/hostedpages?version=2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request for all versions of Payment Pages configuration information: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET <BaseURL>/hostedpages"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"hosted-pages/get_hostedpages/request/notes","deepLinkHash":"/hosted-pages/get_hostedpages#hosted-pages/get_hostedpages/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not have the corresponding tenant setting enabled, such as specifying the request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to 2 but disabliing Payment Pages 2.0, you will receive an error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"versionNumber","in":"query","schemaId":"schema_5","description":"Version of the Payment Pages for which you want to retrieve the configuration information. Specify 2 for Payment Pages 2.0.\n"}],"pointer":"/paths/~1v1~1hostedpages/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1hostedpages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/hostedpages","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"versionNumber","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/hostedpages","href":"hosted-pages/get_hostedpages","openApiOperationId":"Get_HostedPages","summary":"List hosted pages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetHostedPagesType","exampleIds":["paths/~1v1~1hostedpages/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetHostedPagesType","exampleIds":["paths/~1v1~1hostedpages/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1hostedpages/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1hostedpages/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1hostedpages/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1hostedpages/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1hostedpages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetHostedPagesType","exampleIds":["paths/~1v1~1hostedpages/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetHostedPagesType","exampleIds":["paths/~1v1~1hostedpages/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1hostedpages/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1hostedpages/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1hostedpages/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1hostedpages/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hosted-pages/get_hostedpages"}],"panels":[]}]},"httpPath":"/v1/hostedpages"}],"content":{"contentType":"group","meta":{"name":"Hosted Pages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hosted Pages","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":"Hosted payment pages allow your customers to set up a payment method, such as providing a credit card. Since it only handles the payment method, it is suitable for a simple workflow or a complex multi-page, multi-product workflow."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-paymentpage2.0-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hosted Payment Pages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/hostedpages","summary":"List hosted pages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hosted-pages/get_hostedpages","deprecated":false}]}]}]}]}},{"type":"group","label":"RSA Signatures","link":"/v1-api-reference/api/rsa-signatures","routeSlug":"/v1-api-reference/api/rsa-signatures","items":[{"label":"Generate an RSA signature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/rsa-signatures/post_rsasignatures","routeSlug":"/v1-api-reference/api/rsa-signatures/post_rsasignatures","metadata":{"seo":{"title":"Generate an RSA signature","description":"The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. The POST rsa_signatures call generates and returns the required digital signature and token for a Payment Pages 2.0 form. You need to pass the generated signature to your client for it to access Payment Pages 2.0."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_RSASignatures","name":"Generate an RSA signature","isWebhook":false,"pointer":"/paths/~1v1~1rsa-signatures/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate an RSA signature","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":"The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. The POST rsa_signatures call generates and returns the required digital signature and token for a Payment Pages 2.0 form. You need to pass the generated signature to your client for it to access Payment Pages 2.0."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This REST service should be used only when you implement Payment Pages 2.0."},"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":" To avoid potential credit card fraud attacks, you should secure your Payment Pages from being accessed by fraudulent users before you issue client-side digital signatures and tokens. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-paymentpage2.0-digitalsignature-generation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Token Issuance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"Troubleshooting tip:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" After you use this operation to generate an RSA signature, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is successfully returned, please limit the number of the fields in your request to make sure that the maximum length supported by the RSA signature algorithm is not exceeded. The calculation of the request length is determined by the number of the parameters, and the length of each of the parameter name and its value."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1rsa-signatures/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTRSASignatureType"}},"schemaId":"components/schemas/POSTRSASignatureType","pointer":"/paths/~1v1~1rsa-signatures/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/rsa-signatures","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTRSASignatureType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/rsa-signatures","href":"rsa-signatures/post_rsasignatures","openApiOperationId":"POST_RSASignatures","summary":"Generate an RSA signature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTRSASignatureType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTRSASignatureType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTRSASignatureResponseType","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTRSASignatureResponseType","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1rsa-signatures/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTRSASignatureResponseType","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTRSASignatureResponseType","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rsa-signatures/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rsa-signatures/post_rsasignatures"}],"panels":[]}]},"httpPath":"/v1/rsa-signatures"},{"label":"Decrypt an RSA signature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/rsa-signatures/post_decryptrsasignatures","routeSlug":"/v1-api-reference/api/rsa-signatures/post_decryptrsasignatures","metadata":{"seo":{"title":"Decrypt an RSA signature","description":"The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. You use rsa_signatures to generate the required digital signature and token for a Payment Pages 2.0 form, and then you use the decrypt REST service to decrypt the signature to validate the signature and key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_DecryptRSASignatures","name":"Decrypt an RSA signature","isWebhook":false,"pointer":"/paths/~1v1~1rsa-signatures~1decrypt/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decrypt an RSA signature","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":"The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. You use rsa_signatures to generate the required digital signature and token for a Payment Pages 2.0 form, and then you use the decrypt REST service to decrypt the signature to validate the signature and key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This REST service should be used only when you implement Payment Pages 2.0."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1rsa-signatures~1decrypt/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTDecryptionType"}},"schemaId":"components/schemas/POSTDecryptionType","pointer":"/paths/~1v1~1rsa-signatures~1decrypt/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/rsa-signatures/decrypt","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTDecryptionType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/rsa-signatures/decrypt","href":"rsa-signatures/post_decryptrsasignatures","openApiOperationId":"POST_DecryptRSASignatures","summary":"Decrypt an RSA signature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTDecryptionType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTDecryptionType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTDecryptResponseType","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTDecryptResponseType","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1rsa-signatures~1decrypt/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTDecryptResponseType","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTDecryptResponseType","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1rsa-signatures~1decrypt/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rsa-signatures/post_decryptrsasignatures"}],"panels":[]}]},"httpPath":"/v1/rsa-signatures/decrypt"}],"content":{"contentType":"group","meta":{"name":"RSA Signatures"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RSA Signatures","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":"The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/POST_RSASignatures/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate an RSA signature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to generate the required digital signature and token for a Payment Pages 2.0 form, then use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/POST_DecryptRSASignatures/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decrypt an RSA signature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to decrypt the signature to validate the signature and key.\""},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/rsa-signatures","summary":"Generate an RSA signature","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rsa-signatures/post_rsasignatures","deprecated":false},{"title":"/v1/rsa-signatures/decrypt","summary":"Decrypt an RSA signature","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rsa-signatures/post_decryptrsasignatures","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payments","content":null},{"type":"group","label":"Payment Authorization","link":"/v1-api-reference/api/payment-authorization","routeSlug":"/v1-api-reference/api/payment-authorization","items":[{"label":"Create authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-authorization/post_createauthorization","routeSlug":"/v1-api-reference/api/payment-authorization/post_createauthorization","metadata":{"seo":{"title":"Create authorization","description":"Enables you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. Subsequently, use Create a payment or Create an order to capture the authorized funds, or use Cancel authorization to cancel the authorization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateAuthorization","name":"Create authorization","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create authorization","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":"Enables you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. Subsequently, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreatePayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to capture the authorized funds, or use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CancelAuthorization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to cancel the authorization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For gateway integrations that support this operation, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-delayed-capture","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delayed Capture"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"The unique ID of the payment method where the authorization is created.\n","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTDelayAuthorizeCapture"}},"schemaId":"components/schemas/POSTDelayAuthorizeCapture","pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-methods/{payment-method-id}/authorize","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTDelayAuthorizeCapture"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}/authorize","href":"payment-authorization/post_createauthorization","openApiOperationId":"POST_CreateAuthorization","summary":"Create authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTDelayAuthorizeCapture","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTDelayAuthorizeCapture"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTAuthorizeResponse"}},"schemaId":"components/schemas/POSTAuthorizeResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTAuthorizeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTAuthorizeResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-authorization/post_createauthorization"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}/authorize"},{"label":"Cancel authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-authorization/post_cancelauthorization","routeSlug":"/v1-api-reference/api/payment-authorization/post_cancelauthorization","metadata":{"seo":{"title":"Cancel authorization","description":"Allows you to cancel an authorization. For gateway integrations that support this operation, see Delayed Capture."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CancelAuthorization","name":"Cancel authorization","isWebhook":false,"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel authorization","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":"Allows you to cancel an authorization. For gateway integrations that support this operation, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-delayed-capture","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delayed Capture"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-method-id","in":"path","schemaId":"schema_5","description":"The unique ID of the payment method where the authorization is cancelled.\n","required":true}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTVoidAuthorize"}},"schemaId":"components/schemas/POSTVoidAuthorize","pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-methods/{payment-method-id}/voidAuthorize","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-method-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTVoidAuthorize"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-methods/{payment-method-id}/voidAuthorize","href":"payment-authorization/post_cancelauthorization","openApiOperationId":"POST_CancelAuthorization","summary":"Cancel authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTVoidAuthorize","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTVoidAuthorize"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTVoidAuthorizeResponse"}},"schemaId":"components/schemas/POSTVoidAuthorizeResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTVoidAuthorizeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTVoidAuthorizeResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-authorization/post_cancelauthorization"}],"panels":[]}]},"httpPath":"/v1/payment-methods/{payment-method-id}/voidAuthorize"}],"content":{"contentType":"group","meta":{"name":"Payment Authorization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Authorization","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":"The Delayed Capture feature allows you to authorize the availability of funds for a transaction but delay the capture of funds until a later time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateAuthorization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to authorize a payment amount before capturing the payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subsequently, you can use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreatePayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Order/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to capture the authorized funds, or use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CancelAuthorization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to cancel the authorization."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/payment-methods/{payment-method-id}/authorize","summary":"Create authorization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-authorization/post_createauthorization","deprecated":false},{"title":"/v1/payment-methods/{payment-method-id}/voidAuthorize","summary":"Cancel authorization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-authorization/post_cancelauthorization","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Gateways","link":"/v1-api-reference/api/payment-gateways","routeSlug":"/v1-api-reference/api/payment-gateways","items":[{"label":"List all payment gateways","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateways/get_paymentgateways","routeSlug":"/v1-api-reference/api/payment-gateways/get_paymentgateways","metadata":{"seo":{"title":"List all payment gateways","description":"Retrieves all payment gateways configured in your tenant in a single, non-paginated response. There is no limit on the number of gateways returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Paymentgateways","name":"List all payment gateways","isWebhook":false,"pointer":"/paths/~1v1~1paymentgateways/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all payment gateways","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all payment gateways configured in your tenant in a single, non-paginated response. There is no limit on the number of gateways returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1paymentgateways/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/paymentgateways","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/paymentgateways","href":"payment-gateways/get_paymentgateways","openApiOperationId":"GET_Paymentgateways","summary":"List all payment gateways"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentGatwaysResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentGatwaysResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1paymentgateways/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentGatwaysResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentGatwaysResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1paymentgateways/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-gateways/get_paymentgateways"}],"panels":[]}]},"httpPath":"/v1/paymentgateways"},{"label":"Trigger a pre-debit notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateways/triggerpredebitnotification","routeSlug":"/v1-api-reference/api/payment-gateways/triggerpredebitnotification","metadata":{"seo":{"title":"Trigger a pre-debit notification","description":"To support processing recurring UPI payments through Adyen Integration v2.0,a pre-debit notification for each posted invoice must be sent to the UPI usersbefore collecting the recurring payments. Use this operation to send pre-debit notification requeststo the gateway for invoices that meet the requirements.See Implement UPI on Adyen Integration v2.0 for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerPreDebitNotification","name":"Trigger a pre-debit notification","isWebhook":false,"pointer":"/paths/~1v1~1payment-gateways~1pre-debit-notification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger a pre-debit notification","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":"To support processing recurring UPI payments through Adyen Integration v2.0,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a pre-debit notification for each posted invoice must be sent to the UPI users"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before collecting the recurring payments. Use this operation to send pre-debit notification requests"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the gateway for invoices that meet the requirements."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/set-up-payment-gateway-integrations/adyen-payment-gateway/implement-upi-on-adyen-integration-v2.0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Implement UPI on Adyen Integration v2.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before using this operation, ensure the following prerequisites are met:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/set-up-payment-gateway-integrations/adyen-payment-gateway/implement-upi-on-adyen-integration-v2.0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support for UPI transactions on Adyen"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been enabled. This is a feature that can be requested through the Specialized Payment Connections service at an additional cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/set-up-payment-gateway-integrations/adyen-payment-gateway/implement-upi-on-adyen-integration-v2.0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conditions for triggering pre-debit notification requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are met."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-gateways~1pre-debit-notification/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostTriggerPreDebitNotificationRequest"}},"schemaId":"components/schemas/PostTriggerPreDebitNotificationRequest","pointer":"/paths/~1v1~1payment-gateways~1pre-debit-notification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-gateways/pre-debit-notification","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostTriggerPreDebitNotificationRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-gateways/pre-debit-notification","href":"payment-gateways/triggerpredebitnotification","openApiOperationId":"triggerPreDebitNotification","summary":"Trigger a pre-debit notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostTriggerPreDebitNotificationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostTriggerPreDebitNotificationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostTriggerPreDebitNotificationResponse"}},"schemaId":"components/schemas/PostTriggerPreDebitNotificationResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostTriggerPreDebitNotificationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostTriggerPreDebitNotificationResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-gateways/triggerpredebitnotification"}],"panels":[]}]},"httpPath":"/v1/payment-gateways/pre-debit-notification"}],"content":{"contentType":"group","meta":{"name":"Payment Gateways"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Gateways","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 gateways to pass authorization, payments, and settlement data securely to and from the merchant's website to the merchant's processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about payment gateways, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Gateways"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/paymentgateways","summary":"List all payment gateways","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-gateways/get_paymentgateways","deprecated":false},{"title":"/v1/payment-gateways/pre-debit-notification","summary":"Trigger a pre-debit notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-gateways/triggerpredebitnotification","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Gateway Reconciliation","link":"/v1-api-reference/api/payment-gateway-reconciliation","routeSlug":"/v1-api-reference/api/payment-gateway-reconciliation","items":[{"label":"Reverse a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateway-reconciliation/post_reversepayment","routeSlug":"/v1-api-reference/api/payment-gateway-reconciliation/post_reversepayment","metadata":{"seo":{"title":"Reverse a payment","description":"If the Asynchronous Payment Statuses feature is not enabled, thisAPI operation sets the Gateway State field of the payment to Settled, createsa refund for the amount specified in the request, and returns the Refund objectas response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_ReversePayment","name":"Reverse a payment","isWebhook":false,"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverse a payment","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":"If the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-electronic-payment-processing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous Payment Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is not enabled, this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API operation sets the Gateway State field of the payment to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", creates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a refund for the amount specified in the request, and returns the Refund object"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Asynchronous Payment Statuses feature is enabled, for ACH and Bank Transfer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payments that are reversed before they are settled, this API operation sets the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Status field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sets the Gateway State field of the payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", creates an external refund for the amount specified in the request,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and returns the Refund object as response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the reason code \"Payment Reversal\" is active in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-creating-and-editing-reason-codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list, the reason code of the external refund is set to \"Payment Reversal\". Otherwise, the default reason code in the list is used."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-key","in":"path","schemaId":"schema_5","description":"The payment number starting with \"P-\" or the unique payment ID.","required":true}],"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTReversePaymentRequest"}},"schemaId":"components/schemas/POSTReversePaymentRequest","pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/gateway-settlement/payments/{payment-key}/chargeback","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTReversePaymentRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/gateway-settlement/payments/{payment-key}/chargeback","href":"payment-gateway-reconciliation/post_reversepayment","openApiOperationId":"POST_ReversePayment","summary":"Reverse a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTReversePaymentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTReversePaymentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTReversePaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTReversePaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTReversePaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTReversePaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-gateway-reconciliation/post_reversepayment"}],"panels":[]}]},"httpPath":"/v1/gateway-settlement/payments/{payment-key}/chargeback"},{"label":"Reject a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateway-reconciliation/post_rejectpayment","routeSlug":"/v1-api-reference/api/payment-gateway-reconciliation/post_rejectpayment","metadata":{"seo":{"title":"Reject a payment","description":"If the Asynchronous Payment Statuses feature is not enabled, thisAPI operation sets the Gateway State field of the payment to FailedToSettle,creates a refund for the payment amount, and returns the Refund object as response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_RejectPayment","name":"Reject a payment","isWebhook":false,"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reject a payment","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":"If the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-electronic-payment-processing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous Payment Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is not enabled, this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API operation sets the Gateway State field of the payment to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FailedToSettle"},"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":"creates a refund for the payment amount, and returns the Refund object as response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Asynchronous Payment Statuses feature is enabled, for ACH and Bank Transfer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payments, this API operation sets the Payment Status field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway State field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FailedToSettle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and unapply the payment if it is already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the reason code \"Payment Rejection\" is active in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-creating-and-editing-reason-codes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list, the reason code of the external refund is set to \"Payment Rejection\". Otherwise, the default reason code in the list is used."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-key","in":"path","schemaId":"schema_5","description":"The payment number starting with \"P-\" or the unique payment ID.","required":true}],"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTRejectPaymentRequest"}},"schemaId":"components/schemas/POSTRejectPaymentRequest","pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/gateway-settlement/payments/{payment-key}/reject","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTRejectPaymentRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/gateway-settlement/payments/{payment-key}/reject","href":"payment-gateway-reconciliation/post_rejectpayment","openApiOperationId":"POST_RejectPayment","summary":"Reject a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTRejectPaymentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTRejectPaymentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTRejectPaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTRejectPaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTRejectPaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTRejectPaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-gateway-reconciliation/post_rejectpayment"}],"panels":[]}]},"httpPath":"/v1/gateway-settlement/payments/{payment-key}/reject"},{"label":"Settle a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateway-reconciliation/post_settlepayment","routeSlug":"/v1-api-reference/api/payment-gateway-reconciliation/post_settlepayment","metadata":{"seo":{"title":"Settle a payment","description":"If the Asynchronous Payment Statuses feature is not enabled, this API operation sets the Gateway State field of the payment to Settled and returns the Payment object as response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_SettlePayment","name":"Settle a payment","isWebhook":false,"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settle a payment","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":"If the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-electronic-payment-processing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous Payment Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is not enabled, this API operation sets the Gateway State field of the payment to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and returns the Payment object as response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Asynchronous Payment Statuses feature is enabled, for ACH and Bank Transfer payments, this API operation sets the Payment Status field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the Gateway State field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment-key","in":"path","schemaId":"schema_5","description":"The payment number starting with \"P-\" or the unique payment ID.","required":true}],"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTSettlePaymentRequest"}},"schemaId":"components/schemas/POSTSettlePaymentRequest","pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/gateway-settlement/payments/{payment-key}/settle","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"payment-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTSettlePaymentRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/gateway-settlement/payments/{payment-key}/settle","href":"payment-gateway-reconciliation/post_settlepayment","openApiOperationId":"POST_SettlePayment","summary":"Settle a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTSettlePaymentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTSettlePaymentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTSettlePaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTSettlePaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTSettlePaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTSettlePaymentResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-gateway-reconciliation/post_settlepayment"}],"panels":[]}]},"httpPath":"/v1/gateway-settlement/payments/{payment-key}/settle"},{"label":"Reconcile a refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-gateway-reconciliation/post_reconcilerefund","routeSlug":"/v1-api-reference/api/payment-gateway-reconciliation/post_reconcilerefund","metadata":{"seo":{"title":"Reconcile a refund","description":"Reconciles a refund when receiving the gateway reconciliation request or event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_ReconcileRefund","name":"Reconcile a refund","isWebhook":false,"pointer":"/paths/~1v1~1refunds~1{refund-key}~1reconcile/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reconcile a refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reconciles a refund when receiving the gateway reconciliation request or event.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refund-key","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refund number starting with “R-” or the unique refund ID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1refunds~1{refund-key}~1reconcile/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1refunds~1{refund-key}~1reconcile/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTReconcileRefundRequest"}},"schemaId":"components/schemas/POSTReconcileRefundRequest","pointer":"/paths/~1v1~1refunds~1{refund-key}~1reconcile/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/refunds/{refund-key}/reconcile","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"refund-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTReconcileRefundRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/refunds/{refund-key}/reconcile","href":"payment-gateway-reconciliation/post_reconcilerefund","openApiOperationId":"POST_ReconcileRefund","summary":"Reconcile a refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTReconcileRefundRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTReconcileRefundRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTReconcileRefundResponse"}},"schemaId":"components/schemas/POSTReconcileRefundResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTReconcileRefundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTReconcileRefundResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-gateway-reconciliation/post_reconcilerefund"}],"panels":[]}]},"httpPath":"/v1/refunds/{refund-key}/reconcile"}],"content":{"contentType":"group","meta":{"name":"Payment Gateway Reconciliation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Gateway Reconciliation","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":"Gateway reconciliation is the process of verifying that the electronic payment and refund transactions processed in Zuora match the transactions reported by the gateway."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if Zuora processed 200 transactions through a gateway, you should see the same number of transactions on the gateway's reconciliation report, sometimes also called the settlement report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can complete the following Gateway Reconciliation tasks through API:"},"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":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_SettlePayment/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settle a payment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_RejectPayment/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reject a payment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_ReversePayment/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverse a payment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_ReconcileRefund/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reconcile a refund"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/gateway-settlement/payments/{payment-key}/chargeback","summary":"Reverse a payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-gateway-reconciliation/post_reversepayment","deprecated":false},{"title":"/v1/gateway-settlement/payments/{payment-key}/reject","summary":"Reject a payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-gateway-reconciliation/post_rejectpayment","deprecated":false},{"title":"/v1/gateway-settlement/payments/{payment-key}/settle","summary":"Settle a payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-gateway-reconciliation/post_settlepayment","deprecated":false},{"title":"/v1/refunds/{refund-key}/reconcile","summary":"Reconcile a refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-gateway-reconciliation/post_reconcilerefund","deprecated":false}]}]}]}]}},{"type":"group","label":"Payments","link":"/v1-api-reference/api/payments","routeSlug":"/v1-api-reference/api/payments","items":[{"label":"List payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_retrieveallpayments","routeSlug":"/v1-api-reference/api/payments/get_retrieveallpayments","metadata":{"seo":{"title":"List payments","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RetrieveAllPayments","name":"List payments","isWebhook":false,"pointer":"/paths/~1v1~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payments","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all payments from all your customer accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"payments/get_retrieveallpayments/request/filtering","deepLinkHash":"/payments/get_retrieveallpayments#payments/get_retrieveallpayments/request/filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body."},"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":"unappliedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or any other query parameter does not support the less than(<) and the greater than(>) operators."},"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 a filterable field is string, you can set the corresponding query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when filtering. Then, you can get the response data with this field value being "},"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":"Examples:"},"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":"/v1/payments?status=Processed"},"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":"/v1/payments?currency=USD&status=Processed"},"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":"/v1/payments?status=Processed&type=External&sort=+number"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"accountId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"amount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"appliedAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appliedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdDate","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"creditBalanceAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditBalanceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"currency","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"effectiveDate","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"number","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"refundAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_98","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"type","in":"query","schemaId":"schema_99","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"unappliedAmount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unappliedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedDate","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by payment effective date."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the response data is displayed in descending order by payment number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field. The supported sortable fields of this operation are as below:"},"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":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"appliedAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unappliedAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refundAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditBalanceAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectiveDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedById"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"/v1/payments?sort=+number"},"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":"/v1/payments?status=Processed&sort=-number,+amount"},"children":[]}]}]}]}]}]}],"pointer":"/paths/~1v1~1payments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"accountId","in":"query","required":false,"schemaId":"schema_5"},{"name":"amount","in":"query","required":false,"schemaId":"schema_74"},{"name":"appliedAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"createdById","in":"query","required":false,"schemaId":"schema_5"},{"name":"createdDate","in":"query","required":false,"schemaId":"schema_23"},{"name":"creditBalanceAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"currency","in":"query","required":false,"schemaId":"schema_5"},{"name":"effectiveDate","in":"query","required":false,"schemaId":"schema_23"},{"name":"number","in":"query","required":false,"schemaId":"schema_5"},{"name":"refundAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"status","in":"query","required":false,"schemaId":"schema_98"},{"name":"type","in":"query","required":false,"schemaId":"schema_99"},{"name":"unappliedAmount","in":"query","required":false,"schemaId":"schema_74"},{"name":"updatedById","in":"query","required":false,"schemaId":"schema_5"},{"name":"updatedDate","in":"query","required":false,"schemaId":"schema_23"},{"name":"sort","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payments","href":"payments/get_retrieveallpayments","openApiOperationId":"GET_RetrieveAllPayments","summary":"List payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentCollectionResponseType","exampleIds":["paths/~1v1~1payments/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PaymentCollectionResponseType","exampleIds":["paths/~1v1~1payments/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentCollectionResponseType","exampleIds":["paths/~1v1~1payments/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentCollectionResponseType","exampleIds":["paths/~1v1~1payments/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/get_retrieveallpayments"}],"panels":[]}]},"httpPath":"/v1/payments"},{"label":"Create a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/post_createpayment","routeSlug":"/v1-api-reference/api/payments/post_createpayment","metadata":{"seo":{"title":"Create a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreatePayment","name":"Create a payment","isWebhook":false,"pointer":"/paths/~1v1~1payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a payment in the following scenarios:"},"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":"A full or partial payment on an invoice or a debit memo"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A full or partial payment on several invoices and debit memos"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unapplied payment in the following situations:"},"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":"You do not know which customer account the payment belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You know which customer account the payment belongs to, but you do not know which invoice the payment is applied to."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You receive a payment from your customer that exceeds the balance on the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You receive a payment from your customer before the invoice has been created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You intend to create a payment without any invoices or debit memos."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A standalone payment. If you only need to create and process an electronic payment in Zuora through a Zuora gateway integration but settle the payment outside of Zuora, you can create a standalone payment. For a standalone payment, you can specify a currency different from the payment currency in the customer account settings. When Standalone Payment is not enabled, the currency of the standalone payment can be different from the payment currency defined in the customer account settings if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not know to which customer account the payment belongs, you can create a payment without specifying a customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you create a payment, the total number of invoice items and debit memo items that the payment will apply to should be less than or equal to 15,000."},"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://docs.zuora.com?resourceId=payments-create-payment-using-zuora-ui"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Payments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-create-payment-without-customer-account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Payments Without Specifying Customer Accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePaymentType"}},"schemaId":"components/schemas/CreatePaymentType","pointer":"/paths/~1v1~1payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePaymentType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payments","href":"payments/post_createpayment","openApiOperationId":"POST_CreatePayment","summary":"Create a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreatePaymentType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePaymentType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentTypeWithPaymentOption","exampleIds":["paths/~1v1~1payments/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETARPaymentTypeWithPaymentOption","exampleIds":["paths/~1v1~1payments/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETARPaymentTypeWithPaymentOption","exampleIds":["paths/~1v1~1payments/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentTypeWithPaymentOption","exampleIds":["paths/~1v1~1payments/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/post_createpayment"}],"panels":[]}]},"httpPath":"/v1/payments"},{"label":"Update a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/put_updatepayment","routeSlug":"/v1-api-reference/api/payments/put_updatepayment","metadata":{"seo":{"title":"Update a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdatePayment","name":"Update a payment","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a payment","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a payment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePaymentType"}},"schemaId":"components/schemas/UpdatePaymentType","pointer":"/paths/~1v1~1payments~1{paymentKey}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payments/{paymentKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePaymentType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}","href":"payments/put_updatepayment","openApiOperationId":"PUT_UpdatePayment","summary":"Update a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdatePaymentType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePaymentType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/put_updatepayment"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}"},{"label":"Delete a payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/delete_payment","routeSlug":"/v1-api-reference/api/payments/delete_payment","metadata":{"seo":{"title":"Delete a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_Payment","name":"Delete a payment","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a payment","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a payment. Only payments with the Cancelled status can be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Invoice Settlement feature enabled, overpayments applied to credit balance cannot be deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/payments/{paymentKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}","href":"payments/delete_payment","openApiOperationId":"DELETE_Payment","summary":"Delete a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/delete_payment"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}"},{"label":"Retrieve a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_payment","routeSlug":"/v1-api-reference/api/payments/get_payment","metadata":{"seo":{"title":"Retrieve a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Payment","name":"Retrieve a payment","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about one specific payment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payments/{paymentKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}","href":"payments/get_payment","openApiOperationId":"GET_Payment","summary":"Retrieve a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/get_payment"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}"},{"label":"Apply a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/put_applypayment","routeSlug":"/v1-api-reference/api/payments/put_applypayment","metadata":{"seo":{"title":"Apply a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_ApplyPayment","name":"Apply a payment","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}~1apply/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a payment","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies an unapplied payment to invoices and debit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you apply a payment, the total number of invoice items and debit memo items that the payment will apply to must be less than or equal to 15,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the limit is hit, you can follow the instructions:"},"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 you want to apply one payment to multiple invoices or debit memos, decrease the number of invoices or debit memos 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 want to apply one payment to a single invoice or debit memo with a large volume of items, you have to specify invoice items in the request. The maximum number of invoice items that you can specify in the request is 1,000."},"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://docs.zuora.com?resourceId=payments-apply-unapplied-payments-to-memos"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply Unapplied Payments to Invoices and Debit Memos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1apply/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1apply/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyPaymentType"}},"schemaId":"components/schemas/ApplyPaymentType","pointer":"/paths/~1v1~1payments~1{paymentKey}~1apply/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payments/{paymentKey}/apply","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyPaymentType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}/apply","href":"payments/put_applypayment","openApiOperationId":"PUT_ApplyPayment","summary":"Apply a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ApplyPaymentType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyPaymentType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1apply/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/put_applypayment"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}/apply"},{"label":"Cancel a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/put_cancelpayment","routeSlug":"/v1-api-reference/api/payments/put_cancelpayment","metadata":{"seo":{"title":"Cancel a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CancelPayment","name":"Cancel a payment","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a payment","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Invoice Settlement feature enabled, overpayments applied to credit balance cannot be cancelled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payments/{paymentKey}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}/cancel","href":"payments/put_cancelpayment","openApiOperationId":"PUT_CancelPayment","summary":"Cancel a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/put_cancelpayment"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}/cancel"},{"label":"List all parts of a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_paymentparts","routeSlug":"/v1-api-reference/api/payments/get_paymentparts","metadata":{"seo":{"title":"List all parts of a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentParts","name":"List all parts of a payment","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all parts of a payment","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all parts of a payment. A payment can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a payment. Note that a fully refunded payment does not contain any payment part."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payments/{paymentKey}/parts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}/parts","href":"payments/get_paymentparts","openApiOperationId":"GET_PaymentParts","summary":"List all parts of a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentPartsCollectionType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentPartsCollectionType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentPartsCollectionType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentPartsCollectionType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/get_paymentparts"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}/parts"},{"label":"Retrieve a payment part","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_paymentpart","routeSlug":"/v1-api-reference/api/payments/get_paymentpart","metadata":{"seo":{"title":"Retrieve a payment part","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentPart","name":"Retrieve a payment part","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment part","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about a specific payment part. A payment can consist of an unapplied part, and several parts applied to invoices and debit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fully refunded payment does not contain any payment part."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a specific payment part. You can get the payment part ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/developer/api-references/api/operation/GET_PaymentParts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all parts of a payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payments/{paymentKey}/parts/{partid}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"partid","in":"path","required":true,"schemaId":"schema_5"},{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}/parts/{partid}","href":"payments/get_paymentpart","openApiOperationId":"GET_PaymentPart","summary":"Retrieve a payment part"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentPartType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentPartType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentPartType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentPartType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/get_paymentpart"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}/parts/{partid}"},{"label":"List all payment part items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_paymentitemparts","routeSlug":"/v1-api-reference/api/payments/get_paymentitemparts","metadata":{"seo":{"title":"List all payment part items","description":"Note: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentItemParts","name":"List all payment part items","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all payment part items","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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all items of a payment part. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a specific payment part. You can get the payment part ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/developer/api-references/api/operation/GET_PaymentParts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all parts of a payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payments/{paymentKey}/parts/{partid}/item-parts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"partid","in":"path","required":true,"schemaId":"schema_5"},{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}/parts/{partid}/item-parts","href":"payments/get_paymentitemparts","openApiOperationId":"GET_PaymentItemParts","summary":"List all payment part items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentItemPartCollectionType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentItemPartCollectionType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentItemPartCollectionType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentItemPartCollectionType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/get_paymentitemparts"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}/parts/{partid}/item-parts"},{"label":"Retrieve a payment part item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/get_paymentitempart","routeSlug":"/v1-api-reference/api/payments/get_paymentitempart","metadata":{"seo":{"title":"Retrieve a payment part item","description":"Note: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentItemPart","name":"Retrieve a payment part item","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment part item","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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about a specific payment part item. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a specific payment part. You can get the payment part ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/developer/api-references/api/operation/GET_PaymentParts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all parts of a payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"itempartid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a specific payment part item. You can get the payment part item ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/developer/api-references/api/operation/GET_PaymentItemParts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all payment part items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"partid","in":"path","required":true,"schemaId":"schema_5"},{"name":"itempartid","in":"path","required":true,"schemaId":"schema_5"},{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}","href":"payments/get_paymentitempart","openApiOperationId":"GET_PaymentItemPart","summary":"Retrieve a payment part item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentItemPartType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentItemPartType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentItemPartType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentItemPartType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/get_paymentitempart"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}"},{"label":"Refund a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/post_refundpayment","routeSlug":"/v1-api-reference/api/payments/post_refundpayment","metadata":{"seo":{"title":"Refund a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_RefundPayment","name":"Refund a payment","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}~1refunds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund a payment","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunds a full or partial unapplied payment to your customers. To refund applied payments, you must unapply the applied payments from the invoices or debit memos, and then refund the unapplied payments to customers. For more information on the payment refund use case, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-payment-schedules","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment schedules use cases"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-payments/process-payments/create-a-payment-using-zuora-ui/manage-unapplied-payments/management-of-unapplied-payments/refund-payments","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund Payments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1refunds/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1refunds/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostRefundType"}},"schemaId":"components/schemas/PostRefundType","pointer":"/paths/~1v1~1payments~1{paymentKey}~1refunds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payments/{paymentKey}/refunds","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostRefundType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}/refunds","href":"payments/post_refundpayment","openApiOperationId":"POST_RefundPayment","summary":"Refund a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostRefundType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostRefundType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRefundPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRefundPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/post_refundpayment"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}/refunds"},{"label":"Refund a payment with auto-unapplying","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/post_refundpaymentwithautounapply","routeSlug":"/v1-api-reference/api/payments/post_refundpaymentwithautounapply","metadata":{"seo":{"title":"Refund a payment with auto-unapplying","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_RefundPaymentwithAutoUnapply","name":"Refund a payment with auto-unapplying","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund a payment with auto-unapplying","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunds a full or partial unapplied payment to your customers, without the need to unapply the payment first, followed by processing the refund. To refund applied payments, you can now leverage this API to unapply and refund the payment simultaneously. For more information on the payment refund use case, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-payment-schedules","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment schedules use cases"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-payments/process-payments/create-a-payment-using-zuora-ui/manage-unapplied-payments/management-of-unapplied-payments/payment-refund-with-auto-unapplying/refund-a-payment-with-auto-unapply","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund a payment with auto-unapplying"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostRefundwithAutoUnapplyType"}},"schemaId":"components/schemas/PostRefundwithAutoUnapplyType","pointer":"/paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payments/{paymentKey}/refunds/unapply","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostRefundwithAutoUnapplyType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}/refunds/unapply","href":"payments/post_refundpaymentwithautounapply","openApiOperationId":"POST_RefundPaymentwithAutoUnapply","summary":"Refund a payment with auto-unapplying"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostRefundwithAutoUnapplyType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostRefundwithAutoUnapplyType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundPaymentTypeAutoUnapply","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRefundPaymentTypeAutoUnapply","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRefundPaymentTypeAutoUnapply","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundPaymentTypeAutoUnapply","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/post_refundpaymentwithautounapply"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}/refunds/unapply"},{"label":"Transfer a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/put_transferpayment","routeSlug":"/v1-api-reference/api/payments/put_transferpayment","metadata":{"seo":{"title":"Transfer a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_TransferPayment","name":"Transfer a payment","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}~1transfer/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer a payment","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfers an unapplied payment."},"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://docs.zuora.com?resourceId=payments-transfer-an-unapplied-payment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer Unapplied Payments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1transfer/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1transfer/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferPaymentType"}},"schemaId":"components/schemas/TransferPaymentType","pointer":"/paths/~1v1~1payments~1{paymentKey}~1transfer/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payments/{paymentKey}/transfer","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransferPaymentType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}/transfer","href":"payments/put_transferpayment","openApiOperationId":"PUT_TransferPayment","summary":"Transfer a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/TransferPaymentType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferPaymentType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/put_transferpayment"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}/transfer"},{"label":"Unapply a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payments/put_unapplypayment","routeSlug":"/v1-api-reference/api/payments/put_unapplypayment","metadata":{"seo":{"title":"Unapply a payment","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UnapplyPayment","name":"Unapply a payment","isWebhook":false,"pointer":"/paths/~1v1~1payments~1{paymentKey}~1unapply/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unapply a payment","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unapplies an applied payment from invoices and debit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you unapply a payment, the total number of invoice items and debit memo items that the payment will unapply from must be less than or equal to 15,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the limit is hit, you can follow the instructions:"},"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 you want to unapply one payment without specifying invoices or debit memos, you have to specify the invoices or debit memos 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 want to unapply one payment from multiple specified invoices or debit memos, decrease the number of invoices or debit memos 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 want to unapply one payment from a single invoice or debit memo with a large volume of items, you have to specify invoice items in the request. The maximum number of invoice items that you can specify in the request is 1,000."},"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://docs.zuora.com?resourceId=payments-unapply-payments-from-invoices-and-debit-memos"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unapply Payments from Invoices and Debit Memos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of an unapplied payment. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a8082e65b27f6c3015b89e4344c16b1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1unapply/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1unapply/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnapplyPaymentType"}},"schemaId":"components/schemas/UnapplyPaymentType","pointer":"/paths/~1v1~1payments~1{paymentKey}~1unapply/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payments/{paymentKey}/unapply","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UnapplyPaymentType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payments/{paymentKey}/unapply","href":"payments/put_unapplypayment","openApiOperationId":"PUT_UnapplyPayment","summary":"Unapply a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UnapplyPaymentType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnapplyPaymentType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETARPaymentType","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/put_unapplypayment"}],"panels":[]}]},"httpPath":"/v1/payments/{paymentKey}/unapply"}],"content":{"contentType":"group","meta":{"name":"Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payments","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 payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about payments, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-payment-solution","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/payments","summary":"List payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_retrieveallpayments","deprecated":false},{"title":"/v1/payments","summary":"Create a payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/post_createpayment","deprecated":false},{"title":"/v1/payments/{paymentKey}","summary":"Update a payment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/put_updatepayment","deprecated":false},{"title":"/v1/payments/{paymentKey}","summary":"Delete a payment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payments/delete_payment","deprecated":false},{"title":"/v1/payments/{paymentKey}","summary":"Retrieve a payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_payment","deprecated":false},{"title":"/v1/payments/{paymentKey}/apply","summary":"Apply a payment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/put_applypayment","deprecated":false},{"title":"/v1/payments/{paymentKey}/cancel","summary":"Cancel a payment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/put_cancelpayment","deprecated":false},{"title":"/v1/payments/{paymentKey}/parts","summary":"List all parts of a payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_paymentparts","deprecated":false},{"title":"/v1/payments/{paymentKey}/parts/{partid}","summary":"Retrieve a payment part","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_paymentpart","deprecated":false},{"title":"/v1/payments/{paymentKey}/parts/{partid}/item-parts","summary":"List all payment part items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_paymentitemparts","deprecated":false},{"title":"/v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}","summary":"Retrieve a payment part item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_paymentitempart","deprecated":false},{"title":"/v1/payments/{paymentKey}/refunds","summary":"Refund a payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/post_refundpayment","deprecated":false},{"title":"/v1/payments/{paymentKey}/refunds/unapply","summary":"Refund a payment with auto-unapplying","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/post_refundpaymentwithautounapply","deprecated":false},{"title":"/v1/payments/{paymentKey}/transfer","summary":"Transfer a payment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/put_transferpayment","deprecated":false},{"title":"/v1/payments/{paymentKey}/unapply","summary":"Unapply a payment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/put_unapplypayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Transaction Logs","link":"/v1-api-reference/api/payment-transaction-logs","routeSlug":"/v1-api-reference/api/payment-transaction-logs","items":[{"label":"CRUD: Retrieve a payment transaction log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-transaction-logs/object_getpaymenttransactionlog","routeSlug":"/v1-api-reference/api/payment-transaction-logs/object_getpaymenttransactionlog","metadata":{"seo":{"title":"CRUD: Retrieve a payment transaction log","description":"Retrieves information about a specific payment transaction log."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_GETPaymentTransactionLog","name":"CRUD: Retrieve a payment transaction log","isWebhook":false,"pointer":"/paths/~1v1~1object~1payment-transaction-log~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Retrieve a payment transaction log","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves information about a specific payment transaction log.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of a payment transaction log.\n","required":true}],"pointer":"/paths/~1v1~1object~1payment-transaction-log~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1payment-transaction-log~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/object/payment-transaction-log/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v1/object/payment-transaction-log/{id}","href":"payment-transaction-logs/object_getpaymenttransactionlog","openApiOperationId":"Object_GETPaymentTransactionLog","summary":"CRUD: Retrieve a payment transaction log"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetPaymentTransactionLog","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyGetPaymentTransactionLog","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyGetPaymentTransactionLog","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetPaymentTransactionLog","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-transaction-logs/object_getpaymenttransactionlog"}],"panels":[]}]},"httpPath":"/v1/object/payment-transaction-log/{id}"}],"content":{"contentType":"group","meta":{"name":"Payment Transaction Logs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Transaction Logs","showPageActions":true},{"nodeType":"markdoc","content":"Use payment transaction logs to export logs of all transactions from Zuora to the Gateway for Payments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/object/payment-transaction-log/{id}","summary":"CRUD: Retrieve a payment transaction log","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-transaction-logs/object_getpaymenttransactionlog","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Runs","link":"/v1-api-reference/api/payment-runs","routeSlug":"/v1-api-reference/api/payment-runs","items":[{"label":"List payment runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/get_paymentruns","routeSlug":"/v1-api-reference/api/payment-runs/get_paymentruns","metadata":{"seo":{"title":"List payment runs","description":"Retrieves the information about all payment runs. You can define filterable fields to restrict the data returned in the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentRuns","name":"List payment runs","isWebhook":false,"pointer":"/paths/~1v1~1payment-runs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment runs","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 the information about all payment runs. You can define filterable fields to restrict the data returned in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"payment-runs/get_paymentruns/request/filtering","deepLinkHash":"/payment-runs/get_paymentruns#payment-runs/get_paymentruns/request/filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body."},"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 a filterable field is string, you can set the corresponding query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when filtering. Then, you can get the response data with this field value being "},"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":"Examples:"},"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":"/v1/payment-runs?status=Processed"},"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":"/v1/payment-runs?targetDate=2017-10-10&status=Pending"},"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":"/v1/payment-runs?status=Completed&sort=+updatedDate"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"createdById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdDate","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"targetDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedDate","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the response data is displayed in descending order by payment run number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field. The supported sortable fields of this operation are as below:"},"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":"targetDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedById"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"/v1/payment-runs?sort=+createdDate"},"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":"/v1/payment-runs?status=Processing&sort=-createdById,+targetDate"},"children":[]}]}]}]}]}]}],"pointer":"/paths/~1v1~1payment-runs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-runs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-runs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"createdById","in":"query","required":false,"schemaId":"schema_5"},{"name":"createdDate","in":"query","required":false,"schemaId":"schema_23"},{"name":"status","in":"query","required":false,"schemaId":"schema_100"},{"name":"targetDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"updatedById","in":"query","required":false,"schemaId":"schema_5"},{"name":"updatedDate","in":"query","required":false,"schemaId":"schema_23"},{"name":"sort","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/payment-runs","href":"payment-runs/get_paymentruns","openApiOperationId":"GET_PaymentRuns","summary":"List payment runs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunCollectionType","exampleIds":["paths/~1v1~1payment-runs/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentRunCollectionType","exampleIds":["paths/~1v1~1payment-runs/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1payment-runs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentRunCollectionType","exampleIds":["paths/~1v1~1payment-runs/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunCollectionType","exampleIds":["paths/~1v1~1payment-runs/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/get_paymentruns"}],"panels":[]}]},"httpPath":"/v1/payment-runs"},{"label":"Create a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/post_paymentrun","routeSlug":"/v1-api-reference/api/payment-runs/post_paymentrun","metadata":{"seo":{"title":"Create a payment run","description":"Creates a payment run. You can create a payment run to be executed immediately after it is created, or a scheduled payment run to be executed in future."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_PaymentRun","name":"Create a payment run","isWebhook":false,"pointer":"/paths/~1v1~1payment-runs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment run","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 run. You can create a payment run to be executed immediately after it is created, or a scheduled payment run to be executed in future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To filter the payments to be collected for a payment run, you can use either of the following methods but not both:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"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":"paymentGatewayId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingRunId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to define the billing documents to be collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the records of accounts and billing documents to be collected, in a more flexible manner. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-custom-payment-runs-through-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create custom payment runs through Zuora REST API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no filter criteria are specified in the request body, the payment run collects payments for all accounts."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-runs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentRunRequest"}},"schemaId":"components/schemas/POSTPaymentRunRequest","pointer":"/paths/~1v1~1payment-runs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-runs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTPaymentRunRequest"}},"responseCodes":["200"],"pointer":"/v1/payment-runs","href":"payment-runs/post_paymentrun","openApiOperationId":"POST_PaymentRun","summary":"Create a payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTPaymentRunRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentRunRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1payment-runs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/post_paymentrun"}],"panels":[]}]},"httpPath":"/v1/payment-runs"},{"label":"Delete a payment run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/delete_paymentrun","routeSlug":"/v1-api-reference/api/payment-runs/delete_paymentrun","metadata":{"seo":{"title":"Delete a payment run","description":"Deletes a payment run. Only payment runs with the Canceled or Error status can be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_PaymentRun","name":"Delete a payment run","isWebhook":false,"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a payment run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a payment run. Only payment runs with the Canceled or Error status can be deleted.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentRunKey","in":"path","schemaId":"schema_5","description":"The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n","required":true}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/payment-runs/{paymentRunKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentRunKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/payment-runs/{paymentRunKey}","href":"payment-runs/delete_paymentrun","openApiOperationId":"DELETE_PaymentRun","summary":"Delete a payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/delete/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/delete_paymentrun"}],"panels":[]}]},"httpPath":"/v1/payment-runs/{paymentRunKey}"},{"label":"Retrieve a payment run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/get_paymentrun","routeSlug":"/v1-api-reference/api/payment-runs/get_paymentrun","metadata":{"seo":{"title":"Retrieve a payment run","description":"Retrives the information about a specific payment run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentRun","name":"Retrieve a payment run","isWebhook":false,"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrives the information about a specific payment run.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentRunKey","in":"path","schemaId":"schema_5","description":"The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n","required":true}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-runs/{paymentRunKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentRunKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/payment-runs/{paymentRunKey}","href":"payment-runs/get_paymentrun","openApiOperationId":"GET_PaymentRun","summary":"Retrieve a payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/get_paymentrun"}],"panels":[]}]},"httpPath":"/v1/payment-runs/{paymentRunKey}"},{"label":"Update a payment run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/put_paymentrun","routeSlug":"/v1-api-reference/api/payment-runs/put_paymentrun","metadata":{"seo":{"title":"Update a payment run","description":"Updates the information about an unexecuted payment run. Only pending payment runs can be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PaymentRun","name":"Update a payment run","isWebhook":false,"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a payment run","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 information about an unexecuted payment run. Only pending payment runs can be updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If none of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountId"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"batch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billCycleDay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentGatewayId"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billingRunId"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields is specified in the request body, the corresponding payment run collects payments for all accounts."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentRunKey","in":"path","schemaId":"schema_5","description":"The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n","required":true}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPaymentRunRequest"}},"schemaId":"components/schemas/PUTPaymentRunRequest","pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-runs/{paymentRunKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentRunKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTPaymentRunRequest"}},"responseCodes":["200"],"pointer":"/v1/payment-runs/{paymentRunKey}","href":"payment-runs/put_paymentrun","openApiOperationId":"PUT_PaymentRun","summary":"Update a payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTPaymentRunRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPaymentRunRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunType","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}/put/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/put_paymentrun"}],"panels":[]}]},"httpPath":"/v1/payment-runs/{paymentRunKey}"},{"label":"Retrieve payment run data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/get_paymentrundata","routeSlug":"/v1-api-reference/api/payment-runs/get_paymentrundata","metadata":{"seo":{"title":"Retrieve payment run data","description":"Retrieves payment run data and the processing result with details, if the data field was specified in the Create payment run operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentRunData","name":"Retrieve payment run data","isWebhook":false,"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}~1data/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve payment run data","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 payment run data and the processing result with details, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field was specified in the Create payment run operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentRunKey","in":"path","schemaId":"schema_5","description":"The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n","required":true}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}~1data/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}~1data/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-runs/{paymentRunKey}/data","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentRunKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/payment-runs/{paymentRunKey}/data","href":"payment-runs/get_paymentrundata","openApiOperationId":"GET_PaymentRunData","summary":"Retrieve payment run data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunDataArrayResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}~1data/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentRunDataArrayResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}~1data/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}~1data/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentRunDataArrayResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}~1data/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunDataArrayResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}~1data/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/get_paymentrundata"}],"panels":[]}]},"httpPath":"/v1/payment-runs/{paymentRunKey}/data"},{"label":"Retrieve a payment run summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-runs/get_paymentrunsummary","routeSlug":"/v1-api-reference/api/payment-runs/get_paymentrunsummary","metadata":{"seo":{"title":"Retrieve a payment run summary","description":"Retrives the summary of a payment run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentRunSummary","name":"Retrieve a payment run summary","isWebhook":false,"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment run summary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrives the summary of a payment run.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentRunKey","in":"path","schemaId":"schema_5","description":"The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n","required":true}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}~1summary/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}~1summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-runs/{paymentRunKey}/summary","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentRunKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/payment-runs/{paymentRunKey}/summary","href":"payment-runs/get_paymentrunsummary","openApiOperationId":"GET_PaymentRunSummary","summary":"Retrieve a payment run summary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunSummaryResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}~1summary/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentRunSummaryResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}~1summary/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1payment-runs~1{paymentRunKey}~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentRunSummaryResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}~1summary/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentRunSummaryResponse","exampleIds":["paths/~1v1~1payment-runs~1{paymentRunKey}~1summary/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/get_paymentrunsummary"}],"panels":[]}]},"httpPath":"/v1/payment-runs/{paymentRunKey}/summary"}],"content":{"contentType":"group","meta":{"name":"Payment Runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Runs","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 runs to collect payments using electronic payment methods, for example, credit cards and ACH."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about payment runs, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-payment-runs","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Runs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/payment-runs","summary":"List payment runs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-runs/get_paymentruns","deprecated":false},{"title":"/v1/payment-runs","summary":"Create a payment run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-runs/post_paymentrun","deprecated":false},{"title":"/v1/payment-runs/{paymentRunKey}","summary":"Delete a payment run","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-runs/delete_paymentrun","deprecated":false},{"title":"/v1/payment-runs/{paymentRunKey}","summary":"Retrieve a payment run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-runs/get_paymentrun","deprecated":false},{"title":"/v1/payment-runs/{paymentRunKey}","summary":"Update a payment run","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-runs/put_paymentrun","deprecated":false},{"title":"/v1/payment-runs/{paymentRunKey}/data","summary":"Retrieve payment run data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-runs/get_paymentrundata","deprecated":false},{"title":"/v1/payment-runs/{paymentRunKey}/summary","summary":"Retrieve a payment run summary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-runs/get_paymentrunsummary","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Schedules","link":"/v1-api-reference/api/payment-schedules","routeSlug":"/v1-api-reference/api/payment-schedules","items":[{"label":"Retry failed payment schedule items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/post_retrypaymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/post_retrypaymentscheduleitem","metadata":{"seo":{"title":"Retry failed payment schedule items","description":"Retries failed payment schedule items. The payment method and payment gateway of the failed payment can be updated to new values before the retry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_RetryPaymentScheduleItem","name":"Retry failed payment schedule items","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedule-items~1retry-payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retry failed payment schedule items","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":"Retries failed payment schedule items. The payment method and payment gateway of the failed payment can be updated to new values before the retry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that you can retry a payment schedule item only when the payment schedule item is either in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedule-items~1retry-payment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTRetryPaymentScheduleItemRequest"}},"schemaId":"components/schemas/POSTRetryPaymentScheduleItemRequest","pointer":"/paths/~1v1~1payment-schedule-items~1retry-payment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-schedule-items/retry-payment","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTRetryPaymentScheduleItemRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedule-items/retry-payment","href":"payment-schedules/post_retrypaymentscheduleitem","openApiOperationId":"POST_RetryPaymentScheduleItem","summary":"Retry failed payment schedule items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTRetryPaymentScheduleItemRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTRetryPaymentScheduleItemRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTRetryPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTRetryPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedule-items~1retry-payment/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTRetryPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTRetryPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/post_retrypaymentscheduleitem"}],"panels":[]}]},"httpPath":"/v1/payment-schedule-items/retry-payment"},{"label":"Cancel a payment schedule item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_cancelpaymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/put_cancelpaymentscheduleitem","metadata":{"seo":{"title":"Cancel a payment schedule item","description":"Cancels a payment schedule item by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CancelPaymentScheduleItem","name":"Cancel a payment schedule item","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a payment schedule item","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":"Cancels a payment schedule item by ID."},"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":"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 Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"item-id","in":"path","schemaId":"schema_5","description":"The unique ID of a payment schedule item.","required":true}],"pointer":"/paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-schedule-items/{item-id}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"item-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedule-items/{item-id}/cancel","href":"payment-schedules/put_cancelpaymentscheduleitem","openApiOperationId":"PUT_CancelPaymentScheduleItem","summary":"Cancel a payment schedule item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/put_cancelpaymentscheduleitem"}],"panels":[]}]},"httpPath":"/v1/payment-schedule-items/{item-id}/cancel"},{"label":"Skip a payment schedule item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_skippaymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/put_skippaymentscheduleitem","metadata":{"seo":{"title":"Skip a payment schedule item","description":"Skips a payment schedule item by ID. The skipped payment schedule item will turn to the canceled status, and a new item will be scheduled on the next recurring date after the last existing scheduled date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_SkipPaymentScheduleItem","name":"Skip a payment schedule item","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Skip a payment schedule item","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":"Skips a payment schedule item by ID. The skipped payment schedule item will turn to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, and a new item will be scheduled on the next recurring date after the last existing scheduled date."},"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":"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":"Only payment schedule items in recurring payment schedules can be skipped, and the item must be 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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"item-id","in":"path","schemaId":"schema_5","description":"The unique ID of a payment schedule item.   \n","required":true}],"pointer":"/paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-schedule-items/{item-id}/skip","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"item-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedule-items/{item-id}/skip","href":"payment-schedules/put_skippaymentscheduleitem","openApiOperationId":"PUT_SkipPaymentScheduleItem","summary":"Skip a payment schedule item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTSkipPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTSkipPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTSkipPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTSkipPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/put_skippaymentscheduleitem"}],"panels":[]}]},"httpPath":"/v1/payment-schedule-items/{item-id}/skip"},{"label":"Retrieve a payment schedule item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/get_paymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/get_paymentscheduleitem","metadata":{"seo":{"title":"Retrieve a payment schedule item","description":"Retrieves a payment schedule item by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentScheduleItem","name":"Retrieve a payment schedule item","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment schedule item","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 payment schedule item by ID."},"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":"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 Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"psi-id","in":"path","schemaId":"schema_5","description":"The unique ID of a payment schedule item.\n","required":true}],"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-schedule-items/{psi-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"psi-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedule-items/{psi-id}","href":"payment-schedules/get_paymentscheduleitem","openApiOperationId":"GET_PaymentScheduleItem","summary":"Retrieve a payment schedule item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/get_paymentscheduleitem"}],"panels":[]}]},"httpPath":"/v1/payment-schedule-items/{psi-id}"},{"label":"Update a payment schedule item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_paymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/put_paymentscheduleitem","metadata":{"seo":{"title":"Update a payment schedule item","description":"Updates a payment schedule item by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PaymentScheduleItem","name":"Update a payment schedule item","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a payment schedule item","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 payment schedule item by ID."},"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":"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 Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manag](https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To link or unlink multiple payments with the item, specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unlinkPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Multi-currency and Standalone Payments features are not enabled, you can create and update a payment schedule and payment schedule item in a currency other than the account currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of payments that are allowed to be linked to a payment schedule item is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"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":"When unlinking and linking payments with the payment schedule item in one request, Zuora will first unlink the linked payments, and then link new payments to the item."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"psi-id","in":"path","schemaId":"schema_5","description":"The unique ID of a payment schedule item.\n","required":true}],"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPaymentScheduleItemRequest"}},"schemaId":"components/schemas/PUTPaymentScheduleItemRequest","pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-schedule-items/{psi-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"psi-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTPaymentScheduleItemRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedule-items/{psi-id}","href":"payment-schedules/put_paymentscheduleitem","openApiOperationId":"PUT_PaymentScheduleItem","summary":"Update a payment schedule item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTPaymentScheduleItemRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPaymentScheduleItemRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTPaymentScheduleItemResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/put_paymentscheduleitem"}],"panels":[]}]},"httpPath":"/v1/payment-schedule-items/{psi-id}"},{"label":"Delete a payment schedule item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/deletepaymentscheduleitem","routeSlug":"/v1-api-reference/api/payment-schedules/deletepaymentscheduleitem","metadata":{"seo":{"title":"Delete a payment schedule item","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePaymentScheduleItem","name":"Delete a payment schedule item","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a payment schedule item","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a payment schedule item. You can delete a payment schedule item with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"psi-id","in":"path","schemaId":"schema_5","description":"The unique ID of a payment schedule item.\n","required":true}],"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/payment-schedule-items/{psi-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"psi-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedule-items/{psi-id}","href":"payment-schedules/deletepaymentscheduleitem","openApiOperationId":"deletePaymentScheduleItem","summary":"Delete a payment schedule item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/deletepaymentscheduleitem"}],"panels":[]}]},"httpPath":"/v1/payment-schedule-items/{psi-id}"},{"label":"List payment schedules by customer account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/get_paymentschedules","routeSlug":"/v1-api-reference/api/payment-schedules/get_paymentschedules","metadata":{"seo":{"title":"List payment schedules by customer account","description":"Retrieves payment schedules of a customer account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentSchedules","name":"List payment schedules by customer account","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment schedules by customer account","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 payment schedules of a customer account."},"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":"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 Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"lastProcessedItems","in":"query","schemaId":"schema_50","description":"Number of the most recent processed payment schedules dispalyed in the response body.\n"},{"name":"nextPendingItems","in":"query","schemaId":"schema_50","description":"Number of next pending payment schedule items displayed in the response body.\n"},{"name":"accountId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the customer account. If neither "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, all payment schedules will be returned."},"children":[]}]}]}]},{"name":"accountNumber","in":"query","schemaId":"schema_50","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the customer account. If neither "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, all payment schedules will be returned."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-schedules","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"lastProcessedItems","in":"query","required":false,"schemaId":"schema_50"},{"name":"nextPendingItems","in":"query","required":false,"schemaId":"schema_50"},{"name":"accountId","in":"query","required":false,"schemaId":"schema_5"},{"name":"accountNumber","in":"query","required":false,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedules","href":"payment-schedules/get_paymentschedules","openApiOperationId":"GET_PaymentSchedules","summary":"List payment schedules by customer account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentSchedulesResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentSchedulesResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedules/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentSchedulesResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentSchedulesResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/get_paymentschedules"}],"panels":[]}]},"httpPath":"/v1/payment-schedules"},{"label":"Create a payment schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/post_paymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/post_paymentschedule","metadata":{"seo":{"title":"Create a payment schedule","description":"Creates a payment schedule. You can create either recurring payment schedules or custom payment schedules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_PaymentSchedule","name":"Create a payment schedule","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment schedule","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 schedule. You can create either recurring payment schedules or custom payment schedules."},"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":"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":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can choose to use payment schedules to process payments associated with billing documents or unapplied payments. If Standalone Payment is enabled, you can also use payment schedules to process standalone payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple billing documents are associated to a payment schedule, when collecting the payment schedule item, the payment belongs to the payment schedule item will be applied to billing documents based on the due date of the billing document, in the ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Multi-currency and Standalone Payments features are not enabled, you can create and update a payment schedule and payment schedule item in a currency other than the account currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is version controlled. If you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"329.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when creating custom payment schedules associated with billing documents, you need to specify the billing document for each payment schedule item; If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"330.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later available version, when creating custom payment schedules associated with billing documents, you only need to specify the billing documents at the payment schedule level. The default version number is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"329.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". However, we recommend that you specify the version to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"330.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later version."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentScheduleRequest"}},"schemaId":"components/schemas/POSTPaymentScheduleRequest","pointer":"/paths/~1v1~1payment-schedules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-schedules","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTPaymentScheduleRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedules","href":"payment-schedules/post_paymentschedule","openApiOperationId":"POST_PaymentSchedule","summary":"Create a payment schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTPaymentScheduleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentScheduleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedules/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/post_paymentschedule"}],"panels":[]}]},"httpPath":"/v1/payment-schedules"},{"label":"Create multiple payment schedules at once","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/post_paymentschedules","routeSlug":"/v1-api-reference/api/payment-schedules/post_paymentschedules","metadata":{"seo":{"title":"Create multiple payment schedules at once","description":"Creates multiple payment schedules at once. You can create both recurring payment schedules and custom payment schedules in one request.The maximum number of payment schedules that can be created by a single request is 50.The maximum number of payment schedule items that each payment schedule can contain is 1000, i.e., you must specify less than 1000 items for a custom payment schedule, and the occurrences field must be less than 1000 for a recurring payment schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_PaymentSchedules","name":"Create multiple payment schedules at once","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedules~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create multiple payment schedules at once","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 multiple payment schedules at once. You can create both recurring payment schedules and custom payment schedules in one request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of payment schedules that can be created by a single request is 50."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of payment schedule items that each payment schedule can contain is 1000, i.e., you must specify less than 1000 items for a custom payment schedule, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be less than 1000 for a recurring payment schedule."},"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":"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":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"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":"If multiple billing documents are associated to a payment schedule, when collecting the payment schedule item, the payment belongs to the payment schedule item will be applied to billing documents based on the due date of the billing document, in the ascending order."},"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":"If Standalone Payment is enabled, you can choose to use payment schedules to process payments associated with billing documents, standalone payments, or unapplied payments. If Standalone Payment is not enabled, you can only use payment schedules to process unapplied payments or payments associated with billing documents."},"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":"This operation is version controlled. If you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"329.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when creating custom payment schedules associated with billing documents, you need to specify the billing document for each payment schedule item; If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"330.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when creating custom payment schedules associated with billing documents, you only need to specify the billing documents at the payment schedule level. The default version number is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"329.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". However, we recommend that you specify the version to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"330.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"329.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be deprecated soon."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentSchedulesRequest"}},"schemaId":"components/schemas/POSTPaymentSchedulesRequest","pointer":"/paths/~1v1~1payment-schedules~1batch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-schedules/batch","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTPaymentSchedulesRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedules/batch","href":"payment-schedules/post_paymentschedules","openApiOperationId":"POST_PaymentSchedules","summary":"Create multiple payment schedules at once"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTPaymentSchedulesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPaymentSchedulesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTPaymentSchedulesResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTPaymentSchedulesResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedules~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTPaymentSchedulesResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTPaymentSchedulesResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1batch/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/post_paymentschedules"}],"panels":[]}]},"httpPath":"/v1/payment-schedules/batch"},{"label":"Retrieve payment schedule statistic of a date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/get_paymentschedulestatistic","routeSlug":"/v1-api-reference/api/payment-schedules/get_paymentschedulestatistic","metadata":{"seo":{"title":"Retrieve payment schedule statistic of a date","description":"Retrieves the payment schedule statistic of a specific date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentScheduleStatistic","name":"Retrieve payment schedule statistic of a date","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve payment schedule statistic of a date","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 the payment schedule statistic of a specific date."},"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":"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 Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"yyyy-mm-dd","in":"path","schemaId":"schema_32","description":"Specifies the date of the payment schedule statistic you want to view. \n","required":true}],"pointer":"/paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-schedules/statistics/{yyyy-mm-dd}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"yyyy-mm-dd","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedules/statistics/{yyyy-mm-dd}","href":"payment-schedules/get_paymentschedulestatistic","openApiOperationId":"GET_PaymentScheduleStatistic","summary":"Retrieve payment schedule statistic of a date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleStatisticResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentScheduleStatisticResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentScheduleStatisticResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleStatisticResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/get_paymentschedulestatistic"}],"panels":[]}]},"httpPath":"/v1/payment-schedules/statistics/{yyyy-mm-dd}"},{"label":"Retrieve a payment schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/get_paymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/get_paymentschedule","metadata":{"seo":{"title":"Retrieve a payment schedule","description":"Retrieves a payment schedule by payment schedule key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_PaymentSchedule","name":"Retrieve a payment schedule","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment schedule","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 payment schedule by payment schedule key."},"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":"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 Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentScheduleKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of a payment schedule. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a90857b822459cd018224dcb9eb13be"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS-00000007"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"nextPendingItems","in":"query","schemaId":"schema_50","description":"Number of next pending payment schedule items displayed in the response body.\n"},{"name":"lastProcessedItems","in":"query","schemaId":"schema_50","description":"Number of the most recent processed payment schedule items dispalyed in the response body.\n"}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment-schedules/{paymentScheduleKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentScheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"nextPendingItems","in":"query","required":false,"schemaId":"schema_50"},{"name":"lastProcessedItems","in":"query","required":false,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedules/{paymentScheduleKey}","href":"payment-schedules/get_paymentschedule","openApiOperationId":"GET_PaymentSchedule","summary":"Retrieve a payment schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/get_paymentschedule"}],"panels":[]}]},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}"},{"label":"Update a payment schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_paymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/put_paymentschedule","metadata":{"seo":{"title":"Update a payment schedule","description":"Updates a payment schedule. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the Update a payment schedule item operation to update payment schedule items of custom payment schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PaymentSchedule","name":"Update a payment schedule","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a payment schedule","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 payment schedule. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_PaymentScheduleItem/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a payment schedule item"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to update payment schedule items of custom payment schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following rules for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, all pending payment schedule items will be rescheduled using this new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is changed, we recommend passing in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, the system would use the original start date if there is no processed or canceled items, or the last processed or canceled '"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 1 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"' as the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"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 only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated, the new item will start with the last processed or canceled '"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 1 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Multi-currency and Standalone Payments features are not enabled, you can create and update a payment schedule and payment schedule item in a currency other than the account currency."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentScheduleKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of a payment schedule. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a90857b822459cd018224dcb9eb13be"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS-00000007"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPaymentScheduleRequest"}},"schemaId":"components/schemas/PUTPaymentScheduleRequest","pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-schedules/{paymentScheduleKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentScheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTPaymentScheduleRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedules/{paymentScheduleKey}","href":"payment-schedules/put_paymentschedule","openApiOperationId":"PUT_PaymentSchedule","summary":"Update a payment schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTPaymentScheduleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPaymentScheduleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/put_paymentschedule"}],"panels":[]}]},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}"},{"label":"Delete a payment schedule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/deletepaymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/deletepaymentschedule","metadata":{"seo":{"title":"Delete a payment schedule","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePaymentSchedule","name":"Delete a payment schedule","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a payment schedule","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a payment schedule. You can delete a payment schedule with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentScheduleKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of a payment schedule. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a90857b822459cd018224dcb9eb13be"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS-00000007"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/payment-schedules/{paymentScheduleKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentScheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedules/{paymentScheduleKey}","href":"payment-schedules/deletepaymentschedule","openApiOperationId":"deletePaymentSchedule","summary":"Delete a payment schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/deletepaymentschedule"}],"panels":[]}]},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}"},{"label":"Cancel a payment schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_cancelpaymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/put_cancelpaymentschedule","metadata":{"seo":{"title":"Cancel a payment schedule","description":"Cancels a payment schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CancelPaymentSchedule","name":"Cancel a payment schedule","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a payment schedule","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":"Cancels a payment schedule."},"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":"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":"All pending payment schedule items will be canceled, effective from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelDate"},"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":"The Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information on the payment schedule cancellation use case, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-payment-schedules","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment schedules use cases"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentScheduleKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of a payment schedule. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a90857b822459cd018224dcb9eb13be"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS-00000007"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTCancelPaymentScheduleRequest"}},"schemaId":"components/schemas/PUTCancelPaymentScheduleRequest","pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-schedules/{paymentScheduleKey}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentScheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTCancelPaymentScheduleRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedules/{paymentScheduleKey}/cancel","href":"payment-schedules/put_cancelpaymentschedule","openApiOperationId":"PUT_CancelPaymentSchedule","summary":"Cancel a payment schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTCancelPaymentScheduleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTCancelPaymentScheduleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/put_cancelpaymentschedule"}],"panels":[]}]},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}/cancel"},{"label":"Add payment schedule items to a custom payment schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/post_additemstocustompaymentschedule","routeSlug":"/v1-api-reference/api/payment-schedules/post_additemstocustompaymentschedule","metadata":{"seo":{"title":"Add payment schedule items to a custom payment schedule","description":"Adds payment schedule items to a custom payment schedule. You cannot use this operation to add payment schedule items to recurring payment schedules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_AddItemsToCustomPaymentSchedule","name":"Add payment schedule items to a custom payment schedule","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add payment schedule items to a custom payment schedule","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 payment schedule items to a custom payment schedule. You cannot use this operation to add payment schedule items to recurring payment schedules."},"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":"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 Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Multi-currency and Standalone Payments features are not enabled, you can create and update a payment schedule and payment schedule item in a currency other than the account currency."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentScheduleKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of a payment schedule. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a90857b822459cd018224dcb9eb13be"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS-00000007"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTAddItemsToPaymentScheduleRequest"}},"schemaId":"components/schemas/POSTAddItemsToPaymentScheduleRequest","pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment-schedules/{paymentScheduleKey}/items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentScheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTAddItemsToPaymentScheduleRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedules/{paymentScheduleKey}/items","href":"payment-schedules/post_additemstocustompaymentschedule","openApiOperationId":"POST_AddItemsToCustomPaymentSchedule","summary":"Add payment schedule items to a custom payment schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTAddItemsToPaymentScheduleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTAddItemsToPaymentScheduleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/post_additemstocustompaymentschedule"}],"panels":[]}]},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}/items"},{"label":"Preview the result of payment schedule updates","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-schedules/put_paymentscheduleupdatepreview","routeSlug":"/v1-api-reference/api/payment-schedules/put_paymentscheduleupdatepreview","metadata":{"seo":{"title":"Preview the result of payment schedule updates","description":"Preview the result of a payment schedule update. This operation only provides a preview. No changes will be made to the database. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the Update a payment schedule item operation to update payment schedule items of custom payment schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PaymentScheduleUpdatePreview","name":"Preview the result of payment schedule updates","isWebhook":false,"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview the result of payment schedule updates","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":"Preview the result of a payment schedule update. This operation only provides a preview. No changes will be made to the database. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/PUT_PaymentScheduleItem"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a payment schedule item"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to update payment schedule items of custom payment schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following rules for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, all pending payment schedule items will be rescheduled using this new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is changed, we recommend passing in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, the system would use the original start date if there is no processed or canceled items, or the last processed or canceled '"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 1 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"' as the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"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 only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated, the new item will start with the last processed or canceled '"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 1 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 Payment Schedules feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-manage-payments-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentScheduleKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of a payment schedule. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a90857b822459cd018224dcb9eb13be"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS-00000007"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPreviewPaymentScheduleRequest"}},"schemaId":"components/schemas/PUTPreviewPaymentScheduleRequest","pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-schedules/{paymentScheduleKey}/preview","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"paymentScheduleKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTPreviewPaymentScheduleRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-schedules/{paymentScheduleKey}/preview","href":"payment-schedules/put_paymentscheduleupdatepreview","openApiOperationId":"PUT_PaymentScheduleUpdatePreview","summary":"Preview the result of payment schedule updates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTPreviewPaymentScheduleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPreviewPaymentScheduleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPaymentScheduleResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-schedules/put_paymentscheduleupdatepreview"}],"panels":[]}]},"httpPath":"/v1/payment-schedules/{paymentScheduleKey}/preview"}],"content":{"contentType":"group","meta":{"name":"Payment Schedules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Schedules","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 schedules to split invoice or account balances into several installments and automatically process payments for the installments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about payment schedules, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-payment-schedules","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Schedules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/payment-schedule-items/retry-payment","summary":"Retry failed payment schedule items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-schedules/post_retrypaymentscheduleitem","deprecated":false},{"title":"/v1/payment-schedule-items/{item-id}/cancel","summary":"Cancel a payment schedule item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-schedules/put_cancelpaymentscheduleitem","deprecated":false},{"title":"/v1/payment-schedule-items/{item-id}/skip","summary":"Skip a payment schedule item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-schedules/put_skippaymentscheduleitem","deprecated":false},{"title":"/v1/payment-schedule-items/{psi-id}","summary":"Retrieve a payment schedule item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-schedules/get_paymentscheduleitem","deprecated":false},{"title":"/v1/payment-schedule-items/{psi-id}","summary":"Update a payment schedule item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-schedules/put_paymentscheduleitem","deprecated":false},{"title":"/v1/payment-schedule-items/{psi-id}","summary":"Delete a payment schedule item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-schedules/deletepaymentscheduleitem","deprecated":false},{"title":"/v1/payment-schedules","summary":"List payment schedules by customer account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-schedules/get_paymentschedules","deprecated":false},{"title":"/v1/payment-schedules","summary":"Create a payment schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-schedules/post_paymentschedule","deprecated":false},{"title":"/v1/payment-schedules/batch","summary":"Create multiple payment schedules at once","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-schedules/post_paymentschedules","deprecated":false},{"title":"/v1/payment-schedules/statistics/{yyyy-mm-dd}","summary":"Retrieve payment schedule statistic of a date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-schedules/get_paymentschedulestatistic","deprecated":false},{"title":"/v1/payment-schedules/{paymentScheduleKey}","summary":"Retrieve a payment schedule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-schedules/get_paymentschedule","deprecated":false},{"title":"/v1/payment-schedules/{paymentScheduleKey}","summary":"Update a payment schedule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-schedules/put_paymentschedule","deprecated":false},{"title":"/v1/payment-schedules/{paymentScheduleKey}","summary":"Delete a payment schedule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-schedules/deletepaymentschedule","deprecated":false},{"title":"/v1/payment-schedules/{paymentScheduleKey}/cancel","summary":"Cancel a payment schedule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-schedules/put_cancelpaymentschedule","deprecated":false},{"title":"/v1/payment-schedules/{paymentScheduleKey}/items","summary":"Add payment schedule items to a custom payment schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-schedules/post_additemstocustompaymentschedule","deprecated":false},{"title":"/v1/payment-schedules/{paymentScheduleKey}/preview","summary":"Preview the result of payment schedule updates","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-schedules/put_paymentscheduleupdatepreview","deprecated":false}]}]}]}]}},{"type":"group","label":"Refunds","link":"/v1-api-reference/api/refunds","routeSlug":"/v1-api-reference/api/refunds","items":[{"label":"List refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refunds","routeSlug":"/v1-api-reference/api/refunds/get_refunds","metadata":{"seo":{"title":"List refunds","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Refunds","name":"List refunds","isWebhook":false,"pointer":"/paths/~1v1~1refunds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List refunds","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all refunds. Two types of refunds are available, electronic refunds and external refunds."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"refunds/get_refunds/request/filtering","deepLinkHash":"/refunds/get_refunds#refunds/get_refunds/request/filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body."},"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 a filterable field is string, you can set the corresponding query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when filtering. Then, you can get the response data with this field value being "},"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":"Examples:"},"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":"/v1/refunds?status=Processed"},"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":"/v1/refunds?amount=4&status=Processed"},"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":"/v1/refunds?status=Processed&type=External&sort=+number"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"accountId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"amount","in":"query","schemaId":"schema_74","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"createdDate","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"methodType","in":"query","schemaId":"schema_101","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"methodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"number","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"paymentId","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"refundDate","in":"query","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refundDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_102","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"type","in":"query","schemaId":"schema_99","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedById","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"updatedDate","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter filters the response based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the response data is displayed in descending order by refund number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field. The supported sortable fields of this operation are as below:"},"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":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refundDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdById"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updatedById"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"/v1/refunds?sort=+number"},"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":"/v1/refunds?status=Processed&sort=-number,+amount"},"children":[]}]}]}]}]}]}],"pointer":"/paths/~1v1~1refunds/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1refunds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/refunds","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"accountId","in":"query","required":false,"schemaId":"schema_5"},{"name":"amount","in":"query","required":false,"schemaId":"schema_74"},{"name":"createdById","in":"query","required":false,"schemaId":"schema_5"},{"name":"createdDate","in":"query","required":false,"schemaId":"schema_23"},{"name":"methodType","in":"query","required":false,"schemaId":"schema_101"},{"name":"number","in":"query","required":false,"schemaId":"schema_5"},{"name":"paymentId","in":"query","required":false,"schemaId":"schema_5"},{"name":"refundDate","in":"query","required":false,"schemaId":"schema_32"},{"name":"status","in":"query","required":false,"schemaId":"schema_102"},{"name":"type","in":"query","required":false,"schemaId":"schema_99"},{"name":"updatedById","in":"query","required":false,"schemaId":"schema_5"},{"name":"updatedDate","in":"query","required":false,"schemaId":"schema_23"},{"name":"sort","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/refunds","href":"refunds/get_refunds","openApiOperationId":"GET_Refunds","summary":"List refunds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundCollectionType","exampleIds":["paths/~1v1~1refunds/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRefundCollectionType","exampleIds":["paths/~1v1~1refunds/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1refunds/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRefundCollectionType","exampleIds":["paths/~1v1~1refunds/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundCollectionType","exampleIds":["paths/~1v1~1refunds/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/get_refunds"}],"panels":[]}]},"httpPath":"/v1/refunds"},{"label":"Update a refund","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/put_updaterefund","routeSlug":"/v1-api-reference/api/refunds/put_updaterefund","metadata":{"seo":{"title":"Update a refund","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateRefund","name":"Update a refund","isWebhook":false,"pointer":"/paths/~1v1~1refunds~1{refundKey}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a refund","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the basic and finance information about a refund."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refundKey","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or number of a refund. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4028905f5a87c0ff015a889e590e00c9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"R-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1refunds~1{refundKey}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1refunds~1{refundKey}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTRefundType"}},"schemaId":"components/schemas/PUTRefundType","pointer":"/paths/~1v1~1refunds~1{refundKey}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/refunds/{refundKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"refundKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTRefundType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/refunds/{refundKey}","href":"refunds/put_updaterefund","openApiOperationId":"PUT_UpdateRefund","summary":"Update a refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTRefundType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTRefundType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1refunds~1{refundKey}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/put_updaterefund"}],"panels":[]}]},"httpPath":"/v1/refunds/{refundKey}"},{"label":"Delete a refund","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/delete_refund","routeSlug":"/v1-api-reference/api/refunds/delete_refund","metadata":{"seo":{"title":"Delete a refund","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_Refund","name":"Delete a refund","isWebhook":false,"pointer":"/paths/~1v1~1refunds~1{refundKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a refund","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a refund. You can delete a refund with the Canceled status. Note that refunds applied to credit balance cannot be deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refundKey","in":"path","schemaId":"schema_5","description":"The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9.\n","required":true}],"pointer":"/paths/~1v1~1refunds~1{refundKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1refunds~1{refundKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/refunds/{refundKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"refundKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/refunds/{refundKey}","href":"refunds/delete_refund","openApiOperationId":"DELETE_Refund","summary":"Delete a refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1refunds~1{refundKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/delete_refund"}],"panels":[]}]},"httpPath":"/v1/refunds/{refundKey}"},{"label":"Retrieve a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refund","routeSlug":"/v1-api-reference/api/refunds/get_refund","metadata":{"seo":{"title":"Retrieve a refund","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Refund","name":"Retrieve a refund","isWebhook":false,"pointer":"/paths/~1v1~1refunds~1{refundKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a refund","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about a specific refund."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refundKey","in":"path","schemaId":"schema_5","description":"The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9.\n","required":true}],"pointer":"/paths/~1v1~1refunds~1{refundKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1refunds~1{refundKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/refunds/{refundKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"refundKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/refunds/{refundKey}","href":"refunds/get_refund","openApiOperationId":"GET_Refund","summary":"Retrieve a refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1refunds~1{refundKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/get_refund"}],"panels":[]}]},"httpPath":"/v1/refunds/{refundKey}"},{"label":"Cancel a refund","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/put_cancelrefund","routeSlug":"/v1-api-reference/api/refunds/put_cancelrefund","metadata":{"seo":{"title":"Cancel a refund","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CancelRefund","name":"Cancel a refund","isWebhook":false,"pointer":"/paths/~1v1~1refunds~1{refundKey}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a refund","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Invoice Settlement feature enabled, refunds applied to credit balance cannot be cancelled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refundKey","in":"path","schemaId":"schema_5","description":"The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9.      \n","required":true}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/refunds/{refundKey}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"refundKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/refunds/{refundKey}/cancel","href":"refunds/put_cancelrefund","openApiOperationId":"PUT_CancelRefund","summary":"Cancel a refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/put_cancelrefund"}],"panels":[]}]},"httpPath":"/v1/refunds/{refundKey}/cancel"},{"label":"List all parts of a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refundparts","routeSlug":"/v1-api-reference/api/refunds/get_refundparts","metadata":{"seo":{"title":"List all parts of a refund","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RefundParts","name":"List all parts of a refund","isWebhook":false,"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all parts of a refund","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all parts of a refund."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refundKey","in":"path","schemaId":"schema_5","description":"The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.\n","required":true}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/refunds/{refundKey}/parts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"refundKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/refunds/{refundKey}/parts","href":"refunds/get_refundparts","openApiOperationId":"GET_RefundParts","summary":"List all parts of a refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundPartCollectionType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRefundPartCollectionType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRefundPartCollectionType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundPartCollectionType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/get_refundparts"}],"panels":[]}]},"httpPath":"/v1/refunds/{refundKey}/parts"},{"label":"Retrieve a refund part","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refundpart","routeSlug":"/v1-api-reference/api/refunds/get_refundpart","metadata":{"seo":{"title":"Retrieve a refund part","description":"Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RefundPart","name":"Retrieve a refund part","isWebhook":false,"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a refund part","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":"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 is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about a specific refund part."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refundpartid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a specific refund part. You can get the refund part ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_RefundParts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all parts of a refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"refundKey","in":"path","schemaId":"schema_5","description":"The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.\n","required":true}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/refunds/{refundKey}/parts/{refundpartid}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"refundpartid","in":"path","required":true,"schemaId":"schema_5"},{"name":"refundKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/refunds/{refundKey}/parts/{refundpartid}","href":"refunds/get_refundpart","openApiOperationId":"GET_RefundPart","summary":"Retrieve a refund part"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundPartResponseType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RefundPartResponseType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundPartResponseType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundPartResponseType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/get_refundpart"}],"panels":[]}]},"httpPath":"/v1/refunds/{refundKey}/parts/{refundpartid}"},{"label":"List all refund part items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refunditemparts","routeSlug":"/v1-api-reference/api/refunds/get_refunditemparts","metadata":{"seo":{"title":"List all refund part items","description":"Note: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RefundItemParts","name":"List all refund part items","isWebhook":false,"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all refund part items","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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about all items of a refund part. A refund part item is a single line item in a refund part. A refund part can consist of several different types of items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"refundpartid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a specific refund part. You can get the refund part ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_RefundParts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all parts of a refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"refundKey","in":"path","schemaId":"schema_5","description":"The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.\n","required":true}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/refunds/{refundKey}/parts/{refundpartid}/item-parts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"refundpartid","in":"path","required":true,"schemaId":"schema_5"},{"name":"refundKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/refunds/{refundKey}/parts/{refundpartid}/item-parts","href":"refunds/get_refunditemparts","openApiOperationId":"GET_RefundItemParts","summary":"List all refund part items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundItemPartCollectionType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRefundItemPartCollectionType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRefundItemPartCollectionType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundItemPartCollectionType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/get_refunditemparts"}],"panels":[]}]},"httpPath":"/v1/refunds/{refundKey}/parts/{refundpartid}/item-parts"},{"label":"Retrieve a refund part item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/refunds/get_refunditempart","routeSlug":"/v1-api-reference/api/refunds/get_refunditempart","metadata":{"seo":{"title":"Retrieve a refund part item","description":"Note: This operation is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RefundItemPart","name":"Retrieve a refund part item","isWebhook":false,"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a refund part item","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":"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 is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the information about a specific refund part item. A refund part item is a single line item in a refund part. A refund part can consist of several different types of items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itempartid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a specific refund part item. You can get the refund part item ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_RefundItemParts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get refund part items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"refundpartid","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of a specific refund part. You can get the refund part ID from the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_RefundParts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all parts of a refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"refundKey","in":"path","schemaId":"schema_5","description":"The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.\n","required":true}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/refunds/{refundKey}/parts/{refundpartid}/item-parts/{itempartid}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"itempartid","in":"path","required":true,"schemaId":"schema_5"},{"name":"refundpartid","in":"path","required":true,"schemaId":"schema_5"},{"name":"refundKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/refunds/{refundKey}/parts/{refundpartid}/item-parts/{itempartid}","href":"refunds/get_refunditempart","openApiOperationId":"GET_RefundItemPart","summary":"Retrieve a refund part item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundItemPartType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETRefundItemPartType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETRefundItemPartType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETRefundItemPartType","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/get_refunditempart"}],"panels":[]}]},"httpPath":"/v1/refunds/{refundKey}/parts/{refundpartid}/item-parts/{itempartid}"}],"content":{"contentType":"group","meta":{"name":"Refunds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refunds","showPageActions":true},{"nodeType":"markdoc","content":"Zuora allows you to issue and track refunds on payments. Similar to external payments, users can enter external refunds to track refunds that have been performed outside of Zuora Payments (for example, by issuing a check). \nIn addition, you can make electronic refunds using our supported payment gateways, which will automatically refund money to the customer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/refunds","summary":"List refunds","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/get_refunds","deprecated":false},{"title":"/v1/refunds/{refundKey}","summary":"Update a refund","prefix":{"name":"put","color":"put"},"badges":[],"link":"/refunds/put_updaterefund","deprecated":false},{"title":"/v1/refunds/{refundKey}","summary":"Delete a refund","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/refunds/delete_refund","deprecated":false},{"title":"/v1/refunds/{refundKey}","summary":"Retrieve a refund","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/get_refund","deprecated":false},{"title":"/v1/refunds/{refundKey}/cancel","summary":"Cancel a refund","prefix":{"name":"put","color":"put"},"badges":[],"link":"/refunds/put_cancelrefund","deprecated":false},{"title":"/v1/refunds/{refundKey}/parts","summary":"List all parts of a refund","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/get_refundparts","deprecated":false},{"title":"/v1/refunds/{refundKey}/parts/{refundpartid}","summary":"Retrieve a refund part","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/get_refundpart","deprecated":false},{"title":"/v1/refunds/{refundKey}/parts/{refundpartid}/item-parts","summary":"List all refund part items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/get_refunditemparts","deprecated":false},{"title":"/v1/refunds/{refundKey}/parts/{refundpartid}/item-parts/{itempartid}","summary":"Retrieve a refund part item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/get_refunditempart","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Profiles","link":"/v1-api-reference/api/payment-profiles","routeSlug":"/v1-api-reference/api/payment-profiles","items":[{"label":"Create or update payment profiles in bulk","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/payment-profiles/upsertpaymentprofiles","routeSlug":"/v1-api-reference/api/payment-profiles/upsertpaymentprofiles","metadata":{"seo":{"title":"Create or update payment profiles in bulk","description":"Bulk creates payment profiles or updates payment profiles if they already exist."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpsertPaymentProfiles","name":"Create or update payment profiles in bulk","isWebhook":false,"pointer":"/paths/~1v1~1payment-profile/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update payment profiles in bulk","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Bulk creates payment profiles or updates payment profiles if they already exist. \n\nYou can create or update a maximum of 50 payment profiles in a single call.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1payment-profile/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_103"}},"schemaId":"schema_103","pointer":"/paths/~1v1~1payment-profile/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment-profile","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_103"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/payment-profile","href":"payment-profiles/upsertpaymentprofiles","openApiOperationId":"UpsertPaymentProfiles","summary":"Create or update payment profiles in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_103","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_103"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}},"schemaId":"schema_104","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-profile/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-profile/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-profile/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-profile/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1payment-profile/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_104","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-profile/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1payment-profile/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-profile/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1payment-profile/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-profiles/upsertpaymentprofiles"}],"panels":[]}]},"httpPath":"/v1/payment-profile"}],"content":{"contentType":"group","meta":{"name":"Payment Profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Profiles","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":"Payment profiles enable payment flexibility for subscribers by allowing payment methods to be associated with specific subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To learn more about the configuration and usage of Payment Profiles, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-payment-profiles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Profiles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/payment-profile","summary":"Create or update payment profiles in bulk","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-profiles/upsertpaymentprofiles","deprecated":false}]}]}]}]}},{"type":"group","label":"Configurable Payment Retry","link":"/v1-api-reference/api/configurable-payment-retry","routeSlug":"/v1-api-reference/api/configurable-payment-retry","items":[{"label":"List the active retry cycles for an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getactiveinvoicecycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getactiveinvoicecycle","metadata":{"seo":{"title":"List the active retry cycles for an invoice","description":"Gets information of active retry cycles that have not been completed for an invoice in Configurable Payment Retry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActiveInvoiceCycle","name":"List the active retry cycles for an invoice","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1active_invoice_cycle_information~1{invoice_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the active retry cycles for an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets information of active retry cycles that have not been completed for an invoice in Configurable Payment Retry.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoice_id","in":"path","schemaId":"schema_5","description":"ID of an invoice.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1active_invoice_cycle_information~1{invoice_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/payments/active_invoice_cycle_information/{invoice_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"invoice_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/active_invoice_cycle_information/{invoice_id}","href":"configurable-payment-retry/getactiveinvoicecycle","openApiOperationId":"getActiveInvoiceCycle","summary":"List the active retry cycles for an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETActiveInvoiceCycleResponse"}},"schemaId":"components/schemas/GETActiveInvoiceCycleResponse"}],"pointer":"/paths/~1api~1v1~1payments~1active_invoice_cycle_information~1{invoice_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETActiveInvoiceCycleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETActiveInvoiceCycleResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/getactiveinvoicecycle"}],"panels":[]}]},"httpPath":"/api/v1/payments/active_invoice_cycle_information/{invoice_id}"},{"label":"List the active retry cycles for a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getactivedebitmemocycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getactivedebitmemocycle","metadata":{"seo":{"title":"List the active retry cycles for a debit memo","description":"Gets information of active retry cycles that have not been completed for a debit memo in Configurable Payment Retry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActiveDebitMemoCycle","name":"List the active retry cycles for a debit memo","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1active_debit_memo_cycle_information~1{debit_memo_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the active retry cycles for a debit memo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets information of active retry cycles that have not been completed for a debit memo in Configurable Payment Retry.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debit_memo_id","in":"path","schemaId":"schema_5","description":"ID of a debit memo.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1active_debit_memo_cycle_information~1{debit_memo_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/payments/active_debit_memo_cycle_information/{debit_memo_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"debit_memo_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/active_debit_memo_cycle_information/{debit_memo_id}","href":"configurable-payment-retry/getactivedebitmemocycle","openApiOperationId":"getActiveDebitMemoCycle","summary":"List the active retry cycles for a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETActiveDebitMemoCycleResponse"}},"schemaId":"components/schemas/GETActiveDebitMemoCycleResponse"}],"pointer":"/paths/~1api~1v1~1payments~1active_debit_memo_cycle_information~1{debit_memo_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETActiveDebitMemoCycleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETActiveDebitMemoCycleResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/getactivedebitmemocycle"}],"panels":[]}]},"httpPath":"/api/v1/payments/active_debit_memo_cycle_information/{debit_memo_id}"},{"label":"List the active retry cycles for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getactiveaccountcycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getactiveaccountcycle","metadata":{"seo":{"title":"List the active retry cycles for an account","description":"Gets information of active retry cycles that have not been completed for an account in Configurable Payment Retry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActiveAccountCycle","name":"List the active retry cycles for an account","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1active_account_cycle_information~1{account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the active retry cycles for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets information of active retry cycles that have not been completed for an account in Configurable Payment Retry.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_5","description":"ID of an account.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1active_account_cycle_information~1{account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/payments/active_account_cycle_information/{account_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/active_account_cycle_information/{account_id}","href":"configurable-payment-retry/getactiveaccountcycle","openApiOperationId":"getActiveAccountCycle","summary":"List the active retry cycles for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETActiveAccountCycleResponse"}},"schemaId":"components/schemas/GETActiveAccountCycleResponse"}],"pointer":"/paths/~1api~1v1~1payments~1active_account_cycle_information~1{account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETActiveAccountCycleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETActiveAccountCycleResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/getactiveaccountcycle"}],"panels":[]}]},"httpPath":"/api/v1/payments/active_account_cycle_information/{account_id}"},{"label":"List the retry cycle history for an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getinvoicecyclehistory","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getinvoicecyclehistory","metadata":{"seo":{"title":"List the retry cycle history for an invoice","description":"Gets information of all retry cycles for an invoice in Configurable Payment Retry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInvoiceCycleHistory","name":"List the retry cycle history for an invoice","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1invoice_cycle_history~1{invoice_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the retry cycle history for an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets information of all retry cycles for an invoice in Configurable Payment Retry.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoice_id","in":"path","schemaId":"schema_5","description":"ID of an invoice.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1invoice_cycle_history~1{invoice_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/payments/invoice_cycle_history/{invoice_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"invoice_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/invoice_cycle_history/{invoice_id}","href":"configurable-payment-retry/getinvoicecyclehistory","openApiOperationId":"getInvoiceCycleHistory","summary":"List the retry cycle history for an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETInvoiceCycleHistoryResponse"}},"schemaId":"components/schemas/GETInvoiceCycleHistoryResponse"}],"pointer":"/paths/~1api~1v1~1payments~1invoice_cycle_history~1{invoice_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETInvoiceCycleHistoryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETInvoiceCycleHistoryResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/getinvoicecyclehistory"}],"panels":[]}]},"httpPath":"/api/v1/payments/invoice_cycle_history/{invoice_id}"},{"label":"List the retry cycle history for a debit memo.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getdebitmemocyclehistory","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getdebitmemocyclehistory","metadata":{"seo":{"title":"List the retry cycle history for a debit memo.","description":"Gets information of all retry cycles for a debit memo in Configurable Payment Retry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDebitMemoCycleHistory","name":"List the retry cycle history for a debit memo.","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1debit_memo_cycle_history~1{debit_memo_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the retry cycle history for a debit memo.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets information of all retry cycles for a debit memo in Configurable Payment Retry.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debit_memo_id","in":"path","schemaId":"schema_5","description":"ID of a debit memo.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1debit_memo_cycle_history~1{debit_memo_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/payments/debit_memo_cycle_history/{debit_memo_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"debit_memo_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/debit_memo_cycle_history/{debit_memo_id}","href":"configurable-payment-retry/getdebitmemocyclehistory","openApiOperationId":"getDebitMemoCycleHistory","summary":"List the retry cycle history for a debit memo."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoCycleHistoryResponse"}},"schemaId":"components/schemas/GETDebitMemoCycleHistoryResponse"}],"pointer":"/paths/~1api~1v1~1payments~1debit_memo_cycle_history~1{debit_memo_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDebitMemoCycleHistoryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDebitMemoCycleHistoryResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/getdebitmemocyclehistory"}],"panels":[]}]},"httpPath":"/api/v1/payments/debit_memo_cycle_history/{debit_memo_id}"},{"label":"List the retry cycle history for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getaccountcyclehistory","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getaccountcyclehistory","metadata":{"seo":{"title":"List the retry cycle history for an account","description":"Gets information of all retry cycles for an account in Configurable Payment Retry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountCycleHistory","name":"List the retry cycle history for an account","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1account_cycle_history~1{account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the retry cycle history for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets information of all retry cycles for an account in Configurable Payment Retry.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_5","description":"ID of an account.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1account_cycle_history~1{account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/payments/account_cycle_history/{account_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/account_cycle_history/{account_id}","href":"configurable-payment-retry/getaccountcyclehistory","openApiOperationId":"getAccountCycleHistory","summary":"List the retry cycle history for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountCycleHistoryResponse"}},"schemaId":"components/schemas/GETAccountCycleHistoryResponse"}],"pointer":"/paths/~1api~1v1~1payments~1account_cycle_history~1{account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAccountCycleHistoryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountCycleHistoryResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/getaccountcyclehistory"}],"panels":[]}]},"httpPath":"/api/v1/payments/account_cycle_history/{account_id}"},{"label":"Execute the invoice payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putexecuteinvoicepayment","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putexecuteinvoicepayment","metadata":{"seo":{"title":"Execute the invoice payment","description":"For all active retry cycles associated with an invoice, schedules the next payment retry attempt to occur in the next hourly payment processor run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putExecuteInvoicePayment","name":"Execute the invoice payment","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1execute_invoice_payment~1{invoice_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute the invoice payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"For all active retry cycles associated with an invoice, schedules the next payment retry attempt to occur in the next hourly payment processor run.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoice_id","in":"path","schemaId":"schema_5","description":"ID of an invoice.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1execute_invoice_payment~1{invoice_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/payments/execute_invoice_payment/{invoice_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"invoice_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/execute_invoice_payment/{invoice_id}","href":"configurable-payment-retry/putexecuteinvoicepayment","openApiOperationId":"putExecuteInvoicePayment","summary":"Execute the invoice payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_105"}},"schemaId":"schema_105"}],"pointer":"/paths/~1api~1v1~1payments~1execute_invoice_payment~1{invoice_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_105","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_105"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/putexecuteinvoicepayment"}],"panels":[]}]},"httpPath":"/api/v1/payments/execute_invoice_payment/{invoice_id}"},{"label":"Execute the debit memo payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putexecutedebitmemopayment","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putexecutedebitmemopayment","metadata":{"seo":{"title":"Execute the debit memo payment","description":"For all active retry cycles associated with a debit memo, schedules the next payment retry attempt to occur in the next hourly payment processor run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putExecuteDebitMemoPayment","name":"Execute the debit memo payment","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1execute_debit_memo_payment~1{debit_memo_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute the debit memo payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"For all active retry cycles associated with a debit memo, schedules the next payment retry attempt to occur in the next hourly payment processor run.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debit_memo_id","in":"path","schemaId":"schema_5","description":"ID of a debit memo.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1execute_debit_memo_payment~1{debit_memo_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/payments/execute_debit_memo_payment/{debit_memo_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"debit_memo_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/execute_debit_memo_payment/{debit_memo_id}","href":"configurable-payment-retry/putexecutedebitmemopayment","openApiOperationId":"putExecuteDebitMemoPayment","summary":"Execute the debit memo payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"}],"pointer":"/paths/~1api~1v1~1payments~1execute_debit_memo_payment~1{debit_memo_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/putexecutedebitmemopayment"}],"panels":[]}]},"httpPath":"/api/v1/payments/execute_debit_memo_payment/{debit_memo_id}"},{"label":"Execute the account payments","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putexecuteaccountpayments","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putexecuteaccountpayments","metadata":{"seo":{"title":"Execute the account payments","description":"For all active retry cycles associated with an account, schedules the next payment retry attempt to occur in the next hourly payment processor run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putExecuteAccountPayments","name":"Execute the account payments","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1execute_account_payments~1{account_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute the account payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"For all active retry cycles associated with an account, schedules the next payment retry attempt to occur in the next hourly payment processor run.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_5","description":"ID of an account.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1execute_account_payments~1{account_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/payments/execute_account_payments/{account_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/execute_account_payments/{account_id}","href":"configurable-payment-retry/putexecuteaccountpayments","openApiOperationId":"putExecuteAccountPayments","summary":"Execute the account payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107"}],"pointer":"/paths/~1api~1v1~1payments~1execute_account_payments~1{account_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_107","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_107"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/putexecuteaccountpayments"}],"panels":[]}]},"httpPath":"/api/v1/payments/execute_account_payments/{account_id}"},{"label":"Execute payments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/postexecutepayments","routeSlug":"/v1-api-reference/api/configurable-payment-retry/postexecutepayments","metadata":{"seo":{"title":"Execute payments","description":"For all active retry cycles associated with the invoice, debit memo, and/or account IDs provided, schedules the next payment retry attempt to occur in the next hourly payment processor run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postExecutePayments","name":"Execute payments","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1execute_payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"For all active retry cycles associated with the invoice, debit memo, and/or account IDs provided, schedules the next payment retry attempt to occur in the next hourly payment processor run.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_108"}},"schemaId":"schema_108","pointer":"/paths/~1api~1v1~1payments~1execute_payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/payments/execute_payments","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_108"}},"responseCodes":["200"],"pointer":"/api/v1/payments/execute_payments","href":"configurable-payment-retry/postexecutepayments","openApiOperationId":"postExecutePayments","summary":"Execute payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"schemaId":"schema_108","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_108"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_109"}},"schemaId":"schema_109"}],"pointer":"/paths/~1api~1v1~1payments~1execute_payments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_109","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_109"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/postexecutepayments"}],"panels":[]}]},"httpPath":"/api/v1/payments/execute_payments"},{"label":"Remove an invoice from retry cycle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putremoveinovicefromcycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putremoveinovicefromcycle","metadata":{"seo":{"title":"Remove an invoice from retry cycle","description":"Stops any active retry cycles associated with the invoice provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putRemoveInoviceFromCycle","name":"Remove an invoice from retry cycle","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1remove_invoice_from_retry_cycle~1{invoice_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an invoice from retry cycle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Stops any active retry cycles associated with the invoice provided.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"invoice_id","in":"path","schemaId":"schema_5","description":"ID of an invoice.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1remove_invoice_from_retry_cycle~1{invoice_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/payments/remove_invoice_from_retry_cycle/{invoice_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"invoice_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/remove_invoice_from_retry_cycle/{invoice_id}","href":"configurable-payment-retry/putremoveinovicefromcycle","openApiOperationId":"putRemoveInoviceFromCycle","summary":"Remove an invoice from retry cycle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_110"}},"schemaId":"schema_110"}],"pointer":"/paths/~1api~1v1~1payments~1remove_invoice_from_retry_cycle~1{invoice_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_110","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_110"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/putremoveinovicefromcycle"}],"panels":[]}]},"httpPath":"/api/v1/payments/remove_invoice_from_retry_cycle/{invoice_id}"},{"label":"Remove a debit memo from retry cycle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putremovedebitmemofromcycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putremovedebitmemofromcycle","metadata":{"seo":{"title":"Remove a debit memo from retry cycle","description":"Stops any active retry cycles associated with the debit memo provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putRemoveDebitMemoFromCycle","name":"Remove a debit memo from retry cycle","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1remove_debit_memo_from_retry_cycle~1{debit_memo_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a debit memo from retry cycle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Stops any active retry cycles associated with the debit memo provided.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"debit_memo_id","in":"path","schemaId":"schema_5","description":"ID of a debit memo.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1remove_debit_memo_from_retry_cycle~1{debit_memo_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/payments/remove_debit_memo_from_retry_cycle/{debit_memo_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"debit_memo_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/remove_debit_memo_from_retry_cycle/{debit_memo_id}","href":"configurable-payment-retry/putremovedebitmemofromcycle","openApiOperationId":"putRemoveDebitMemoFromCycle","summary":"Remove a debit memo from retry cycle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}},"schemaId":"schema_111"}],"pointer":"/paths/~1api~1v1~1payments~1remove_debit_memo_from_retry_cycle~1{debit_memo_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_111","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/putremovedebitmemofromcycle"}],"panels":[]}]},"httpPath":"/api/v1/payments/remove_debit_memo_from_retry_cycle/{debit_memo_id}"},{"label":"Remove an account from retry cycle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/putremoveaccountfromcycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/putremoveaccountfromcycle","metadata":{"seo":{"title":"Remove an account from retry cycle","description":"Stops any active retry cycles associated with the account provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putRemoveAccountFromCycle","name":"Remove an account from retry cycle","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1remove_account_from_retry_cycle~1{account_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an account from retry cycle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Stops any active retry cycles associated with the account provided.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_5","description":"ID of an account.","required":true}],"pointer":"/paths/~1api~1v1~1payments~1remove_account_from_retry_cycle~1{account_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/payments/remove_account_from_retry_cycle/{account_id}","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/payments/remove_account_from_retry_cycle/{account_id}","href":"configurable-payment-retry/putremoveaccountfromcycle","openApiOperationId":"putRemoveAccountFromCycle","summary":"Remove an account from retry cycle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112"}},"schemaId":"schema_112"}],"pointer":"/paths/~1api~1v1~1payments~1remove_account_from_retry_cycle~1{account_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_112","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/putremoveaccountfromcycle"}],"panels":[]}]},"httpPath":"/api/v1/payments/remove_account_from_retry_cycle/{account_id}"},{"label":"Submit a payment to retry cycle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/postsubmitpaymenttocycle","routeSlug":"/v1-api-reference/api/configurable-payment-retry/postsubmitpaymenttocycle","metadata":{"seo":{"title":"Submit a payment to retry cycle","description":"This API request submits a failed payment to the Configurable Payment Retry retry cycle. The request adds the failed payment to the existing CPR retry cycle. If no CPR retry cycle exists, this request creates a new one and adds the failed payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSubmitPaymentToCycle","name":"Submit a payment to retry cycle","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1submit_failed_payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a payment to retry cycle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API request submits a failed payment to the Configurable Payment Retry retry cycle. The request adds the failed payment to the existing CPR retry cycle. If no CPR retry cycle exists, this request creates a new one and adds the failed payment.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113","pointer":"/paths/~1api~1v1~1payments~1submit_failed_payment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/payments/submit_failed_payment","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_113"}},"responseCodes":["200"],"pointer":"/api/v1/payments/submit_failed_payment","href":"configurable-payment-retry/postsubmitpaymenttocycle","openApiOperationId":"postSubmitPaymentToCycle","summary":"Submit a payment to retry cycle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114"}},"schemaId":"schema_114"}],"pointer":"/paths/~1api~1v1~1payments~1submit_failed_payment/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_114","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/postsubmitpaymenttocycle"}],"panels":[]}]},"httpPath":"/api/v1/payments/submit_failed_payment"},{"label":"List the baseline metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getbaselinemetrics","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getbaselinemetrics","metadata":{"seo":{"title":"List the baseline metrics","description":"Gets baseline metrics for Configurable Payment Retry, including Retry Success Rate and trend, Document Success Rate and trend, and Average Days Outstanding and trend. See Response Schema for detailed descriptions of the metrics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBaselineMetrics","name":"List the baseline metrics","isWebhook":false,"pointer":"/paths/~1api~1v1~1metrics~1baseline/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the baseline metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets baseline metrics for Configurable Payment Retry, including Retry Success Rate and trend, Document Success Rate and trend, and Average Days Outstanding and trend. See Response Schema for detailed descriptions of the metrics.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/metrics/baseline","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/metrics/baseline","href":"configurable-payment-retry/getbaselinemetrics","openApiOperationId":"getBaselineMetrics","summary":"List the baseline metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETBaselineMetricsResponse"}},"schemaId":"components/schemas/GETBaselineMetricsResponse"}],"pointer":"/paths/~1api~1v1~1metrics~1baseline/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETBaselineMetricsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETBaselineMetricsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/getbaselinemetrics"}],"panels":[]}]},"httpPath":"/api/v1/metrics/baseline"},{"label":"List the amount recovered metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getamountrecovered","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getamountrecovered","metadata":{"seo":{"title":"List the amount recovered metrics","description":"Gets the Amount Recovered metrics, including the total amount recovered and the amount recovered over the last 30 days broken down by currency."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAmountRecovered","name":"List the amount recovered metrics","isWebhook":false,"pointer":"/paths/~1api~1v1~1metrics~1amount_recovered/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the amount recovered metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the Amount Recovered metrics, including the total amount recovered and the amount recovered over the last 30 days broken down by currency.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/metrics/amount_recovered","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/metrics/amount_recovered","href":"configurable-payment-retry/getamountrecovered","openApiOperationId":"getAmountRecovered","summary":"List the amount recovered metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAmountRecoveredResponse"}},"schemaId":"components/schemas/GETAmountRecoveredResponse"}],"pointer":"/paths/~1api~1v1~1metrics~1amount_recovered/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAmountRecoveredResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAmountRecoveredResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/getamountrecovered"}],"panels":[]}]},"httpPath":"/api/v1/metrics/amount_recovered"},{"label":"List the document success rate metrics by customer group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getdocumentsuccessratebycustomergroup","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getdocumentsuccessratebycustomergroup","metadata":{"seo":{"title":"List the document success rate metrics by customer group","description":"Gets the Document Success Rate timeseries for each customer group over the past 6 months. The data of the current month will not be included. For example, if it is April 15th today, the data for April will not be included. Data for March and earlier will be shown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDocumentSuccessRateByCustomerGroup","name":"List the document success rate metrics by customer group","isWebhook":false,"pointer":"/paths/~1api~1v1~1metrics~1customer_group_over_time/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the document success rate metrics by customer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the Document Success Rate timeseries for each customer group over the past 6 months. The data of the current month will not be included. For example, if it is April 15th today, the data for April will not be included. Data for March and earlier will be shown.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/metrics/customer_group_over_time","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/metrics/customer_group_over_time","href":"configurable-payment-retry/getdocumentsuccessratebycustomergroup","openApiOperationId":"getDocumentSuccessRateByCustomerGroup","summary":"List the document success rate metrics by customer group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDocumentSuccessRateByCustomerGroupResponse"}},"schemaId":"components/schemas/GETDocumentSuccessRateByCustomerGroupResponse"}],"pointer":"/paths/~1api~1v1~1metrics~1customer_group_over_time/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETDocumentSuccessRateByCustomerGroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETDocumentSuccessRateByCustomerGroupResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/getdocumentsuccessratebycustomergroup"}],"panels":[]}]},"httpPath":"/api/v1/metrics/customer_group_over_time"},{"label":"List the customer group metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configurable-payment-retry/getcustomergroupmetrics","routeSlug":"/v1-api-reference/api/configurable-payment-retry/getcustomergroupmetrics","metadata":{"seo":{"title":"List the customer group metrics","description":"Gets the following metrics for each customer group that is in the active status:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomerGroupMetrics","name":"List the customer group metrics","isWebhook":false,"pointer":"/paths/~1api~1v1~1metrics~1customer_group/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the customer group metrics","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":"Gets the following metrics for each customer group that is in the active status:"},"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":"Document Success Rate and trend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry Success Rate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Average Attempts"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/metrics/customer_group","servers":[{"url":"https://payment-retry.apps.zuora.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/metrics/customer_group","href":"configurable-payment-retry/getcustomergroupmetrics","openApiOperationId":"getCustomerGroupMetrics","summary":"List the customer group metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://payment-retry.apps.zuora.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCustomerGroupMetricsResponse"}},"schemaId":"components/schemas/GETCustomerGroupMetricsResponse"}],"pointer":"/paths/~1api~1v1~1metrics~1customer_group/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCustomerGroupMetricsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCustomerGroupMetricsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configurable-payment-retry/getcustomergroupmetrics"}],"panels":[]}]},"httpPath":"/api/v1/metrics/customer_group"}],"content":{"contentType":"group","meta":{"name":"Configurable Payment Retry"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configurable Payment Retry","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":"Configurable Payment Retry APIs use basic authentication. The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click the drop-down arrow at the end of an endpoint to display the full endpoint. To learn more about the configuration and usage of Configurable Payment Retry, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-configurable-payment-retry"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configurable Payment Retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/payments/active_invoice_cycle_information/{invoice_id}","summary":"List the active retry cycles for an invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configurable-payment-retry/getactiveinvoicecycle","deprecated":false},{"title":"/api/v1/payments/active_debit_memo_cycle_information/{debit_memo_id}","summary":"List the active retry cycles for a debit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configurable-payment-retry/getactivedebitmemocycle","deprecated":false},{"title":"/api/v1/payments/active_account_cycle_information/{account_id}","summary":"List the active retry cycles for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configurable-payment-retry/getactiveaccountcycle","deprecated":false},{"title":"/api/v1/payments/invoice_cycle_history/{invoice_id}","summary":"List the retry cycle history for an invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configurable-payment-retry/getinvoicecyclehistory","deprecated":false},{"title":"/api/v1/payments/debit_memo_cycle_history/{debit_memo_id}","summary":"List the retry cycle history for a debit memo.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configurable-payment-retry/getdebitmemocyclehistory","deprecated":false},{"title":"/api/v1/payments/account_cycle_history/{account_id}","summary":"List the retry cycle history for an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configurable-payment-retry/getaccountcyclehistory","deprecated":false},{"title":"/api/v1/payments/execute_invoice_payment/{invoice_id}","summary":"Execute the invoice payment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/configurable-payment-retry/putexecuteinvoicepayment","deprecated":false},{"title":"/api/v1/payments/execute_debit_memo_payment/{debit_memo_id}","summary":"Execute the debit memo payment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/configurable-payment-retry/putexecutedebitmemopayment","deprecated":false},{"title":"/api/v1/payments/execute_account_payments/{account_id}","summary":"Execute the account payments","prefix":{"name":"put","color":"put"},"badges":[],"link":"/configurable-payment-retry/putexecuteaccountpayments","deprecated":false},{"title":"/api/v1/payments/execute_payments","summary":"Execute payments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/configurable-payment-retry/postexecutepayments","deprecated":false},{"title":"/api/v1/payments/remove_invoice_from_retry_cycle/{invoice_id}","summary":"Remove an invoice from retry cycle","prefix":{"name":"put","color":"put"},"badges":[],"link":"/configurable-payment-retry/putremoveinovicefromcycle","deprecated":false},{"title":"/api/v1/payments/remove_debit_memo_from_retry_cycle/{debit_memo_id}","summary":"Remove a debit memo from retry cycle","prefix":{"name":"put","color":"put"},"badges":[],"link":"/configurable-payment-retry/putremovedebitmemofromcycle","deprecated":false},{"title":"/api/v1/payments/remove_account_from_retry_cycle/{account_id}","summary":"Remove an account from retry cycle","prefix":{"name":"put","color":"put"},"badges":[],"link":"/configurable-payment-retry/putremoveaccountfromcycle","deprecated":false},{"title":"/api/v1/payments/submit_failed_payment","summary":"Submit a payment to retry cycle","prefix":{"name":"post","color":"post"},"badges":[],"link":"/configurable-payment-retry/postsubmitpaymenttocycle","deprecated":false},{"title":"/api/v1/metrics/baseline","summary":"List the baseline metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configurable-payment-retry/getbaselinemetrics","deprecated":false},{"title":"/api/v1/metrics/amount_recovered","summary":"List the amount recovered metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configurable-payment-retry/getamountrecovered","deprecated":false},{"title":"/api/v1/metrics/customer_group_over_time","summary":"List the document success rate metrics by customer group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configurable-payment-retry/getdocumentsuccessratebycustomergroup","deprecated":false},{"title":"/api/v1/metrics/customer_group","summary":"List the customer group metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configurable-payment-retry/getcustomergroupmetrics","deprecated":false}]}]}]}]}},{"type":"separator","label":"Object Query","content":null},{"type":"group","label":"Object Queries","link":"/v1-api-reference/api/object-queries","routeSlug":"/v1-api-reference/api/object-queries","items":[{"label":"List accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryaccounts","routeSlug":"/v1-api-reference/api/object-queries/queryaccounts","metadata":{"seo":{"title":"List accounts","description":"Lists accounts. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryAccounts","name":"List accounts","isWebhook":false,"pointer":"/paths/~1object-query~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists accounts. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"batch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billcycleday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billtoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"communicationprofileid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"crmid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defaultpaymentmethodid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicetemplateid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lastinvoicedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shiptoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"soldtoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_116","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"batch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billcycleday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billtoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"communicationprofileid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"crmid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defaultpaymentmethodid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicetemplateid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lastinvoicedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shiptoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"soldtoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/accounts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_116"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/accounts","href":"object-queries/queryaccounts","openApiOperationId":"queryAccounts","summary":"List accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117","exampleIds":["paths/~1object-query~1accounts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_117","exampleIds":["paths/~1object-query~1accounts/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_117","exampleIds":["paths/~1object-query~1accounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117","exampleIds":["paths/~1object-query~1accounts/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryaccounts"}],"panels":[]}]},"httpPath":"/object-query/accounts"},{"label":"Retrieve an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryaccountbykey","routeSlug":"/v1-api-reference/api/object-queries/queryaccountbykey","metadata":{"seo":{"title":"Retrieve an account","description":"Retrieve the details of a specific Account object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryAccountByKey","name":"Retrieve an account","isWebhook":false,"pointer":"/paths/~1object-query~1accounts~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Account object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1accounts~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_116","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1accounts~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1accounts~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/accounts/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_116"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/accounts/{key}","href":"object-queries/queryaccountbykey","openApiOperationId":"queryAccountByKey","summary":"Retrieve an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedAccount","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedAccount","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1accounts~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedAccount","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedAccount","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1accounts~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryaccountbykey"}],"panels":[]}]},"httpPath":"/object-query/accounts/{key}"},{"label":"List amendments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryamendments","routeSlug":"/v1-api-reference/api/object-queries/queryamendments","metadata":{"seo":{"title":"List amendments","description":"Lists amendments. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryAmendments","name":"List amendments","isWebhook":false,"pointer":"/paths/~1object-query~1amendments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List amendments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists amendments. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivepolicy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"newrateplanid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removedrateplanid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subtype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Amendment object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivepolicy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"newrateplanid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removedrateplanid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subtype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1amendments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1amendments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/amendments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/amendments","href":"object-queries/queryamendments","openApiOperationId":"queryAmendments","summary":"List amendments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118","exampleIds":["paths/~1object-query~1amendments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_118","exampleIds":["paths/~1object-query~1amendments/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1amendments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_118","exampleIds":["paths/~1object-query~1amendments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118","exampleIds":["paths/~1object-query~1amendments/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryamendments"}],"panels":[]}]},"httpPath":"/object-query/amendments"},{"label":"Retrieve an amendment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryamendmentbykey","routeSlug":"/v1-api-reference/api/object-queries/queryamendmentbykey","metadata":{"seo":{"title":"Retrieve an amendment","description":"Retrieve the details of a specific Amendment object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryAmendmentByKey","name":"Retrieve an amendment","isWebhook":false,"pointer":"/paths/~1object-query~1amendments~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an amendment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Amendment object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1amendments~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Amendment object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1amendments~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1amendments~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/amendments/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/amendments/{key}","href":"object-queries/queryamendmentbykey","openApiOperationId":"queryAmendmentByKey","summary":"Retrieve an amendment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedAmendment","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedAmendment","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"}],"pointer":"/paths/~1object-query~1amendments~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedAmendment","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedAmendment","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1amendments~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryamendmentbykey"}],"panels":[]}]},"httpPath":"/object-query/amendments/{key}"},{"label":"List bill runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querybillingruns","routeSlug":"/v1-api-reference/api/object-queries/querybillingruns","metadata":{"seo":{"title":"List bill runs","description":"Lists bill runs. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryBillingRuns","name":"List bill runs","isWebhook":false,"pointer":"/paths/~1object-query~1billing-runs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bill runs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists bill runs. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdbyid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billingrunnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executeddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numberofaccounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numberofinvoices"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numberofcreditmemos"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"targetdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"batches"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repeattype"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Bill Run object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createdbyid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billingrunnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executeddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numberofaccounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numberofinvoices"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numberofcreditmemos"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"targetdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"batches"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repeattype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1billing-runs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1billing-runs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/billing-runs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/billing-runs","href":"object-queries/querybillingruns","openApiOperationId":"queryBillingRuns","summary":"List bill runs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_119","exampleIds":["paths/~1object-query~1billing-runs/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_119","exampleIds":["paths/~1object-query~1billing-runs/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1billing-runs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_119","exampleIds":["paths/~1object-query~1billing-runs/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_119","exampleIds":["paths/~1object-query~1billing-runs/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querybillingruns"}],"panels":[]}]},"httpPath":"/object-query/billing-runs"},{"label":"Retrieve a bill run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querybillingrunbykey","routeSlug":"/v1-api-reference/api/object-queries/querybillingrunbykey","metadata":{"seo":{"title":"Retrieve a bill run","description":"Retrieve the details of a specific Bill Run object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryBillingRunByKey","name":"Retrieve a bill run","isWebhook":false,"pointer":"/paths/~1object-query~1billing-runs~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a bill run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Bill Run object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1billing-runs~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Bill Run object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1billing-runs~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1billing-runs~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/billing-runs/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/billing-runs/{key}","href":"object-queries/querybillingrunbykey","openApiOperationId":"queryBillingRunByKey","summary":"Retrieve a bill run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedBillingRun","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedBillingRun","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1billing-runs~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedBillingRun","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedBillingRun","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1billing-runs~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querybillingrunbykey"}],"panels":[]}]},"httpPath":"/object-query/billing-runs/{key}"},{"label":"List contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycontacts","routeSlug":"/v1-api-reference/api/object-queries/querycontacts","metadata":{"seo":{"title":"List contacts","description":"Lists contacts. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryContacts","name":"List contacts","isWebhook":false,"pointer":"/paths/~1object-query~1contacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists contacts. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"firstname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lastname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personalemail"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workemail"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workphone"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Contact object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"firstname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lastname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personalemail"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workemail"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workphone"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1contacts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/contacts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/contacts","href":"object-queries/querycontacts","openApiOperationId":"queryContacts","summary":"List contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120","exampleIds":["paths/~1object-query~1contacts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_120","exampleIds":["paths/~1object-query~1contacts/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_120","exampleIds":["paths/~1object-query~1contacts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120","exampleIds":["paths/~1object-query~1contacts/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycontacts"}],"panels":[]}]},"httpPath":"/object-query/contacts"},{"label":"Retrieve a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycontactbykey","routeSlug":"/v1-api-reference/api/object-queries/querycontactbykey","metadata":{"seo":{"title":"Retrieve a contact","description":"Retrieve the details of a specific Contact object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryContactByKey","name":"Retrieve a contact","isWebhook":false,"pointer":"/paths/~1object-query~1contacts~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Contact object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1contacts~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Contact object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1contacts~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1contacts~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/contacts/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/contacts/{key}","href":"object-queries/querycontactbykey","openApiOperationId":"queryContactByKey","summary":"Retrieve a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedContact","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedContact","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1contacts~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedContact","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedContact","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contacts~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycontactbykey"}],"panels":[]}]},"httpPath":"/object-query/contacts/{key}"},{"label":"List credit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemos","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemos","metadata":{"seo":{"title":"List credit memos","description":"Lists credit memos. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCreditMemos","name":"List credit memos","isWebhook":false,"pointer":"/paths/~1object-query~1credit-memos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List credit memos","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists credit memos. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"einvoicestatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"memodate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"memonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourcetype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalamount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_121","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"einvoicestatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"memodate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"memonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourcetype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalamount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memos/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/credit-memos","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_121"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/credit-memos","href":"object-queries/querycreditmemos","openApiOperationId":"queryCreditMemos","summary":"List credit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_122","exampleIds":["paths/~1object-query~1credit-memos/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_122","exampleIds":["paths/~1object-query~1credit-memos/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1credit-memos/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_122","exampleIds":["paths/~1object-query~1credit-memos/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_122","exampleIds":["paths/~1object-query~1credit-memos/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycreditmemos"}],"panels":[]}]},"httpPath":"/object-query/credit-memos"},{"label":"Retrieve a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemobykey","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemobykey","metadata":{"seo":{"title":"Retrieve a credit memo","description":"Retrieve the details of a specific Credit Memo object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCreditMemoByKey","name":"Retrieve a credit memo","isWebhook":false,"pointer":"/paths/~1object-query~1credit-memos~1{key}/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":"Retrieve the details of a specific Credit Memo object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1credit-memos~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_121","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memos~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memos~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/credit-memos/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_121"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/credit-memos/{key}","href":"object-queries/querycreditmemobykey","openApiOperationId":"queryCreditMemoByKey","summary":"Retrieve a credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedCreditMemo","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedCreditMemo","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1credit-memos~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedCreditMemo","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedCreditMemo","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memos~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycreditmemobykey"}],"panels":[]}]},"httpPath":"/object-query/credit-memos/{key}"},{"label":"List credit memo applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemoapplications","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemoapplications","metadata":{"seo":{"title":"List credit memo applications","description":"Lists credit memo applications. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCreditMemoApplications","name":"List credit memo applications","isWebhook":false,"pointer":"/paths/~1object-query~1credit-memo-applications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List credit memo applications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists credit memo applications. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationgroupid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_123","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationgroupid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memo-applications/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memo-applications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/credit-memo-applications","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_123"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/credit-memo-applications","href":"object-queries/querycreditmemoapplications","openApiOperationId":"queryCreditMemoApplications","summary":"List credit memo applications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_124","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1credit-memo-applications/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_124","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycreditmemoapplications"}],"panels":[]}]},"httpPath":"/object-query/credit-memo-applications"},{"label":"Retrieve a credit memo application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemoapplicationbykey","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemoapplicationbykey","metadata":{"seo":{"title":"Retrieve a credit memo application","description":"Retrieve the details of a specific Credit Memo Application object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCreditMemoApplicationByKey","name":"Retrieve a credit memo application","isWebhook":false,"pointer":"/paths/~1object-query~1credit-memo-applications~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a credit memo application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Credit Memo Application object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1credit-memo-applications~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_123","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memo-applications~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memo-applications~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/credit-memo-applications/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_123"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/credit-memo-applications/{key}","href":"object-queries/querycreditmemoapplicationbykey","openApiOperationId":"queryCreditMemoApplicationByKey","summary":"Retrieve a credit memo application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedCreditMemoApplication","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedCreditMemoApplication","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1credit-memo-applications~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedCreditMemoApplication","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedCreditMemoApplication","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-applications~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycreditmemoapplicationbykey"}],"panels":[]}]},"httpPath":"/object-query/credit-memo-applications/{key}"},{"label":"List credit memo items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemoitems","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemoitems","metadata":{"seo":{"title":"List credit memo items","description":"Lists credit memo items. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCreditMemoItems","name":"List credit memo items","isWebhook":false,"pointer":"/paths/~1object-query~1credit-memo-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List credit memo items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists credit memo items. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excludeitembillingfromrevenueaccounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceitemtype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_125","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excludeitembillingfromrevenueaccounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fulfillmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderlineitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceitemtype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memo-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memo-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/credit-memo-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_125"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/credit-memo-items","href":"object-queries/querycreditmemoitems","openApiOperationId":"queryCreditMemoItems","summary":"List credit memo items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_126","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1credit-memo-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_126","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycreditmemoitems"}],"panels":[]}]},"httpPath":"/object-query/credit-memo-items"},{"label":"Retrieve a credit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycreditmemoitembykey","routeSlug":"/v1-api-reference/api/object-queries/querycreditmemoitembykey","metadata":{"seo":{"title":"Retrieve a credit memo item","description":"Retrieve the details of a specific Credit Memo Item object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCreditMemoItemByKey","name":"Retrieve a credit memo item","isWebhook":false,"pointer":"/paths/~1object-query~1credit-memo-items~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a credit memo item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Credit Memo Item object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1credit-memo-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_125","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memo-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1credit-memo-items~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/credit-memo-items/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_125"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/credit-memo-items/{key}","href":"object-queries/querycreditmemoitembykey","openApiOperationId":"queryCreditMemoItemByKey","summary":"Retrieve a credit memo item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedCreditMemoItem","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedCreditMemoItem","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1credit-memo-items~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedCreditMemoItem","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedCreditMemoItem","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1credit-memo-items~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycreditmemoitembykey"}],"panels":[]}]},"httpPath":"/object-query/credit-memo-items/{key}"},{"label":"List daily consumption summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydailyconsumptionsummaries","routeSlug":"/v1-api-reference/api/object-queries/querydailyconsumptionsummaries","metadata":{"seo":{"title":"List daily consumption summaries","description":"Lists daily consumption summaries. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDailyConsumptionSummaries","name":"List daily consumption summaries","isWebhook":false,"pointer":"/paths/~1object-query~1daily-consumption-summaries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List daily consumption summaries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists daily consumption summaries. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1daily-consumption-summaries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1daily-consumption-summaries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/daily-consumption-summaries","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/daily-consumption-summaries","href":"object-queries/querydailyconsumptionsummaries","openApiOperationId":"queryDailyConsumptionSummaries","summary":"List daily consumption summaries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127","headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1daily-consumption-summaries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querydailyconsumptionsummaries"}],"panels":[]}]},"httpPath":"/object-query/daily-consumption-summaries"},{"label":"Retrieve a daily consumption summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydailyconsumptionsummarybykey","routeSlug":"/v1-api-reference/api/object-queries/querydailyconsumptionsummarybykey","metadata":{"seo":{"title":"Retrieve a daily consumption summary","description":"Retrieve the details of a specific Daily Consumption Summary object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDailyConsumptionSummaryByKey","name":"Retrieve a daily consumption summary","isWebhook":false,"pointer":"/paths/~1object-query~1daily-consumption-summaries~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a daily consumption summary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Daily Consumption Summary object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1daily-consumption-summaries~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1daily-consumption-summaries~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1daily-consumption-summaries~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/daily-consumption-summaries/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/daily-consumption-summaries/{key}","href":"object-queries/querydailyconsumptionsummarybykey","openApiOperationId":"queryDailyConsumptionSummaryByKey","summary":"Retrieve a daily consumption summary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedDailyConsumptionSummary","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedDailyConsumptionSummary","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedDailyConsumptionSummary","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedDailyConsumptionSummary","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querydailyconsumptionsummarybykey"}],"panels":[]}]},"httpPath":"/object-query/daily-consumption-summaries/{key}"},{"label":"List debit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydebitmemos","routeSlug":"/v1-api-reference/api/object-queries/querydebitmemos","metadata":{"seo":{"title":"List debit memos","description":"Lists debit memos. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDebitMemos","name":"List debit memos","isWebhook":false,"pointer":"/paths/~1object-query~1debit-memos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List debit memos","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists debit memos. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"einvoicestatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"memodate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"memonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourcetype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalamount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_128","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"einvoicestatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"memodate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"memonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourcetype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalamount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1debit-memos/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1debit-memos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/debit-memos","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_128"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/debit-memos","href":"object-queries/querydebitmemos","openApiOperationId":"queryDebitMemos","summary":"List debit memos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129","exampleIds":["paths/~1object-query~1debit-memos/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_129","exampleIds":["paths/~1object-query~1debit-memos/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1debit-memos/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_129","exampleIds":["paths/~1object-query~1debit-memos/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129","exampleIds":["paths/~1object-query~1debit-memos/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querydebitmemos"}],"panels":[]}]},"httpPath":"/object-query/debit-memos"},{"label":"Retrieve a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydebitmemobykey","routeSlug":"/v1-api-reference/api/object-queries/querydebitmemobykey","metadata":{"seo":{"title":"Retrieve a debit memo","description":"Retrieve the details of a specific Debit Memo object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDebitMemoByKey","name":"Retrieve a debit memo","isWebhook":false,"pointer":"/paths/~1object-query~1debit-memos~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a debit memo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Debit Memo object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1debit-memos~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_128","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1debit-memos~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1debit-memos~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/debit-memos/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_128"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/debit-memos/{key}","href":"object-queries/querydebitmemobykey","openApiOperationId":"queryDebitMemoByKey","summary":"Retrieve a debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedDebitMemo","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedDebitMemo","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1debit-memos~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedDebitMemo","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedDebitMemo","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memos~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querydebitmemobykey"}],"panels":[]}]},"httpPath":"/object-query/debit-memos/{key}"},{"label":"List debit memo items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydebitmemoitems","routeSlug":"/v1-api-reference/api/object-queries/querydebitmemoitems","metadata":{"seo":{"title":"List debit memo items","description":"Lists debit memo items. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDebitMemoItems","name":"List debit memo items","isWebhook":false,"pointer":"/paths/~1object-query~1debit-memo-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List debit memo items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists debit memo items. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excludeitembillingfromrevenueaccounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceitemtype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemoid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_130","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excludeitembillingfromrevenueaccounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceitemtype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1debit-memo-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1debit-memo-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/debit-memo-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_130"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/debit-memo-items","href":"object-queries/querydebitmemoitems","openApiOperationId":"queryDebitMemoItems","summary":"List debit memo items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_131","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_131","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1debit-memo-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_131","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_131","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querydebitmemoitems"}],"panels":[]}]},"httpPath":"/object-query/debit-memo-items"},{"label":"Retrieve a debit memo item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydebitmemoitembykey","routeSlug":"/v1-api-reference/api/object-queries/querydebitmemoitembykey","metadata":{"seo":{"title":"Retrieve a debit memo item","description":"Retrieve the details of a specific Debit Memo Item object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDebitMemoItemByKey","name":"Retrieve a debit memo item","isWebhook":false,"pointer":"/paths/~1object-query~1debit-memo-items~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a debit memo item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Debit Memo Item object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1debit-memo-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_130","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1debit-memo-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1debit-memo-items~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/debit-memo-items/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_130"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/debit-memo-items/{key}","href":"object-queries/querydebitmemoitembykey","openApiOperationId":"queryDebitMemoItemByKey","summary":"Retrieve a debit memo item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedDebitMemoItem","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedDebitMemoItem","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1debit-memo-items~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedDebitMemoItem","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedDebitMemoItem","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1debit-memo-items~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querydebitmemoitembykey"}],"panels":[]}]},"httpPath":"/object-query/debit-memo-items/{key}"},{"label":"List delivery adjustments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydeliveryadjustments","routeSlug":"/v1-api-reference/api/object-queries/querydeliveryadjustments","metadata":{"seo":{"title":"List delivery adjustments","description":"Lists Delivery Adjustment objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDeliveryAdjustments","name":"List delivery adjustments","isWebhook":false,"pointer":"/paths/~1object-query~1delivery-adjustments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List delivery adjustments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Delivery Adjustment objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"adjustmentnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"segmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalsubid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceowneraccountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"adjustmentnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"segmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalsubid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceowneraccountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1delivery-adjustments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1delivery-adjustments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/delivery-adjustments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/delivery-adjustments","href":"object-queries/querydeliveryadjustments","openApiOperationId":"queryDeliveryAdjustments","summary":"List delivery adjustments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_132","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1delivery-adjustments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_132","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querydeliveryadjustments"}],"panels":[]}]},"httpPath":"/object-query/delivery-adjustments"},{"label":"Retrieve a delivery adjustment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querydeliveryadjustmentbykey","routeSlug":"/v1-api-reference/api/object-queries/querydeliveryadjustmentbykey","metadata":{"seo":{"title":"Retrieve a delivery adjustment","description":"Retrieves a Delivery Adjustment object. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDeliveryAdjustmentByKey","name":"Retrieve a delivery adjustment","isWebhook":false,"pointer":"/paths/~1object-query~1delivery-adjustments~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a delivery adjustment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a Delivery Adjustment object. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"ID or number of the delivery adjustment.\n","required":true}],"pointer":"/paths/~1object-query~1delivery-adjustments~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable fields include:"},"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":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"adjustmentnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"segmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalsubid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceowneraccountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable fields include:"},"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":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"adjustmentnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemonumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"segmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalsubid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceowneraccountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1delivery-adjustments~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1delivery-adjustments~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/delivery-adjustments/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/delivery-adjustments/{key}","href":"object-queries/querydeliveryadjustmentbykey","openApiOperationId":"queryDeliveryAdjustmentByKey","summary":"Retrieve a delivery adjustment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedDeliveryAdjustment","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedDeliveryAdjustment","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1delivery-adjustments~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedDeliveryAdjustment","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedDeliveryAdjustment","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1delivery-adjustments~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querydeliveryadjustmentbykey"}],"panels":[]}]},"httpPath":"/object-query/delivery-adjustments/{key}"},{"label":"List fulfillments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryfulfillments","routeSlug":"/v1-api-reference/api/object-queries/queryfulfillments","metadata":{"seo":{"title":"List fulfillments","description":"Lists Fulfillment objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryFulfillments","name":"List fulfillments","isWebhook":false,"pointer":"/paths/~1object-query~1fulfillments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List fulfillments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Fulfillment objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderlineitemid - fulfillmentnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"externalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1fulfillments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1fulfillments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/fulfillments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/fulfillments","href":"object-queries/queryfulfillments","openApiOperationId":"queryFulfillments","summary":"List fulfillments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133","exampleIds":["paths/~1object-query~1fulfillments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_133","exampleIds":["paths/~1object-query~1fulfillments/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1fulfillments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_133","exampleIds":["paths/~1object-query~1fulfillments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133","exampleIds":["paths/~1object-query~1fulfillments/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryfulfillments"}],"panels":[]}]},"httpPath":"/object-query/fulfillments"},{"label":"Retrieve a fulfillment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryfulfillmentbykey","routeSlug":"/v1-api-reference/api/object-queries/queryfulfillmentbykey","metadata":{"seo":{"title":"Retrieve a fulfillment","description":"Retrieves a Fulfillment object. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryFulfillmentByKey","name":"Retrieve a fulfillment","isWebhook":false,"pointer":"/paths/~1object-query~1fulfillments~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a fulfillment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a Fulfillment object. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"ID or number of the fulfillment.\n","required":true}],"pointer":"/paths/~1object-query~1fulfillments~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderlineitemid - fulfillmentnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"externalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1fulfillments~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1fulfillments~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/fulfillments/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/fulfillments/{key}","href":"object-queries/queryfulfillmentbykey","openApiOperationId":"queryFulfillmentByKey","summary":"Retrieve a fulfillment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedFulfillment","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedFulfillment","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1fulfillments~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedFulfillment","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedFulfillment","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1fulfillments~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryfulfillmentbykey"}],"panels":[]}]},"httpPath":"/object-query/fulfillments/{key}"},{"label":"List invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoices","routeSlug":"/v1-api-reference/api/object-queries/queryinvoices","metadata":{"seo":{"title":"List invoices","description":"Lists invoices. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryInvoices","name":"List invoices","isWebhook":false,"pointer":"/paths/~1object-query~1invoices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists invoices. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"duedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourcetype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"einvoicestatus"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_134","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"duedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourcetype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"einvoicestatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1invoices/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1invoices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/invoices","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_134"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/invoices","href":"object-queries/queryinvoices","openApiOperationId":"queryInvoices","summary":"List invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_135","exampleIds":["paths/~1object-query~1invoices/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_135","exampleIds":["paths/~1object-query~1invoices/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1invoices/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_135","exampleIds":["paths/~1object-query~1invoices/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_135","exampleIds":["paths/~1object-query~1invoices/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryinvoices"}],"panels":[]}]},"httpPath":"/object-query/invoices"},{"label":"Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoicebykey","routeSlug":"/v1-api-reference/api/object-queries/queryinvoicebykey","metadata":{"seo":{"title":"Retrieve an invoice","description":"Retrieves the details of a specific Invoice object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryInvoiceByKey","name":"Retrieve an invoice","isWebhook":false,"pointer":"/paths/~1object-query~1invoices~1{key}/get","hasSamples":false},"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 the details of a specific Invoice object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1invoices~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_134","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1invoices~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1invoices~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/invoices/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_134"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/invoices/{key}","href":"object-queries/queryinvoicebykey","openApiOperationId":"queryInvoiceByKey","summary":"Retrieve an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedInvoice","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedInvoice","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1invoices~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedInvoice","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedInvoice","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoices~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryinvoicebykey"}],"panels":[]}]},"httpPath":"/object-query/invoices/{key}"},{"label":"List invoice items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoiceitems","routeSlug":"/v1-api-reference/api/object-queries/queryinvoiceitems","metadata":{"seo":{"title":"List invoice items","description":"Lists invoice items. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryInvoiceItems","name":"List invoice items","isWebhook":false,"pointer":"/paths/~1object-query~1invoice-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List invoice items","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":"Lists invoice items. You can use the query parameters to filter, expand, and sort the returned results."},"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":": You must specify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to query invoice items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountingcode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excludeitembillingfromrevenueaccounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"servicestartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceitemtype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bookingreference"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_136","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountingcode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excludeitembillingfromrevenueaccounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fulfillmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"servicestartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceitemtype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bookingreference"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}],"required":true},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1invoice-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1invoice-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/invoice-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_136"},{"name":"filter[]","in":"query","required":true,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/invoice-items","href":"object-queries/queryinvoiceitems","openApiOperationId":"queryInvoiceItems","summary":"List invoice items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137","exampleIds":["paths/~1object-query~1invoice-items/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_137","exampleIds":["paths/~1object-query~1invoice-items/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1invoice-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_137","exampleIds":["paths/~1object-query~1invoice-items/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137","exampleIds":["paths/~1object-query~1invoice-items/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryinvoiceitems"}],"panels":[]}]},"httpPath":"/object-query/invoice-items"},{"label":"Retrieve an invoice item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoiceitembykey","routeSlug":"/v1-api-reference/api/object-queries/queryinvoiceitembykey","metadata":{"seo":{"title":"Retrieve an invoice item","description":"Retrieve the details of a specific Invoice Item object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryInvoiceItemByKey","name":"Retrieve an invoice item","isWebhook":false,"pointer":"/paths/~1object-query~1invoice-items~1{key}/get","hasSamples":false},"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":"Retrieve the details of a specific Invoice Item object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1invoice-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_136","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1invoice-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1invoice-items~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/invoice-items/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_136"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/invoice-items/{key}","href":"object-queries/queryinvoiceitembykey","openApiOperationId":"queryInvoiceItemByKey","summary":"Retrieve an invoice item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedInvoiceItem","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedInvoiceItem","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1invoice-items~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedInvoiceItem","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedInvoiceItem","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-items~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryinvoiceitembykey"}],"panels":[]}]},"httpPath":"/object-query/invoice-items/{key}"},{"label":"List invoice schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoiceschedules","routeSlug":"/v1-api-reference/api/object-queries/queryinvoiceschedules","metadata":{"seo":{"title":"List invoice schedules","description":"Lists invoice schedules. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryInvoiceSchedules","name":"List invoice schedules","isWebhook":false,"pointer":"/paths/~1object-query~1invoice-schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List invoice schedules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists invoice schedules. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nextrundate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_138","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nextrundate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1invoice-schedules/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1invoice-schedules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/invoice-schedules","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_138"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/invoice-schedules","href":"object-queries/queryinvoiceschedules","openApiOperationId":"queryInvoiceSchedules","summary":"List invoice schedules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_139","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_139","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1invoice-schedules/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_139","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_139","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryinvoiceschedules"}],"panels":[]}]},"httpPath":"/object-query/invoice-schedules"},{"label":"Retrieve an invoice schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryinvoiceschedulebykey","routeSlug":"/v1-api-reference/api/object-queries/queryinvoiceschedulebykey","metadata":{"seo":{"title":"Retrieve an invoice schedule","description":"Retrieves the details of a specific Invoice Schedule object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryInvoiceScheduleByKey","name":"Retrieve an invoice schedule","isWebhook":false,"pointer":"/paths/~1object-query~1invoice-schedules~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an invoice schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the details of a specific Invoice Schedule object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1invoice-schedules~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_138","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1invoice-schedules~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1invoice-schedules~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/invoice-schedules/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_138"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/invoice-schedules/{key}","href":"object-queries/queryinvoiceschedulebykey","openApiOperationId":"queryInvoiceScheduleByKey","summary":"Retrieve an invoice schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedInvoiceSchedule","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedInvoiceSchedule","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1invoice-schedules~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedInvoiceSchedule","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedInvoiceSchedule","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1invoice-schedules~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryinvoiceschedulebykey"}],"panels":[]}]},"httpPath":"/object-query/invoice-schedules/{key}"},{"label":"List order actions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryorderactions","routeSlug":"/v1-api-reference/api/object-queries/queryorderactions","metadata":{"seo":{"title":"List order actions","description":"Lists order actions. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryOrderActions","name":"List order actions","isWebhook":false,"pointer":"/paths/~1object-query~1order-actions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List order actions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists order actions. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionversionamendmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_140","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionversionamendmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1order-actions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1order-actions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/order-actions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_140"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/order-actions","href":"object-queries/queryorderactions","openApiOperationId":"queryOrderActions","summary":"List order actions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141","exampleIds":["paths/~1object-query~1order-actions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_141","exampleIds":["paths/~1object-query~1order-actions/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1order-actions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_141","exampleIds":["paths/~1object-query~1order-actions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141","exampleIds":["paths/~1object-query~1order-actions/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryorderactions"}],"panels":[]}]},"httpPath":"/object-query/order-actions"},{"label":"Retrieve an order action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryorderactionbykey","routeSlug":"/v1-api-reference/api/object-queries/queryorderactionbykey","metadata":{"seo":{"title":"Retrieve an order action","description":"Retrieve the details of a specific Order Action object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryOrderActionByKey","name":"Retrieve an order action","isWebhook":false,"pointer":"/paths/~1object-query~1order-actions~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Order Action object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1order-actions~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_140","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1order-actions~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1order-actions~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/order-actions/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_140"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/order-actions/{key}","href":"object-queries/queryorderactionbykey","openApiOperationId":"queryOrderActionByKey","summary":"Retrieve an order action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedOrderAction","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedOrderAction","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1order-actions~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedOrderAction","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedOrderAction","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-actions~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryorderactionbykey"}],"panels":[]}]},"httpPath":"/object-query/order-actions/{key}"},{"label":"List order line items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryorderlineitems","routeSlug":"/v1-api-reference/api/object-queries/queryorderlineitems","metadata":{"seo":{"title":"List order line items","description":"Lists order line items. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryOrderLineItems","name":"List order line items","isWebhook":false,"pointer":"/paths/~1object-query~1order-line-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List order line items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists order line items. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itemname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itemnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itemstate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itemtype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ordernumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productcode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uom"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"relatedsubscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inlinediscounttype"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_142","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itemname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itemnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itemstate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itemtype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ordernumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productcode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billtoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"soldto"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"owneraccountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceowneraccountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uom"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"relatedsubscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalorderid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalordernumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalorderlineitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inlinediscounttype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1order-line-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1order-line-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/order-line-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_142"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/order-line-items","href":"object-queries/queryorderlineitems","openApiOperationId":"queryOrderLineItems","summary":"List order line items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143","exampleIds":["paths/~1object-query~1order-line-items/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_143","exampleIds":["paths/~1object-query~1order-line-items/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1order-line-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_143","exampleIds":["paths/~1object-query~1order-line-items/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143","exampleIds":["paths/~1object-query~1order-line-items/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryorderlineitems"}],"panels":[]}]},"httpPath":"/object-query/order-line-items"},{"label":"Retrieve an order line item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryorderlineitembykey","routeSlug":"/v1-api-reference/api/object-queries/queryorderlineitembykey","metadata":{"seo":{"title":"Retrieve an order line item","description":"Retrieve the details of a specific Order Line Item object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryOrderLineItemByKey","name":"Retrieve an order line item","isWebhook":false,"pointer":"/paths/~1object-query~1order-line-items~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order line item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Order Line Item object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1order-line-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_142","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1order-line-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1order-line-items~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/order-line-items/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_142"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/order-line-items/{key}","href":"object-queries/queryorderlineitembykey","openApiOperationId":"queryOrderLineItemByKey","summary":"Retrieve an order line item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedOrderLineItem","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedOrderLineItem","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1order-line-items~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedOrderLineItem","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedOrderLineItem","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1order-line-items~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryorderlineitembykey"}],"panels":[]}]},"httpPath":"/object-query/order-line-items/{key}"},{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryorders","routeSlug":"/v1-api-reference/api/object-queries/queryorders","metadata":{"seo":{"title":"List orders","description":"Lists orders. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryOrders","name":"List orders","isWebhook":false,"pointer":"/paths/~1object-query~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists orders. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ordernumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicescheduleid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_144","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows you to expand responses by including related object information in a single call."},"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":": For draft and scheduled orders, information on the subscription, rate plan, and rate plan charges is not available nor displayed until the following conditions are met:"},"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":"A scheduled order is executed and its status is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"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":"A draft order is activated and its status is changed to "},"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":"completed"},"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 example, if an order is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, information on the subscription, rate plan, and rate plan charges is not displayed."},"children":[]}]}]}]},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ordernumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicescheduleid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1orders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/orders","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_144"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/orders","href":"object-queries/queryorders","openApiOperationId":"queryOrders","summary":"List orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}},"schemaId":"schema_145","headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_145","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryorders"}],"panels":[]}]},"httpPath":"/object-query/orders"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryordersbykey","routeSlug":"/v1-api-reference/api/object-queries/queryordersbykey","metadata":{"seo":{"title":"Retrieve an order","description":"Retrieve the details of a specific Order object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryOrdersByKey","name":"Retrieve an order","isWebhook":false,"pointer":"/paths/~1object-query~1orders~1{key}/get","hasSamples":false},"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":"Retrieve the details of a specific Order object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1orders~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_144","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows you to expand responses by including related object information in a single call."},"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":": For draft and scheduled orders, information on the subscription, rate plan, and rate plan charges is not available nor displayed until the following conditions are met:"},"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":"A scheduled order is executed and its status is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"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":"A draft order is activated and its status is changed to "},"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":"completed"},"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 example, if an order is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, information on the subscription, rate plan, and rate plan charges is not displayed."},"children":[]}]}]}]},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ordernumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicescheduleid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1orders~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1orders~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/orders/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_144"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/orders/{key}","href":"object-queries/queryordersbykey","openApiOperationId":"queryOrdersByKey","summary":"Retrieve an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedOrders","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedOrders","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1orders~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedOrders","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedOrders","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1orders~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryordersbykey"}],"panels":[]}]},"httpPath":"/object-query/orders/{key}"},{"label":"List payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypayments","routeSlug":"/v1-api-reference/api/object-queries/querypayments","metadata":{"seo":{"title":"List payments","description":"Lists payments. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPayments","name":"List payments","isWebhook":false,"pointer":"/paths/~1object-query~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists payments. You can use the query parameters to filter, expand, and sort the returned results.  \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gatewayorderid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gatewaystate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentmethodid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentmethodsnapshotid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourcename"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unappliedamount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createddate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_146","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gatewayorderid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gatewaystate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentmethodid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentmethodsnapshotid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourcename"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unappliedamount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_146"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payments","href":"object-queries/querypayments","openApiOperationId":"queryPayments","summary":"List payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147","exampleIds":["paths/~1object-query~1payments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_147","exampleIds":["paths/~1object-query~1payments/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_147","exampleIds":["paths/~1object-query~1payments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147","exampleIds":["paths/~1object-query~1payments/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypayments"}],"panels":[]}]},"httpPath":"/object-query/payments"},{"label":"Retrieve a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentbykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentbykey","metadata":{"seo":{"title":"Retrieve a payment","description":"Retrieve the details of a specific Payment object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentByKey","name":"Retrieve a payment","isWebhook":false,"pointer":"/paths/~1object-query~1payments~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Payment object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1payments~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_146","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payments~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payments~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payments/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_146"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payments/{key}","href":"object-queries/querypaymentbykey","openApiOperationId":"queryPaymentByKey","summary":"Retrieve a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPayment","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedPayment","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payments~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedPayment","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPayment","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payments~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentbykey"}],"panels":[]}]},"httpPath":"/object-query/payments/{key}"},{"label":"List payment applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentapplications","routeSlug":"/v1-api-reference/api/object-queries/querypaymentapplications","metadata":{"seo":{"title":"List payment applications","description":"Lists payment applications. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentApplications","name":"List payment applications","isWebhook":false,"pointer":"/paths/~1object-query~1payment-applications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment applications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists payment applications. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationgroupid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_148","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationgroupid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-applications/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-applications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-applications","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_148"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-applications","href":"object-queries/querypaymentapplications","openApiOperationId":"queryPaymentApplications","summary":"List payment applications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149","exampleIds":["paths/~1object-query~1payment-applications/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_149","exampleIds":["paths/~1object-query~1payment-applications/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-applications/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_149","exampleIds":["paths/~1object-query~1payment-applications/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149","exampleIds":["paths/~1object-query~1payment-applications/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentapplications"}],"panels":[]}]},"httpPath":"/object-query/payment-applications"},{"label":"Retrieve a payment application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentapplicationbykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentapplicationbykey","metadata":{"seo":{"title":"Retrieve a payment application","description":"Retrieve the details of a specific Payment Application object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentApplicationByKey","name":"Retrieve a payment application","isWebhook":false,"pointer":"/paths/~1object-query~1payment-applications~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Payment Application object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1payment-applications~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_148","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-applications~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-applications~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-applications/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_148"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-applications/{key}","href":"object-queries/querypaymentapplicationbykey","openApiOperationId":"queryPaymentApplicationByKey","summary":"Retrieve a payment application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentApplication","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedPaymentApplication","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-applications~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedPaymentApplication","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentApplication","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-applications~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentapplicationbykey"}],"panels":[]}]},"httpPath":"/object-query/payment-applications/{key}"},{"label":"List payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentmethods","routeSlug":"/v1-api-reference/api/object-queries/querypaymentmethods","metadata":{"seo":{"title":"List payment methods","description":"Lists payment methods. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentMethods","name":"List payment methods","isWebhook":false,"pointer":"/paths/~1object-query~1payment-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists payment methods. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"achaccountname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"achbankname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"achcountry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"issystem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessidentificationcode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditcardexpirationmonth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditcardexpirationyear"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditcardmasknumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lasttransactiondatetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paypalbaid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_150","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"achaccountname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"achbankname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"achcountry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"issystem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessidentificationcode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditcardexpirationmonth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditcardexpirationyear"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditcardmasknumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lasttransactiondatetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paypalbaid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-methods","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_150"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-methods","href":"object-queries/querypaymentmethods","openApiOperationId":"queryPaymentMethods","summary":"List payment methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151","exampleIds":["paths/~1object-query~1payment-methods/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_151","exampleIds":["paths/~1object-query~1payment-methods/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-methods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_151","exampleIds":["paths/~1object-query~1payment-methods/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151","exampleIds":["paths/~1object-query~1payment-methods/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentmethods"}],"panels":[]}]},"httpPath":"/object-query/payment-methods"},{"label":"Retrieve a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentmethodbykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentmethodbykey","metadata":{"seo":{"title":"Retrieve a payment method","description":"Retrieve the details of a specific Payment Method object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentMethodByKey","name":"Retrieve a payment method","isWebhook":false,"pointer":"/paths/~1object-query~1payment-methods~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Payment Method object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1payment-methods~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_150","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-methods~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-methods~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-methods/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_150"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-methods/{key}","href":"object-queries/querypaymentmethodbykey","openApiOperationId":"queryPaymentMethodByKey","summary":"Retrieve a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentMethod","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedPaymentMethod","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-methods~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedPaymentMethod","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentMethod","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-methods~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentmethodbykey"}],"panels":[]}]},"httpPath":"/object-query/payment-methods/{key}"},{"label":"List payment method snapshots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentmethodsnapshots","routeSlug":"/v1-api-reference/api/object-queries/querypaymentmethodsnapshots","metadata":{"seo":{"title":"List payment method snapshots","description":"Lists payment method snapshots. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentMethodSnapshots","name":"List payment method snapshots","isWebhook":false,"pointer":"/paths/~1object-query~1payment-method-snapshots/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment method snapshots","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":"Lists payment method snapshots. You can use the query parameters to filter, expand, and sort the returned results."},"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":": You must specify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to query payment method snapshots."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditcardcountry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentmethodid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Payment Method Snapshot object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditcardcountry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentmethodid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}],"required":true},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-method-snapshots/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-method-snapshots/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-method-snapshots","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":true,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-method-snapshots","href":"object-queries/querypaymentmethodsnapshots","openApiOperationId":"queryPaymentMethodSnapshots","summary":"List payment method snapshots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_152","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-method-snapshots/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_152","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentmethodsnapshots"}],"panels":[]}]},"httpPath":"/object-query/payment-method-snapshots"},{"label":"Retrieve a payment method snapshot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentmethodsnapshotbykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentmethodsnapshotbykey","metadata":{"seo":{"title":"Retrieve a payment method snapshot","description":"Retrieve the details of a specific Payment Method Snapshot object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentMethodSnapshotByKey","name":"Retrieve a payment method snapshot","isWebhook":false,"pointer":"/paths/~1object-query~1payment-method-snapshots~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment method snapshot","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Payment Method Snapshot object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1payment-method-snapshots~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Payment Method Snapshot object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-method-snapshots~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-method-snapshots~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-method-snapshots/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-method-snapshots/{key}","href":"object-queries/querypaymentmethodsnapshotbykey","openApiOperationId":"queryPaymentMethodSnapshotByKey","summary":"Retrieve a payment method snapshot"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentMethodSnapshot","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedPaymentMethodSnapshot","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-method-snapshots~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedPaymentMethodSnapshot","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentMethodSnapshot","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentmethodsnapshotbykey"}],"panels":[]}]},"httpPath":"/object-query/payment-method-snapshots/{key}"},{"label":"List payment runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentruns","routeSlug":"/v1-api-reference/api/object-queries/querypaymentruns","metadata":{"seo":{"title":"List payment runs","description":"Lists payment runs. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentRuns","name":"List payment runs","isWebhook":false,"pointer":"/paths/~1object-query~1payment-runs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment runs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists payment runs. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executeddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numberofpayments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentrunnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"targetdate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Payment Run object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executeddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numberofpayments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentrunnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"targetdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-runs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-runs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-runs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-runs","href":"object-queries/querypaymentruns","openApiOperationId":"queryPaymentRuns","summary":"List payment runs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153","exampleIds":["paths/~1object-query~1payment-runs/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_153","exampleIds":["paths/~1object-query~1payment-runs/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-runs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_153","exampleIds":["paths/~1object-query~1payment-runs/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153","exampleIds":["paths/~1object-query~1payment-runs/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentruns"}],"panels":[]}]},"httpPath":"/object-query/payment-runs"},{"label":"Retrieve a payment run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentrunbykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentrunbykey","metadata":{"seo":{"title":"Retrieve a payment run","description":"Retrieve the details of a specific Payment Run object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentRunByKey","name":"Retrieve a payment run","isWebhook":false,"pointer":"/paths/~1object-query~1payment-runs~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Payment Run object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1payment-runs~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Payment Run object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-runs~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-runs~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-runs/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-runs/{key}","href":"object-queries/querypaymentrunbykey","openApiOperationId":"queryPaymentRunByKey","summary":"Retrieve a payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentRun","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedPaymentRun","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-runs~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedPaymentRun","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentRun","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-runs~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentrunbykey"}],"panels":[]}]},"httpPath":"/object-query/payment-runs/{key}"},{"label":"List payment schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentschedules","routeSlug":"/v1-api-reference/api/object-queries/querypaymentschedules","metadata":{"seo":{"title":"List payment schedules","description":"Lists payment schedules. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentSchedules","name":"List payment schedules","isWebhook":false,"pointer":"/paths/~1object-query~1payment-schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment schedules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists payment schedules. You can use the query parameters to filter, expand, and sort the returned results.  \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"occurrences"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Payment Schedule object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"occurrences"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-schedules/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-schedules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-schedules","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-schedules","href":"object-queries/querypaymentschedules","openApiOperationId":"queryPaymentSchedules","summary":"List payment schedules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_154","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_154","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-schedules/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_154","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_154","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentschedules"}],"panels":[]}]},"httpPath":"/object-query/payment-schedules"},{"label":"Retrieve a payment schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentschedulebykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentschedulebykey","metadata":{"seo":{"title":"Retrieve a payment schedule","description":"Retrieve the details of a specific Payment Schedule object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentScheduleByKey","name":"Retrieve a payment schedule","isWebhook":false,"pointer":"/paths/~1object-query~1payment-schedules~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Payment Schedule object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1payment-schedules~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Payment Schedule object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-schedules~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-schedules~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-schedules/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-schedules/{key}","href":"object-queries/querypaymentschedulebykey","openApiOperationId":"queryPaymentScheduleByKey","summary":"Retrieve a payment schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentSchedule","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedPaymentSchedule","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-schedules~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedPaymentSchedule","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentSchedule","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedules~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentschedulebykey"}],"panels":[]}]},"httpPath":"/object-query/payment-schedules/{key}"},{"label":"List payment schedule items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentscheduleitems","routeSlug":"/v1-api-reference/api/object-queries/querypaymentscheduleitems","metadata":{"seo":{"title":"List payment schedule items","description":"Lists Payment Schedule Item objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentScheduleItems","name":"List payment schedule items","isWebhook":false,"pointer":"/paths/~1object-query~1payment-schedule-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment schedule items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Payment Schedule Item objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentscheduleid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scheduleddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancellationreason"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_155","description":"Allows you to expand responses by including related object information in a single call.\nThe Payment Schedule Item object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debitmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentscheduleid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scheduleddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancellationreason"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-schedule-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-schedule-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-schedule-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_155"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-schedule-items","href":"object-queries/querypaymentscheduleitems","openApiOperationId":"queryPaymentScheduleItems","summary":"List payment schedule items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_156","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_156","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-schedule-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_156","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_156","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentscheduleitems"}],"panels":[]}]},"httpPath":"/object-query/payment-schedule-items"},{"label":"Retrieve a payment schedule item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querypaymentscheduleitembykey","routeSlug":"/v1-api-reference/api/object-queries/querypaymentscheduleitembykey","metadata":{"seo":{"title":"Retrieve a payment schedule item","description":"Retrieve the details of a specific Payment Schedule Item object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPaymentScheduleItemByKey","name":"Retrieve a payment schedule item","isWebhook":false,"pointer":"/paths/~1object-query~1payment-schedule-items~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment schedule item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Payment Schedule Item object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1payment-schedule-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_155","description":"Allows you to expand responses by including related object information in a single call.\nThe Payment Schedule Item object does not support expanding any related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1payment-schedule-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1payment-schedule-items~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/payment-schedule-items/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_155"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/payment-schedule-items/{key}","href":"object-queries/querypaymentscheduleitembykey","openApiOperationId":"queryPaymentScheduleItemByKey","summary":"Retrieve a payment schedule item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentScheduleItem","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedPaymentScheduleItem","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1payment-schedule-items~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedPaymentScheduleItem","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPaymentScheduleItem","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1payment-schedule-items~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querypaymentscheduleitembykey"}],"panels":[]}]},"httpPath":"/object-query/payment-schedule-items/{key}"},{"label":"List prepaid balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalances","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalances","metadata":{"seo":{"title":"List prepaid balances","description":"Lists Prepaid Balance objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPrepaidBalances","name":"List prepaid balances","isWebhook":false,"pointer":"/paths/~1object-query~1prepaid-balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List prepaid balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Prepaid Balance objects. You can use the query parameters to filter, expand, and sort the returned results.  \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"origsubscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uom"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_157","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"origsubscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uom"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balances/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/prepaid-balances","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_157"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/prepaid-balances","href":"object-queries/queryprepaidbalances","openApiOperationId":"queryPrepaidBalances","summary":"List prepaid balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_158","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1prepaid-balances/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_158","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryprepaidbalances"}],"panels":[]}]},"httpPath":"/object-query/prepaid-balances"},{"label":"Retrieve a prepaid balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalancebykey","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalancebykey","metadata":{"seo":{"title":"Retrieve a prepaid balance","description":"Retrieve the details of a specific Prepaid Balance object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPrepaidBalanceByKey","name":"Retrieve a prepaid balance","isWebhook":false,"pointer":"/paths/~1object-query~1prepaid-balances~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a prepaid balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Prepaid Balance object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1prepaid-balances~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_157","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balances~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balances~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/prepaid-balances/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_157"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/prepaid-balances/{key}","href":"object-queries/queryprepaidbalancebykey","openApiOperationId":"queryPrepaidBalanceByKey","summary":"Retrieve a prepaid balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPrepaidBalance","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedPrepaidBalance","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1prepaid-balances~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedPrepaidBalance","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPrepaidBalance","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balances~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryprepaidbalancebykey"}],"panels":[]}]},"httpPath":"/object-query/prepaid-balances/{key}"},{"label":"List prepaid balance funds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalancefunds","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalancefunds","metadata":{"seo":{"title":"List prepaid balance funds","description":"Lists prepaid balance funds. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPrepaidBalanceFunds","name":"List prepaid balance funds","isWebhook":false,"pointer":"/paths/~1object-query~1prepaid-balance-funds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List prepaid balance funds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists prepaid balance funds. You can use the query parameters to filter, expand, and sort the returned results.  \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepaidbalanceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vpsummaryid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_159","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepaidbalanceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vpsummaryid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balance-funds/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balance-funds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/prepaid-balance-funds","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_159"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/prepaid-balance-funds","href":"object-queries/queryprepaidbalancefunds","openApiOperationId":"queryPrepaidBalanceFunds","summary":"List prepaid balance funds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_160","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1prepaid-balance-funds/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_160","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryprepaidbalancefunds"}],"panels":[]}]},"httpPath":"/object-query/prepaid-balance-funds"},{"label":"Retrieve a prepaid balance fund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalancefundbykey","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalancefundbykey","metadata":{"seo":{"title":"Retrieve a prepaid balance fund","description":"Retrieve the details of a specific Prepaid Balance Fund object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPrepaidBalanceFundByKey","name":"Retrieve a prepaid balance fund","isWebhook":false,"pointer":"/paths/~1object-query~1prepaid-balance-funds~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a prepaid balance fund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Prepaid Balance Fund object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1prepaid-balance-funds~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_159","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balance-funds~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balance-funds~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/prepaid-balance-funds/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_159"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/prepaid-balance-funds/{key}","href":"object-queries/queryprepaidbalancefundbykey","openApiOperationId":"queryPrepaidBalanceFundByKey","summary":"Retrieve a prepaid balance fund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPrepaidBalanceFund","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedPrepaidBalanceFund","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedPrepaidBalanceFund","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPrepaidBalanceFund","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryprepaidbalancefundbykey"}],"panels":[]}]},"httpPath":"/object-query/prepaid-balance-funds/{key}"},{"label":"List prepaid balance transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalancetransactions","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalancetransactions","metadata":{"seo":{"title":"List prepaid balance transactions","description":"Lists prepaid balance transactions. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPrepaidBalanceTransactions","name":"List prepaid balance transactions","isWebhook":false,"pointer":"/paths/~1object-query~1prepaid-balance-transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List prepaid balance transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists prepaid balance transactions. You can use the query parameters to filter, expand, and sort the returned results.  \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepaidbalanceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fundid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactiondate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepaidbalancetransactiontype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createddate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_161","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepaidbalanceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fundid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactiondate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balance-transactions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balance-transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/prepaid-balance-transactions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_161"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/prepaid-balance-transactions","href":"object-queries/queryprepaidbalancetransactions","openApiOperationId":"queryPrepaidBalanceTransactions","summary":"List prepaid balance transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_162","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1prepaid-balance-transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_162","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryprepaidbalancetransactions"}],"panels":[]}]},"httpPath":"/object-query/prepaid-balance-transactions"},{"label":"Retrieve a prepaid balance transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprepaidbalancetransactionbykey","routeSlug":"/v1-api-reference/api/object-queries/queryprepaidbalancetransactionbykey","metadata":{"seo":{"title":"Retrieve a prepaid balance transaction","description":"Retrieve the details of a Prepaid Balance Transaction object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPrepaidBalanceTransactionByKey","name":"Retrieve a prepaid balance transaction","isWebhook":false,"pointer":"/paths/~1object-query~1prepaid-balance-transactions~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a prepaid balance transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a Prepaid Balance Transaction object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1prepaid-balance-transactions~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_161","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balance-transactions~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1prepaid-balance-transactions~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/prepaid-balance-transactions/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_161"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/prepaid-balance-transactions/{key}","href":"object-queries/queryprepaidbalancetransactionbykey","openApiOperationId":"queryPrepaidBalanceTransactionByKey","summary":"Retrieve a prepaid balance transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPrepaidBalanceTransaction","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedPrepaidBalanceTransaction","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedPrepaidBalanceTransaction","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedPrepaidBalanceTransaction","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryprepaidbalancetransactionbykey"}],"panels":[]}]},"httpPath":"/object-query/prepaid-balance-transactions/{key}"},{"label":"List processed usage records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprocessedusages","routeSlug":"/v1-api-reference/api/object-queries/queryprocessedusages","metadata":{"seo":{"title":"List processed usage records","description":"Lists Processed Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProcessedUsages","name":"List processed usage records","isWebhook":false,"pointer":"/paths/~1object-query~1processed-usages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List processed usage records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Processed Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usageid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billingperiodenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billingperiodstartdate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_163","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usageid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billingperiodenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billingperiodstartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1processed-usages/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1processed-usages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/processed-usages","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_163"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/processed-usages","href":"object-queries/queryprocessedusages","openApiOperationId":"queryProcessedUsages","summary":"List processed usage records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164","exampleIds":["paths/~1object-query~1processed-usages/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_164","exampleIds":["paths/~1object-query~1processed-usages/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1processed-usages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_164","exampleIds":["paths/~1object-query~1processed-usages/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164","exampleIds":["paths/~1object-query~1processed-usages/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryprocessedusages"}],"panels":[]}]},"httpPath":"/object-query/processed-usages"},{"label":"Retrieve a processed usage record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryprocessedusagebykey","routeSlug":"/v1-api-reference/api/object-queries/queryprocessedusagebykey","metadata":{"seo":{"title":"Retrieve a processed usage record","description":"Retrieve the details of a specific Processed Usage Record object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProcessedUsageByKey","name":"Retrieve a processed usage record","isWebhook":false,"pointer":"/paths/~1object-query~1processed-usages~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a processed usage record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Processed Usage Record object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1processed-usages~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_163","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1processed-usages~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1processed-usages~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/processed-usages/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_163"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/processed-usages/{key}","href":"object-queries/queryprocessedusagebykey","openApiOperationId":"queryProcessedUsageByKey","summary":"Retrieve a processed usage record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedProcessedUsage","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedProcessedUsage","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1processed-usages~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedProcessedUsage","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedProcessedUsage","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1processed-usages~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryprocessedusagebykey"}],"panels":[]}]},"httpPath":"/object-query/processed-usages/{key}"},{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproducts","routeSlug":"/v1-api-reference/api/object-queries/queryproducts","metadata":{"seo":{"title":"List products","description":"Lists Product objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProducts","name":"List products","isWebhook":false,"pointer":"/paths/~1object-query~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Product objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectiveenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivestartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sku"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_165","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectiveenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivestartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sku"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1products/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/products","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_165"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/products","href":"object-queries/queryproducts","openApiOperationId":"queryProducts","summary":"List products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1object-query~1products/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_166","exampleIds":["paths/~1object-query~1products/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1products/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_166","exampleIds":["paths/~1object-query~1products/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1object-query~1products/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryproducts"}],"panels":[]}]},"httpPath":"/object-query/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductbykey","routeSlug":"/v1-api-reference/api/object-queries/queryproductbykey","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieve the details of a specific Product object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProductByKey","name":"Retrieve a product","isWebhook":false,"pointer":"/paths/~1object-query~1products~1{key}/get","hasSamples":false},"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":"Retrieve the details of a specific Product object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"ID or SKU of a product.","required":true}],"pointer":"/paths/~1object-query~1products~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_165","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1products~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1products~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/products/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_165"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/products/{key}","href":"object-queries/queryproductbykey","openApiOperationId":"queryProductByKey","summary":"Retrieve a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedProduct","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedProduct","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1products~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedProduct","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedProduct","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1products~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryproductbykey"}],"panels":[]}]},"httpPath":"/object-query/products/{key}"},{"label":"List product rate plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplans","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplans","metadata":{"seo":{"title":"List product rate plans","description":"Lists Product Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProductRatePlans","name":"List product rate plans","isWebhook":false,"pointer":"/paths/~1object-query~1product-rate-plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product rate plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Product Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivestartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectiveenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplannumber"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_167","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivestartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectiveenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplannumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plans/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/product-rate-plans","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_167"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/product-rate-plans","href":"object-queries/queryproductrateplans","openApiOperationId":"queryProductRatePlans","summary":"List product rate plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_168","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_168","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1product-rate-plans/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_168","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_168","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryproductrateplans"}],"panels":[]}]},"httpPath":"/object-query/product-rate-plans"},{"label":"Retrieve a product rate plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplanbykey","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplanbykey","metadata":{"seo":{"title":"Retrieve a product rate plan","description":"Retrieve the details of a specific Product Rate Plan object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProductRatePlanByKey","name":"Retrieve a product rate plan","isWebhook":false,"pointer":"/paths/~1object-query~1product-rate-plans~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product rate plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Product Rate Plan object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"ID of a product rate plan.","required":true}],"pointer":"/paths/~1object-query~1product-rate-plans~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_167","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plans~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plans~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/product-rate-plans/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_167"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/product-rate-plans/{key}","href":"object-queries/queryproductrateplanbykey","openApiOperationId":"queryProductRatePlanByKey","summary":"Retrieve a product rate plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedProductRatePlan","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedProductRatePlan","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1product-rate-plans~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedProductRatePlan","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedProductRatePlan","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plans~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryproductrateplanbykey"}],"panels":[]}]},"httpPath":"/object-query/product-rate-plans/{key}"},{"label":"List product rate plan charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplancharges","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplancharges","metadata":{"seo":{"title":"List product rate plan charges","description":"Lists Product Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProductRatePlanCharges","name":"List product rate plan charges","isWebhook":false,"pointer":"/paths/~1object-query~1product-rate-plan-charges/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product rate plan charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Product Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billcycleday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargemodel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanchargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_169","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billcycleday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargemodel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargetype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"isprepaid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanchargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plan-charges/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plan-charges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/product-rate-plan-charges","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_169"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/product-rate-plan-charges","href":"object-queries/queryproductrateplancharges","openApiOperationId":"queryProductRatePlanCharges","summary":"List product rate plan charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_170","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1product-rate-plan-charges/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_170","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryproductrateplancharges"}],"panels":[]}]},"httpPath":"/object-query/product-rate-plan-charges"},{"label":"Retrieve a product rate plan charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplanchargebykey","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplanchargebykey","metadata":{"seo":{"title":"Retrieve a product rate plan charge","description":"Retrieve the details of a specific Product Rate Plan Charge object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProductRatePlanChargeByKey","name":"Retrieve a product rate plan charge","isWebhook":false,"pointer":"/paths/~1object-query~1product-rate-plan-charges~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product rate plan charge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Product Rate Plan Charge object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"ID of a product rate plan charge.","required":true}],"pointer":"/paths/~1object-query~1product-rate-plan-charges~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_169"},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plan-charges~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plan-charges~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/product-rate-plan-charges/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_169"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/product-rate-plan-charges/{key}","href":"object-queries/queryproductrateplanchargebykey","openApiOperationId":"queryProductRatePlanChargeByKey","summary":"Retrieve a product rate plan charge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedProductRatePlanCharge","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedProductRatePlanCharge","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedProductRatePlanCharge","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedProductRatePlanCharge","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryproductrateplanchargebykey"}],"panels":[]}]},"httpPath":"/object-query/product-rate-plan-charges/{key}"},{"label":"List product rate plan charge tiers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplanchargetiers","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplanchargetiers","metadata":{"seo":{"title":"List product rate plan charge tiers","description":"Lists Product Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProductRatePlanChargeTiers","name":"List product rate plan charge tiers","isWebhook":false,"pointer":"/paths/~1object-query~1product-rate-plan-charge-tiers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product rate plan charge tiers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Product Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productchargedefinitionid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_171","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productrateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productchargedefinitionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plan-charge-tiers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plan-charge-tiers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/product-rate-plan-charge-tiers","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_171"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/product-rate-plan-charge-tiers","href":"object-queries/queryproductrateplanchargetiers","openApiOperationId":"queryProductRatePlanChargeTiers","summary":"List product rate plan charge tiers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_172","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1product-rate-plan-charge-tiers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_172","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryproductrateplanchargetiers"}],"panels":[]}]},"httpPath":"/object-query/product-rate-plan-charge-tiers"},{"label":"Retrieve a product rate plan charge tier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryproductrateplanchargetierbykey","routeSlug":"/v1-api-reference/api/object-queries/queryproductrateplanchargetierbykey","metadata":{"seo":{"title":"Retrieve a product rate plan charge tier","description":"Retrieve the details of a specific Product Rate Plan Charge Tier object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProductRatePlanChargeTierByKey","name":"Retrieve a product rate plan charge tier","isWebhook":false,"pointer":"/paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product rate plan charge tier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Product Rate Plan Charge Tier object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"ID of a product rate plan charge tier.","required":true}],"pointer":"/paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_171","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/product-rate-plan-charge-tiers/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_171"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/product-rate-plan-charge-tiers/{key}","href":"object-queries/queryproductrateplanchargetierbykey","openApiOperationId":"queryProductRatePlanChargeTierByKey","summary":"Retrieve a product rate plan charge tier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedProductRatePlanChargeTier","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedProductRatePlanChargeTier","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedProductRatePlanChargeTier","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedProductRatePlanChargeTier","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryproductrateplanchargetierbykey"}],"panels":[]}]},"httpPath":"/object-query/product-rate-plan-charge-tiers/{key}"},{"label":"List ramps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryramps","routeSlug":"/v1-api-reference/api/object-queries/queryramps","metadata":{"seo":{"title":"List ramps","description":"Lists Ramp objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRamps","name":"List ramps","isWebhook":false,"pointer":"/paths/~1object-query~1ramps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List ramps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Ramp objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderId"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1ramps/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1ramps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/ramps","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/ramps","href":"object-queries/queryramps","openApiOperationId":"queryRamps","summary":"List ramps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_173","exampleIds":["paths/~1object-query~1ramps/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_173","exampleIds":["paths/~1object-query~1ramps/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1ramps/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_173","exampleIds":["paths/~1object-query~1ramps/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_173","exampleIds":["paths/~1object-query~1ramps/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryramps"}],"panels":[]}]},"httpPath":"/object-query/ramps"},{"label":"Retrieve a ramp","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrampbykey","routeSlug":"/v1-api-reference/api/object-queries/queryrampbykey","metadata":{"seo":{"title":"Retrieve a ramp","description":"Retrieve a Ramp object. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRampByKey","name":"Retrieve a ramp","isWebhook":false,"pointer":"/paths/~1object-query~1ramps~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a ramp","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a Ramp object. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"ID or number of the ramp.\n","required":true}],"pointer":"/paths/~1object-query~1ramps~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderId"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1ramps~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1ramps~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/ramps/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/ramps/{key}","href":"object-queries/queryrampbykey","openApiOperationId":"queryRampByKey","summary":"Retrieve a ramp"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRamp","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedRamp","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1ramps~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedRamp","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRamp","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1ramps~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrampbykey"}],"panels":[]}]},"httpPath":"/object-query/ramps/{key}"},{"label":"List rate plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplans","routeSlug":"/v1-api-reference/api/object-queries/queryrateplans","metadata":{"seo":{"title":"List rate plans","description":"Lists Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRatePlans","name":"List rate plans","isWebhook":false,"pointer":"/paths/~1object-query~1rate-plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List rate plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results.  \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amendmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionownerid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"externallymanagedplanid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionrateplannumber"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_174","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amendmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionownerid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceownerid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"externallymanagedplanid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalrateplanid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionofferid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionrateplannumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plans/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/rate-plans","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_174"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/rate-plans","href":"object-queries/queryrateplans","openApiOperationId":"queryRatePlans","summary":"List rate plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175","exampleIds":["paths/~1object-query~1rate-plans/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_175","exampleIds":["paths/~1object-query~1rate-plans/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1rate-plans/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_175","exampleIds":["paths/~1object-query~1rate-plans/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175","exampleIds":["paths/~1object-query~1rate-plans/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrateplans"}],"panels":[]}]},"httpPath":"/object-query/rate-plans"},{"label":"Retrieve a rate plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplanbykey","routeSlug":"/v1-api-reference/api/object-queries/queryrateplanbykey","metadata":{"seo":{"title":"Retrieve a rate plan","description":"Retrieve the details of a specific Rate Plan object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRatePlanByKey","name":"Retrieve a rate plan","isWebhook":false,"pointer":"/paths/~1object-query~1rate-plans~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a rate plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Rate Plan object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"ID of a rate plan.","required":true}],"pointer":"/paths/~1object-query~1rate-plans~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_174","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plans~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plans~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/rate-plans/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_174"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/rate-plans/{key}","href":"object-queries/queryrateplanbykey","openApiOperationId":"queryRatePlanByKey","summary":"Retrieve a rate plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRatePlan","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedRatePlan","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1rate-plans~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedRatePlan","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRatePlan","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plans~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrateplanbykey"}],"panels":[]}]},"httpPath":"/object-query/rate-plans/{key}"},{"label":"List rate plan charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplancharges","routeSlug":"/v1-api-reference/api/object-queries/queryrateplancharges","metadata":{"seo":{"title":"List rate plan charges","description":"Lists Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results.Note: You must specify a filter[] query parameter to query rate plan charges."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRatePlanCharges","name":"List rate plan charges","isWebhook":false,"pointer":"/paths/~1object-query~1rate-plan-charges/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List rate plan charges","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":"Lists Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":": You must specify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to query rate plan charges."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicescheduleid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"isprepaid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productchargedefinitionid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_176","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billcycleday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargemodel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargenumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"chargetype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicescheduleid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"isprepaid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionownerid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceownerid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productchargedefinitionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uom"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}],"required":true},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plan-charges/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plan-charges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/rate-plan-charges","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_176"},{"name":"filter[]","in":"query","required":true,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/rate-plan-charges","href":"object-queries/queryrateplancharges","openApiOperationId":"queryRatePlanCharges","summary":"List rate plan charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_177","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_177","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1rate-plan-charges/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_177","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_177","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrateplancharges"}],"panels":[]}]},"httpPath":"/object-query/rate-plan-charges"},{"label":"Retrieve a rate plan charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplanchargebykey","routeSlug":"/v1-api-reference/api/object-queries/queryrateplanchargebykey","metadata":{"seo":{"title":"Retrieve a rate plan charge","description":"Retrieve the details of a specific Rate Plan Charge object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRatePlanChargeByKey","name":"Retrieve a rate plan charge","isWebhook":false,"pointer":"/paths/~1object-query~1rate-plan-charges~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a rate plan charge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Rate Plan Charge object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"ID of a rate plan charge.","required":true}],"pointer":"/paths/~1object-query~1rate-plan-charges~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_176","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plan-charges~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plan-charges~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/rate-plan-charges/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_176"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/rate-plan-charges/{key}","href":"object-queries/queryrateplanchargebykey","openApiOperationId":"queryRatePlanChargeByKey","summary":"Retrieve a rate plan charge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRatePlanCharge","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedRatePlanCharge","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1rate-plan-charges~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedRatePlanCharge","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRatePlanCharge","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrateplanchargebykey"}],"panels":[]}]},"httpPath":"/object-query/rate-plan-charges/{key}"},{"label":"List rate plan charge tiers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplanchargetiers","routeSlug":"/v1-api-reference/api/object-queries/queryrateplanchargetiers","metadata":{"seo":{"title":"List rate plan charge tiers","description":"Lists Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRatePlanChargeTiers","name":"List rate plan charge tiers","isWebhook":false,"pointer":"/paths/~1object-query~1rate-plan-charge-tiers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List rate plan charge tiers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_178","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]}]}],"required":true},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plan-charge-tiers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plan-charge-tiers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/rate-plan-charge-tiers","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_178"},{"name":"filter[]","in":"query","required":true,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/rate-plan-charge-tiers","href":"object-queries/queryrateplanchargetiers","openApiOperationId":"queryRatePlanChargeTiers","summary":"List rate plan charge tiers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_179","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1rate-plan-charge-tiers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_179","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrateplanchargetiers"}],"panels":[]}]},"httpPath":"/object-query/rate-plan-charge-tiers"},{"label":"Retrieve a rate plan charge tier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrateplanchargetierbykey","routeSlug":"/v1-api-reference/api/object-queries/queryrateplanchargetierbykey","metadata":{"seo":{"title":"Retrieve a rate plan charge tier","description":"Retrieve the details of a specific Rate Plan Charge Tier object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRatePlanChargeTierByKey","name":"Retrieve a rate plan charge tier","isWebhook":false,"pointer":"/paths/~1object-query~1rate-plan-charge-tiers~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a rate plan charge tier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Rate Plan Charge Tier object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"ID of a rate plan charge tier.","required":true}],"pointer":"/paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_178","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]}]}],"required":true},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/rate-plan-charge-tiers/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_178"},{"name":"filter[]","in":"query","required":true,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/rate-plan-charge-tiers/{key}","href":"object-queries/queryrateplanchargetierbykey","openApiOperationId":"queryRatePlanChargeTierByKey","summary":"Retrieve a rate plan charge tier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRatePlanChargeTier","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedRatePlanChargeTier","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedRatePlanChargeTier","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRatePlanChargeTier","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrateplanchargetierbykey"}],"panels":[]}]},"httpPath":"/object-query/rate-plan-charge-tiers/{key}"},{"label":"List rating results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryratingresults","routeSlug":"/v1-api-reference/api/object-queries/queryratingresults","metadata":{"seo":{"title":"List rating results","description":"Lists Rating Result objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRatingResults","name":"List rating results","isWebhook":false,"pointer":"/paths/~1object-query~1rating-results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List rating results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Rating Result objects. You can use the query parameters to filter, expand, and sort the returned results.  \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"servicestartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ispartial"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_180","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rateplanchargeid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"servicestartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serviceenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ispartial"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1rating-results/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1rating-results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/rating-results","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_180"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/rating-results","href":"object-queries/queryratingresults","openApiOperationId":"queryRatingResults","summary":"List rating results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_181","exampleIds":["paths/~1object-query~1rating-results/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_181","exampleIds":["paths/~1object-query~1rating-results/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1rating-results/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_181","exampleIds":["paths/~1object-query~1rating-results/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_181","exampleIds":["paths/~1object-query~1rating-results/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryratingresults"}],"panels":[]}]},"httpPath":"/object-query/rating-results"},{"label":"Retrieve a rating result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryratingresultbykey","routeSlug":"/v1-api-reference/api/object-queries/queryratingresultbykey","metadata":{"seo":{"title":"Retrieve a rating result","description":"Retrieve the details of a specific Rating Result object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRatingResultByKey","name":"Retrieve a rating result","isWebhook":false,"pointer":"/paths/~1object-query~1rating-results~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a rating result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Rating Result object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1rating-results~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_180","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1rating-results~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1rating-results~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/rating-results/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_180"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/rating-results/{key}","href":"object-queries/queryratingresultbykey","openApiOperationId":"queryRatingResultByKey","summary":"Retrieve a rating result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRatingResult","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedRatingResult","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1rating-results~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedRatingResult","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRatingResult","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-results~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryratingresultbykey"}],"panels":[]}]},"httpPath":"/object-query/rating-results/{key}"},{"label":"List refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefunds","routeSlug":"/v1-api-reference/api/object-queries/queryrefunds","metadata":{"seo":{"title":"List refunds","description":"Lists Refund objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRefunds","name":"List refunds","isWebhook":false,"pointer":"/paths/~1object-query~1refunds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List refunds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Refund objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentmethodsnapshotid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentmethodid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reasoncode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refunddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refundnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourcetype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_182","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentmethodsnapshotid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentmethodid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reasoncode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refunddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refundnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sourcetype"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1refunds/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1refunds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/refunds","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_182"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/refunds","href":"object-queries/queryrefunds","openApiOperationId":"queryRefunds","summary":"List refunds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183","exampleIds":["paths/~1object-query~1refunds/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_183","exampleIds":["paths/~1object-query~1refunds/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1refunds/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_183","exampleIds":["paths/~1object-query~1refunds/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183","exampleIds":["paths/~1object-query~1refunds/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrefunds"}],"panels":[]}]},"httpPath":"/object-query/refunds"},{"label":"Retrieve a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefundbykey","routeSlug":"/v1-api-reference/api/object-queries/queryrefundbykey","metadata":{"seo":{"title":"Retrieve a refund","description":"Retrieve the details of a specific Refund object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRefundByKey","name":"Retrieve a refund","isWebhook":false,"pointer":"/paths/~1object-query~1refunds~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Refund object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1refunds~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_182","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1refunds~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1refunds~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/refunds/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_182"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/refunds/{key}","href":"object-queries/queryrefundbykey","openApiOperationId":"queryRefundByKey","summary":"Retrieve a refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRefund","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedRefund","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1refunds~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedRefund","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRefund","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refunds~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrefundbykey"}],"panels":[]}]},"httpPath":"/object-query/refunds/{key}"},{"label":"List refund applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefundapplications","routeSlug":"/v1-api-reference/api/object-queries/queryrefundapplications","metadata":{"seo":{"title":"List refund applications","description":"Lists Refund Application objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRefundApplications","name":"List refund applications","isWebhook":false,"pointer":"/paths/~1object-query~1refund-applications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List refund applications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Refund Application objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationgroupid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refundid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_184","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicationgroupid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditmemoid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refundid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1refund-applications/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1refund-applications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/refund-applications","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_184"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/refund-applications","href":"object-queries/queryrefundapplications","openApiOperationId":"queryRefundApplications","summary":"List refund applications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_185","exampleIds":["paths/~1object-query~1refund-applications/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_185","exampleIds":["paths/~1object-query~1refund-applications/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1refund-applications/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_185","exampleIds":["paths/~1object-query~1refund-applications/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_185","exampleIds":["paths/~1object-query~1refund-applications/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrefundapplications"}],"panels":[]}]},"httpPath":"/object-query/refund-applications"},{"label":"Retrieve a refund application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefundapplicationbykey","routeSlug":"/v1-api-reference/api/object-queries/queryrefundapplicationbykey","metadata":{"seo":{"title":"Retrieve a refund application","description":"Retrieve the details of a specific Refund Application object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRefundApplicationByKey","name":"Retrieve a refund application","isWebhook":false,"pointer":"/paths/~1object-query~1refund-applications~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a refund application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Refund Application object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1refund-applications~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_184","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1refund-applications~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1refund-applications~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/refund-applications/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_184"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/refund-applications/{key}","href":"object-queries/queryrefundapplicationbykey","openApiOperationId":"queryRefundApplicationByKey","summary":"Retrieve a refund application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRefundApplication","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedRefundApplication","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1refund-applications~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedRefundApplication","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRefundApplication","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-applications~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrefundapplicationbykey"}],"panels":[]}]},"httpPath":"/object-query/refund-applications/{key}"},{"label":"List refund application items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefundapplicationitems","routeSlug":"/v1-api-reference/api/object-queries/queryrefundapplicationitems","metadata":{"seo":{"title":"List refund application items","description":"Lists Refund Application Item objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRefundApplicationItems","name":"List refund application items","isWebhook":false,"pointer":"/paths/~1object-query~1refund-application-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List refund application items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Refund Application Item objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_186","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1refund-application-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1refund-application-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/refund-application-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_186"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/refund-application-items","href":"object-queries/queryrefundapplicationitems","openApiOperationId":"queryRefundApplicationItems","summary":"List refund application items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_187"}},"schemaId":"schema_187","headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1refund-application-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_187","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_187"}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrefundapplicationitems"}],"panels":[]}]},"httpPath":"/object-query/refund-application-items"},{"label":"Retrieve a refund application item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryrefundapplicationitembykey","routeSlug":"/v1-api-reference/api/object-queries/queryrefundapplicationitembykey","metadata":{"seo":{"title":"Retrieve a refund application item","description":"Retrieve the details of a specific Refund Application Item object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRefundApplicationItemByKey","name":"Retrieve a refund application item","isWebhook":false,"pointer":"/paths/~1object-query~1refund-application-items~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a refund application item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Refund Application Item object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1refund-application-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_186","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1refund-application-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1refund-application-items~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/refund-application-items/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_186"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/refund-application-items/{key}","href":"object-queries/queryrefundapplicationitembykey","openApiOperationId":"queryRefundApplicationItemByKey","summary":"Retrieve a refund application item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRefundApplicationItem"}},"schemaId":"components/schemas/ExpandedRefundApplicationItem","headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1refund-application-items~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedRefundApplicationItem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedRefundApplicationItem"}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1refund-application-items~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryrefundapplicationitembykey"}],"panels":[]}]},"httpPath":"/object-query/refund-application-items/{key}"},{"label":"List summary statement runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/getsummarystatementruns","routeSlug":"/v1-api-reference/api/object-queries/getsummarystatementruns","metadata":{"seo":{"title":"List summary statement runs","description":"Lists statement runs. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSummaryStatementRuns","name":"List summary statement runs","isWebhook":false,"pointer":"/paths/~1object-query~1summarystatementruns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List summary statement runs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists statement runs. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_188","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_189","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1summarystatementruns/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1summarystatementruns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/summarystatementruns","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_188"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_189"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/summarystatementruns","href":"object-queries/getsummarystatementruns","openApiOperationId":"getSummaryStatementRuns","summary":"List summary statement runs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedSummaryStatementRun","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ExpandedSummaryStatementRun","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1summarystatementruns/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedSummaryStatementRun","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedSummaryStatementRun","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/getsummarystatementruns"}],"panels":[]}]},"httpPath":"/object-query/summarystatementruns"},{"label":"Retrieve a summary statement run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/getsummarystatementrun","routeSlug":"/v1-api-reference/api/object-queries/getsummarystatementrun","metadata":{"seo":{"title":"Retrieve a summary statement run","description":"Retrieves a statement run by using the statement run ID or number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSummaryStatementRun","name":"Retrieve a summary statement run","isWebhook":false,"pointer":"/paths/~1object-query~1summarystatementruns~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a summary statement run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a statement run by using the statement run ID or number.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Statement run ID or number.","required":true}],"pointer":"/paths/~1object-query~1summarystatementruns~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_188","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_189","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1summarystatementruns~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1summarystatementruns~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/summarystatementruns/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_188"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_189"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/summarystatementruns/{key}","href":"object-queries/getsummarystatementrun","openApiOperationId":"getSummaryStatementRun","summary":"Retrieve a summary statement run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedSummaryStatementRun","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ExpandedSummaryStatementRun","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1summarystatementruns~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedSummaryStatementRun","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedSummaryStatementRun","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatementruns~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/getsummarystatementrun"}],"panels":[]}]},"httpPath":"/object-query/summarystatementruns/{key}"},{"label":"List summary statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/getsummarystatements","routeSlug":"/v1-api-reference/api/object-queries/getsummarystatements","metadata":{"seo":{"title":"List summary statements","description":"Lists summary statements."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSummaryStatements","name":"List summary statements","isWebhook":false,"pointer":"/paths/~1object-query~1summarystatements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List summary statements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists summary statements. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_191","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1summarystatements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1summarystatements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/summarystatements","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_190"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_191"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/summarystatements","href":"object-queries/getsummarystatements","openApiOperationId":"getSummaryStatements","summary":"List summary statements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedSummaryStatement","exampleIds":["paths/~1object-query~1summarystatements/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ExpandedSummaryStatement","exampleIds":["paths/~1object-query~1summarystatements/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1summarystatements/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedSummaryStatement","exampleIds":["paths/~1object-query~1summarystatements/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedSummaryStatement","exampleIds":["paths/~1object-query~1summarystatements/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/getsummarystatements"}],"panels":[]}]},"httpPath":"/object-query/summarystatements"},{"label":"Retrieve a summary statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/getsummarystatement","routeSlug":"/v1-api-reference/api/object-queries/getsummarystatement","metadata":{"seo":{"title":"Retrieve a summary statement","description":"Retrieves a statement based on the specified summary statement key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSummaryStatement","name":"Retrieve a summary statement","isWebhook":false,"pointer":"/paths/~1object-query~1summarystatements~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a summary statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a statement based on the specified summary statement key.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Statement ID or number.","required":true}],"pointer":"/paths/~1object-query~1summarystatements~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"endDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statementNumber"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_192","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_191","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1summarystatements~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1summarystatements~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/summarystatements/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_192"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_191"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/summarystatements/{key}","href":"object-queries/getsummarystatement","openApiOperationId":"getSummaryStatement","summary":"Retrieve a summary statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedSummaryStatement","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ExpandedSummaryStatement","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1summarystatements~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedSummaryStatement","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedSummaryStatement","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1summarystatements~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/getsummarystatement"}],"panels":[]}]},"httpPath":"/object-query/summarystatements/{key}"},{"label":"List subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querysubscriptions","routeSlug":"/v1-api-reference/api/object-queries/querysubscriptions","metadata":{"seo":{"title":"List subscriptions","description":"Lists Subscription objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"querySubscriptions","name":"List subscriptions","isWebhook":false,"pointer":"/paths/~1object-query~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Subscription objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contracteffectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creatoraccountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creatorinvoiceownerid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceownerid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"previoussubscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"renewalterm"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"islatestversion"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionversionamendmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"termenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"termstartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"version"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cmrr"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"externallymanagedby"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicescheduleid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_193","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contracteffectivedate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creatoraccountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creatorinvoiceownerid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceownerid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"originalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"previoussubscriptionid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"renewalterm"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"islatestversion"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionversionamendmentid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"termenddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"termstartdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"version"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cmrr"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"externallymanagedby"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoicescheduleid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quotenumber__qt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1subscriptions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/subscriptions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_193"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/subscriptions","href":"object-queries/querysubscriptions","openApiOperationId":"querySubscriptions","summary":"List subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194","exampleIds":["paths/~1object-query~1subscriptions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_194","exampleIds":["paths/~1object-query~1subscriptions/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_194","exampleIds":["paths/~1object-query~1subscriptions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194","exampleIds":["paths/~1object-query~1subscriptions/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querysubscriptions"}],"panels":[]}]},"httpPath":"/object-query/subscriptions"},{"label":"Retrieve a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querysubscriptionbykey","routeSlug":"/v1-api-reference/api/object-queries/querysubscriptionbykey","metadata":{"seo":{"title":"Retrieve a subscription","description":"Retrieve the details of a specific Subscription object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"querySubscriptionByKey","name":"Retrieve a subscription","isWebhook":false,"pointer":"/paths/~1object-query~1subscriptions~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Subscription object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1subscriptions~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_193","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1subscriptions~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1subscriptions~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/subscriptions/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_193"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/subscriptions/{key}","href":"object-queries/querysubscriptionbykey","openApiOperationId":"querySubscriptionByKey","summary":"Retrieve a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedSubscription","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedSubscription","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1subscriptions~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedSubscription","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedSubscription","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1subscriptions~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querysubscriptionbykey"}],"panels":[]}]},"httpPath":"/object-query/subscriptions/{key}"},{"label":"List taxation items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querytaxationitems","routeSlug":"/v1-api-reference/api/object-queries/querytaxationitems","metadata":{"seo":{"title":"List taxation items","description":"Lists Taxation Item objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryTaxationItems","name":"List taxation items","isWebhook":false,"pointer":"/paths/~1object-query~1taxation-items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List taxation items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Taxation Item objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Taxation Item object does not support expanding related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1taxation-items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1taxation-items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/taxation-items","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/taxation-items","href":"object-queries/querytaxationitems","openApiOperationId":"queryTaxationItems","summary":"List taxation items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1object-query~1taxation-items/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_195","exampleIds":["paths/~1object-query~1taxation-items/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1taxation-items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_195","exampleIds":["paths/~1object-query~1taxation-items/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1object-query~1taxation-items/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querytaxationitems"}],"panels":[]}]},"httpPath":"/object-query/taxation-items"},{"label":"Retrieve a taxation item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querytaxationitembykey","routeSlug":"/v1-api-reference/api/object-queries/querytaxationitembykey","metadata":{"seo":{"title":"Retrieve a taxation item","description":"Retrieve the details of a specific Taxation Item object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryTaxationItemByKey","name":"Retrieve a taxation item","isWebhook":false,"pointer":"/paths/~1object-query~1taxation-items~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a taxation item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Taxation Item object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1taxation-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call.\nThe Taxation Item object does not support expanding related objects."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1taxation-items~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1taxation-items~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/taxation-items/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/taxation-items/{key}","href":"object-queries/querytaxationitembykey","openApiOperationId":"queryTaxationItemByKey","summary":"Retrieve a taxation item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedTaxationItem","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedTaxationItem","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1taxation-items~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedTaxationItem","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedTaxationItem","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1taxation-items~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querytaxationitembykey"}],"panels":[]}]},"httpPath":"/object-query/taxation-items/{key}"},{"label":"List usage records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryusages","routeSlug":"/v1-api-reference/api/object-queries/queryusages","metadata":{"seo":{"title":"List usage records","description":"Lists Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryUsages","name":"List usage records","isWebhook":false,"pointer":"/paths/~1object-query~1usages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List usage records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enddatetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quantity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rbestatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startdatetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uom"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_150","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enddatetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quantity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rbestatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startdatetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uom"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1usages/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1usages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/usages","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_150"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/usages","href":"object-queries/queryusages","openApiOperationId":"queryUsages","summary":"List usage records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_196","exampleIds":["paths/~1object-query~1usages/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_196","exampleIds":["paths/~1object-query~1usages/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1usages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_196","exampleIds":["paths/~1object-query~1usages/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_196","exampleIds":["paths/~1object-query~1usages/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryusages"}],"panels":[]}]},"httpPath":"/object-query/usages"},{"label":"Retrieve a usage record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryusagebykey","routeSlug":"/v1-api-reference/api/object-queries/queryusagebykey","metadata":{"seo":{"title":"Retrieve a usage record","description":"Retrieve the details of a specific Usage Record object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryUsageByKey","name":"Retrieve a usage record","isWebhook":false,"pointer":"/paths/~1object-query~1usages~1{key}/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":"Retrieve the details of a specific Usage Record object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1usages~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_150","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1usages~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1usages~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/usages/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_150"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/usages/{key}","href":"object-queries/queryusagebykey","openApiOperationId":"queryUsageByKey","summary":"Retrieve a usage record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedUsage","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedUsage","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1usages~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedUsage","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedUsage","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1usages~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryusagebykey"}],"panels":[]}]},"httpPath":"/object-query/usages/{key}"},{"label":"List validity period summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryvalidityperiodsummarys","routeSlug":"/v1-api-reference/api/object-queries/queryvalidityperiodsummarys","metadata":{"seo":{"title":"List validity period summaries","description":"Lists Validity Period Summary objects. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryValidityPeriodSummarys","name":"List validity period summaries","isWebhook":false,"pointer":"/paths/~1object-query~1validity-period-summaries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List validity period summaries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists Validity Period Summary objects. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepaidbalanceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_197","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepaidbalanceid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"startdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptionnumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1validity-period-summaries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1validity-period-summaries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/validity-period-summaries","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_197"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/validity-period-summaries","href":"object-queries/queryvalidityperiodsummarys","openApiOperationId":"queryValidityPeriodSummarys","summary":"List validity period summaries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_198","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_198","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1validity-period-summaries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_198","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_198","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryvalidityperiodsummarys"}],"panels":[]}]},"httpPath":"/object-query/validity-period-summaries"},{"label":"Retrieve a validity period summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryvalidityperiodsummarybykey","routeSlug":"/v1-api-reference/api/object-queries/queryvalidityperiodsummarybykey","metadata":{"seo":{"title":"Retrieve a validity period summary","description":"Retrieve the details of a specific Validity Period Summary object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryValidityPeriodSummaryByKey","name":"Retrieve a validity period summary","isWebhook":false,"pointer":"/paths/~1object-query~1validity-period-summaries~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a validity period summary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a specific Validity Period Summary object.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID or Number.","required":true}],"pointer":"/paths/~1object-query~1validity-period-summaries~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_197","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1validity-period-summaries~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1validity-period-summaries~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/validity-period-summaries/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_197"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/validity-period-summaries/{key}","href":"object-queries/queryvalidityperiodsummarybykey","openApiOperationId":"queryValidityPeriodSummaryByKey","summary":"Retrieve a validity period summary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedValidityPeriodSummary","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ExpandedValidityPeriodSummary","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1validity-period-summaries~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpandedValidityPeriodSummary","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpandedValidityPeriodSummary","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1validity-period-summaries~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryvalidityperiodsummarybykey"}],"panels":[]}]},"httpPath":"/object-query/validity-period-summaries/{key}"},{"label":"List custom object records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycustomobjects","routeSlug":"/v1-api-reference/api/object-queries/querycustomobjects","metadata":{"seo":{"title":"List custom object records","description":"Lists custom object records. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCustomObjects","name":"List custom object records","isWebhook":false,"pointer":"/paths/~1object-query~1{custom-object-name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom object records","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":"Lists custom object records. You can use the query parameters to filter, expand, and sort the returned results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a custom object is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{namespace}__{objectname}s"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default__cars"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Sorting queried custom objects by ID is not supported."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom-object-name","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Object Name with NameSpace, e.g. default__cars"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1object-query~1{custom-object-name}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1{custom-object-name}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1{custom-object-name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/{custom-object-name}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"custom-object-name","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/{custom-object-name}","href":"object-queries/querycustomobjects","openApiOperationId":"queryCustomObjects","summary":"List custom object records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_199","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_199","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1{custom-object-name}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_199","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_199","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycustomobjects"}],"panels":[]}]},"httpPath":"/object-query/{custom-object-name}"},{"label":"Retrieve a custom object record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycustomobjectbykey","routeSlug":"/v1-api-reference/api/object-queries/querycustomobjectbykey","metadata":{"seo":{"title":"Retrieve a custom object record","description":"Retrieve the details of a specific custom object record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCustomObjectBykey","name":"Retrieve a custom object record","isWebhook":false,"pointer":"/paths/~1object-query~1{custom-object-name}~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a custom object record","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":"Retrieve the details of a specific custom object record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a custom object is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{namespace}__{objectname}s"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default__cars"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom-object-name","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Object Name with NameSpace, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default__cars"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"key","in":"path","schemaId":"schema_5","description":"Object ID.","required":true}],"pointer":"/paths/~1object-query~1{custom-object-name}~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":"A case-insensitive filter on the list."},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1{custom-object-name}~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1{custom-object-name}~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/{custom-object-name}/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"custom-object-name","in":"path","required":true,"schemaId":"schema_5"},{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/{custom-object-name}/{key}","href":"object-queries/querycustomobjectbykey","openApiOperationId":"queryCustomObjectBykey","summary":"Retrieve a custom object record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_200","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_200","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1{custom-object-name}~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_200","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_200","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1{custom-object-name}~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycustomobjectbykey"}],"panels":[]}]},"httpPath":"/object-query/{custom-object-name}/{key}"},{"label":"List contact snapshots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycontactsnapshots","routeSlug":"/v1-api-reference/api/object-queries/querycontactsnapshots","metadata":{"seo":{"title":"List contact snapshots","description":"Lists contact snapshots. You can use the query parameters to filter, expand, and sort the returned results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryContactSnapshots","name":"List contact snapshots","isWebhook":false,"pointer":"/paths/~1object-query~1contact-snapshots/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List contact snapshots","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists contact snapshots. You can use the query parameters to filter, expand, and sort the returned results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a list. For instance, if you make a list request and receive 100 objects,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\ the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\ (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\ array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored.\\n"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported sortable fields: \\n  - id\\n  - updateddate\\n  - contactid"},"children":[]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information\nin a single call.\n"},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contactid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}: Use the format like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter on custom fields."},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1contact-snapshots/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1contact-snapshots/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/contact-snapshots","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/contact-snapshots","href":"object-queries/querycontactsnapshots","openApiOperationId":"queryContactSnapshots","summary":"List contact snapshots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_201","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_201","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1contact-snapshots/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_201","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_201","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycontactsnapshots"}],"panels":[]}]},"httpPath":"/object-query/contact-snapshots"},{"label":"Retrieve a contact snapshot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/querycontactsnapshotbykey","routeSlug":"/v1-api-reference/api/object-queries/querycontactsnapshotbykey","metadata":{"seo":{"title":"Retrieve a contact snapshot","description":"Retrieves detailed information about a specific contact snapshot by its unique ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryContactSnapshotByKey","name":"Retrieve a contact snapshot","isWebhook":false,"pointer":"/paths/~1object-query~1contact-snapshots~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a contact snapshot","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific contact snapshot by its unique ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","description":"The unique identifier of the contact snapshot to retrieve.","required":true}],"pointer":"/paths/~1object-query~1contact-snapshots~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a list. For instance, if you make a list request and receive 100 objects,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountnumber.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You cannot sort on properties in arrays. If the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array-type properties are specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, they are ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields that can be sorted include:"},"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":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contactid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call."},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list. The available options include:"},"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":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updateddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contactid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{indexedcustomfield}"},"children":[]}]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1contact-snapshots~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1contact-snapshots~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/contact-snapshots/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/contact-snapshots/{key}","href":"object-queries/querycontactsnapshotbykey","openApiOperationId":"queryContactSnapshotByKey","summary":"Retrieve a contact snapshot"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NestedContactSnapshotOnExpand","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/NestedContactSnapshotOnExpand","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1contact-snapshots~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NestedContactSnapshotOnExpand","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NestedContactSnapshotOnExpand","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1contact-snapshots~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/querycontactsnapshotbykey"}],"panels":[]}]},"httpPath":"/object-query/contact-snapshots/{key}"},{"label":"List rating details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryratingdetails","routeSlug":"/v1-api-reference/api/object-queries/queryratingdetails","metadata":{"seo":{"title":"List rating details","description":"Lists rating details. Use query parameters to paginate and filter results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRatingDetails","name":"List rating details","isWebhook":false,"pointer":"/paths/~1object-query~1rating-details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List rating details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists rating details. Use query parameters to paginate and filter results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id.DESC"},"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":"Supported sortable 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":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditmemoitemid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call. This operation does not have expandable fields.\n"},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditmemoitemid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also filter on custom fields using the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1rating-details/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1rating-details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/rating-details","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/rating-details","href":"object-queries/queryratingdetails","openApiOperationId":"queryRatingDetails","summary":"List rating details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryRatingDetailsResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/QueryRatingDetailsResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1rating-details/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueryRatingDetailsResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryRatingDetailsResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryratingdetails"}],"panels":[]}]},"httpPath":"/object-query/rating-details"},{"label":"Retrieve a rating detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/object-queries/queryratingdetailbykey","routeSlug":"/v1-api-reference/api/object-queries/queryratingdetailbykey","metadata":{"seo":{"title":"Retrieve a rating detail","description":"Retrieves a single rating detail by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryRatingDetailByKey","name":"Retrieve a rating detail","isWebhook":false,"pointer":"/paths/~1object-query~1rating-details~1{key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a rating detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single rating detail by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"key","in":"path","schemaId":"schema_5","required":true}],"pointer":"/paths/~1object-query~1rating-details~1{key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of results to return in a single page. If the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than 1 or greater than 99, Zuora will return a 400 error."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", your subsequent call can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=W3sib3JkZXJ="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to fetch the next page of the list."},"children":[]}]}]}]},{"name":"sort[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id.DESC"},"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":"Supported sortable 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":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditmemoitemid"},"children":[]}]}]}]}]},{"name":"expand[]","in":"query","schemaId":"schema_42","description":"Allows you to expand responses by including related object information in a single call. This operation does not have expandable fields.\n"},{"name":"filter[]","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A case-insensitive filter on the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported filterable 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":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceitemid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditmemoitemid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also filter on custom fields using the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customField__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"fields[]","in":"query","schemaId":"schema_42","description":"A case-insensitive query parameter that allows you to specify which fields are returned in the response.","example":"id,createddate"},{"name":"includeNullFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields will be returned in the response, including those with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only fields with non-null values will be returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1object-query~1rating-details~1{key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1object-query~1rating-details~1{key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-query/rating-details/{key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_115"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"filter[]","in":"query","required":false,"schemaId":"schema_42"},{"name":"fields[]","in":"query","required":false,"example":"id,createddate","schemaId":"schema_42"},{"name":"includeNullFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-query/rating-details/{key}","href":"object-queries/queryratingdetailbykey","openApiOperationId":"queryRatingDetailByKey","summary":"Retrieve a rating detail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RatingDetails","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/RatingDetails","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_41"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1object-query~1rating-details~1{key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RatingDetails","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RatingDetails","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/200/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonOQErrorResponse","exampleIds":["paths/~1object-query~1rating-details~1{key}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/object-queries/queryratingdetailbykey"}],"panels":[]}]},"httpPath":"/object-query/rating-details/{key}"}],"content":{"contentType":"group","meta":{"name":"Object Queries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Object Queries","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":"The Object Query API contains GET operations that allow you to query objects in your Zuora tenant in an efficient, consistent, and flexible manner."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters, you have the flexibility to retrieve related object information in a single call and define the returned response that best suits your needs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to define which fields are returned in the response for a given object."},"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":"sort[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter allows you to sort the results in ascending or descending order based on the specified field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These parameters are case-insensitive matching."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For general Object Queries limitations and comprehensive introduction to these query parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/expand-filter-fields-sort/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expand, filter, fields, and sort"},"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 filterable, expandable, and sortable fields on each object, refer to the Query Parameters section for each API operation."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/object-query/accounts","summary":"List accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryaccounts","deprecated":false},{"title":"/object-query/accounts/{key}","summary":"Retrieve an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryaccountbykey","deprecated":false},{"title":"/object-query/amendments","summary":"List amendments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryamendments","deprecated":false},{"title":"/object-query/amendments/{key}","summary":"Retrieve an amendment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryamendmentbykey","deprecated":false},{"title":"/object-query/billing-runs","summary":"List bill runs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querybillingruns","deprecated":false},{"title":"/object-query/billing-runs/{key}","summary":"Retrieve a bill run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querybillingrunbykey","deprecated":false},{"title":"/object-query/contacts","summary":"List contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycontacts","deprecated":false},{"title":"/object-query/contacts/{key}","summary":"Retrieve a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycontactbykey","deprecated":false},{"title":"/object-query/credit-memos","summary":"List credit memos","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycreditmemos","deprecated":false},{"title":"/object-query/credit-memos/{key}","summary":"Retrieve a credit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycreditmemobykey","deprecated":false},{"title":"/object-query/credit-memo-applications","summary":"List credit memo applications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycreditmemoapplications","deprecated":false},{"title":"/object-query/credit-memo-applications/{key}","summary":"Retrieve a credit memo application","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycreditmemoapplicationbykey","deprecated":false},{"title":"/object-query/credit-memo-items","summary":"List credit memo items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycreditmemoitems","deprecated":false},{"title":"/object-query/credit-memo-items/{key}","summary":"Retrieve a credit memo item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycreditmemoitembykey","deprecated":false},{"title":"/object-query/daily-consumption-summaries","summary":"List daily consumption summaries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querydailyconsumptionsummaries","deprecated":false},{"title":"/object-query/daily-consumption-summaries/{key}","summary":"Retrieve a daily consumption summary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querydailyconsumptionsummarybykey","deprecated":false},{"title":"/object-query/debit-memos","summary":"List debit memos","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querydebitmemos","deprecated":false},{"title":"/object-query/debit-memos/{key}","summary":"Retrieve a debit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querydebitmemobykey","deprecated":false},{"title":"/object-query/debit-memo-items","summary":"List debit memo items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querydebitmemoitems","deprecated":false},{"title":"/object-query/debit-memo-items/{key}","summary":"Retrieve a debit memo item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querydebitmemoitembykey","deprecated":false},{"title":"/object-query/delivery-adjustments","summary":"List delivery adjustments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querydeliveryadjustments","deprecated":false},{"title":"/object-query/delivery-adjustments/{key}","summary":"Retrieve a delivery adjustment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querydeliveryadjustmentbykey","deprecated":false},{"title":"/object-query/fulfillments","summary":"List fulfillments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryfulfillments","deprecated":false},{"title":"/object-query/fulfillments/{key}","summary":"Retrieve a fulfillment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryfulfillmentbykey","deprecated":false},{"title":"/object-query/invoices","summary":"List invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryinvoices","deprecated":false},{"title":"/object-query/invoices/{key}","summary":"Retrieve an invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryinvoicebykey","deprecated":false},{"title":"/object-query/invoice-items","summary":"List invoice items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryinvoiceitems","deprecated":false},{"title":"/object-query/invoice-items/{key}","summary":"Retrieve an invoice item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryinvoiceitembykey","deprecated":false},{"title":"/object-query/invoice-schedules","summary":"List invoice schedules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryinvoiceschedules","deprecated":false},{"title":"/object-query/invoice-schedules/{key}","summary":"Retrieve an invoice schedule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryinvoiceschedulebykey","deprecated":false},{"title":"/object-query/order-actions","summary":"List order actions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryorderactions","deprecated":false},{"title":"/object-query/order-actions/{key}","summary":"Retrieve an order action","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryorderactionbykey","deprecated":false},{"title":"/object-query/order-line-items","summary":"List order line items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryorderlineitems","deprecated":false},{"title":"/object-query/order-line-items/{key}","summary":"Retrieve an order line item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryorderlineitembykey","deprecated":false},{"title":"/object-query/orders","summary":"List orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryorders","deprecated":false},{"title":"/object-query/orders/{key}","summary":"Retrieve an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryordersbykey","deprecated":false},{"title":"/object-query/payments","summary":"List payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypayments","deprecated":false},{"title":"/object-query/payments/{key}","summary":"Retrieve a payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentbykey","deprecated":false},{"title":"/object-query/payment-applications","summary":"List payment applications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentapplications","deprecated":false},{"title":"/object-query/payment-applications/{key}","summary":"Retrieve a payment application","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentapplicationbykey","deprecated":false},{"title":"/object-query/payment-methods","summary":"List payment methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentmethods","deprecated":false},{"title":"/object-query/payment-methods/{key}","summary":"Retrieve a payment method","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentmethodbykey","deprecated":false},{"title":"/object-query/payment-method-snapshots","summary":"List payment method snapshots","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentmethodsnapshots","deprecated":false},{"title":"/object-query/payment-method-snapshots/{key}","summary":"Retrieve a payment method snapshot","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentmethodsnapshotbykey","deprecated":false},{"title":"/object-query/payment-runs","summary":"List payment runs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentruns","deprecated":false},{"title":"/object-query/payment-runs/{key}","summary":"Retrieve a payment run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentrunbykey","deprecated":false},{"title":"/object-query/payment-schedules","summary":"List payment schedules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentschedules","deprecated":false},{"title":"/object-query/payment-schedules/{key}","summary":"Retrieve a payment schedule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentschedulebykey","deprecated":false},{"title":"/object-query/payment-schedule-items","summary":"List payment schedule items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentscheduleitems","deprecated":false},{"title":"/object-query/payment-schedule-items/{key}","summary":"Retrieve a payment schedule item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querypaymentscheduleitembykey","deprecated":false},{"title":"/object-query/prepaid-balances","summary":"List prepaid balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryprepaidbalances","deprecated":false},{"title":"/object-query/prepaid-balances/{key}","summary":"Retrieve a prepaid balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryprepaidbalancebykey","deprecated":false},{"title":"/object-query/prepaid-balance-funds","summary":"List prepaid balance funds","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryprepaidbalancefunds","deprecated":false},{"title":"/object-query/prepaid-balance-funds/{key}","summary":"Retrieve a prepaid balance fund","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryprepaidbalancefundbykey","deprecated":false},{"title":"/object-query/prepaid-balance-transactions","summary":"List prepaid balance transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryprepaidbalancetransactions","deprecated":false},{"title":"/object-query/prepaid-balance-transactions/{key}","summary":"Retrieve a prepaid balance transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryprepaidbalancetransactionbykey","deprecated":false},{"title":"/object-query/processed-usages","summary":"List processed usage records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryprocessedusages","deprecated":false},{"title":"/object-query/processed-usages/{key}","summary":"Retrieve a processed usage record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryprocessedusagebykey","deprecated":false},{"title":"/object-query/products","summary":"List products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryproducts","deprecated":false},{"title":"/object-query/products/{key}","summary":"Retrieve a product","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryproductbykey","deprecated":false},{"title":"/object-query/product-rate-plans","summary":"List product rate plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryproductrateplans","deprecated":false},{"title":"/object-query/product-rate-plans/{key}","summary":"Retrieve a product rate plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryproductrateplanbykey","deprecated":false},{"title":"/object-query/product-rate-plan-charges","summary":"List product rate plan charges","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryproductrateplancharges","deprecated":false},{"title":"/object-query/product-rate-plan-charges/{key}","summary":"Retrieve a product rate plan charge","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryproductrateplanchargebykey","deprecated":false},{"title":"/object-query/product-rate-plan-charge-tiers","summary":"List product rate plan charge tiers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryproductrateplanchargetiers","deprecated":false},{"title":"/object-query/product-rate-plan-charge-tiers/{key}","summary":"Retrieve a product rate plan charge tier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryproductrateplanchargetierbykey","deprecated":false},{"title":"/object-query/ramps","summary":"List ramps","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryramps","deprecated":false},{"title":"/object-query/ramps/{key}","summary":"Retrieve a ramp","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrampbykey","deprecated":false},{"title":"/object-query/rate-plans","summary":"List rate plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrateplans","deprecated":false},{"title":"/object-query/rate-plans/{key}","summary":"Retrieve a rate plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrateplanbykey","deprecated":false},{"title":"/object-query/rate-plan-charges","summary":"List rate plan charges","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrateplancharges","deprecated":false},{"title":"/object-query/rate-plan-charges/{key}","summary":"Retrieve a rate plan charge","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrateplanchargebykey","deprecated":false},{"title":"/object-query/rate-plan-charge-tiers","summary":"List rate plan charge tiers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrateplanchargetiers","deprecated":false},{"title":"/object-query/rate-plan-charge-tiers/{key}","summary":"Retrieve a rate plan charge tier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrateplanchargetierbykey","deprecated":false},{"title":"/object-query/rating-results","summary":"List rating results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryratingresults","deprecated":false},{"title":"/object-query/rating-results/{key}","summary":"Retrieve a rating result","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryratingresultbykey","deprecated":false},{"title":"/object-query/refunds","summary":"List refunds","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrefunds","deprecated":false},{"title":"/object-query/refunds/{key}","summary":"Retrieve a refund","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrefundbykey","deprecated":false},{"title":"/object-query/refund-applications","summary":"List refund applications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrefundapplications","deprecated":false},{"title":"/object-query/refund-applications/{key}","summary":"Retrieve a refund application","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrefundapplicationbykey","deprecated":false},{"title":"/object-query/refund-application-items","summary":"List refund application items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrefundapplicationitems","deprecated":false},{"title":"/object-query/refund-application-items/{key}","summary":"Retrieve a refund application item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryrefundapplicationitembykey","deprecated":false},{"title":"/object-query/summarystatementruns","summary":"List summary statement runs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/getsummarystatementruns","deprecated":false},{"title":"/object-query/summarystatementruns/{key}","summary":"Retrieve a summary statement run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/getsummarystatementrun","deprecated":false},{"title":"/object-query/summarystatements","summary":"List summary statements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/getsummarystatements","deprecated":false},{"title":"/object-query/summarystatements/{key}","summary":"Retrieve a summary statement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/getsummarystatement","deprecated":false},{"title":"/object-query/subscriptions","summary":"List subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querysubscriptions","deprecated":false},{"title":"/object-query/subscriptions/{key}","summary":"Retrieve a subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querysubscriptionbykey","deprecated":false},{"title":"/object-query/taxation-items","summary":"List taxation items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querytaxationitems","deprecated":false},{"title":"/object-query/taxation-items/{key}","summary":"Retrieve a taxation item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querytaxationitembykey","deprecated":false},{"title":"/object-query/usages","summary":"List usage records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryusages","deprecated":false},{"title":"/object-query/usages/{key}","summary":"Retrieve a usage record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryusagebykey","deprecated":false},{"title":"/object-query/validity-period-summaries","summary":"List validity period summaries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryvalidityperiodsummarys","deprecated":false},{"title":"/object-query/validity-period-summaries/{key}","summary":"Retrieve a validity period summary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryvalidityperiodsummarybykey","deprecated":false},{"title":"/object-query/{custom-object-name}","summary":"List custom object records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycustomobjects","deprecated":false},{"title":"/object-query/{custom-object-name}/{key}","summary":"Retrieve a custom object record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycustomobjectbykey","deprecated":false},{"title":"/object-query/contact-snapshots","summary":"List contact snapshots","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycontactsnapshots","deprecated":false},{"title":"/object-query/contact-snapshots/{key}","summary":"Retrieve a contact snapshot","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/querycontactsnapshotbykey","deprecated":false},{"title":"/object-query/rating-details","summary":"List rating details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryratingdetails","deprecated":false},{"title":"/object-query/rating-details/{key}","summary":"Retrieve a rating detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/object-queries/queryratingdetailbykey","deprecated":false}]}]}]}]}},{"type":"separator","label":"Finance","content":null},{"type":"group","label":"Accounting Codes","link":"/v1-api-reference/api/accounting-codes","routeSlug":"/v1-api-reference/api/accounting-codes","items":[{"label":"List all accounting codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/get_allaccountingcodes","routeSlug":"/v1-api-reference/api/accounting-codes/get_allaccountingcodes","metadata":{"seo":{"title":"List all accounting codes","description":"This reference describes how to query all accounting codes in your chart of accounts through the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AllAccountingCodes","name":"List all accounting codes","isWebhook":false,"pointer":"/paths/~1v1~1accounting-codes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all accounting codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This reference describes how to query all accounting codes in your chart of accounts through the REST API."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_202","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1accounting-codes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-codes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting-codes","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_202"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-codes","href":"accounting-codes/get_allaccountingcodes","openApiOperationId":"GET_AllAccountingCodes","summary":"List all accounting codes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountingCodesType","exampleIds":["paths/~1v1~1accounting-codes/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAccountingCodesType","exampleIds":["paths/~1v1~1accounting-codes/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-codes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAccountingCodesType","exampleIds":["paths/~1v1~1accounting-codes/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountingCodesType","exampleIds":["paths/~1v1~1accounting-codes/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-codes/get_allaccountingcodes"}],"panels":[]}]},"httpPath":"/v1/accounting-codes"},{"label":"Create an accounting code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/post_accountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/post_accountingcode","metadata":{"seo":{"title":"Create an accounting code","description":"This reference describes how to create a new accounting code through the REST API.The accounting code will be active as soon as it has been created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_AccountingCode","name":"Create an accounting code","isWebhook":false,"pointer":"/paths/~1v1~1accounting-codes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an accounting code","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":"This reference describes how to create a new accounting code through the REST API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code will be active as soon as it has been created."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounting-codes/post_accountingcode/request/prerequisites","deepLinkHash":"/accounting-codes/post_accountingcode#accounting-codes/post_accountingcode/request/prerequisites"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have Zuora Finance enabled on your tenant, you must have the  Configure Accounting Codes permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-codes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTAccountingCodeType"}},"schemaId":"components/schemas/POSTAccountingCodeType","pointer":"/paths/~1v1~1accounting-codes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting-codes","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTAccountingCodeType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-codes","href":"accounting-codes/post_accountingcode","openApiOperationId":"POST_AccountingCode","summary":"Create an accounting code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTAccountingCodeType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTAccountingCodeType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTAccountingCodeResponseType","exampleIds":["paths/~1v1~1accounting-codes/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTAccountingCodeResponseType","exampleIds":["paths/~1v1~1accounting-codes/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-codes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTAccountingCodeResponseType","exampleIds":["paths/~1v1~1accounting-codes/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTAccountingCodeResponseType","exampleIds":["paths/~1v1~1accounting-codes/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-codes/post_accountingcode"}],"panels":[]}]},"httpPath":"/v1/accounting-codes"},{"label":"Delete an accounting code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/delete_accountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/delete_accountingcode","metadata":{"seo":{"title":"Delete an accounting code","description":"This reference describes how to delete an accounting code through the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_AccountingCode","name":"Delete an accounting code","isWebhook":false,"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an accounting code","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":"This reference describes how to delete an accounting code through the REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounting-codes/delete_accountingcode/request/prerequisites","deepLinkHash":"/accounting-codes/delete_accountingcode#accounting-codes/delete_accountingcode/request/prerequisites"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have Zuora Finance enabled on your tenant, then you must have the Delete Unused Accounting Code permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounting-codes/delete_accountingcode/request/limitations","deepLinkHash":"/accounting-codes/delete_accountingcode#accounting-codes/delete_accountingcode/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only delete accounting codes that have never been associated with any transactions. An accounting code must be deactivated before you can delete it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ac-id","in":"path","schemaId":"schema_5","description":"ID of the accounting code you want to delete.","required":true}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/accounting-codes/{ac-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ac-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-codes/{ac-id}","href":"accounting-codes/delete_accountingcode","openApiOperationId":"DELETE_AccountingCode","summary":"Delete an accounting code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-codes/delete_accountingcode"}],"panels":[]}]},"httpPath":"/v1/accounting-codes/{ac-id}"},{"label":"Retrieve an accounting code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/get_accountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/get_accountingcode","metadata":{"seo":{"title":"Retrieve an accounting code","description":"This reference describes how to query an accounting code through the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AccountingCode","name":"Retrieve an accounting code","isWebhook":false,"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an accounting code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This reference describes how to query an accounting code through the REST API."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ac-id","in":"path","schemaId":"schema_5","description":"ID of the accounting code you want to query.","required":true}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting-codes/{ac-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ac-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-codes/{ac-id}","href":"accounting-codes/get_accountingcode","openApiOperationId":"GET_AccountingCode","summary":"Retrieve an accounting code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountingCodeItemType","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAccountingCodeItemType","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAccountingCodeItemType","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountingCodeItemType","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-codes/get_accountingcode"}],"panels":[]}]},"httpPath":"/v1/accounting-codes/{ac-id}"},{"label":"Update an accounting code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/put_accountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/put_accountingcode","metadata":{"seo":{"title":"Update an accounting code","description":"This reference describes how to update an existing accounting code through the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_AccountingCode","name":"Update an accounting code","isWebhook":false,"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an accounting code","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":"This reference describes how to update an existing accounting code through the REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounting-codes/put_accountingcode/request/prerequisites","deepLinkHash":"/accounting-codes/put_accountingcode#accounting-codes/put_accountingcode/request/prerequisites"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have Zuora Finance enabled on your tenant, you must have the  Manage Accounting Code permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounting-codes/put_accountingcode/request/limitations","deepLinkHash":"/accounting-codes/put_accountingcode#accounting-codes/put_accountingcode/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only update accounting codes that are not already associated with any transactions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ac-id","in":"path","schemaId":"schema_5","description":"ID of the accounting code you want to update.","required":true}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTAccountingCodeType"}},"schemaId":"components/schemas/PUTAccountingCodeType","pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounting-codes/{ac-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ac-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTAccountingCodeType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-codes/{ac-id}","href":"accounting-codes/put_accountingcode","openApiOperationId":"PUT_AccountingCode","summary":"Update an accounting code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTAccountingCodeType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTAccountingCodeType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-codes/put_accountingcode"}],"panels":[]}]},"httpPath":"/v1/accounting-codes/{ac-id}"},{"label":"Activate an accounting code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/put_activateaccountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/put_activateaccountingcode","metadata":{"seo":{"title":"Activate an accounting code","description":"This reference describes how to activate an accounting code through the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_ActivateAccountingCode","name":"Activate an accounting code","isWebhook":false,"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}~1activate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate an accounting code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This reference describes how to activate an accounting code through the REST API.\n\nPrerequisites\n-------------\nIf you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ac-id","in":"path","schemaId":"schema_5","description":"ID of the accounting code you want to activate.","required":true}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounting-codes/{ac-id}/activate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ac-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-codes/{ac-id}/activate","href":"accounting-codes/put_activateaccountingcode","openApiOperationId":"PUT_ActivateAccountingCode","summary":"Activate an accounting code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-codes/put_activateaccountingcode"}],"panels":[]}]},"httpPath":"/v1/accounting-codes/{ac-id}/activate"},{"label":"Deactivate an accounting code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-codes/put_deactivateaccountingcode","routeSlug":"/v1-api-reference/api/accounting-codes/put_deactivateaccountingcode","metadata":{"seo":{"title":"Deactivate an accounting code","description":"This reference describes how to deactivate an accounting code through the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_DeactivateAccountingCode","name":"Deactivate an accounting code","isWebhook":false,"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate an accounting code","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":"This reference describes how to deactivate an accounting code through the REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounting-codes/put_deactivateaccountingcode/request/prerequisites","deepLinkHash":"/accounting-codes/put_deactivateaccountingcode#accounting-codes/put_deactivateaccountingcode/request/prerequisites"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounting-codes/put_deactivateaccountingcode/request/limitations","deepLinkHash":"/accounting-codes/put_deactivateaccountingcode#accounting-codes/put_deactivateaccountingcode/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only deactivate accounting codes that are not associated with any transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot disable accounting codes of type AccountsReceivable."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ac-id","in":"path","schemaId":"schema_5","description":"ID of the accounting code you want to deactivate.","required":true}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounting-codes/{ac-id}/deactivate","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ac-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-codes/{ac-id}/deactivate","href":"accounting-codes/put_deactivateaccountingcode","openApiOperationId":"PUT_DeactivateAccountingCode","summary":"Deactivate an accounting code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-codes/put_deactivateaccountingcode"}],"panels":[]}]},"httpPath":"/v1/accounting-codes/{ac-id}/deactivate"}],"content":{"contentType":"group","meta":{"name":"Accounting Codes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounting Codes","showPageActions":true},{"nodeType":"markdoc","content":"Accounting Codes are commonly referred to as General Ledger Accounts or General Ledger Account Codes. In Zuora, the use of accounting codes are optional but recommended. \n\nThis section contains the operations that allow you to create, update, get, delete, activate, or deactivate accounting codes in Zuora."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/accounting-codes","summary":"List all accounting codes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounting-codes/get_allaccountingcodes","deprecated":false},{"title":"/v1/accounting-codes","summary":"Create an accounting code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounting-codes/post_accountingcode","deprecated":false},{"title":"/v1/accounting-codes/{ac-id}","summary":"Delete an accounting code","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/accounting-codes/delete_accountingcode","deprecated":false},{"title":"/v1/accounting-codes/{ac-id}","summary":"Retrieve an accounting code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounting-codes/get_accountingcode","deprecated":false},{"title":"/v1/accounting-codes/{ac-id}","summary":"Update an accounting code","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounting-codes/put_accountingcode","deprecated":false},{"title":"/v1/accounting-codes/{ac-id}/activate","summary":"Activate an accounting code","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounting-codes/put_activateaccountingcode","deprecated":false},{"title":"/v1/accounting-codes/{ac-id}/deactivate","summary":"Deactivate an accounting code","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounting-codes/put_deactivateaccountingcode","deprecated":false}]}]}]}]}},{"type":"group","label":"Accounting Periods","link":"/v1-api-reference/api/accounting-periods","routeSlug":"/v1-api-reference/api/accounting-periods","items":[{"label":"List all accounting periods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/get_allaccountingperiods","routeSlug":"/v1-api-reference/api/accounting-periods/get_allaccountingperiods","metadata":{"seo":{"title":"List all accounting periods","description":"Retrieves all accounting periods on your tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AllAccountingPeriods","name":"List all accounting periods","isWebhook":false,"pointer":"/paths/~1v1~1accounting-periods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all accounting periods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all accounting periods on your tenant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_202","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1accounting-periods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-periods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting-periods","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_202"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-periods","href":"accounting-periods/get_allaccountingperiods","openApiOperationId":"GET_AllAccountingPeriods","summary":"List all accounting periods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountingPeriodsType","exampleIds":["paths/~1v1~1accounting-periods/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAccountingPeriodsType","exampleIds":["paths/~1v1~1accounting-periods/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-periods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAccountingPeriodsType","exampleIds":["paths/~1v1~1accounting-periods/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountingPeriodsType","exampleIds":["paths/~1v1~1accounting-periods/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-periods/get_allaccountingperiods"}],"panels":[]}]},"httpPath":"/v1/accounting-periods"},{"label":"Create an accounting period","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/post_accountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/post_accountingperiod","metadata":{"seo":{"title":"Create an accounting period","description":"Creates an accounting period.Prerequisites"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_AccountingPeriod","name":"Create an accounting period","isWebhook":false,"pointer":"/paths/~1v1~1accounting-periods/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an accounting period","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 accounting period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"You must have Zuora Finance enabled on your tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must have the Create Accounting Period user permission."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"When creating the first accounting period on your tenant, the start date must be equal to or earlier than the date of the earliest transaction on the tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period must start on February 1."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Revenue Recognition Package and have enabled the \"Monthly recognition over time\" revenue recognition model, the accounting period start date and end date must be on the first day and last day of the month, respectively. Note that the start and end dates do not necessarily have to be in the same month."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-periods/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTAccountingPeriodType"}},"schemaId":"components/schemas/POSTAccountingPeriodType","pointer":"/paths/~1v1~1accounting-periods/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting-periods","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTAccountingPeriodType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-periods","href":"accounting-periods/post_accountingperiod","openApiOperationId":"POST_AccountingPeriod","summary":"Create an accounting period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTAccountingPeriodType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTAccountingPeriodType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTAccountingPeriodResponseType","exampleIds":["paths/~1v1~1accounting-periods/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTAccountingPeriodResponseType","exampleIds":["paths/~1v1~1accounting-periods/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-periods/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTAccountingPeriodResponseType","exampleIds":["paths/~1v1~1accounting-periods/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTAccountingPeriodResponseType","exampleIds":["paths/~1v1~1accounting-periods/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-periods/post_accountingperiod"}],"panels":[]}]},"httpPath":"/v1/accounting-periods"},{"label":"Delete an accounting period","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/delete_accountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/delete_accountingperiod","metadata":{"seo":{"title":"Delete an accounting period","description":"Deletes an accounting period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_AccountingPeriod","name":"Delete an accounting period","isWebhook":false,"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an accounting period","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 an accounting period."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounting-periods/delete_accountingperiod/request/prerequisites","deepLinkHash":"/accounting-periods/delete_accountingperiod#accounting-periods/delete_accountingperiod/request/prerequisites"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"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":"You must have Zuora Finance enabled on your tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must have the Delete Accounting Period user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-finance-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finance Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"accounting-periods/delete_accountingperiod/request/limitations","deepLinkHash":"/accounting-periods/delete_accountingperiod#accounting-periods/delete_accountingperiod/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting period to be deleted:"},"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":"Must be the most recent accounting period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be an open accounting period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must have no revenue distributed into it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must not have any active journal entries."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must not be the open-ended accounting period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must not be in the process of running a trial balance."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ap-id","in":"path","schemaId":"schema_5","description":"ID of the accounting period you want to delete.","required":true}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/accounting-periods/{ap-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ap-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-periods/{ap-id}","href":"accounting-periods/delete_accountingperiod","openApiOperationId":"DELETE_AccountingPeriod","summary":"Delete an accounting period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-periods/delete_accountingperiod"}],"panels":[]}]},"httpPath":"/v1/accounting-periods/{ap-id}"},{"label":"Retrieve an accounting period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/get_accountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/get_accountingperiod","metadata":{"seo":{"title":"Retrieve an accounting period","description":"Retrieves an accounting period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AccountingPeriod","name":"Retrieve an accounting period","isWebhook":false,"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an accounting period","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 accounting period."},"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":"Prerequisites"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You must have Zuora Finance enabled on your tenant."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ap-id","in":"path","schemaId":"schema_5","description":"ID of the accounting period you want to get.","required":true}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting-periods/{ap-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ap-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-periods/{ap-id}","href":"accounting-periods/get_accountingperiod","openApiOperationId":"GET_AccountingPeriod","summary":"Retrieve an accounting period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountingPeriodType","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAccountingPeriodType","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAccountingPeriodType","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAccountingPeriodType","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-periods/get_accountingperiod"}],"panels":[]}]},"httpPath":"/v1/accounting-periods/{ap-id}"},{"label":"Update an accounting period","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/put_updateaccountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/put_updateaccountingperiod","metadata":{"seo":{"title":"Update an accounting period","description":"Updates an accounting period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateAccountingPeriod","name":"Update an accounting period","isWebhook":false,"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an accounting period","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 an accounting period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"You must have Zuora Finance enabled on your tenant."},"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":"You must have the Create Accounting Period user permission. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-finance-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finance Roles"},"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":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"You can update the start date of only the earliest accounting period on your tenant. You cannot update the start date of later periods."},"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":"If you update the earliest accounting period, the start date must be equal to or earlier than the date of the earliest transaction on the tenant."},"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":"Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period must start on February 1."},"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":"If you have the Revenue Recognition Package and have enabled the \"Monthly recognition over time\" revenue recognition model, the accounting period start date and end date must be on the first day and last day of the month, respectively. Note that the start and end dates do not necessarily have to be in the same month."},"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":"You cannot update the start date or end date of an accounting period if:"},"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":"Any revenue has been distributed into the period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period has any active journal entries."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ap-id","in":"path","schemaId":"schema_5","description":"ID of the accounting period you want to update.","required":true}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTAccountingPeriodType"}},"schemaId":"components/schemas/PUTAccountingPeriodType","pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounting-periods/{ap-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ap-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTAccountingPeriodType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-periods/{ap-id}","href":"accounting-periods/put_updateaccountingperiod","openApiOperationId":"PUT_UpdateAccountingPeriod","summary":"Update an accounting period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTAccountingPeriodType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTAccountingPeriodType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-periods/put_updateaccountingperiod"}],"panels":[]}]},"httpPath":"/v1/accounting-periods/{ap-id}"},{"label":"Close an accounting period","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/put_closeaccountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/put_closeaccountingperiod","metadata":{"seo":{"title":"Close an accounting period","description":"Close an accounting period by accounting period ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CloseAccountingPeriod","name":"Close an accounting period","isWebhook":false,"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1close/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close an accounting period","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":"Close an accounting period by accounting period ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must have Zuora Finance enabled on your tenant. You must have the Manage Close Process and Run Trial Balance user permissions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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 accounting period cannot already be closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting period cannot be in the process of running a trial balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All earlier accounting periods must be closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There must be no required action items for the accounting period. See Reconcile Transactions Before Closing an Accounting Period for more information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you close an accounting period in Zuora, a trial balance is automatically run for that period. A successful response means only that the accounting period is now closed, but does not mean that the trial balance has successfully completed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ap-id","in":"path","schemaId":"schema_5","description":"ID of the accounting period you want to close.","required":true}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1close/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1close/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounting-periods/{ap-id}/close","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ap-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-periods/{ap-id}/close","href":"accounting-periods/put_closeaccountingperiod","openApiOperationId":"PUT_CloseAccountingPeriod","summary":"Close an accounting period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-periods/put_closeaccountingperiod"}],"panels":[]}]},"httpPath":"/v1/accounting-periods/{ap-id}/close"},{"label":"Set an accounting period to pending close","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/put_pendingcloseaccountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/put_pendingcloseaccountingperiod","metadata":{"seo":{"title":"Set an accounting period to pending close","description":"Sets an accounting period to pending close."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_PendingCloseAccountingPeriod","name":"Set an accounting period to pending close","isWebhook":false,"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set an accounting period to pending close","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":"Sets an accounting period to pending close."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"You must have Zuora Finance enabled on your tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must have the Manage Close Process and Run Trial Balance user permissions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"The accounting period cannot be closed or pending close."},"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":"The accounting period cannot be in the process of running a trial balance."},"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":"All earlier accounting periods must be closed."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you set an accounting period to pending close in Zuora, a trial balance is automatically run for that period. A response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"success\": true }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  means only that the accounting period status is now pending close, but does not mean that the trial balance has successfully completed. You can use the Get Accounting Period REST API call to view details about the outcome of the trial balance."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ap-id","in":"path","schemaId":"schema_5","description":"ID of the accounting period you want to set to pending close.","required":true}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounting-periods/{ap-id}/pending-close","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ap-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-periods/{ap-id}/pending-close","href":"accounting-periods/put_pendingcloseaccountingperiod","openApiOperationId":"PUT_PendingCloseAccountingPeriod","summary":"Set an accounting period to pending close"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-periods/put_pendingcloseaccountingperiod"}],"panels":[]}]},"httpPath":"/v1/accounting-periods/{ap-id}/pending-close"},{"label":"Reopen an accounting period","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/put_reopenaccountingperiod","routeSlug":"/v1-api-reference/api/accounting-periods/put_reopenaccountingperiod","metadata":{"seo":{"title":"Reopen an accounting period","description":"Re-opens an accounting period.Prerequisites"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_ReopenAccountingPeriod","name":"Reopen an accounting period","isWebhook":false,"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reopen an accounting period","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":"Re-opens an accounting period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"You must have Zuora Finance enabled on your tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must have the Manage Close Process and Run Trial Balance user permissions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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 accounting period must be closed or pending close."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only re-open an accounting period that is immediately previous to an open period."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ap-id","in":"path","schemaId":"schema_5","description":"ID of the accounting period that you want to re-open.","required":true}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounting-periods/{ap-id}/reopen","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ap-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-periods/{ap-id}/reopen","href":"accounting-periods/put_reopenaccountingperiod","openApiOperationId":"PUT_ReopenAccountingPeriod","summary":"Reopen an accounting period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-periods/put_reopenaccountingperiod"}],"panels":[]}]},"httpPath":"/v1/accounting-periods/{ap-id}/reopen"},{"label":"Run trial balance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/accounting-periods/put_runtrialbalance","routeSlug":"/v1-api-reference/api/accounting-periods/put_runtrialbalance","metadata":{"seo":{"title":"Run trial balance","description":"Runs the trial balance for an accounting period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_RunTrialBalance","name":"Run trial balance","isWebhook":false,"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run trial balance","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":"Runs the trial balance for an accounting period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"You must have Zuora Finance enabled on your tenant."},"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":"You must have the Manage Close Process and Run Trial Balance user permissions. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-finance-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finance Roles"},"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":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"The accounting period must be open."},"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":"The accounting period cannot already be in the process of running a trial balance."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The trial balance is run asynchronously. A response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"success\": true }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means only that the trial balance has started processing, but does not mean that the trial balance has successfully completed. You can use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_AccountingPeriod"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Accounting Period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" REST API call to view details about the outcome of the trial balance."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ap-id","in":"path","schemaId":"schema_5","description":"ID of the accounting period for which you want to run a trial balance.","required":true}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounting-periods/{ap-id}/run-trial-balance","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"ap-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/accounting-periods/{ap-id}/run-trial-balance","href":"accounting-periods/put_runtrialbalance","openApiOperationId":"PUT_RunTrialBalance","summary":"Run trial balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-periods/put_runtrialbalance"}],"panels":[]}]},"httpPath":"/v1/accounting-periods/{ap-id}/run-trial-balance"}],"content":{"contentType":"group","meta":{"name":"Accounting Periods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounting Periods","showPageActions":true},{"nodeType":"markdoc","content":"A key step in configuring Finance is to create accounting periods in Zuora to match your company's financial calendar. \nThis allows Zuora to produce reports and data exports organized by accounting periods, and to perform the work of closing the accounting periods for the revenue sub-ledger."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/accounting-periods","summary":"List all accounting periods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounting-periods/get_allaccountingperiods","deprecated":false},{"title":"/v1/accounting-periods","summary":"Create an accounting period","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounting-periods/post_accountingperiod","deprecated":false},{"title":"/v1/accounting-periods/{ap-id}","summary":"Delete an accounting period","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/accounting-periods/delete_accountingperiod","deprecated":false},{"title":"/v1/accounting-periods/{ap-id}","summary":"Retrieve an accounting period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounting-periods/get_accountingperiod","deprecated":false},{"title":"/v1/accounting-periods/{ap-id}","summary":"Update an accounting period","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounting-periods/put_updateaccountingperiod","deprecated":false},{"title":"/v1/accounting-periods/{ap-id}/close","summary":"Close an accounting period","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounting-periods/put_closeaccountingperiod","deprecated":false},{"title":"/v1/accounting-periods/{ap-id}/pending-close","summary":"Set an accounting period to pending close","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounting-periods/put_pendingcloseaccountingperiod","deprecated":false},{"title":"/v1/accounting-periods/{ap-id}/reopen","summary":"Reopen an accounting period","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounting-periods/put_reopenaccountingperiod","deprecated":false},{"title":"/v1/accounting-periods/{ap-id}/run-trial-balance","summary":"Run trial balance","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounting-periods/put_runtrialbalance","deprecated":false}]}]}]}]}},{"type":"group","label":"Summary Journal Entries","link":"/v1-api-reference/api/summary-journal-entries","routeSlug":"/v1-api-reference/api/summary-journal-entries","items":[{"label":"Create a summary journal entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/post_summaryjournalentry","routeSlug":"/v1-api-reference/api/summary-journal-entries/post_summaryjournalentry","metadata":{"seo":{"title":"Create a summary journal entry","description":"This REST API reference describes how to manually create a summary journal entry. Request and response field descriptions and sample code are provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_SummaryJournalEntry","name":"Create a summary journal entry","isWebhook":false,"pointer":"/paths/~1v1~1journal-entries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a summary journal entry","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":"This REST API reference describes how to manually create a summary journal entry. Request and response field descriptions and sample code are provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"summary-journal-entries/post_summaryjournalentry/request/requirements","deepLinkHash":"/summary-journal-entries/post_summaryjournalentry#summary-journal-entries/post_summaryjournalentry/request/requirements"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.The sum of debits must equal the sum of credits in the summary journal entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.The following applies only if you use foreign currency conversion:"},"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 you have configured Aggregate transactions with different currencies during a Journal Run to \"Yes\", the value of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be the same as your tenant's home currency. That is, you must create journal entries using your home currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All journal entries in an accounting period must either all be aggregated or all be unaggregated. You cannot have a mix of aggregated and unaggregated journal entries in the same accounting period."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1journal-entries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTJournalEntryType"}},"schemaId":"components/schemas/POSTJournalEntryType","pointer":"/paths/~1v1~1journal-entries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/journal-entries","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTJournalEntryType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/journal-entries","href":"summary-journal-entries/post_summaryjournalentry","openApiOperationId":"POST_SummaryJournalEntry","summary":"Create a summary journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTJournalEntryType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTJournalEntryType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTJournalEntryResponseType","exampleIds":["paths/~1v1~1journal-entries/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTJournalEntryResponseType","exampleIds":["paths/~1v1~1journal-entries/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1journal-entries/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTJournalEntryResponseType","exampleIds":["paths/~1v1~1journal-entries/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTJournalEntryResponseType","exampleIds":["paths/~1v1~1journal-entries/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/summary-journal-entries/post_summaryjournalentry"}],"panels":[]}]},"httpPath":"/v1/journal-entries"},{"label":"List all summary journal entries in a journal run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/get_allsummaryjournalentries","routeSlug":"/v1-api-reference/api/summary-journal-entries/get_allsummaryjournalentries","metadata":{"seo":{"title":"List all summary journal entries in a journal run","description":"This REST API reference describes how to retrieve information about all summary journal entries in a journal run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AllSummaryJournalEntries","name":"List all summary journal entries in a journal run","isWebhook":false,"pointer":"/paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all summary journal entries in a journal run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\nThis REST API reference describes how to retrieve information about all summary journal entries in a journal run.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jr-number","in":"path","schemaId":"schema_5","description":"Journal run number.","required":true}],"pointer":"/paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_203","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/journal-entries/journal-runs/{jr-number}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jr-number","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_203"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/journal-entries/journal-runs/{jr-number}","href":"summary-journal-entries/get_allsummaryjournalentries","openApiOperationId":"GET_AllSummaryJournalEntries","summary":"List all summary journal entries in a journal run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETJournalEntriesInJournalRunType","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETJournalEntriesInJournalRunType","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETJournalEntriesInJournalRunType","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETJournalEntriesInJournalRunType","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/summary-journal-entries/get_allsummaryjournalentries"}],"panels":[]}]},"httpPath":"/v1/journal-entries/journal-runs/{jr-number}"},{"label":"Delete a summary journal entry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/delete_summaryjournalentry","routeSlug":"/v1-api-reference/api/summary-journal-entries/delete_summaryjournalentry","metadata":{"seo":{"title":"Delete a summary journal entry","description":"This reference describes how to delete a summary journal entry using the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_SummaryJournalEntry","name":"Delete a summary journal entry","isWebhook":false,"pointer":"/paths/~1v1~1journal-entries~1{je-number}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a summary journal entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This reference describes how to delete a summary journal entry using the REST API.\n\nYou must have the \"Delete Cancelled Journal Entry\" user permission enabled to delete summary journal entries.\n\nA summary journal entry must be canceled before it can be deleted.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"je-number","in":"path","schemaId":"schema_5","description":"Journal entry number in the format JE-00000001.","required":true}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/journal-entries/{je-number}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"je-number","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/journal-entries/{je-number}","href":"summary-journal-entries/delete_summaryjournalentry","openApiOperationId":"DELETE_SummaryJournalEntry","summary":"Delete a summary journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/summary-journal-entries/delete_summaryjournalentry"}],"panels":[]}]},"httpPath":"/v1/journal-entries/{je-number}"},{"label":"Retrieve a summary journal entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/get_summaryjournalentry","routeSlug":"/v1-api-reference/api/summary-journal-entries/get_summaryjournalentry","metadata":{"seo":{"title":"Retrieve a summary journal entry","description":"This REST API reference describes how to get information about a summary journal entry by its journal entry number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_SummaryJournalEntry","name":"Retrieve a summary journal entry","isWebhook":false,"pointer":"/paths/~1v1~1journal-entries~1{je-number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a summary journal entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This REST API reference describes how to get information about a summary journal entry by its journal entry number.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"je-number","in":"path","schemaId":"schema_5","description":"","required":true}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/journal-entries/{je-number}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"je-number","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/journal-entries/{je-number}","href":"summary-journal-entries/get_summaryjournalentry","openApiOperationId":"GET_SummaryJournalEntry","summary":"Retrieve a summary journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETJournalEntryDetailType","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETJournalEntryDetailType","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETJournalEntryDetailType","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETJournalEntryDetailType","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/summary-journal-entries/get_summaryjournalentry"}],"panels":[]}]},"httpPath":"/v1/journal-entries/{je-number}"},{"label":"Update a summary journal entry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/put_basicsummaryjournalentry","routeSlug":"/v1-api-reference/api/summary-journal-entries/put_basicsummaryjournalentry","metadata":{"seo":{"title":"Update a summary journal entry","description":"This REST API reference describes how to update the basic information of a summary journal entry. Request and response field descriptions and sample code are provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_BasicSummaryJournalEntry","name":"Update a summary journal entry","isWebhook":false,"pointer":"/paths/~1v1~1journal-entries~1{je-number}~1basic-information/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a summary journal entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\nThis REST API reference describes how to update the basic information of a summary journal entry. Request and response field descriptions and sample code are provided.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"je-number","in":"path","schemaId":"schema_5","description":"Journal entry number in the format JE-00000001.","required":true}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTBasicSummaryJournalEntryType"}},"schemaId":"components/schemas/PUTBasicSummaryJournalEntryType","pointer":"/paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/journal-entries/{je-number}/basic-information","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"je-number","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTBasicSummaryJournalEntryType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/journal-entries/{je-number}/basic-information","href":"summary-journal-entries/put_basicsummaryjournalentry","openApiOperationId":"PUT_BasicSummaryJournalEntry","summary":"Update a summary journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTBasicSummaryJournalEntryType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTBasicSummaryJournalEntryType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/summary-journal-entries/put_basicsummaryjournalentry"}],"panels":[]}]},"httpPath":"/v1/journal-entries/{je-number}/basic-information"},{"label":"Cancel a summary journal entry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/summary-journal-entries/put_summaryjournalentry","routeSlug":"/v1-api-reference/api/summary-journal-entries/put_summaryjournalentry","metadata":{"seo":{"title":"Cancel a summary journal entry","description":"This reference describes how to cancel a summary journal entry using the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_SummaryJournalEntry","name":"Cancel a summary journal entry","isWebhook":false,"pointer":"/paths/~1v1~1journal-entries~1{je-number}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a summary journal entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\nThis reference describes how to cancel a summary journal entry using the REST API.\n    \nYou must have the \"Cancel Journal Entry\" user permission enabled to cancel summary journal entries.\n    \nA summary journal entry cannot be canceled if its Transferred to Accounting status is \"Yes\" or \"Processing\".\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"je-number","in":"path","schemaId":"schema_5","description":"Journal entry number in the format JE-00000001.","required":true}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/journal-entries/{je-number}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"je-number","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/journal-entries/{je-number}/cancel","href":"summary-journal-entries/put_summaryjournalentry","openApiOperationId":"PUT_SummaryJournalEntry","summary":"Cancel a summary journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/summary-journal-entries/put_summaryjournalentry"}],"panels":[]}]},"httpPath":"/v1/journal-entries/{je-number}/cancel"}],"content":{"contentType":"group","meta":{"name":"Summary Journal Entries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Summary Journal Entries","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":"A summary journal entry is a summary of Zuora transaction amounts organized by accounting code and general ledger segments. A segment adds more reporting granularity through business dimensions, such as country or product."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/accounts-receivable/finance/summary-journal-entries/summary-journal-entries-introduction","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Summary Journal Entries Introduction"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/journal-entries","summary":"Create a summary journal entry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/summary-journal-entries/post_summaryjournalentry","deprecated":false},{"title":"/v1/journal-entries/journal-runs/{jr-number}","summary":"List all summary journal entries in a journal run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/summary-journal-entries/get_allsummaryjournalentries","deprecated":false},{"title":"/v1/journal-entries/{je-number}","summary":"Delete a summary journal entry","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/summary-journal-entries/delete_summaryjournalentry","deprecated":false},{"title":"/v1/journal-entries/{je-number}","summary":"Retrieve a summary journal entry","prefix":{"name":"get","color":"get"},"badges":[],"link":"/summary-journal-entries/get_summaryjournalentry","deprecated":false},{"title":"/v1/journal-entries/{je-number}/basic-information","summary":"Update a summary journal entry","prefix":{"name":"put","color":"put"},"badges":[],"link":"/summary-journal-entries/put_basicsummaryjournalentry","deprecated":false},{"title":"/v1/journal-entries/{je-number}/cancel","summary":"Cancel a summary journal entry","prefix":{"name":"put","color":"put"},"badges":[],"link":"/summary-journal-entries/put_summaryjournalentry","deprecated":false}]}]}]}]}},{"type":"group","label":"Journal Runs","link":"/v1-api-reference/api/journal-runs","routeSlug":"/v1-api-reference/api/journal-runs","items":[{"label":"Create a journal run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/journal-runs/post_journalrun","routeSlug":"/v1-api-reference/api/journal-runs/post_journalrun","metadata":{"seo":{"title":"Create a journal run","description":"This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_JournalRun","name":"Create a journal run","isWebhook":false,"pointer":"/paths/~1v1~1journal-runs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a journal run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1journal-runs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTJournalRunType"}},"schemaId":"components/schemas/POSTJournalRunType","pointer":"/paths/~1v1~1journal-runs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/journal-runs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTJournalRunType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/journal-runs","href":"journal-runs/post_journalrun","openApiOperationId":"POST_JournalRun","summary":"Create a journal run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTJournalRunType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTJournalRunType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTJournalRunResponseType","exampleIds":["paths/~1v1~1journal-runs/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTJournalRunResponseType","exampleIds":["paths/~1v1~1journal-runs/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1journal-runs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTJournalRunResponseType","exampleIds":["paths/~1v1~1journal-runs/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTJournalRunResponseType","exampleIds":["paths/~1v1~1journal-runs/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-runs/post_journalrun"}],"panels":[]}]},"httpPath":"/v1/journal-runs"},{"label":"Delete a journal run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/journal-runs/delete_journalrun","routeSlug":"/v1-api-reference/api/journal-runs/delete_journalrun","metadata":{"seo":{"title":"Delete a journal run","description":"This reference describes how to delete a journal run using the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_JournalRun","name":"Delete a journal run","isWebhook":false,"pointer":"/paths/~1v1~1journal-runs~1{jr-number}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a journal run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This reference describes how to delete a journal run using the REST API.\n                      \n You can only delete journal runs that have already been canceled.\n                      \n You must have the \"Delete Cancelled Journal Run\" Zuora Finance user permission enabled to delete journal runs.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jr-number","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal run number. Must be a valid journal run number in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JR-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1journal-runs~1{jr-number}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1journal-runs~1{jr-number}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/journal-runs/{jr-number}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jr-number","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/journal-runs/{jr-number}","href":"journal-runs/delete_journalrun","openApiOperationId":"DELETE_JournalRun","summary":"Delete a journal run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1journal-runs~1{jr-number}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-runs/delete_journalrun"}],"panels":[]}]},"httpPath":"/v1/journal-runs/{jr-number}"},{"label":"Retrieve a journal run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/journal-runs/get_journalrun","routeSlug":"/v1-api-reference/api/journal-runs/get_journalrun","metadata":{"seo":{"title":"Retrieve a journal run","description":"This REST API reference describes how to get information about a journal run. Request and response field descriptions and sample code are provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_JournalRun","name":"Retrieve a journal run","isWebhook":false,"pointer":"/paths/~1v1~1journal-runs~1{jr-number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a journal run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This REST API reference describes how to get information about a journal run. Request and response field descriptions and sample code are provided.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jr-number","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal run number. Must be a valid journal run number in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JR-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1journal-runs~1{jr-number}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1journal-runs~1{jr-number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/journal-runs/{jr-number}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jr-number","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/journal-runs/{jr-number}","href":"journal-runs/get_journalrun","openApiOperationId":"GET_JournalRun","summary":"Retrieve a journal run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETJournalRunType","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETJournalRunType","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1journal-runs~1{jr-number}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETJournalRunType","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETJournalRunType","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-runs/get_journalrun"}],"panels":[]}]},"httpPath":"/v1/journal-runs/{jr-number}"},{"label":"Cancel a journal run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/journal-runs/put_journalrun","routeSlug":"/v1-api-reference/api/journal-runs/put_journalrun","metadata":{"seo":{"title":"Cancel a journal run","description":"This reference describes how to cancel a journal run using the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_JournalRun","name":"Cancel a journal run","isWebhook":false,"pointer":"/paths/~1v1~1journal-runs~1{jr-number}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a journal run","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":"This reference describes how to cancel a journal run using the REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The summary journal entries in the journal run are canceled asynchronously. See the \"Example\" section below for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must have the \"Cancel Journal Run\" Zuora Finance user permission enabled to cancel journal runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"journal-runs/put_journalrun/request/notes","deepLinkHash":"/journal-runs/put_journalrun#journal-runs/put_journalrun/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you cancel a journal run, the summary journal entries associated with that journal run are canceled asynchronously. A response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"success\": true }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means only that the specified journal run has a status of \"Pending\", \"Error\", or \"Completed\" and therefore can be canceled, but does not mean that the whole journal run was successfully canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, let's say you want to cancel journal run JR-00000075. The journal run status is \"Completed\" and it contains ten journal entries. One of the journal entries has its Transferred to Accounting status set to \"Yes\", meaning that the entry cannot be canceled. The workflow might go as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You make an API call to cancel the journal run."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The journal run status is \"Completed\", so you receive a response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"success\": true }"},"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":"Zuora begins asynchronously canceling journal entries associated with the journal run. The journal entry whose Transferred to Accounting status is \"Yes\" fails to be canceled. The cancelation process continues, and the other journal entries are successfully canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The journal run status remains as \"Completed\". The status does not change to \"Canceled\" because the journal run still contains a journey entry that is not canceled."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jr-number","in":"path","schemaId":"schema_5","description":"Journal run number. Must be a valid journal run number in the format JR-00000001. \nYou can only cancel a journal run whose status is \"Pending\", \"Error\", or \"Completed\".\n","required":true}],"pointer":"/paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/journal-runs/{jr-number}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jr-number","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/journal-runs/{jr-number}/cancel","href":"journal-runs/put_journalrun","openApiOperationId":"PUT_JournalRun","summary":"Cancel a journal run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-runs/put_journalrun"}],"panels":[]}]},"httpPath":"/v1/journal-runs/{jr-number}/cancel"}],"content":{"contentType":"group","meta":{"name":"Journal Runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Journal Runs","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 journal runs to automatically create summary journal entities that are suitable for importing into your general ledger system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about journal runs, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-journal-runs","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal Runs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/journal-runs","summary":"Create a journal run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/journal-runs/post_journalrun","deprecated":false},{"title":"/v1/journal-runs/{jr-number}","summary":"Delete a journal run","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/journal-runs/delete_journalrun","deprecated":false},{"title":"/v1/journal-runs/{jr-number}","summary":"Retrieve a journal run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/journal-runs/get_journalrun","deprecated":false},{"title":"/v1/journal-runs/{jr-number}/cancel","summary":"Cancel a journal run","prefix":{"name":"put","color":"put"},"badges":[],"link":"/journal-runs/put_journalrun","deprecated":false}]}]}]}]}},{"type":"group","label":"Mass Updater","link":"/v1-api-reference/api/mass-updater","routeSlug":"/v1-api-reference/api/mass-updater","items":[{"label":"Perform a mass action","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/mass-updater/post_massupdater","routeSlug":"/v1-api-reference/api/mass-updater/post_massupdater","metadata":{"seo":{"title":"Perform a mass action","description":"Describes how to perform a mass action through the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_MassUpdater","name":"Perform a mass action","isWebhook":false,"pointer":"/paths/~1v1~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Perform a mass action","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":"Describes how to perform a mass action through the REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this API method, you send a multipart/form-data request containing a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file with data about the mass action you want to perform. Zuora returns a key and then asynchronously processes the mass action. You can use the key to get details about the result of the mass action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to use this operation to perform the Mass Payment Upload (MPU) mass action, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=ar-mass-updater-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass Payment Upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_204"}},"schemaId":"schema_204","pointer":"/paths/~1v1~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/bulk","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_204"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/bulk","href":"mass-updater/post_massupdater","openApiOperationId":"POST_MassUpdater","summary":"Perform a mass action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_204","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_204"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTMassUpdateResponseType","exampleIds":["paths/~1v1~1bulk/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTMassUpdateResponseType","exampleIds":["paths/~1v1~1bulk/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTMassUpdateResponseType","exampleIds":["paths/~1v1~1bulk/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTMassUpdateResponseType","exampleIds":["paths/~1v1~1bulk/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mass-updater/post_massupdater"}],"panels":[]}]},"httpPath":"/v1/bulk"},{"label":"List all results of a mass action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/mass-updater/get_massupdater","routeSlug":"/v1-api-reference/api/mass-updater/get_massupdater","metadata":{"seo":{"title":"List all results of a mass action","description":"Describes how to get information about the result of a mass action through the REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_MassUpdater","name":"List all results of a mass action","isWebhook":false,"pointer":"/paths/~1v1~1bulk~1{bulk-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all results of a mass action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Describes how to get information about the result of a mass action through the REST API. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulk-key","in":"path","schemaId":"schema_5","description":"String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API.\n","required":true}],"pointer":"/paths/~1v1~1bulk~1{bulk-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1bulk~1{bulk-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/bulk/{bulk-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"bulk-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/bulk/{bulk-key}","href":"mass-updater/get_massupdater","openApiOperationId":"GET_MassUpdater","summary":"List all results of a mass action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETMassUpdateType","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETMassUpdateType","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1bulk~1{bulk-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETMassUpdateType","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETMassUpdateType","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mass-updater/get_massupdater"}],"panels":[]}]},"httpPath":"/v1/bulk/{bulk-key}"},{"label":"Stop a mass action","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/mass-updater/put_massupdater","routeSlug":"/v1-api-reference/api/mass-updater/put_massupdater","metadata":{"seo":{"title":"Stop a mass action","description":"Describes how to stop a mass action through the REST API. You can stop a mass action when its status is Pending or Processing. After you have stopped a mass action, you can get the mass action result to see details of the mass action."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_MassUpdater","name":"Stop a mass action","isWebhook":false,"pointer":"/paths/~1v1~1bulk~1{bulk-key}~1stop/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop a mass action","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":"Describes how to stop a mass action through the REST API. You can stop a mass action when its status is Pending or Processing. After you have stopped a mass action, you can get the mass action result to see details of the mass action."},"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":"If you stop a mass action when its status is Pending, no response file is generated because no records have been processed."},"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":"If you stop a mass action when its status is Processing, a response file is generated. You can check the response file to see which records have been processed and which have not. In the response file, the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (successful) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (failed) for processed records, and a blank value for unprocessed records."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records that have already been processed when a mass action is stopped are not rolled back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulk-key","in":"path","schemaId":"schema_5","description":"String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API.\n","required":true}],"pointer":"/paths/~1v1~1bulk~1{bulk-key}~1stop/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1bulk~1{bulk-key}~1stop/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/bulk/{bulk-key}/stop","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"bulk-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/bulk/{bulk-key}/stop","href":"mass-updater/put_massupdater","openApiOperationId":"PUT_MassUpdater","summary":"Stop a mass action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mass-updater/put_massupdater"}],"panels":[]}]},"httpPath":"/v1/bulk/{bulk-key}/stop"}],"content":{"contentType":"group","meta":{"name":"Mass Updater"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mass Updater","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 mass updater to perform mass actions more easily."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about mass updater, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-mass-updater-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass Updater"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/bulk","summary":"Perform a mass action","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mass-updater/post_massupdater","deprecated":false},{"title":"/v1/bulk/{bulk-key}","summary":"List all results of a mass action","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mass-updater/get_massupdater","deprecated":false},{"title":"/v1/bulk/{bulk-key}/stop","summary":"Stop a mass action","prefix":{"name":"put","color":"put"},"badges":[],"link":"/mass-updater/put_massupdater","deprecated":false}]}]}]}]}},{"type":"separator","label":"Events and Notifications","content":null},{"type":"group","label":"Notifications","link":"/v1-api-reference/api/notifications","routeSlug":"/v1-api-reference/api/notifications","items":[{"label":"Create a notification definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/post_create_notification_definition","routeSlug":"/v1-api-reference/api/notifications/post_create_notification_definition","metadata":{"seo":{"title":"Create a notification definition","description":"Creates a notification definition. If a filter rule is specified, it will be evaluated to see if the notification definition is qualified to handle the incoming events during runtime. If the notification is qualified, it will send the email and invoke the callout if it has an email template or a callout."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Create_Notification_Definition","name":"Create a notification definition","isWebhook":false,"pointer":"/paths/~1notifications~1notification-definitions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a notification definition","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 notification definition. If a filter rule is specified, it will be evaluated to see if the notification definition is qualified to handle the incoming events during runtime. If the notification is qualified, it will send the email and invoke the callout if it has an email template or a callout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation supports creating notification definitions for all event 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":"To create a notification definition for a standard event, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For more information about standard event category codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard event category code for events and notifications"},"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":"To create a notification definition for a Zuora custom event, custom event, or custom scheduled event, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-zuora-custom-event-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora custom events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom event triggers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom scheduled events"},"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":"You must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both at the same time."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1notification-definitions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPublicNotificationDefinitionRequest","exampleIds":["paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition","paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition with filter rules"]}},"schemaId":"components/schemas/POSTPublicNotificationDefinitionRequest","exampleIds":["paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition","paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition with filter rules"],"pointer":"/paths/~1notifications~1notification-definitions/post/requestBody","description":"The request body used to create the notification definition."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notifications/notification-definitions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTPublicNotificationDefinitionRequest","exampleIds":["paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition","paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition with filter rules"]}},"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/notification-definitions","href":"notifications/post_create_notification_definition","openApiOperationId":"POST_Create_Notification_Definition","summary":"Create a notification definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTPublicNotificationDefinitionRequest","exampleIds":["paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition","paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition with filter rules"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPublicNotificationDefinitionRequest","exampleIds":["paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition","paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition with filter rules"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicNotificationDefinitionResponse"}},"schemaId":"components/schemas/GETPublicNotificationDefinitionResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1notification-definitions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPublicNotificationDefinitionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicNotificationDefinitionResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/post_create_notification_definition"}],"panels":[]}]},"httpPath":"/notifications/notification-definitions"},{"label":"List notification definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_query_notification_definitions","routeSlug":"/v1-api-reference/api/notifications/get_query_notification_definitions","metadata":{"seo":{"title":"List notification definitions","description":"Queries notification definitions with the specified filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Query_Notification_Definitions","name":"List notification definitions","isWebhook":false,"pointer":"/paths/~1notifications~1notification-definitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List notification definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries notification definitions with the specified filters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_58","description":"The first index of the query result."},{"name":"limit","in":"query","schemaId":"schema_66","description":"The maximum number of results the query should return."},{"name":"profileId","in":"query","schemaId":"schema_96","description":"Id of the profile."},{"name":"eventCategory","in":"query","schemaId":"schema_205","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event category code for a standard event, on which the notification definition is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the list of supported standard event category codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard event category code for events and notifications"},"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":"You cannot specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the same time."},"children":[]}]}]}]},{"name":"eventTypeName","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the Zuora custom event, custom event, or custom scheduled event on which the notification definition is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the same time."},"children":[]}]}]}]},{"name":"emailTemplateId","in":"query","schemaId":"schema_96","description":"The ID of the email template."}],"pointer":"/paths/~1notifications~1notification-definitions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1notification-definitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/notification-definitions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"start","in":"query","schemaId":"schema_58"},{"name":"limit","in":"query","schemaId":"schema_66"},{"name":"profileId","in":"query","schemaId":"schema_96"},{"name":"eventCategory","in":"query","schemaId":"schema_205"},{"name":"eventTypeName","in":"query","schemaId":"schema_5"},{"name":"emailTemplateId","in":"query","schemaId":"schema_96"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","405","415","500"],"pointer":"/notifications/notification-definitions","href":"notifications/get_query_notification_definitions","openApiOperationId":"GET_Query_Notification_Definitions","summary":"List notification definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_206"}},"schemaId":"schema_206","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1notification-definitions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_206","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_206"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/get_query_notification_definitions"}],"panels":[]}]},"httpPath":"/notifications/notification-definitions"},{"label":"Retrieve a notification definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_get_notification_definition","routeSlug":"/v1-api-reference/api/notifications/get_get_notification_definition","metadata":{"seo":{"title":"Retrieve a notification definition","description":"Queries the notification definition of the given ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Get_Notification_Definition","name":"Retrieve a notification definition","isWebhook":false,"pointer":"/paths/~1notifications~1notification-definitions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a notification definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries the notification definition of the given ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the notification definition.","required":true}],"pointer":"/paths/~1notifications~1notification-definitions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1notification-definitions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/notification-definitions/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","405","415","500"],"pointer":"/notifications/notification-definitions/{id}","href":"notifications/get_get_notification_definition","openApiOperationId":"GET_Get_Notification_Definition","summary":"Retrieve a notification definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicNotificationDefinitionResponse"}},"schemaId":"components/schemas/GETPublicNotificationDefinitionResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora request ID passed from the request or generated by the API Gateway.","schema":{"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_207"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1notification-definitions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPublicNotificationDefinitionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicNotificationDefinitionResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/get_get_notification_definition"}],"panels":[]}]},"httpPath":"/notifications/notification-definitions/{id}"},{"label":"Update a notification definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/put_update_notification_definition","routeSlug":"/v1-api-reference/api/notifications/put_update_notification_definition","metadata":{"seo":{"title":"Update a notification definition","description":"Updates a notification definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_Update_Notification_Definition","name":"Update a notification definition","isWebhook":false,"pointer":"/paths/~1notifications~1notification-definitions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a notification definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a notification definition.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the notification definition to be updated.","required":true}],"pointer":"/paths/~1notifications~1notification-definitions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1notification-definitions~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/PUTPublicNotificationDefinitionRequest"}},"schemaId":"components/schemas/PUTPublicNotificationDefinitionRequest","pointer":"/paths/~1notifications~1notification-definitions~1{id}/put/requestBody","description":"The request body of the notification definition to be updated."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/notifications/notification-definitions/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTPublicNotificationDefinitionRequest"}},"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/notification-definitions/{id}","href":"notifications/put_update_notification_definition","openApiOperationId":"PUT_Update_Notification_Definition","summary":"Update a notification definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTPublicNotificationDefinitionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPublicNotificationDefinitionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicNotificationDefinitionResponse"}},"schemaId":"components/schemas/GETPublicNotificationDefinitionResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1notification-definitions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPublicNotificationDefinitionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicNotificationDefinitionResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/put/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/put_update_notification_definition"}],"panels":[]}]},"httpPath":"/notifications/notification-definitions/{id}"},{"label":"Delete a notification definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/delete_delete_notification_definition","routeSlug":"/v1-api-reference/api/notifications/delete_delete_notification_definition","metadata":{"seo":{"title":"Delete a notification definition","description":"Deletes a notification definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_Delete_Notification_Definition","name":"Delete a notification definition","isWebhook":false,"pointer":"/paths/~1notifications~1notification-definitions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a notification definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a notification definition.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the notification definition to be deleted.","required":true}],"pointer":"/paths/~1notifications~1notification-definitions~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1notification-definitions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/notifications/notification-definitions/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","404","405","415","500"],"pointer":"/notifications/notification-definitions/{id}","href":"notifications/delete_delete_notification_definition","openApiOperationId":"DELETE_Delete_Notification_Definition","summary":"Delete a notification definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1notification-definitions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1notification-definitions~1{id}/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/delete_delete_notification_definition"}],"panels":[]}]},"httpPath":"/notifications/notification-definitions/{id}"},{"label":"Create or update email templates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/post_createorupdateemailtemplates","routeSlug":"/v1-api-reference/api/notifications/post_createorupdateemailtemplates","metadata":{"seo":{"title":"Create or update email templates","description":"Creates email templates for standard or custom events if you do not specify email template IDs, or updates existing email templates if you specify valid email template IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateOrUpdateEmailTemplates","name":"Create or update email templates","isWebhook":false,"pointer":"/paths/~1notifications~1email-templates~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update email templates","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 email templates for standard or custom events if you do not specify email template IDs, or updates existing email templates if you specify valid email template IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each email template when you are creating email templates, whether the template is created for a standard event, a custom event, or a custom scheduled event is dependent on whether you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"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 you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the email template is created based on a standard event. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard Event Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all standard event category codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the email template is created based on the corresponding custom event or custom scheduled event. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom event triggers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about custom events, and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom scheduled events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about custom scheduled events."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of email templates that you can create or update by one call is 1,000."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1email-templates~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateOrUpdateEmailTemplateRequest","exampleIds":["paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Create an email template","paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Update an email template"]}},"schemaId":"components/schemas/POSTCreateOrUpdateEmailTemplateRequest","exampleIds":["paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Create an email template","paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Update an email template"],"pointer":"/paths/~1notifications~1email-templates~1import/post/requestBody","description":"The request body to import or update email templates."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notifications/email-templates/import","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTCreateOrUpdateEmailTemplateRequest","exampleIds":["paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Create an email template","paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Update an email template"]}},"responseCodes":["200"],"pointer":"/notifications/email-templates/import","href":"notifications/post_createorupdateemailtemplates","openApiOperationId":"POST_CreateOrUpdateEmailTemplates","summary":"Create or update email templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTCreateOrUpdateEmailTemplateRequest","exampleIds":["paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Create an email template","paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Update an email template"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateOrUpdateEmailTemplateRequest","exampleIds":["paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Create an email template","paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Update an email template"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse"}},"schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1email-templates~1import/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/post_createorupdateemailtemplates"}],"panels":[]}]},"httpPath":"/notifications/email-templates/import"},{"label":"Create an email template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/post_create_email_template","routeSlug":"/v1-api-reference/api/notifications/post_create_email_template","metadata":{"seo":{"title":"Create an email template","description":"Creates an email template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Create_Email_Template","name":"Create an email template","isWebhook":false,"pointer":"/paths/~1notifications~1email-templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an email template","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 email template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation supports creating the email template for all event 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":"If you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the email template is created based on a standard event. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard Event Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all standard event category codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the email template is created based on the corresponding custom event or custom scheduled event. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom event triggers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about custom events, and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom scheduled events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about custom scheduled events."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1email-templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPublicEmailTemplateRequest"}},"schemaId":"components/schemas/POSTPublicEmailTemplateRequest","pointer":"/paths/~1notifications~1email-templates/post/requestBody","description":"The request body to create an email template."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notifications/email-templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTPublicEmailTemplateRequest"}},"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/email-templates","href":"notifications/post_create_email_template","openApiOperationId":"POST_Create_Email_Template","summary":"Create an email template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTPublicEmailTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPublicEmailTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicEmailTemplateResponse"}},"schemaId":"components/schemas/GETPublicEmailTemplateResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1email-templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPublicEmailTemplateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicEmailTemplateResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/post_create_email_template"}],"panels":[]}]},"httpPath":"/notifications/email-templates"},{"label":"List email templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_query_email_templates","routeSlug":"/v1-api-reference/api/notifications/get_query_email_templates","metadata":{"seo":{"title":"List email templates","description":"Queries email templates. This operation supports querying email templates for all event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Query_Email_Templates","name":"List email templates","isWebhook":false,"pointer":"/paths/~1notifications~1email-templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List email templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries email templates. This operation supports querying email templates for all event types.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_58","description":"The first index of the query result."},{"name":"limit","in":"query","schemaId":"schema_66","description":"The maximum number of results the query should return."},{"name":"eventCategory","in":"query","schemaId":"schema_205","description":"The event category code for standard events."},{"name":"eventTypeName","in":"query","schemaId":"schema_5","description":"The name of the custom event or custom scheduled event."},{"name":"name","in":"query","schemaId":"schema_5","description":"The name of the email template."}],"pointer":"/paths/~1notifications~1email-templates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1email-templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/email-templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"start","in":"query","schemaId":"schema_58"},{"name":"limit","in":"query","schemaId":"schema_66"},{"name":"eventCategory","in":"query","schemaId":"schema_205"},{"name":"eventTypeName","in":"query","schemaId":"schema_5"},{"name":"name","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","405","415","500"],"pointer":"/notifications/email-templates","href":"notifications/get_query_email_templates","openApiOperationId":"GET_Query_Email_Templates","summary":"List email templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_208","exampleIds":["paths/~1notifications~1email-templates/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_208","exampleIds":["paths/~1notifications~1email-templates/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1email-templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_208","exampleIds":["paths/~1notifications~1email-templates/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_208","exampleIds":["paths/~1notifications~1email-templates/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/get_query_email_templates"}],"panels":[]}]},"httpPath":"/notifications/email-templates"},{"label":"Retrieve an email template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_get_email_template","routeSlug":"/v1-api-reference/api/notifications/get_get_email_template","metadata":{"seo":{"title":"Retrieve an email template","description":"Queries the email template based on the specified ID. This operation supports retrieving the email template for all event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Get_Email_Template","name":"Retrieve an email template","isWebhook":false,"pointer":"/paths/~1notifications~1email-templates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an email template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries the email template based on the specified ID. This operation supports retrieving the email template for all event types.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the email template.","required":true}],"pointer":"/paths/~1notifications~1email-templates~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1email-templates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/email-templates/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/email-templates/{id}","href":"notifications/get_get_email_template","openApiOperationId":"GET_Get_Email_Template","summary":"Retrieve an email template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicEmailTemplateResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPublicEmailTemplateResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n    examples:\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_209"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1email-templates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPublicEmailTemplateResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicEmailTemplateResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/get_get_email_template"}],"panels":[]}]},"httpPath":"/notifications/email-templates/{id}"},{"label":"Update an email template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/put_update_email_template","routeSlug":"/v1-api-reference/api/notifications/put_update_email_template","metadata":{"seo":{"title":"Update an email template","description":"Updates an email template. This operation supports updating the email template for all event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_Update_Email_Template","name":"Update an email template","isWebhook":false,"pointer":"/paths/~1notifications~1email-templates~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an email template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an email template. This operation supports updating the email template for all event types.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the email template to be updated.","required":true}],"pointer":"/paths/~1notifications~1email-templates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1email-templates~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/PUTPublicEmailTemplateRequest"}},"schemaId":"components/schemas/PUTPublicEmailTemplateRequest","pointer":"/paths/~1notifications~1email-templates~1{id}/put/requestBody","description":"The request body to update an email template."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/notifications/email-templates/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTPublicEmailTemplateRequest"}},"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/email-templates/{id}","href":"notifications/put_update_email_template","openApiOperationId":"PUT_Update_Email_Template","summary":"Update an email template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTPublicEmailTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPublicEmailTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicEmailTemplateResponse"}},"schemaId":"components/schemas/GETPublicEmailTemplateResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1email-templates~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPublicEmailTemplateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicEmailTemplateResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/put/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/put_update_email_template"}],"panels":[]}]},"httpPath":"/notifications/email-templates/{id}"},{"label":"Delete an email template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/delete_delete_email_template","routeSlug":"/v1-api-reference/api/notifications/delete_delete_email_template","metadata":{"seo":{"title":"Delete an email template","description":"Deletes an email template. This operation supports deleting an email template for all event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_Delete_Email_Template","name":"Delete an email template","isWebhook":false,"pointer":"/paths/~1notifications~1email-templates~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an email template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an email template. This operation supports deleting an email template for all event types.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the email template to be deleted.","required":true}],"pointer":"/paths/~1notifications~1email-templates~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1email-templates~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/notifications/email-templates/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","404","405","415","500"],"pointer":"/notifications/email-templates/{id}","href":"notifications/delete_delete_email_template","openApiOperationId":"DELETE_Delete_Email_Template","summary":"Delete an email template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1email-templates~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1email-templates~1{id}/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/delete_delete_email_template"}],"panels":[]}]},"httpPath":"/notifications/email-templates/{id}"},{"label":"Create or update callout templates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/createorupdatecallouttemplates","routeSlug":"/v1-api-reference/api/notifications/createorupdatecallouttemplates","metadata":{"seo":{"title":"Create or update callout templates","description":"Creates callout templates for standard or custom events if you do not specify callout template IDs, or updates existing callout templates if you specify valid callout template IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateOrUpdateCalloutTemplates","name":"Create or update callout templates","isWebhook":false,"pointer":"/paths/~1notifications~1callout-templates~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update callout templates","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 callout templates for standard or custom events if you do not specify callout template IDs, or updates existing callout templates if you specify valid callout template IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each callout template when you are creating callout templates, whether the template is created for a standard event, a custom event, or a custom scheduled event is dependent on whether you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"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 you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the callout template is created based on a standard event. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard event category code for events and notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all standard event category codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the callout template is created based on the corresponding custom event, Zuora custom event, or custom scheduled event. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom event triggers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about custom events, and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom scheduled events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about custom scheduled events."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of callout templates that you can create or update by one call is 1,000."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1callout-templates~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateOrUpdateCalloutTemplateRequest"}},"schemaId":"components/schemas/POSTCreateOrUpdateCalloutTemplateRequest","pointer":"/paths/~1notifications~1callout-templates~1import/post/requestBody","description":"The request body to import or update callout templates."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notifications/callout-templates/import","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTCreateOrUpdateCalloutTemplateRequest"}},"responseCodes":["200"],"pointer":"/notifications/callout-templates/import","href":"notifications/createorupdatecallouttemplates","openApiOperationId":"CreateOrUpdateCalloutTemplates","summary":"Create or update callout templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTCreateOrUpdateCalloutTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCreateOrUpdateCalloutTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse"}},"schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1callout-templates~1import/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/createorupdatecallouttemplates"}],"panels":[]}]},"httpPath":"/notifications/callout-templates/import"},{"label":"Create a callout template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/createcallouttemplate","routeSlug":"/v1-api-reference/api/notifications/createcallouttemplate","metadata":{"seo":{"title":"Create a callout template","description":"Creates a callout template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateCalloutTemplate","name":"Create a callout template","isWebhook":false,"pointer":"/paths/~1notifications~1callout-templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a callout template","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 callout template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation supports creating the callout template for all event 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":"To create a callout template for a standard event, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For more information about standard event category codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard event category code for events and notifications"},"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":"To create a callout template for a Zuora custom event, custom event, or custom scheduled event, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-zuora-custom-event-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora custom events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom event triggers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom scheduled events"},"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":"You must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both at the same time."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1callout-templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPublicCalloutTemplateRequest","exampleIds":["paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Without authentication","paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Base authentication","paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"]}},"schemaId":"components/schemas/POSTPublicCalloutTemplateRequest","exampleIds":["paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Without authentication","paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Base authentication","paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"],"pointer":"/paths/~1notifications~1callout-templates/post/requestBody","description":"The request body to create a callout template."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notifications/callout-templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTPublicCalloutTemplateRequest","exampleIds":["paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Without authentication","paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Base authentication","paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"]}},"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/callout-templates","href":"notifications/createcallouttemplate","openApiOperationId":"CreateCalloutTemplate","summary":"Create a callout template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTPublicCalloutTemplateRequest","exampleIds":["paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Without authentication","paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Base authentication","paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTPublicCalloutTemplateRequest","exampleIds":["paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Without authentication","paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Base authentication","paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1callout-templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/createcallouttemplate"}],"panels":[]}]},"httpPath":"/notifications/callout-templates"},{"label":"List callout templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/getcallouttemplates","routeSlug":"/v1-api-reference/api/notifications/getcallouttemplates","metadata":{"seo":{"title":"List callout templates","description":"Queries callout templates. This operation supports querying callout templates for all event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCalloutTemplates","name":"List callout templates","isWebhook":false,"pointer":"/paths/~1notifications~1callout-templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List callout templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries callout templates. This operation supports querying callout templates for all event types.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_58","description":"The first index of the query result."},{"name":"limit","in":"query","schemaId":"schema_66","description":"The maximum number of results the query should return."},{"name":"eventCategory","in":"query","schemaId":"schema_205","description":"The event category code of a standard event to which the callout templates you want to query relates."},{"name":"eventTypeName","in":"query","schemaId":"schema_5","description":"The name of a Zuora custom event, custom event, or custom scheduled event to which the callout templates you want to query relates.\n"},{"name":"name","in":"query","schemaId":"schema_5","description":"The name of the callout template."}],"pointer":"/paths/~1notifications~1callout-templates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1callout-templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/callout-templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"start","in":"query","schemaId":"schema_58"},{"name":"limit","in":"query","schemaId":"schema_66"},{"name":"eventCategory","in":"query","schemaId":"schema_205"},{"name":"eventTypeName","in":"query","schemaId":"schema_5"},{"name":"name","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/callout-templates","href":"notifications/getcallouttemplates","openApiOperationId":"GetCalloutTemplates","summary":"List callout templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210","exampleIds":["paths/~1notifications~1callout-templates/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_210","exampleIds":["paths/~1notifications~1callout-templates/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1callout-templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_210","exampleIds":["paths/~1notifications~1callout-templates/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210","exampleIds":["paths/~1notifications~1callout-templates/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/getcallouttemplates"}],"panels":[]}]},"httpPath":"/notifications/callout-templates"},{"label":"Retrieve a callout template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/getcallouttemplte","routeSlug":"/v1-api-reference/api/notifications/getcallouttemplte","metadata":{"seo":{"title":"Retrieve a callout template","description":"Queries the callout template based on the specified ID. This operation supports retrieving the callout template for all event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCalloutTemplte","name":"Retrieve a callout template","isWebhook":false,"pointer":"/paths/~1notifications~1callout-templates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a callout template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries the callout template based on the specified ID. This operation supports retrieving the callout template for all event types.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the callout template.","required":true}],"pointer":"/paths/~1notifications~1callout-templates~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1callout-templates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/callout-templates/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/callout-templates/{id}","href":"notifications/getcallouttemplte","openApiOperationId":"GetCalloutTemplte","summary":"Retrieve a callout template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n    examples:\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_209"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1callout-templates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/getcallouttemplte"}],"panels":[]}]},"httpPath":"/notifications/callout-templates/{id}"},{"label":"Update a callout template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/updatecallouttemplate","routeSlug":"/v1-api-reference/api/notifications/updatecallouttemplate","metadata":{"seo":{"title":"Update a callout template","description":"Updates a callout template. This operation supports updating the callout template for all event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateCalloutTemplate","name":"Update a callout template","isWebhook":false,"pointer":"/paths/~1notifications~1callout-templates~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a callout template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a callout template. This operation supports updating the callout template for all event types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the callout template to be updated.","required":true}],"pointer":"/paths/~1notifications~1callout-templates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1callout-templates~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/PUTPublicCalloutTemplateRequest","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Without authentication","paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Base authentication","paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"]}},"schemaId":"components/schemas/PUTPublicCalloutTemplateRequest","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Without authentication","paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Base authentication","paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"],"pointer":"/paths/~1notifications~1callout-templates~1{id}/put/requestBody","description":"The request body to update a callout template."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/notifications/callout-templates/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTPublicCalloutTemplateRequest","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Without authentication","paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Base authentication","paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"]}},"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/callout-templates/{id}","href":"notifications/updatecallouttemplate","openApiOperationId":"UpdateCalloutTemplate","summary":"Update a callout template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTPublicCalloutTemplateRequest","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Without authentication","paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Base authentication","paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTPublicCalloutTemplateRequest","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Without authentication","paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Base authentication","paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1callout-templates~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETPublicCalloutTemplateResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/put/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/updatecallouttemplate"}],"panels":[]}]},"httpPath":"/notifications/callout-templates/{id}"},{"label":"Delete a callout template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/deletecallouttemplate","routeSlug":"/v1-api-reference/api/notifications/deletecallouttemplate","metadata":{"seo":{"title":"Delete a callout template","description":"Deletes a callout template. This operation supports deleting a callout template for all event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteCalloutTemplate","name":"Delete a callout template","isWebhook":false,"pointer":"/paths/~1notifications~1callout-templates~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a callout template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a callout template. This operation supports deleting a callout template for all event types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the callout template to be deleted.","required":true}],"pointer":"/paths/~1notifications~1callout-templates~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1callout-templates~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/notifications/callout-templates/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","404","405","415","500"],"pointer":"/notifications/callout-templates/{id}","href":"notifications/deletecallouttemplate","openApiOperationId":"DeleteCalloutTemplate","summary":"Delete a callout template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1callout-templates~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1callout-templates~1{id}/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/deletecallouttemplate"}],"panels":[]}]},"httpPath":"/notifications/callout-templates/{id}"},{"label":"Create or update reusable blocks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/createorupdatereusableblocks","routeSlug":"/v1-api-reference/api/notifications/createorupdatereusableblocks","metadata":{"seo":{"title":"Create or update reusable blocks","description":"Creates reusable blocks if you do not specify block IDs, or updates existing reusable blocks if you specify valid block IDs. All fields must be provided for each reusable block you want to update."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrUpdateReusableBlocks","name":"Create or update reusable blocks","isWebhook":false,"pointer":"/paths/~1notifications~1reusable-blocks~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update reusable blocks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates reusable blocks if you do not specify block IDs, or updates existing reusable blocks if you specify valid block IDs. All fields must be provided for each reusable block you want to update.\n\nThe maximum number of reusable blocks that you can create or update by one call is 1,000.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1reusable-blocks~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrUpdateReusableBlockRequest","exampleIds":["paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Create a reusable block","paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Update a reusable block"]}},"schemaId":"components/schemas/CreateOrUpdateReusableBlockRequest","exampleIds":["paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Create a reusable block","paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Update a reusable block"],"pointer":"/paths/~1notifications~1reusable-blocks~1import/post/requestBody","description":"The request body to import or update reusable blocks."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notifications/reusable-blocks/import","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateOrUpdateReusableBlockRequest","exampleIds":["paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Create a reusable block","paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Update a reusable block"]}},"responseCodes":["200"],"pointer":"/notifications/reusable-blocks/import","href":"notifications/createorupdatereusableblocks","openApiOperationId":"createOrUpdateReusableBlocks","summary":"Create or update reusable blocks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateOrUpdateReusableBlockRequest","exampleIds":["paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Create a reusable block","paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Update a reusable block"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrUpdateReusableBlockRequest","exampleIds":["paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Create a reusable block","paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Update a reusable block"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse"}},"schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1reusable-blocks~1import/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrUpdateEmailTemplatesResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/createorupdatereusableblocks"}],"panels":[]}]},"httpPath":"/notifications/reusable-blocks/import"},{"label":"Create a reusable block","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/createreusableblock","routeSlug":"/v1-api-reference/api/notifications/createreusableblock","metadata":{"seo":{"title":"Create a reusable block","description":"Creates a reusable block for email templates, such as email headers or footers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createReusableBlock","name":"Create a reusable block","isWebhook":false,"pointer":"/paths/~1notifications~1reusable-blocks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a reusable block","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a reusable block for email templates, such as email headers or footers.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1reusable-blocks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePublicReusableBlockRequest"}},"schemaId":"components/schemas/CreatePublicReusableBlockRequest","pointer":"/paths/~1notifications~1reusable-blocks/post/requestBody","description":"The request body to create a reusable block."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notifications/reusable-blocks","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePublicReusableBlockRequest"}},"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/reusable-blocks","href":"notifications/createreusableblock","openApiOperationId":"createReusableBlock","summary":"Create a reusable block"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreatePublicReusableBlockRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePublicReusableBlockRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPublicReusableBlockResponse"}},"schemaId":"components/schemas/GetPublicReusableBlockResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1reusable-blocks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPublicReusableBlockResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPublicReusableBlockResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/createreusableblock"}],"panels":[]}]},"httpPath":"/notifications/reusable-blocks"},{"label":"List reusable blocks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/getreusableblocks","routeSlug":"/v1-api-reference/api/notifications/getreusableblocks","metadata":{"seo":{"title":"List reusable blocks","description":"Queries reusable blocks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReusableBlocks","name":"List reusable blocks","isWebhook":false,"pointer":"/paths/~1notifications~1reusable-blocks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List reusable blocks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries reusable blocks.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_58","description":"The first index of the query result."},{"name":"limit","in":"query","schemaId":"schema_211","description":"The maximum number of results the query should return."},{"name":"activeOnly","in":"query","schemaId":"schema_212","description":"Whether to return only active reusable blocks."},{"name":"category","in":"query","schemaId":"schema_213","description":"The category that the returned blocks belong to."},{"name":"name","in":"query","schemaId":"schema_5","description":"The name of the block the query should return."},{"name":"tag","in":"query","schemaId":"schema_42","description":"The tags the returned blocks are associated with. If multiple tags are specified, only blocks that match all specified tags are returned."}],"pointer":"/paths/~1notifications~1reusable-blocks/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1reusable-blocks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/reusable-blocks","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"start","in":"query","schemaId":"schema_58"},{"name":"limit","in":"query","schemaId":"schema_211"},{"name":"activeOnly","in":"query","schemaId":"schema_212"},{"name":"category","in":"query","schemaId":"schema_213"},{"name":"name","in":"query","schemaId":"schema_5"},{"name":"tag","in":"query","schemaId":"schema_42"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/reusable-blocks","href":"notifications/getreusableblocks","openApiOperationId":"getReusableBlocks","summary":"List reusable blocks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_214","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_214","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1reusable-blocks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_214","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_214","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/getreusableblocks"}],"panels":[]}]},"httpPath":"/notifications/reusable-blocks"},{"label":"Retrieve a reusable block","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/getreusableblock","routeSlug":"/v1-api-reference/api/notifications/getreusableblock","metadata":{"seo":{"title":"Retrieve a reusable block","description":"Queries the reusable block based on the specified ID or name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReusableBlock","name":"Retrieve a reusable block","isWebhook":false,"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a reusable block","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries the reusable block based on the specified ID or name.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blockKey","in":"path","schemaId":"schema_5","description":"The ID or name of the reusable block.\n","required":true}],"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/reusable-blocks/{blockKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"blockKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/reusable-blocks/{blockKey}","href":"notifications/getreusableblock","openApiOperationId":"getReusableBlock","summary":"Retrieve a reusable block"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPublicReusableBlockResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetPublicReusableBlockResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n    examples:\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_209"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPublicReusableBlockResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPublicReusableBlockResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/getreusableblock"}],"panels":[]}]},"httpPath":"/notifications/reusable-blocks/{blockKey}"},{"label":"Update a reusable block","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/updatereusableblock","routeSlug":"/v1-api-reference/api/notifications/updatereusableblock","metadata":{"seo":{"title":"Update a reusable block","description":"Updates a reusable block."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateReusableBlock","name":"Update a reusable block","isWebhook":false,"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a reusable block","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a reusable block.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blockKey","in":"path","schemaId":"schema_5","description":"The ID or name of the reusable block.\n","required":true}],"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePublicReusableBlockRequest"}},"schemaId":"components/schemas/UpdatePublicReusableBlockRequest","pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/put/requestBody","description":"The request body to update a reusable block."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/notifications/reusable-blocks/{blockKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"blockKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePublicReusableBlockRequest"}},"responseCodes":["200","400","404","405","415","500"],"pointer":"/notifications/reusable-blocks/{blockKey}","href":"notifications/updatereusableblock","openApiOperationId":"updateReusableBlock","summary":"Update a reusable block"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdatePublicReusableBlockRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePublicReusableBlockRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdatePublicReusableBlockResponse"}},"schemaId":"components/schemas/UpdatePublicReusableBlockResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdatePublicReusableBlockResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdatePublicReusableBlockResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/updatereusableblock"}],"panels":[]}]},"httpPath":"/notifications/reusable-blocks/{blockKey}"},{"label":"Delete a reusable block","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/deletereusableblock","routeSlug":"/v1-api-reference/api/notifications/deletereusableblock","metadata":{"seo":{"title":"Delete a reusable block","description":"Deletes a reusable block."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteReusableBlock","name":"Delete a reusable block","isWebhook":false,"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a reusable block","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a reusable block.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blockKey","in":"path","schemaId":"schema_5","description":"The ID or name of the reusable block.\n","required":true}],"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/notifications/reusable-blocks/{blockKey}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"blockKey","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","404","405","415","500"],"pointer":"/notifications/reusable-blocks/{blockKey}","href":"notifications/deletereusableblock","openApiOperationId":"deleteReusableBlock","summary":"Delete a reusable block"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/405/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/405/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/415/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/404/content/application~1json/examples/response"]}}},{"code":"405","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/405/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/405/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/415/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/deletereusableblock"}],"panels":[]}]},"httpPath":"/notifications/reusable-blocks/{blockKey}"},{"label":"Delete notification histories for an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/delete_delete_notification_history_for_account","routeSlug":"/v1-api-reference/api/notifications/delete_delete_notification_history_for_account","metadata":{"seo":{"title":"Delete notification histories for an account","description":"Delete all notification histories for the given account. All email and callout notifications for this account will be deleted upon successful operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_Delete_Notification_History_For_Account","name":"Delete notification histories for an account","isWebhook":false,"pointer":"/paths/~1notifications~1history/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete notification histories for an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete all notification histories for the given account. All email and callout notifications for this account will be deleted upon successful operation.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountId","in":"query","schemaId":"schema_96","description":"The ID of the account whose notification histories are to be deleted.","required":true}],"pointer":"/paths/~1notifications~1history/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1history/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/notifications/history","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"accountId","in":"query","required":true,"schemaId":"schema_96"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["202","400","404"],"pointer":"/notifications/history","href":"notifications/delete_delete_notification_history_for_account","openApiOperationId":"DELETE_Delete_Notification_History_For_Account","summary":"Delete notification histories for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationsHistoryDeletionTaskResponse","exampleIds":["paths/~1notifications~1history/delete/responses/202/content/application~1json/examples/response"]}},"schemaId":"components/schemas/NotificationsHistoryDeletionTaskResponse","exampleIds":["paths/~1notifications~1history/delete/responses/202/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_215"}},"schemaId":"schema_215","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1history/delete/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1history/delete/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1history/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/NotificationsHistoryDeletionTaskResponse","exampleIds":["paths/~1notifications~1history/delete/responses/202/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationsHistoryDeletionTaskResponse","exampleIds":["paths/~1notifications~1history/delete/responses/202/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_215","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_215"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1history/delete/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1history/delete/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/delete_delete_notification_history_for_account"}],"panels":[]}]},"httpPath":"/notifications/history"},{"label":"Retrieve a notification history deletion task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_get_notification_history_deletion_task","routeSlug":"/v1-api-reference/api/notifications/get_get_notification_history_deletion_task","metadata":{"seo":{"title":"Retrieve a notification history deletion task","description":"Get the notification history deletion task by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Get_Notification_History_Deletion_Task","name":"Retrieve a notification history deletion task","isWebhook":false,"pointer":"/paths/~1notifications~1history~1tasks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a notification history deletion task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the notification history deletion task by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the notification history deletion task. You can get the deletion task ID from the 202 response body of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/DELETE_Delete_Notification_History_For_Account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete notification histories for an account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1notifications~1history~1tasks~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1history~1tasks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/history/tasks/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/notifications/history/tasks/{id}","href":"notifications/get_get_notification_history_deletion_task","openApiOperationId":"GET_Get_Notification_History_Deletion_Task","summary":"Retrieve a notification history deletion task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationsHistoryDeletionTaskResponse","exampleIds":["paths/~1notifications~1history~1tasks~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/NotificationsHistoryDeletionTaskResponse","exampleIds":["paths/~1notifications~1history~1tasks~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1history~1tasks~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1history~1tasks~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1history~1tasks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationsHistoryDeletionTaskResponse","exampleIds":["paths/~1notifications~1history~1tasks~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationsHistoryDeletionTaskResponse","exampleIds":["paths/~1notifications~1history~1tasks~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1history~1tasks~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1notifications~1history~1tasks~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/get_get_notification_history_deletion_task"}],"panels":[]}]},"httpPath":"/notifications/history/tasks/{id}"},{"label":"Resend callout notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/post_resendcalloutnotifications","routeSlug":"/v1-api-reference/api/notifications/post_resendcalloutnotifications","metadata":{"seo":{"title":"Resend callout notifications","description":"Resends callout notifications if your customers did not receive previous callout notifications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_ResendCalloutNotifications","name":"Resend callout notifications","isWebhook":false,"pointer":"/paths/~1notifications~1callout-histories~1resend/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend callout notifications","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":"Resends callout notifications if your customers did not receive previous callout notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about the status codes and response contents of this operation are as follows:"},"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":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response content"},"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":"Success for all notifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"202 Accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(blank)"},"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":"Success for at least one notification"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"202 Accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code and error message of each failed notification"},"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":"Failure for all notifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code and error message of each failed notification"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1callout-histories~1resend/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTResendCalloutNotifications"}},"schemaId":"components/schemas/POSTResendCalloutNotifications","pointer":"/paths/~1notifications~1callout-histories~1resend/post/requestBody","description":"The request body to resend callout notifications."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notifications/callout-histories/resend","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTResendCalloutNotifications"}},"responseCodes":["202","400"],"pointer":"/notifications/callout-histories/resend","href":"notifications/post_resendcalloutnotifications","openApiOperationId":"POST_ResendCalloutNotifications","summary":"Resend callout notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTResendCalloutNotifications","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTResendCalloutNotifications"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResendCalloutNotificationsFailedResponse","exampleIds":["paths/~1notifications~1callout-histories~1resend/post/responses/202/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ResendCalloutNotificationsFailedResponse","exampleIds":["paths/~1notifications~1callout-histories~1resend/post/responses/202/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResendCalloutNotificationsFailedResponse","exampleIds":["paths/~1notifications~1callout-histories~1resend/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ResendCalloutNotificationsFailedResponse","exampleIds":["paths/~1notifications~1callout-histories~1resend/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1callout-histories~1resend/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/ResendCalloutNotificationsFailedResponse","exampleIds":["paths/~1notifications~1callout-histories~1resend/post/responses/202/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResendCalloutNotificationsFailedResponse","exampleIds":["paths/~1notifications~1callout-histories~1resend/post/responses/202/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ResendCalloutNotificationsFailedResponse","exampleIds":["paths/~1notifications~1callout-histories~1resend/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResendCalloutNotificationsFailedResponse","exampleIds":["paths/~1notifications~1callout-histories~1resend/post/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/post_resendcalloutnotifications"}],"panels":[]}]},"httpPath":"/notifications/callout-histories/resend"},{"label":"Resend email notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/post_resendemailnotifications","routeSlug":"/v1-api-reference/api/notifications/post_resendemailnotifications","metadata":{"seo":{"title":"Resend email notifications","description":"Resends email notifications if your customers did not receive previous email notifications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_ResendEmailNotifications","name":"Resend email notifications","isWebhook":false,"pointer":"/paths/~1notifications~1email-histories~1resend/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend email notifications","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":"Resends email notifications if your customers did not receive previous email notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about the status codes and response contents of this operation are as follows:"},"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":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response content"},"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":"Success for all notifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"202 Accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(blank)"},"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":"Success for at least one notification"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"202 Accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code and error message of each failed notification"},"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":"Failure for all notifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code and error message of each failed notification"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1notifications~1email-histories~1resend/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTResendEmailNotifications"}},"schemaId":"components/schemas/POSTResendEmailNotifications","pointer":"/paths/~1notifications~1email-histories~1resend/post/requestBody","description":"The request body to resend email notifications."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notifications/email-histories/resend","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTResendEmailNotifications"}},"responseCodes":["202","400"],"pointer":"/notifications/email-histories/resend","href":"notifications/post_resendemailnotifications","openApiOperationId":"POST_ResendEmailNotifications","summary":"Resend email notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTResendEmailNotifications","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTResendEmailNotifications"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResendEmailNotificationsFailedResponse","exampleIds":["paths/~1notifications~1email-histories~1resend/post/responses/202/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ResendEmailNotificationsFailedResponse","exampleIds":["paths/~1notifications~1email-histories~1resend/post/responses/202/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResendEmailNotificationsFailedResponse","exampleIds":["paths/~1notifications~1email-histories~1resend/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ResendEmailNotificationsFailedResponse","exampleIds":["paths/~1notifications~1email-histories~1resend/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1notifications~1email-histories~1resend/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/ResendEmailNotificationsFailedResponse","exampleIds":["paths/~1notifications~1email-histories~1resend/post/responses/202/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResendEmailNotificationsFailedResponse","exampleIds":["paths/~1notifications~1email-histories~1resend/post/responses/202/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ResendEmailNotificationsFailedResponse","exampleIds":["paths/~1notifications~1email-histories~1resend/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResendEmailNotificationsFailedResponse","exampleIds":["paths/~1notifications~1email-histories~1resend/post/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/post_resendemailnotifications"}],"panels":[]}]},"httpPath":"/notifications/email-histories/resend"},{"label":"List callout notification histories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_callouthistory","routeSlug":"/v1-api-reference/api/notifications/get_callouthistory","metadata":{"seo":{"title":"List callout notification histories","description":"Describes how to get a notification history for callouts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CalloutHistory","name":"List callout notification histories","isWebhook":false,"pointer":"/paths/~1v1~1notification-history~1callout/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List callout notification histories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Describes how to get a notification history for callouts.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"endTime","in":"query","schemaId":"schema_23","description":"The final date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss."},{"name":"startTime","in":"query","schemaId":"schema_23","description":"The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss."},{"name":"objectId","in":"query","schemaId":"schema_5","description":"The ID of an object that triggered a callout notification. \n"},{"name":"failedOnly","in":"query","schemaId":"schema_27","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only return failed records. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", return all records in the given date range. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"eventCategory","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of records to be returned by event category."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following formats 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":"code","inline":true,"attributes":{"content":"{Event Type Namespace}:{Event Type Name}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the Custom Events feature is enabled in your tenant. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.notification:NewSubscriptionCreated"},"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":"Numeric code of the event category if the Custom Events feature is not enabled in your tenant. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1210"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Category Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}]},{"name":"includeResponseContent","in":"query","schemaId":"schema_27","description":""}],"pointer":"/paths/~1v1~1notification-history~1callout/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1notification-history~1callout/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/notification-history/callout","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"endTime","in":"query","required":false,"schemaId":"schema_23"},{"name":"startTime","in":"query","required":false,"schemaId":"schema_23"},{"name":"objectId","in":"query","required":false,"schemaId":"schema_5"},{"name":"failedOnly","in":"query","required":false,"schemaId":"schema_27"},{"name":"eventCategory","in":"query","required":false,"schemaId":"schema_5"},{"name":"includeResponseContent","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/notification-history/callout","href":"notifications/get_callouthistory","openApiOperationId":"GET_CalloutHistory","summary":"List callout notification histories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCalloutHistoryVOsType","exampleIds":["paths/~1v1~1notification-history~1callout/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCalloutHistoryVOsType","exampleIds":["paths/~1v1~1notification-history~1callout/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1notification-history~1callout/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCalloutHistoryVOsType","exampleIds":["paths/~1v1~1notification-history~1callout/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCalloutHistoryVOsType","exampleIds":["paths/~1v1~1notification-history~1callout/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/get_callouthistory"}],"panels":[]}]},"httpPath":"/v1/notification-history/callout"},{"label":"List email notification histories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/notifications/get_emailhistory","routeSlug":"/v1-api-reference/api/notifications/get_emailhistory","metadata":{"seo":{"title":"List email notification histories","description":"Describes how to get a notification history for notification emails."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_EmailHistory","name":"List email notification histories","isWebhook":false,"pointer":"/paths/~1v1~1notification-history~1email/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List email notification histories","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":"Describes how to get a notification history for notification emails."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"notifications/get_emailhistory/request/notes","deepLinkHash":"/notifications/get_emailhistory#notifications/get_emailhistory/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request parameters and their values may be appended with a \"?\" following the HTTPS GET request.  Additional request parameter are separated by \"&\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET https://rest.zuora.com/v1/notification-history/email?startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000&pageSize=1"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"accountId","in":"query","schemaId":"schema_5","description":"ID of an account. By specifying this query parameter, you can filter email notification histories by account."},{"name":"endTime","in":"query","schemaId":"schema_23","description":"The end date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime - startTime) is three days."},{"name":"startTime","in":"query","schemaId":"schema_23","description":"The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime - startTime) is three days."},{"name":"objectId","in":"query","schemaId":"schema_5","description":"The Id of an object that triggered an email notification.\n"},{"name":"failedOnly","in":"query","schemaId":"schema_27","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only returns failed records. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", returns all records in the given date range. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not specified."},"children":[]}]}]}]},{"name":"eventCategory","in":"query","schemaId":"schema_205","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of records to be returned by event category."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following formats 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":"code","inline":true,"attributes":{"content":"{Event Type Namespace}:{Event Type Name}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the Custom Events feature is enabled in your tenant. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.notification:NewSubscriptionCreated"},"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":"Numeric code of the event category if the Custom Events feature is not enabled in your tenant. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1210"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Category Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1notification-history~1email/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1notification-history~1email/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/notification-history/email","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"accountId","in":"query","schemaId":"schema_5"},{"name":"endTime","in":"query","required":false,"schemaId":"schema_23"},{"name":"startTime","in":"query","required":false,"schemaId":"schema_23"},{"name":"objectId","in":"query","required":false,"schemaId":"schema_5"},{"name":"failedOnly","in":"query","required":false,"schemaId":"schema_27"},{"name":"eventCategory","in":"query","required":false,"schemaId":"schema_205"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/notification-history/email","href":"notifications/get_emailhistory","openApiOperationId":"GET_EmailHistory","summary":"List email notification histories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETEmailHistoryVOsType","exampleIds":["paths/~1v1~1notification-history~1email/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETEmailHistoryVOsType","exampleIds":["paths/~1v1~1notification-history~1email/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1notification-history~1email/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETEmailHistoryVOsType","exampleIds":["paths/~1v1~1notification-history~1email/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETEmailHistoryVOsType","exampleIds":["paths/~1v1~1notification-history~1email/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/get_emailhistory"}],"panels":[]}]},"httpPath":"/v1/notification-history/email"}],"content":{"contentType":"group","meta":{"name":"Notifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notifications","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":"Notifications are the actions taken to inform users or call third-party endpoints when a certain event happens. Typical actions include emails and callouts. Callouts typically refer to HTTP invocations, such as HTTP calls to REST services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora notification system processes the events in the same order in which they are triggered. The timing and delivery of notifications can still vary based on factors such as retries, concurrency, and network latency. But Zuora guarantees the best performance possible with the right performance boosters and tuning."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notifications are associated with Communication Profiles, which allow you to send specific event-driven notifications to targeted customers. Zuora provides the following Settings API to access the settings of Communication Profiles:* "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-get-communication-profiles-with-settings-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all Communication Profiles"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-communication-profile-with-settings-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new Communication Profile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-modify-communication-profile-with-settings-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modify a Communication Profile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-get-notifications-under-particular-communication-profile-with-settings-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all Notifications under a particular Communication Profile"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/notifications/notification-definitions","summary":"Create a notification definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/post_create_notification_definition","deprecated":false},{"title":"/notifications/notification-definitions","summary":"List notification definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/get_query_notification_definitions","deprecated":false},{"title":"/notifications/notification-definitions/{id}","summary":"Retrieve a notification definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/get_get_notification_definition","deprecated":false},{"title":"/notifications/notification-definitions/{id}","summary":"Update a notification definition","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notifications/put_update_notification_definition","deprecated":false},{"title":"/notifications/notification-definitions/{id}","summary":"Delete a notification definition","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/notifications/delete_delete_notification_definition","deprecated":false},{"title":"/notifications/email-templates/import","summary":"Create or update email templates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/post_createorupdateemailtemplates","deprecated":false},{"title":"/notifications/email-templates","summary":"Create an email template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/post_create_email_template","deprecated":false},{"title":"/notifications/email-templates","summary":"List email templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/get_query_email_templates","deprecated":false},{"title":"/notifications/email-templates/{id}","summary":"Retrieve an email template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/get_get_email_template","deprecated":false},{"title":"/notifications/email-templates/{id}","summary":"Update an email template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notifications/put_update_email_template","deprecated":false},{"title":"/notifications/email-templates/{id}","summary":"Delete an email template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/notifications/delete_delete_email_template","deprecated":false},{"title":"/notifications/callout-templates/import","summary":"Create or update callout templates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/createorupdatecallouttemplates","deprecated":false},{"title":"/notifications/callout-templates","summary":"Create a callout template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/createcallouttemplate","deprecated":false},{"title":"/notifications/callout-templates","summary":"List callout templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/getcallouttemplates","deprecated":false},{"title":"/notifications/callout-templates/{id}","summary":"Retrieve a callout template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/getcallouttemplte","deprecated":false},{"title":"/notifications/callout-templates/{id}","summary":"Update a callout template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notifications/updatecallouttemplate","deprecated":false},{"title":"/notifications/callout-templates/{id}","summary":"Delete a callout template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/notifications/deletecallouttemplate","deprecated":false},{"title":"/notifications/reusable-blocks/import","summary":"Create or update reusable blocks","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/createorupdatereusableblocks","deprecated":false},{"title":"/notifications/reusable-blocks","summary":"Create a reusable block","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/createreusableblock","deprecated":false},{"title":"/notifications/reusable-blocks","summary":"List reusable blocks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/getreusableblocks","deprecated":false},{"title":"/notifications/reusable-blocks/{blockKey}","summary":"Retrieve a reusable block","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/getreusableblock","deprecated":false},{"title":"/notifications/reusable-blocks/{blockKey}","summary":"Update a reusable block","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notifications/updatereusableblock","deprecated":false},{"title":"/notifications/reusable-blocks/{blockKey}","summary":"Delete a reusable block","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/notifications/deletereusableblock","deprecated":false},{"title":"/notifications/history","summary":"Delete notification histories for an account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/notifications/delete_delete_notification_history_for_account","deprecated":false},{"title":"/notifications/history/tasks/{id}","summary":"Retrieve a notification history deletion task","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/get_get_notification_history_deletion_task","deprecated":false},{"title":"/notifications/callout-histories/resend","summary":"Resend callout notifications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/post_resendcalloutnotifications","deprecated":false},{"title":"/notifications/email-histories/resend","summary":"Resend email notifications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/post_resendemailnotifications","deprecated":false},{"title":"/v1/notification-history/callout","summary":"List callout notification histories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/get_callouthistory","deprecated":false},{"title":"/v1/notification-history/email","summary":"List email notification histories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/get_emailhistory","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Event Triggers","link":"/v1-api-reference/api/custom-event-triggers","routeSlug":"/v1-api-reference/api/custom-event-triggers","items":[{"label":"Create an event trigger","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-event-triggers/post_eventtrigger","routeSlug":"/v1-api-reference/api/custom-event-triggers/post_eventtrigger","metadata":{"seo":{"title":"Create an event trigger","description":"When you create an event trigger, you must specify the base object and define the trigger condition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_EventTrigger","name":"Create an event trigger","isWebhook":false,"pointer":"/paths/~1events~1event-triggers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an event trigger","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":"When you create an event trigger, you must specify the base object and define the trigger condition."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-event-triggers/post_eventtrigger/request/specify-the-base-object","deepLinkHash":"/custom-event-triggers/post_eventtrigger#custom-event-triggers/post_eventtrigger/request/specify-the-base-object"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the base object"},"children":[]}]}]},{"$$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":"baseObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify which object to define a trigger on. You can define an event trigger on any of the following objects:"},"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":"Account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AccountingCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AccountingPeriod"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amendment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillingRun"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditBalanceAdjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditMemo"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditMemoApplication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditMemoApplicationItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditMemoItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditMemoPart"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DebitMemo"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DebitMemoItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DeliveryAdjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fulfillment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fund"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceAdjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceItemAdjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JournalEntry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JournalEntryItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OrderAction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OrderLineItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PaymentApplication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PaymentMethod"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PaymentPart"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PaymentSchedule"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PaymentScheduleItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductFeature"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductRatePlan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductRatePlanChargeTier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RatePlan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RatePlanCharge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RatePlanChargeTier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RatingResult"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RefundApplication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RefundPart"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RevenueEvent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RevenueEventItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RevenueSchedule"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RevenueScheduleItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SubscriptionChargeDeliverySchedule"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SubscriptionChargePriceInterval"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SubscriptionChargePriceIntervalTier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SubscriptionOffer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SubscriptionProductFeature"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TaxationItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdaterDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ValidityPeriodSummary"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition to the above Zuora standard objects, you can also use custom objects as base objects for custom events."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"custom-event-triggers/post_eventtrigger/request/tenant-level-base-objects-and-tenant-level-event-triggers","deepLinkHash":"/custom-event-triggers/post_eventtrigger#custom-event-triggers/post_eventtrigger/request/tenant-level-base-objects-and-tenant-level-event-triggers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tenant level base objects and tenant level event triggers"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora identifies the following base objects and custom objects as the tenant level base objects:"},"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":"AccountingCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AccountingPeriod"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillingRun"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JournalEntry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JournalEntryItem"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductFeature"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductRatePlan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductRatePlanChargeTier"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event triggers defined on tenant level base objects are tenant level event triggers. Notifications associated with tenant level events are system notifications."},"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":" Tenant level event triggers and system notifications are only available in the default profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-event-triggers/post_eventtrigger/request/define-the-trigger-condition","deepLinkHash":"/custom-event-triggers/post_eventtrigger#custom-event-triggers/post_eventtrigger/request/define-the-trigger-condition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define the trigger condition"},"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":"condition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://commons.apache.org/proper/commons-jexl/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JEXL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that specifies when to trigger events. The expression can contain fields from the object that the trigger is defined on."},"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 condition cannot contain fields from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-export-zoql"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects that are joined to the object that the trigger is defined on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the following condition causes an event to be triggered whenever an invoice is posted with an amount greater than 1000:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where:"},"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":"changeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a keyword that specifies the type of change that occurred to the Invoice object. For all objects, the supported values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSERT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":",  and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE"},"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":"code","inline":true,"attributes":{"content":"Invoice.Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the value of the Invoice object's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field after the change occurred."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice.Status_old"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the value of the Invoice object's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field before the change occurred."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the above example, the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"baseObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"custom-event-triggers/post_eventtrigger/request/limitations","deepLinkHash":"/custom-event-triggers/post_eventtrigger#custom-event-triggers/post_eventtrigger/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event trigger has the following limitations:"},"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":"Base object values for Zuora standard objects are case sensitive. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is correct, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Paymentmethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentmethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is incorrect."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base object values for custom objects must be lowercase. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default__vehicle"},"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":"The INSERT change type is not supported on RatePlan base objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The INSERT change type is not supported on SubscriptionProductFeature base objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating custom events, you cannot match fields of the RatePlanCharge object against constant values for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"condition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. For example, the following condition will cause errors: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanCharge.ShippingProcessStatus__c == 'Shipping Confirmed'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipping Confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a constant value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields on objects are case-sensitive. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentMethod.createdbyid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can result in errors. The correct format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentMethod.CreatedById"},"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":"A condition cannot contain fields from data source objects that are joined to the base object."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not create duplicate events because they will be either merged or deleted. Zuora considers events that have the same trigger condition as duplicate events, regardless of event type names."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-custom-event-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events~1event-triggers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostEventTriggerRequest"}},"schemaId":"components/schemas/PostEventTriggerRequest","pointer":"/paths/~1events~1event-triggers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/events/event-triggers","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostEventTriggerRequest"}},"responseCodes":["200","400","500"],"pointer":"/events/event-triggers","href":"custom-event-triggers/post_eventtrigger","openApiOperationId":"POST_EventTrigger","summary":"Create an event trigger"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostEventTriggerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostEventTriggerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1events~1event-triggers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/post/responses/400/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-event-triggers/post_eventtrigger"}],"panels":[]}]},"httpPath":"/events/event-triggers"},{"label":"List event triggers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-event-triggers/get_eventtriggers","routeSlug":"/v1-api-reference/api/custom-event-triggers/get_eventtriggers","metadata":{"seo":{"title":"List event triggers","description":"List event triggers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_EventTriggers","name":"List event triggers","isWebhook":false,"pointer":"/paths/~1events~1event-triggers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event triggers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"baseObject","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zuora object that trigger condition is defined upon. The format of the value in this field depends on the base object type:"},"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":"Standard object: object name, which should follow the pattern ^[A-Z][\\w-]*$. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"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":"Custom object: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default__<custom_object_api_name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default__vehicle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"eventTypeName","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event type name. Should be specified in the pattern: ^[A-Za-z]{1,}[\\w-]*$"},"children":[]}]}]}]},{"name":"active","in":"query","schemaId":"schema_5","description":"The status of the event trigger."},{"name":"start","in":"query","schemaId":"schema_216","description":"The first index of the query result. Default to 0 if absent, and the minimum is 0."},{"name":"limit","in":"query","schemaId":"schema_217","description":"The maximum number of data records to be returned. Default to 10 if absent."}],"pointer":"/paths/~1events~1event-triggers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events~1event-triggers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/event-triggers","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"baseObject","in":"query","required":false,"schemaId":"schema_5"},{"name":"eventTypeName","in":"query","required":false,"schemaId":"schema_5"},{"name":"active","in":"query","required":false,"schemaId":"schema_5"},{"name":"start","in":"query","required":false,"schemaId":"schema_216"},{"name":"limit","in":"query","required":false,"schemaId":"schema_217"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/events/event-triggers","href":"custom-event-triggers/get_eventtriggers","openApiOperationId":"GET_EventTriggers","summary":"List event triggers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_218","exampleIds":["paths/~1events~1event-triggers/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_218","exampleIds":["paths/~1events~1event-triggers/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1events~1event-triggers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_218","exampleIds":["paths/~1events~1event-triggers/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_218","exampleIds":["paths/~1events~1event-triggers/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/get/responses/400/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-event-triggers/get_eventtriggers"}],"panels":[]}]},"httpPath":"/events/event-triggers"},{"label":"Retrieve an event trigger","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-event-triggers/get_eventtrigger","routeSlug":"/v1-api-reference/api/custom-event-triggers/get_eventtrigger","metadata":{"seo":{"title":"Retrieve an event trigger","description":"Retrieve an event trigger"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_EventTrigger","name":"Retrieve an event trigger","isWebhook":false,"pointer":"/paths/~1events~1event-triggers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an event trigger","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","required":true}],"pointer":"/paths/~1events~1event-triggers~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events~1event-triggers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/event-triggers/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/events/event-triggers/{id}","href":"custom-event-triggers/get_eventtrigger","openApiOperationId":"GET_EventTrigger","summary":"Retrieve an event trigger"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1events~1event-triggers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/404/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-event-triggers/get_eventtrigger"}],"panels":[]}]},"httpPath":"/events/event-triggers/{id}"},{"label":"Update an event trigger","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-event-triggers/put_eventtrigger","routeSlug":"/v1-api-reference/api/custom-event-triggers/put_eventtrigger","metadata":{"seo":{"title":"Update an event trigger","description":"Update an event trigger"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_EventTrigger","name":"Update an event trigger","isWebhook":false,"pointer":"/paths/~1events~1event-triggers~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an event trigger","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","required":true}],"pointer":"/paths/~1events~1event-triggers~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events~1event-triggers~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/PutEventTriggerRequest"}},"schemaId":"components/schemas/PutEventTriggerRequest","pointer":"/paths/~1events~1event-triggers~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/events/event-triggers/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutEventTriggerRequest"}},"responseCodes":["200","404","500"],"pointer":"/events/event-triggers/{id}","href":"custom-event-triggers/put_eventtrigger","openApiOperationId":"PUT_EventTrigger","summary":"Update an event trigger"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutEventTriggerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutEventTriggerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1events~1event-triggers~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventTrigger","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/404/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/put/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-event-triggers/put_eventtrigger"}],"panels":[]}]},"httpPath":"/events/event-triggers/{id}"},{"label":"Delete an event trigger","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-event-triggers/delete_eventtrigger","routeSlug":"/v1-api-reference/api/custom-event-triggers/delete_eventtrigger","metadata":{"seo":{"title":"Delete an event trigger","description":"Delete an event trigger"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_EventTrigger","name":"Delete an event trigger","isWebhook":false,"pointer":"/paths/~1events~1event-triggers~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an event trigger","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","required":true}],"pointer":"/paths/~1events~1event-triggers~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events~1event-triggers~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/events/event-triggers/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","404","500"],"pointer":"/events/event-triggers/{id}","href":"custom-event-triggers/delete_eventtrigger","openApiOperationId":"DELETE_EventTrigger","summary":"Delete an event trigger"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/delete/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/delete/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1events~1event-triggers~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/delete/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/delete/responses/404/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1event-triggers~1{id}/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-event-triggers/delete_eventtrigger"}],"panels":[]}]},"httpPath":"/events/event-triggers/{id}"}],"content":{"contentType":"group","meta":{"name":"Custom Event Triggers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Event Triggers","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":"The Event Trigger service manages the business events and trigger conditions that are defined on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=zuora-business-object-model"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Business Object Model"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or custom objects. When a Zuora object changes, the trigger conditions defined on the object are evaluated, and if any condition qualifies, a business event will be triggered and turned into a notification."},"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":": Event Triggers operations are only applicable to custom events."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events/event-triggers","summary":"Create an event trigger","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-event-triggers/post_eventtrigger","deprecated":false},{"title":"/events/event-triggers","summary":"List event triggers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-event-triggers/get_eventtriggers","deprecated":false},{"title":"/events/event-triggers/{id}","summary":"Retrieve an event trigger","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-event-triggers/get_eventtrigger","deprecated":false},{"title":"/events/event-triggers/{id}","summary":"Update an event trigger","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-event-triggers/put_eventtrigger","deprecated":false},{"title":"/events/event-triggers/{id}","summary":"Delete an event trigger","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-event-triggers/delete_eventtrigger","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Scheduled Events","link":"/v1-api-reference/api/custom-scheduled-events","routeSlug":"/v1-api-reference/api/custom-scheduled-events","items":[{"label":"Create a scheduled event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-scheduled-events/post_scheduledevent","routeSlug":"/v1-api-reference/api/custom-scheduled-events/post_scheduledevent","metadata":{"seo":{"title":"Create a scheduled event","description":"To create a custom scheduled event, you must specify the base object, the base field and the scheduled time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_ScheduledEvent","name":"Create a scheduled event","isWebhook":false,"pointer":"/paths/~1events~1scheduled-events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a scheduled event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"To create a custom scheduled event, you must specify the base object, the base field and the scheduled time.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events~1scheduled-events/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostScheduledEventRequest"}},"schemaId":"components/schemas/PostScheduledEventRequest","pointer":"/paths/~1events~1scheduled-events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/events/scheduled-events","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostScheduledEventRequest"}},"responseCodes":["200","400","500"],"pointer":"/events/scheduled-events","href":"custom-scheduled-events/post_scheduledevent","openApiOperationId":"POST_ScheduledEvent","summary":"Create a scheduled event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostScheduledEventRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostScheduledEventRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetScheduledEventResponse"}},"schemaId":"components/schemas/GetScheduledEventResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1events~1scheduled-events/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetScheduledEventResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetScheduledEventResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/post/responses/400/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-scheduled-events/post_scheduledevent"}],"panels":[]}]},"httpPath":"/events/scheduled-events"},{"label":"List all scheduled events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-scheduled-events/get_scheduledevents","routeSlug":"/v1-api-reference/api/custom-scheduled-events/get_scheduledevents","metadata":{"seo":{"title":"List all scheduled events","description":"List all scheduled events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ScheduledEvents","name":"List all scheduled events","isWebhook":false,"pointer":"/paths/~1events~1scheduled-events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all scheduled events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"eventTypeName","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the scheduled event. Should be specified in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$"},"children":[]}]}]}]},{"name":"apiObject","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base object that the scheduled event is defined upon. Should be specified in the pattern: ^[A-Z][\\w\\-]*$"},"children":[]}]}]}]},{"name":"apiField","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base field of the base object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Should be specified in the pattern: ^[A-Z][\\w\\-]*$"},"children":[]}]}]}]},{"name":"active","in":"query","schemaId":"schema_27","description":"Indicate whether the scheduled event is active or inactive."},{"name":"start","in":"query","schemaId":"schema_216","description":"The first index of the query result. Default to 0 if absent, and the minimum is 0."},{"name":"limit","in":"query","schemaId":"schema_217","description":"The maximum number of data records to be returned. Default to 10 if absent."}],"pointer":"/paths/~1events~1scheduled-events/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events~1scheduled-events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/scheduled-events","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"eventTypeName","in":"query","required":false,"schemaId":"schema_5"},{"name":"apiObject","in":"query","required":false,"schemaId":"schema_5"},{"name":"apiField","in":"query","required":false,"schemaId":"schema_5"},{"name":"active","in":"query","required":false,"schemaId":"schema_27"},{"name":"start","in":"query","required":false,"schemaId":"schema_216"},{"name":"limit","in":"query","required":false,"schemaId":"schema_217"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/events/scheduled-events","href":"custom-scheduled-events/get_scheduledevents","openApiOperationId":"GET_ScheduledEvents","summary":"List all scheduled events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_219"}},"schemaId":"schema_219","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1events~1scheduled-events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_219","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_219"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-scheduled-events/get_scheduledevents"}],"panels":[]}]},"httpPath":"/events/scheduled-events"},{"label":"Retrieve a scheduled event by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-scheduled-events/get_scheduledeventbyid","routeSlug":"/v1-api-reference/api/custom-scheduled-events/get_scheduledeventbyid","metadata":{"seo":{"title":"Retrieve a scheduled event by ID","description":"Retrieve a scheduled event by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ScheduledEventByID","name":"Retrieve a scheduled event by ID","isWebhook":false,"pointer":"/paths/~1events~1scheduled-events~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a scheduled event by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the scheduled event.","required":true}],"pointer":"/paths/~1events~1scheduled-events~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events~1scheduled-events~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/scheduled-events/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/events/scheduled-events/{id}","href":"custom-scheduled-events/get_scheduledeventbyid","openApiOperationId":"GET_ScheduledEventByID","summary":"Retrieve a scheduled event by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetScheduledEventResponse"}},"schemaId":"components/schemas/GetScheduledEventResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1events~1scheduled-events~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetScheduledEventResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetScheduledEventResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/get/responses/404/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-scheduled-events/get_scheduledeventbyid"}],"panels":[]}]},"httpPath":"/events/scheduled-events/{id}"},{"label":"Update a scheduled event by ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-scheduled-events/update_scheduledeventbyid","routeSlug":"/v1-api-reference/api/custom-scheduled-events/update_scheduledeventbyid","metadata":{"seo":{"title":"Update a scheduled event by ID","description":"Update a scheduled event by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UPDATE_ScheduledEventByID","name":"Update a scheduled event by ID","isWebhook":false,"pointer":"/paths/~1events~1scheduled-events~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a scheduled event by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the scheduled event.","required":true}],"pointer":"/paths/~1events~1scheduled-events~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events~1scheduled-events~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/PutScheduledEventRequest"}},"schemaId":"components/schemas/PutScheduledEventRequest","pointer":"/paths/~1events~1scheduled-events~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/events/scheduled-events/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutScheduledEventRequest"}},"responseCodes":["200","400","500"],"pointer":"/events/scheduled-events/{id}","href":"custom-scheduled-events/update_scheduledeventbyid","openApiOperationId":"UPDATE_ScheduledEventByID","summary":"Update a scheduled event by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutScheduledEventRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutScheduledEventRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetScheduledEventResponse"}},"schemaId":"components/schemas/GetScheduledEventResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/put/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1events~1scheduled-events~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetScheduledEventResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetScheduledEventResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/put/responses/400/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/put/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-scheduled-events/update_scheduledeventbyid"}],"panels":[]}]},"httpPath":"/events/scheduled-events/{id}"},{"label":"Delete a scheduled event by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-scheduled-events/delete_scheduledeventbyid","routeSlug":"/v1-api-reference/api/custom-scheduled-events/delete_scheduledeventbyid","metadata":{"seo":{"title":"Delete a scheduled event by ID","description":"Delete a scheduled event by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_ScheduledEventByID","name":"Delete a scheduled event by ID","isWebhook":false,"pointer":"/paths/~1events~1scheduled-events~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a scheduled event by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the scheduled event.","required":true}],"pointer":"/paths/~1events~1scheduled-events~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events~1scheduled-events~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/events/scheduled-events/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","404","500"],"pointer":"/events/scheduled-events/{id}","href":"custom-scheduled-events/delete_scheduledeventbyid","openApiOperationId":"DELETE_ScheduledEventByID","summary":"Delete a scheduled event by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/delete/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/delete/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1events~1scheduled-events~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/delete/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/delete/responses/404/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1events~1scheduled-events~1{id}/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-scheduled-events/delete_scheduledeventbyid"}],"panels":[]}]},"httpPath":"/events/scheduled-events/{id}"}],"content":{"contentType":"group","meta":{"name":"Custom Scheduled Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Scheduled Events","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":"A custom scheduled event notification is evaluated at the scheduled time of the related scheduled event on a daily basis. If the date meets the combination of the base field and the notification parameters, the notification will be triggered immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about Custom Scheduled Events, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-custom-scheduled-event-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Scheduled Events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events/scheduled-events","summary":"Create a scheduled event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-scheduled-events/post_scheduledevent","deprecated":false},{"title":"/events/scheduled-events","summary":"List all scheduled events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-scheduled-events/get_scheduledevents","deprecated":false},{"title":"/events/scheduled-events/{id}","summary":"Retrieve a scheduled event by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-scheduled-events/get_scheduledeventbyid","deprecated":false},{"title":"/events/scheduled-events/{id}","summary":"Update a scheduled event by ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-scheduled-events/update_scheduledeventbyid","deprecated":false},{"title":"/events/scheduled-events/{id}","summary":"Delete a scheduled event by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-scheduled-events/delete_scheduledeventbyid","deprecated":false}]}]}]}]}},{"type":"separator","label":"Custom Objects","content":null},{"type":"group","label":"Custom Object Definitions","link":"/v1-api-reference/api/custom-object-definitions","routeSlug":"/v1-api-reference/api/custom-object-definitions","items":[{"type":"link","label":"Error handling","link":"/v1-api-reference/api/custom-object-definitions/error-handling","routeSlug":"/v1-api-reference/api/custom-object-definitions/error-handling","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Error handling"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-definitions/error-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Custom Objects API call fails, an error code will be returned in the response body. See See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-objects/custom-objects-api/custom-objects-api-error-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Objects API error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Create custom object definitions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-definitions/post_customobjectdefinitions","routeSlug":"/v1-api-reference/api/custom-object-definitions/post_customobjectdefinitions","metadata":{"seo":{"title":"Create custom object definitions","description":"You can post custom object definitions with the request body schema described below."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CustomObjectDefinitions","name":"Create custom object definitions","isWebhook":false,"pointer":"/paths/~1objects~1definitions~1default/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create custom object definitions","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":"You can post custom object definitions with the request body schema described below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation also allows you to use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_AllCustomObjectDefinitionsInNamespace"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List custom object definitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response schema as its request schema. If you want to copy all the existing custom objects from an old tenant to a new tenant, you can make a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_AllCustomObjectDefinitionsInNamespace"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List custom object definitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call in your old tenant and then use its response directly as the request of this operation in the new tenant to import all the custom objects from the old tenant."},"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":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is the UI label of the custom object. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the API Name of the custom object."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-definitions/post_customobjectdefinitions/request/limitations","deepLinkHash":"/custom-object-definitions/post_customobjectdefinitions#custom-object-definitions/post_customobjectdefinitions/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This custom object definition has the following limitations:"},"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 maximum number of characters for the Custom Object API Name ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is 64."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of characters for the Custom Object Label ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is\t64."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of characters for the Custom Object Description 250."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of custom fields in an custom object\tis 50."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of characters for the custom field API name is\t64."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of characters for the custom field label ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is\t64."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of characters for the custom field Description\tis 250."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of picklist or multiselect options is 250."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum length of characters for the Text field is 255."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum length of characters for the Long Text field is from 256 to 8,192."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of digits to the left of the decimal point for the Number field is 13, and to the right is 9."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1definitions~1default/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostCustomObjectDefinitionsRequest"}},"schemaId":"components/schemas/PostCustomObjectDefinitionsRequest","pointer":"/paths/~1objects~1definitions~1default/post/requestBody","description":"The custom object definitions to be created"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/objects/definitions/default","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostCustomObjectDefinitionsRequest"}},"responseCodes":["200","400"],"pointer":"/objects/definitions/default","href":"custom-object-definitions/post_customobjectdefinitions","openApiOperationId":"POST_CustomObjectDefinitions","summary":"Create custom object definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostCustomObjectDefinitionsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostCustomObjectDefinitionsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse"}},"schemaId":"components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1definitions~1default/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse"}}},{"code":"400","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-definitions/post_customobjectdefinitions"}],"panels":[]}]},"httpPath":"/objects/definitions/default"},{"label":"List custom object definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-definitions/get_allcustomobjectdefinitionsinnamespace","routeSlug":"/v1-api-reference/api/custom-object-definitions/get_allcustomobjectdefinitionsinnamespace","metadata":{"seo":{"title":"List custom object definitions","description":"Get all custom objects definitions for a given tenant. If you want to copy all the existing custom objects from an old tenant to a new tenant, you can call this operation in your old tenant and then use its response directly as the request of the Create custom object definitions call in the new tenant to import all the custom objects from the old tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AllCustomObjectDefinitionsInNamespace","name":"List custom object definitions","isWebhook":false,"pointer":"/paths/~1objects~1definitions~1default/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom object definitions","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":"Get all custom objects definitions for a given tenant. If you want to copy all the existing custom objects from an old tenant to a new tenant, you can call this operation in your old tenant and then use its response directly as the request of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CustomObjectDefinitions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create custom object definitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call in the new tenant to import all the custom objects from the old tenant."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"select","in":"query","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"select"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response will only contain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of each custom object."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1definitions~1default/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1definitions~1default/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/objects/definitions/default","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"select","in":"query","required":false,"schemaId":"schema_220"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/objects/definitions/default","href":"custom-object-definitions/get_allcustomobjectdefinitionsinnamespace","openApiOperationId":"GET_AllCustomObjectDefinitionsInNamespace","summary":"List custom object definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse"}},"schemaId":"components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1definitions~1default/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-definitions/get_allcustomobjectdefinitionsinnamespace"}],"panels":[]}]},"httpPath":"/objects/definitions/default"},{"label":"Update an object definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-definitions/updateobjectdefinition","routeSlug":"/v1-api-reference/api/custom-object-definitions/updateobjectdefinition","metadata":{"seo":{"title":"Update an object definition","description":"Updates custom object definitions or custom field definitions for standard and custom objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateObjectDefinition","name":"Update an object definition","isWebhook":false,"pointer":"/paths/~1objects~1migrations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an object definition","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 custom object definitions or custom field definitions for standard and custom objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system asynchronously processes requests to update custom object definitions or advanced custom field definitions and returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the “Retrieve a custom object bulk job” operation to check whether the asynchronous job is completed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about advanced custom fields, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-fields-and-legacy-custom-fields","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields and legacy custom fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-definitions/updateobjectdefinition/request/limitations","deepLinkHash":"/custom-object-definitions/updateobjectdefinition#custom-object-definitions/updateobjectdefinition/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating custom field definition has the following limitations:"},"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":"You can only have one action per update request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot delete fields from custom objects that contain records."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only add required fields to custom objects with no records."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can change optional fields to required only on the custom objects with no records."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-definitions/updateobjectdefinition/request/note","deepLinkHash":"/custom-object-definitions/updateobjectdefinition#custom-object-definitions/updateobjectdefinition/request/note"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulk deletion of custom fields on standard and custom objects is temporarily unavailable as we refine the Custom Field feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can still delete custom fields individually during this refinement process. If you want to delete multiple custom fields, ensure that you send each deletion request only after receiving the response for the previous request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulk deletion capability will be restored once the refinement is complete."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1migrations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MigrationUpdateCustomObjectDefinitionsRequest","exampleIds":["paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a standard object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a standard object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a custom field from a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Rename a custom field on a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a relationship for a custom field","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a relationship for a custom field"]}},"schemaId":"components/schemas/MigrationUpdateCustomObjectDefinitionsRequest","exampleIds":["paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a standard object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a standard object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a custom field from a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Rename a custom field on a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a relationship for a custom field","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a relationship for a custom field"],"pointer":"/paths/~1objects~1migrations/post/requestBody","description":"Migration resource for object and namespace changes."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/objects/migrations","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MigrationUpdateCustomObjectDefinitionsRequest","exampleIds":["paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a standard object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a standard object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a custom field from a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Rename a custom field on a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a relationship for a custom field","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a relationship for a custom field"]}},"responseCodes":["200"],"pointer":"/objects/migrations","href":"custom-object-definitions/updateobjectdefinition","openApiOperationId":"updateObjectDefinition","summary":"Update an object definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/MigrationUpdateCustomObjectDefinitionsRequest","exampleIds":["paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a standard object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a standard object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a custom field from a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Rename a custom field on a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a relationship for a custom field","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a relationship for a custom field"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MigrationUpdateCustomObjectDefinitionsRequest","exampleIds":["paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a standard object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a standard object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a custom field from a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Rename a custom field on a custom object","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a relationship for a custom field","paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a relationship for a custom field"]}},"examples":[{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationUpdateCustomObjectDefinitionsResponse"}},"schemaId":"components/schemas/MigrationUpdateCustomObjectDefinitionsResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1migrations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MigrationUpdateCustomObjectDefinitionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationUpdateCustomObjectDefinitionsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-definitions/updateobjectdefinition"}],"panels":[]}]},"httpPath":"/objects/migrations"},{"label":"Retrieve a custom object definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-definitions/get_customobjectdefinitionbytype","routeSlug":"/v1-api-reference/api/custom-object-definitions/get_customobjectdefinitionbytype","metadata":{"seo":{"title":"Retrieve a custom object definition","description":"Retrieves the custom object definition by type for the given tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CustomObjectDefinitionByType","name":"Retrieve a custom object definition","isWebhook":false,"pointer":"/paths/~1objects~1definitions~1default~1{object}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a custom object definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the custom object definition by type for the given tenant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object","in":"path","schemaId":"schema_5","description":"Specifies the custom object's API name as object. It is case-sensitive.","required":true}],"pointer":"/paths/~1objects~1definitions~1default~1{object}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1definitions~1default~1{object}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/objects/definitions/default/{object}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/objects/definitions/default/{object}","href":"custom-object-definitions/get_customobjectdefinitionbytype","openApiOperationId":"GET_CustomObjectDefinitionByType","summary":"Retrieve a custom object definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectDefinition"}},"schemaId":"components/schemas/CustomObjectDefinition","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Resource Request-URI not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1definitions~1default~1{object}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectDefinition"}}},{"code":"404","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-definitions/get_customobjectdefinitionbytype"}],"panels":[]}]},"httpPath":"/objects/definitions/default/{object}"},{"label":"Delete a custom object definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-definitions/delete_customobjectdefinitionbytype","routeSlug":"/v1-api-reference/api/custom-object-definitions/delete_customobjectdefinitionbytype","metadata":{"seo":{"title":"Delete a custom object definition","description":"Deletes the custom object definition for the provided type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_CustomObjectDefinitionByType","name":"Delete a custom object definition","isWebhook":false,"pointer":"/paths/~1objects~1definitions~1default~1{object}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom object definition","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 the custom object definition for the provided type."},"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":" A custom object definition can only be deleted if no record of this custom object type exists."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object","in":"path","schemaId":"schema_5","description":"Specifies the custom object's API name as object. It is case-sensitive.","required":true}],"pointer":"/paths/~1objects~1definitions~1default~1{object}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1definitions~1default~1{object}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/objects/definitions/default/{object}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/objects/definitions/default/{object}","href":"custom-object-definitions/delete_customobjectdefinitionbytype","openApiOperationId":"Delete_CustomObjectDefinitionByType","summary":"Delete a custom object definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_221"}},"schemaId":"schema_221","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1definitions~1default~1{object}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_221","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_221"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-definitions/delete_customobjectdefinitionbytype"}],"panels":[]}]},"httpPath":"/objects/definitions/default/{object}"}],"content":{"contentType":"group","meta":{"name":"Custom Object Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Object Definitions","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":"With Custom Objects service, you can define custom objects, extending the Zuora data model to accommodate your specific use cases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can sign up for a free account on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://identity.getpostman.com/signup"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman website"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and download the app in case you do not use Postman yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the Custom Object Definitions API is versioned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header. The response may be different for the same request with a different API version. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/objects/definitions/default","summary":"Create custom object definitions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-object-definitions/post_customobjectdefinitions","deprecated":false},{"title":"/objects/definitions/default","summary":"List custom object definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-object-definitions/get_allcustomobjectdefinitionsinnamespace","deprecated":false},{"title":"/objects/migrations","summary":"Update an object definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-object-definitions/updateobjectdefinition","deprecated":false},{"title":"/objects/definitions/default/{object}","summary":"Retrieve a custom object definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-object-definitions/get_customobjectdefinitionbytype","deprecated":false},{"title":"/objects/definitions/default/{object}","summary":"Delete a custom object definition","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-object-definitions/delete_customobjectdefinitionbytype","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Object Records","link":"/v1-api-reference/api/custom-object-records","routeSlug":"/v1-api-reference/api/custom-object-records","items":[{"type":"link","label":"Error handling","link":"/v1-api-reference/api/custom-object-records/error-handling","routeSlug":"/v1-api-reference/api/custom-object-records/error-handling","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Error handling"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-records/error-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Custom Objects API call fails, an error code will be returned in the response body. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-objects/custom-objects-api/custom-objects-api-error-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Objects API error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Create custom object records","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/post_customobjectrecords","routeSlug":"/v1-api-reference/api/custom-object-records/post_customobjectrecords","metadata":{"seo":{"title":"Create custom object records","description":"Creates custom object records with the given type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CustomObjectRecords","name":"Create custom object records","isWebhook":false,"pointer":"/paths/~1objects~1records~1default~1{object}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create custom object records","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 custom object records with the given type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon creating records of a custom object type, the 200 response contains a list of records that have been successfully processed and stored."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-records/post_customobjectrecords/request/limitations","deepLinkHash":"/custom-object-records/post_customobjectrecords#custom-object-records/post_customobjectrecords/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call has the following limitations:"},"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 maximum number of records that you can create by one call is 1,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The storage of empty strings in records is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null values must be formatted as the following example:"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"records\": [\n    {\n      \"fieldName__c\": null\n    }\n  ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"records\": [\n    {\n      \"fieldName__c\": null\n    }\n  ]\n}\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating or updating custom object records with relationship-type fields, Zuora verifies the related objects against the transactional databases, which are updated in near real-time. The record creation or modification fails upon unsuccessful verifications. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the related objects are newly created in your tenant, it might need some time for the transactional database synchronization."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object","in":"path","schemaId":"schema_5","description":"Specifies the custom object's API name as object. It is case-sensitive.","required":true}],"pointer":"/paths/~1objects~1records~1default~1{object}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1records~1default~1{object}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostCustomObjectRecordsRequest","exampleIds":["paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned off","paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned on"]}},"schemaId":"components/schemas/PostCustomObjectRecordsRequest","exampleIds":["paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned off","paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned on"],"pointer":"/paths/~1objects~1records~1default~1{object}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/objects/records/default/{object}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostCustomObjectRecordsRequest","exampleIds":["paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned off","paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned on"]}},"responseCodes":["200","400","401","500"],"pointer":"/objects/records/default/{object}","href":"custom-object-records/post_customobjectrecords","openApiOperationId":"POST_CustomObjectRecords","summary":"Create custom object records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PostCustomObjectRecordsRequest","exampleIds":["paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned off","paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned on"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostCustomObjectRecordsRequest","exampleIds":["paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned off","paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned on"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 200 response indicates that the records have been partially or completely created."},"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":"allowPartialSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 200 response indicates that all object records have been successfully created."},"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":"allowPartialSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 200 response indicates that some records might not be succesffully created and the error information might be contained in the response body."},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostCustomObjectRecordsResponse","exampleIds":["paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned off","paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned on"]}},"schemaId":"components/schemas/PostCustomObjectRecordsResponse","exampleIds":["paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned off","paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned on"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Failed schema validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordsErrorResponse"}},"schemaId":"components/schemas/CustomObjectRecordsErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse401Record"}},"schemaId":"components/schemas/ErrorResponse401Record","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal error. Retry the returned records.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordsThrottledResponse"}},"schemaId":"components/schemas/CustomObjectRecordsThrottledResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1records~1default~1{object}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostCustomObjectRecordsResponse","exampleIds":["paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned off","paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned on"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostCustomObjectRecordsResponse","exampleIds":["paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned off","paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned on"]}}},{"code":"400","schemaId":"components/schemas/CustomObjectRecordsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordsErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse401Record","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse401Record"}}},{"code":"500","schemaId":"components/schemas/CustomObjectRecordsThrottledResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordsThrottledResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-records/post_customobjectrecords"}],"panels":[]}]},"httpPath":"/objects/records/default/{object}"},{"label":"List records for a custom object","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/get_allrecordsforcustomobjecttype","routeSlug":"/v1-api-reference/api/custom-object-records/get_allrecordsforcustomobjecttype","metadata":{"seo":{"title":"List records for a custom object","description":"Lists all object records of the given type. You can also use the q query parameter to filter the output records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AllRecordsForCustomObjectType","name":"List records for a custom object","isWebhook":false,"pointer":"/paths/~1objects~1records~1default~1{object}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List records for a custom object","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":"Lists all object records of the given type. You can also use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"q"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to filter the output records."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-records/get_allrecordsforcustomobjecttype/request/custom-objects-read-consistency","deepLinkHash":"/custom-object-records/get_allrecordsforcustomobjecttype#custom-object-records/get_allrecordsforcustomobjecttype/request/custom-objects-read-consistency"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Objects read consistency"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Objects support eventually consistency. When you read custom object records, the response might not reflect the result of a recently completed operation and might include some stale data. The operations include creating, updating, and deleting custom object records.  If you repeat your read request after a short time, the response should return the latest data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you create five records and perform a query that these five records satisfy the query conditions, there might be a delay before these records can be returned in the query result."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object","in":"path","schemaId":"schema_5","description":"Specifies the custom object's API name as object. It is case-sensitive.","required":true}],"pointer":"/paths/~1objects~1records~1default~1{object}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string to filter the records of a custom object. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-objects/custom-object-record-management/query-syntax-of-custom-object-records","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query syntax of custom object records"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"q"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter only applies to filterable fields."},"children":[]}]}]}]},{"name":"ids","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUIDs of the records to be queried. Each UUID must be a string of 36 characters. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /objects/records/default/passenger?ids=258d65b2-7bc6-4142-88bc-5184931af493&ids=82ecc9f7-b192-4f88-a4a3-4b2af6c750a1"},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_222","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of records returned per page in the response. The call returns the first page if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for use in forward pagination. Pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the previous response to retrieve the next page of records."},"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":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is required when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1records~1default~1{object}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1records~1default~1{object}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/objects/records/default/{object}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"q","in":"query","required":false,"schemaId":"schema_5"},{"name":"ids","in":"query","required":false,"schemaId":"schema_5"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_222"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_96"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/objects/records/default/{object}","href":"custom-object-records/get_allrecordsforcustomobjecttype","openApiOperationId":"GET_AllRecordsForCustomObjectType","summary":"List records for a custom object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryCustomObjectRecordsResponse"}},"schemaId":"components/schemas/QueryCustomObjectRecordsResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1records~1default~1{object}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueryCustomObjectRecordsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryCustomObjectRecordsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-records/get_allrecordsforcustomobjecttype"}],"panels":[]}]},"httpPath":"/objects/records/default/{object}"},{"label":"Retrieve a custom object record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/get_customobjectrecordbyid","routeSlug":"/v1-api-reference/api/custom-object-records/get_customobjectrecordbyid","metadata":{"seo":{"title":"Retrieve a custom object record","description":"Retrieves a record of a given type by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CustomObjectRecordByID","name":"Retrieve a custom object record","isWebhook":false,"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a custom object record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a record of a given type by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object","in":"path","schemaId":"schema_5","description":"Specifies the custom object's API name as object. It is case-sensitive.","required":true},{"name":"id","in":"path","schemaId":"schema_223","description":"Id identifier in uuid form","required":true}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/objects/records/default/{object}/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object","in":"path","required":true,"schemaId":"schema_5"},{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/objects/records/default/{object}/{id}","href":"custom-object-records/get_customobjectrecordbyid","openApiOperationId":"GET_CustomObjectRecordByID","summary":"Retrieve a custom object record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordWithAllFields"}},"schemaId":"components/schemas/CustomObjectRecordWithAllFields","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectRecordWithAllFields","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordWithAllFields"}}},{"code":"404","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-records/get_customobjectrecordbyid"}],"panels":[]}]},"httpPath":"/objects/records/default/{object}/{id}"},{"label":"Update a custom object record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/put_customobjectrecord","routeSlug":"/v1-api-reference/api/custom-object-records/put_customobjectrecord","metadata":{"seo":{"title":"Update a custom object record","description":"Updates a record of the given type and ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_CustomObjectRecord","name":"Update a custom object record","isWebhook":false,"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a custom object record","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 record of the given type and ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-records/put_customobjectrecord/request/limitations","deepLinkHash":"/custom-object-records/put_customobjectrecord#custom-object-records/put_customobjectrecord/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"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 storage of empty strings in records is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null values must be formatted as the following example:"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"records\": [\n    {\n      \"fieldName__c\": null\n    }\n  ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"records\": [\n    {\n      \"fieldName__c\": null\n    }\n  ]\n}\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating or updating custom object records with relationship-type fields, Zuora verifies the related objects against the transactional databases, which are updated in near real-time. The record creation or modification fails upon unsuccessful verifications. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the related objects are newly created in your tenant, it might need some time for the transactional database synchronization."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object","in":"path","schemaId":"schema_5","description":"Specifies the custom object's API name as object. It is case-sensitive.","required":true},{"name":"id","in":"path","schemaId":"schema_223","description":"Id identifier in uuid form","required":true}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"If-Match","in":"header","schemaId":"schema_5","description":"The expected ETag of the resource. You can use this header to perform a conditional request. Zuora responds with 412 Precondition Failed if the ETag of the resource does not match the value of this header. \n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1records~1default~1{object}~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/CustomObjectRecordWithOnlyCustomFields"}},"schemaId":"components/schemas/CustomObjectRecordWithOnlyCustomFields","pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/objects/records/default/{object}/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object","in":"path","required":true,"schemaId":"schema_5"},{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"If-Match","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordWithOnlyCustomFields"}},"responseCodes":["200","404"],"pointer":"/objects/records/default/{object}/{id}","href":"custom-object-records/put_customobjectrecord","openApiOperationId":"PUT_CustomObjectRecord","summary":"Update a custom object record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CustomObjectRecordWithOnlyCustomFields","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordWithOnlyCustomFields"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordWithAllFields"}},"schemaId":"components/schemas/CustomObjectRecordWithAllFields","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Object record does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectRecordWithAllFields","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordWithAllFields"}}},{"code":"404","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-records/put_customobjectrecord"}],"panels":[]}]},"httpPath":"/objects/records/default/{object}/{id}"},{"label":"Partially update a custom object record","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/patch_partialupdatecustomobjectrecord","routeSlug":"/v1-api-reference/api/custom-object-records/patch_partialupdatecustomobjectrecord","metadata":{"seo":{"title":"Partially update a custom object record","description":"Updates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in RFC 7386."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Patch_PartialUpdateCustomObjectRecord","name":"Partially update a custom object record","isWebhook":false,"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a custom object record","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 one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7386"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7386"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-records/patch_partialupdatecustomobjectrecord/request/limitations","deepLinkHash":"/custom-object-records/patch_partialupdatecustomobjectrecord#custom-object-records/patch_partialupdatecustomobjectrecord/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"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 storage of empty strings in records is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null values must be formatted as the following example:"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"records\": [\n    {\n      \"fieldName__c\": null\n    }\n  ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"records\": [\n    {\n      \"fieldName__c\": null\n    }\n  ]\n}\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating or updating custom object records with relationship-type fields, Zuora verifies the related objects against the transactional databases, which are updated in near real-time. The record creation or modification fails upon unsuccessful verifications. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the related objects are newly created in your tenant, it might need some time for the transactional database synchronization."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object","in":"path","schemaId":"schema_5","description":"Specifies the custom object's API name as object. It is case-sensitive.","required":true},{"name":"id","in":"path","schemaId":"schema_223","description":"Id identifier in uuid form","required":true}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/CustomObjectRecordWithOnlyCustomFields"}},"schemaId":"components/schemas/CustomObjectRecordWithOnlyCustomFields","pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/objects/records/default/{object}/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object","in":"path","required":true,"schemaId":"schema_5"},{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/CustomObjectRecordWithOnlyCustomFields"}},"responseCodes":["200","404"],"pointer":"/objects/records/default/{object}/{id}","href":"custom-object-records/patch_partialupdatecustomobjectrecord","openApiOperationId":"Patch_PartialUpdateCustomObjectRecord","summary":"Partially update a custom object record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CustomObjectRecordWithOnlyCustomFields","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/CustomObjectRecordWithOnlyCustomFields"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordWithAllFields"}},"schemaId":"components/schemas/CustomObjectRecordWithAllFields","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Object record does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectRecordWithAllFields","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordWithAllFields"}}},{"code":"404","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-records/patch_partialupdatecustomobjectrecord"}],"panels":[]}]},"httpPath":"/objects/records/default/{object}/{id}"},{"label":"Delete a custom object record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/delete_customobjectrecordbyid","routeSlug":"/v1-api-reference/api/custom-object-records/delete_customobjectrecordbyid","metadata":{"seo":{"title":"Delete a custom object record","description":"Deletes a custom object record of the given type and ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_CustomObjectRecordByID","name":"Delete a custom object record","isWebhook":false,"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom object record","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 custom object record of the given type and ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that 200 response will be returned under either of the following conditions:"},"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 record is identified and successfully deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The record could not be found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the record is deleted immediately and, therefore, will not be retained upon successful deletion."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object","in":"path","schemaId":"schema_5","description":"Specifies the custom object's API name as object. It is case-sensitive.","required":true},{"name":"id","in":"path","schemaId":"schema_223","description":"Id identifier in uuid form","required":true}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/objects/records/default/{object}/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object","in":"path","required":true,"schemaId":"schema_5"},{"name":"id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/objects/records/default/{object}/{id}","href":"custom-object-records/delete_customobjectrecordbyid","openApiOperationId":"Delete_CustomObjectRecordByID","summary":"Delete a custom object record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224"}},"schemaId":"schema_224","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1records~1default~1{object}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_224","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-records/delete_customobjectrecordbyid"}],"panels":[]}]},"httpPath":"/objects/records/default/{object}/{id}"},{"label":"Update or delete custom object records","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-records/post_customobjectrecordsbatchupdateordelete","routeSlug":"/v1-api-reference/api/custom-object-records/post_customobjectrecordsbatchupdateordelete","metadata":{"seo":{"title":"Update or delete custom object records","description":"Makes a batch update or delete of custom object records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CustomObjectRecordsBatchUpdateOrDelete","name":"Update or delete custom object records","isWebhook":false,"pointer":"/paths/~1objects~1batch~1default~1{object}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update or delete custom object records","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":"Makes a batch update or delete of custom object records."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-records/post_customobjectrecordsbatchupdateordelete/request/limitations","deepLinkHash":"/custom-object-records/post_customobjectrecordsbatchupdateordelete#custom-object-records/post_customobjectrecordsbatchupdateordelete/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call has the following limitations:"},"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 maximum number of records that you can update by one call is 1,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of records that you can delete by one call is 1,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The storage of empty strings in records is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null values must be formatted as the following example:"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"action\": {\n    \"type\": \"update\",\n    \"records\": {\n      \"64edb2a5-2796-4e95-9559-846f8636a01b\": {\n        \"fieldName__c\": null\n      }\n    }\n  }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"action\": {\n    \"type\": \"update\",\n    \"records\": {\n      \"64edb2a5-2796-4e95-9559-846f8636a01b\": {\n        \"fieldName__c\": null\n      }\n    }\n  }\n}\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating or updating custom object records with relationship-type fields, Zuora verifies the related objects against the transactional databases, which are updated in near real-time. The record creation or modification fails upon unsuccessful verifications. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the related objects are newly created in your tenant, it might need some time for the transactional database synchronization."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object","in":"path","schemaId":"schema_5","description":"Specifies the custom object's API name as object. It is case-sensitive.","required":true}],"pointer":"/paths/~1objects~1batch~1default~1{object}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1batch~1default~1{object}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordBatchRequest"}},"schemaId":"components/schemas/CustomObjectRecordBatchRequest","pointer":"/paths/~1objects~1batch~1default~1{object}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/objects/batch/default/{object}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordBatchRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/objects/batch/default/{object}","href":"custom-object-records/post_customobjectrecordsbatchupdateordelete","openApiOperationId":"POST_CustomObjectRecordsBatchUpdateOrDelete","summary":"Update or delete custom object records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CustomObjectRecordBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the bacth "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action, it indicates the batch records have been successfully deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the batch "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action, it indicates that the batch records have been partially or completely updated."},"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":"allowPartialSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 200 response indicates that all object records have been successfully updated."},"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":"allowPartialSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 200 response indicates that some records might not be succesffully updated and the error information might be contained in the response body."},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordsBatchUpdatePartialSuccessResponse"}},"schemaId":"components/schemas/CustomObjectRecordsBatchUpdatePartialSuccessResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed schema validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the batch "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action, the 400 response only returns when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowPartialSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the batch records have failed schema validation."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordsErrorResponse"}},"schemaId":"components/schemas/CustomObjectRecordsErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse401Record"}},"schemaId":"components/schemas/ErrorResponse401Record","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"500","description":"Internal error. Retry the returned records.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordsThrottledResponse"}},"schemaId":"components/schemas/CustomObjectRecordsThrottledResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1batch~1default~1{object}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectRecordsBatchUpdatePartialSuccessResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordsBatchUpdatePartialSuccessResponse"}}},{"code":"400","schemaId":"components/schemas/CustomObjectRecordsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordsErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse401Record","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse401Record"}}},{"code":"500","schemaId":"components/schemas/CustomObjectRecordsThrottledResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectRecordsThrottledResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-records/post_customobjectrecordsbatchupdateordelete"}],"panels":[]}]},"httpPath":"/objects/batch/default/{object}"}],"content":{"contentType":"group","meta":{"name":"Custom Object Records"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Object Records","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":"With Custom Objects service, you can create, update, delete and find custom object records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can sign up for a free account on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://identity.getpostman.com/signup"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman website"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and download the app in case you do not use Postman yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the Custom Object Records API is versioned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header. The response may be different for the same request with a different API version. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/objects/records/default/{object}","summary":"Create custom object records","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-object-records/post_customobjectrecords","deprecated":false},{"title":"/objects/records/default/{object}","summary":"List records for a custom object","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-object-records/get_allrecordsforcustomobjecttype","deprecated":false},{"title":"/objects/records/default/{object}/{id}","summary":"Retrieve a custom object record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-object-records/get_customobjectrecordbyid","deprecated":false},{"title":"/objects/records/default/{object}/{id}","summary":"Update a custom object record","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-object-records/put_customobjectrecord","deprecated":false},{"title":"/objects/records/default/{object}/{id}","summary":"Partially update a custom object record","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-object-records/patch_partialupdatecustomobjectrecord","deprecated":false},{"title":"/objects/records/default/{object}/{id}","summary":"Delete a custom object record","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-object-records/delete_customobjectrecordbyid","deprecated":false},{"title":"/objects/batch/default/{object}","summary":"Update or delete custom object records","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-object-records/post_customobjectrecordsbatchupdateordelete","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Object Jobs","link":"/v1-api-reference/api/custom-object-jobs","routeSlug":"/v1-api-reference/api/custom-object-jobs","items":[{"type":"link","label":"Error handling","link":"/v1-api-reference/api/custom-object-jobs/error-handling","routeSlug":"/v1-api-reference/api/custom-object-jobs/error-handling","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Error handling"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-jobs/error-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Custom Objects API call fails, an error code will be returned in the response body. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-objects/custom-objects-api/custom-objects-api-error-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Objects API error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Submit a custom object bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/post_customobjectbulkjob","routeSlug":"/v1-api-reference/api/custom-object-jobs/post_customobjectbulkjob","metadata":{"seo":{"title":"Submit a custom object bulk job","description":"Submits a bulk job request for a bulk operation on the specified custom object records. A succcessful call returns a newly created bulk job. The job ID can be used to poll the job status or upload the CSV file if it is a create or update job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CustomObjectBulkJob","name":"Submit a custom object bulk job","isWebhook":false,"pointer":"/paths/~1objects~1jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a custom object bulk job","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":"Submits a bulk job request for a bulk operation on the specified custom object records. A succcessful call returns a newly created bulk job. The job ID can be used to poll the job status or upload the CSV file if it is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" job."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"custom-object-jobs/post_customobjectbulkjob/request/limits","deepLinkHash":"/custom-object-jobs/post_customobjectbulkjob#custom-object-jobs/post_customobjectbulkjob/request/limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This custom object bulk jobs have the following limits:"},"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 concurrent bulk job limit per tenant is 5. Bulk jobs in "},"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 are counted towards the concurrent bulk job limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulk job execuation order is not guaranteed, which means the bulk job that you submit ealier may be executed later."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the users that have the \"Delete Custom Objects\" permission can create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bulk job. Only the users that have the \"Edit Custom Objects\" permission can create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bulk job. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-user-role-for-platform"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform Permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobRequest"}},"schemaId":"components/schemas/CustomObjectBulkJobRequest","pointer":"/paths/~1objects~1jobs/post/requestBody","description":"Custom Objects bulk job request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/objects/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobRequest"}},"responseCodes":["200","400","403"],"pointer":"/objects/jobs","href":"custom-object-jobs/post_customobjectbulkjob","openApiOperationId":"POST_CustomObjectBulkJob","summary":"Submit a custom object bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CustomObjectBulkJobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobResponse"}},"schemaId":"components/schemas/CustomObjectBulkJobResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"403","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs/post/responses/403/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs/post/responses/403/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectBulkJobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobResponse"}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs/post/responses/400/content/application~1json/examples/response"]}}},{"code":"403","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs/post/responses/403/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs/post/responses/403/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-jobs/post_customobjectbulkjob"}],"panels":[]}]},"httpPath":"/objects/jobs"},{"label":"List all custom object bulk jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/get_allcustomobjectbulkjobs","routeSlug":"/v1-api-reference/api/custom-object-jobs/get_allcustomobjectbulkjobs","metadata":{"seo":{"title":"List all custom object bulk jobs","description":"Lists all custom object bulk jobs submitted by your tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AllCustomObjectBulkJobs","name":"List all custom object bulk jobs","isWebhook":false,"pointer":"/paths/~1objects~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all custom object bulk jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all custom object bulk jobs submitted by your tenant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_225","description":"The number of records returned per page in the response."},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$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":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" points to the last job of the previous result set. The cursor job is not included in this query result. The call returns the first page if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_226","description":"The status of bulk jobs to be retrieved."}],"pointer":"/paths/~1objects~1jobs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/objects/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_225"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"status","in":"query","required":false,"schemaId":"schema_226"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/objects/jobs","href":"custom-object-jobs/get_allcustomobjectbulkjobs","openApiOperationId":"GET_AllCustomObjectBulkJobs","summary":"List all custom object bulk jobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobResponseCollection"}},"schemaId":"components/schemas/CustomObjectBulkJobResponseCollection","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectBulkJobResponseCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobResponseCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-jobs/get_allcustomobjectbulkjobs"}],"panels":[]}]},"httpPath":"/objects/jobs"},{"label":"Retrieve a custom object bulk job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/get_customobjectbulkjob","routeSlug":"/v1-api-reference/api/custom-object-jobs/get_customobjectbulkjob","metadata":{"seo":{"title":"Retrieve a custom object bulk job","description":"Retrieves the custom object bulk job details by job ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CustomObjectBulkJob","name":"Retrieve a custom object bulk job","isWebhook":false,"pointer":"/paths/~1objects~1jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a custom object bulk job","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 the custom object bulk job details by job ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the users that have the \"View Custom Objects\" permission can retrieve custom object bulk jobs. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-user-role-for-platform"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform Permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the custom object bulk job to be retrieved.","required":true}],"pointer":"/paths/~1objects~1jobs~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/objects/jobs/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/objects/jobs/{id}","href":"custom-object-jobs/get_customobjectbulkjob","openApiOperationId":"GET_CustomObjectBulkJob","summary":"Retrieve a custom object bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobResponse"}},"schemaId":"components/schemas/CustomObjectBulkJobResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Bulk job not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectBulkJobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobResponse"}}},{"code":"404","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-jobs/get_customobjectbulkjob"}],"panels":[]}]},"httpPath":"/objects/jobs/{id}"},{"label":"Upload a file for a custom object bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/post_uploadfileforcustomobjectbulkjob","routeSlug":"/v1-api-reference/api/custom-object-jobs/post_uploadfileforcustomobjectbulkjob","metadata":{"seo":{"title":"Upload a file for a custom object bulk job","description":"Uploads a .csv file for a custom object bulk job to create or update custom object records. The job must be in pending status. Only one file is allowed per job. Each file supports only one type of operation, with an id column required for update operations. The job will start once the upload is finished."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_UploadFileForCustomObjectBulkJob","name":"Upload a file for a custom object bulk job","isWebhook":false,"pointer":"/paths/~1objects~1jobs~1{id}~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a file for a custom object bulk job","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":"Uploads a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file for a custom object bulk job to create or update custom object records. The job must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Only one file is allowed per job. Each file supports only one type of operation, with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column required for update operations. The job will start once the upload is finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the users that have the \"Edit Custom Objects\" permission can upload files to custom object bulk jobs. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-user-role-for-platform"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform Permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the custom object bulk job that the file is uploaded to.","required":true}],"pointer":"/paths/~1objects~1jobs~1{id}~1files/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_5","description":[{"$$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":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the request must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1objects~1jobs~1{id}~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/csv"],"mediaTypeSchemas":{"text/csv":{"schemaId":"schema_227"}},"schemaId":"schema_227","pointer":"/paths/~1objects~1jobs~1{id}~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/objects/jobs/{id}/files","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"text/csv":{"schemaId":"schema_227"}},"responseCodes":["200","400","403","404"],"pointer":"/objects/jobs/{id}/files","href":"custom-object-jobs/post_uploadfileforcustomobjectbulkjob","openApiOperationId":"POST_UploadFileForCustomObjectBulkJob","summary":"Upload a file for a custom object bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_227","mediaTypes":["text/csv"],"mediaTypeSchemas":{"text/csv":{"schemaId":"schema_227"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CustomObjectBulkJobResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"403","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/403/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/403/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Job not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1jobs~1{id}~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectBulkJobResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/400/content/application~1json/examples/response"]}}},{"code":"403","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/403/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/403/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1files/post/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-jobs/post_uploadfileforcustomobjectbulkjob"}],"panels":[]}]},"httpPath":"/objects/jobs/{id}/files"},{"label":"List all errors for a custom object bulk job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/get_customobjectbulkjoberrors","routeSlug":"/v1-api-reference/api/custom-object-jobs/get_customobjectbulkjoberrors","metadata":{"seo":{"title":"List all errors for a custom object bulk job","description":"Lists all errors for a custom object bulk job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CustomObjectBulkJobErrors","name":"List all errors for a custom object bulk job","isWebhook":false,"pointer":"/paths/~1objects~1jobs~1{id}~1errors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all errors for a custom object bulk job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all errors for a custom object bulk job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the custom object bulk job that you retrieve errors for.","required":true}],"pointer":"/paths/~1objects~1jobs~1{id}~1errors/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1jobs~1{id}~1errors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/objects/jobs/{id}/errors","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/objects/jobs/{id}/errors","href":"custom-object-jobs/get_customobjectbulkjoberrors","openApiOperationId":"GET_CustomObjectBulkJobErrors","summary":"List all errors for a custom object bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobErrorResponseCollection"}},"schemaId":"components/schemas/CustomObjectBulkJobErrorResponseCollection","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Job not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1errors/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1errors/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1jobs~1{id}~1errors/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectBulkJobErrorResponseCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobErrorResponseCollection"}}},{"code":"404","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1errors/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1errors/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-jobs/get_customobjectbulkjoberrors"}],"panels":[]}]},"httpPath":"/objects/jobs/{id}/errors"},{"label":"Cancel a custom object bulk job","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-object-jobs/patch_customobjectbulkjob","routeSlug":"/v1-api-reference/api/custom-object-jobs/patch_customobjectbulkjob","metadata":{"seo":{"title":"Cancel a custom object bulk job","description":"Cancel a custom object bulk job. Note that you can cancel a custom object bulk job only if the job status is accepted or pending."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH_CustomObjectBulkJob","name":"Cancel a custom object bulk job","isWebhook":false,"pointer":"/paths/~1objects~1jobs~1{id}~1cancel/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a custom object bulk job","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":"Cancel a custom object bulk job. Note that you can cancel a custom object bulk job only if the job status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"The ID of the custom object bulk job that you want to cancel.","required":true}],"pointer":"/paths/~1objects~1jobs~1{id}~1cancel/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version that determines the response schema. The default version is used if this parameter is not included. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"pointer":"/paths/~1objects~1jobs~1{id}~1cancel/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/objects/jobs/{id}/cancel","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_32"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/objects/jobs/{id}/cancel","href":"custom-object-jobs/patch_customobjectbulkjob","openApiOperationId":"PATCH_CustomObjectBulkJob","summary":"Cancel a custom object bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CustomObjectBulkJobResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Job not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1objects~1jobs~1{id}~1cancel/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomObjectBulkJobResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomObjectBulkJobResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1objects~1jobs~1{id}~1cancel/patch/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-jobs/patch_customobjectbulkjob"}],"panels":[]}]},"httpPath":"/objects/jobs/{id}/cancel"}],"content":{"contentType":"group","meta":{"name":"Custom Object Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Object Jobs","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":"With Custom Objects service, you can submit a bulk job request to create, update, or delete custom object records in a batch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can sign up for a free account on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://identity.getpostman.com/signup"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman website"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and download the app in case you do not use Postman yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the Custom Object Jobs API is versioned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header. The response may be different for the same request with a different API version. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header if you expect a specific response schema."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/objects/jobs","summary":"Submit a custom object bulk job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-object-jobs/post_customobjectbulkjob","deprecated":false},{"title":"/objects/jobs","summary":"List all custom object bulk jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-object-jobs/get_allcustomobjectbulkjobs","deprecated":false},{"title":"/objects/jobs/{id}","summary":"Retrieve a custom object bulk job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-object-jobs/get_customobjectbulkjob","deprecated":false},{"title":"/objects/jobs/{id}/files","summary":"Upload a file for a custom object bulk job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-object-jobs/post_uploadfileforcustomobjectbulkjob","deprecated":false},{"title":"/objects/jobs/{id}/errors","summary":"List all errors for a custom object bulk job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-object-jobs/get_customobjectbulkjoberrors","deprecated":false},{"title":"/objects/jobs/{id}/cancel","summary":"Cancel a custom object bulk job","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-object-jobs/patch_customobjectbulkjob","deprecated":false}]}]}]}]}},{"type":"separator","label":"System Health","content":null},{"type":"group","label":"API Health","link":"/v1-api-reference/api/api-health","routeSlug":"/v1-api-reference/api/api-health","items":[{"label":"List API volume summary records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/api-health/get_systemhealthapivolumesummary","routeSlug":"/v1-api-reference/api/api-health/get_systemhealthapivolumesummary","metadata":{"seo":{"title":"List API volume summary records","description":"Returns volume summary of API usage that generated by your Zuora tenant within a specified time range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_SystemHealthApiVolumeSummary","name":"List API volume summary records","isWebhook":false,"pointer":"/paths/~1system-health~1api-requests~1volume-summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List API volume summary records","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":"Returns volume summary of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-rest-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" usage that generated by your Zuora tenant within a specified time range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can filter the summary by API path name and http method."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"path","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by API path name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can refer to the api listed in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-apis-dashboard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API System Health Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the path name. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/accounts/{account-key}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"httpMethod","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by http method. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"startTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-09-22T09:07+0800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"endTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-09-29T09:07+0800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1system-health~1api-requests~1volume-summary/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1system-health~1api-requests~1volume-summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/system-health/api-requests/volume-summary","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"path","in":"query","required":false,"schemaId":"schema_5"},{"name":"httpMethod","in":"query","required":false,"schemaId":"schema_5"},{"name":"startTime","in":"query","required":true,"schemaId":"schema_23"},{"name":"endTime","in":"query","required":true,"schemaId":"schema_23"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/system-health/api-requests/volume-summary","href":"api-health/get_systemhealthapivolumesummary","openApiOperationId":"GET_SystemHealthApiVolumeSummary","summary":"List API volume summary records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApiVolumeSummaryResponse","exampleIds":["paths/~1system-health~1api-requests~1volume-summary/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetApiVolumeSummaryResponse","exampleIds":["paths/~1system-health~1api-requests~1volume-summary/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1volume-summary/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1volume-summary/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1system-health~1api-requests~1volume-summary/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetApiVolumeSummaryResponse","exampleIds":["paths/~1system-health~1api-requests~1volume-summary/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApiVolumeSummaryResponse","exampleIds":["paths/~1system-health~1api-requests~1volume-summary/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1volume-summary/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1volume-summary/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-health/get_systemhealthapivolumesummary"}],"panels":[]}]},"httpPath":"/system-health/api-requests/volume-summary"},{"label":"List API failure records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/api-health/getsystemhealthapifailurerecords","routeSlug":"/v1-api-reference/api/api-health/getsystemhealthapifailurerecords","metadata":{"seo":{"title":"List API failure records","description":"Returns failure records of API usage that are generated by your Zuora tenant within a specified time range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSystemHealthApiFailureRecords","name":"List API failure records","isWebhook":false,"pointer":"/paths/~1system-health~1api-requests~1failures/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List API failure records","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":"Returns failure records of API usage that are generated by your Zuora tenant within a specified time range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can filter the failure records by one or multiple 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":"text","inline":true,"attributes":{"content":"API path name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP method"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track ID"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"path","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by API path name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can refer to the API listed in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-apis-dashboard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API System Health Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the path name."},"children":[]}]}]}],"example":"/v1/accounts/{account-key}"},{"name":"httpMethod","in":"query","schemaId":"schema_5","description":"Filters the volume summary by http method.\n","example":"POST"},{"name":"responseCode","in":"query","schemaId":"schema_5","description":"Filters the volume summary by response code.\n","example":"INVALID_TYPE"},{"name":"requestId","in":"query","schemaId":"schema_5","description":"Filters the volume summary by request ID.\n"},{"name":"trackId","in":"query","schemaId":"schema_5","description":"Filters the volume summary by track ID.\n"},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form: "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"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 you do not specify any sortable field, the response data is sorted by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timerange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in descending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The supported sortable fields of this operation are as below:"},"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":"timerange"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http_method"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http_status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]}]}]}]}],"example":"sort=+latency"},{"name":"startTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2022-09-22T09:07+0800"},{"name":"endTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]}]}]}],"required":true,"example":"2022-09-29T09:07+0800"}],"pointer":"/paths/~1system-health~1api-requests~1failures/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1system-health~1api-requests~1failures/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/system-health/api-requests/failures","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"path","in":"query","required":false,"example":"/v1/accounts/{account-key}","schemaId":"schema_5"},{"name":"httpMethod","in":"query","required":false,"example":"POST","schemaId":"schema_5"},{"name":"responseCode","in":"query","required":false,"example":"INVALID_TYPE","schemaId":"schema_5"},{"name":"requestId","in":"query","required":false,"schemaId":"schema_5"},{"name":"trackId","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort","in":"query","required":false,"example":"sort=+latency","schemaId":"schema_5"},{"name":"startTime","in":"query","required":true,"example":"2022-09-22T09:07+0800","schemaId":"schema_23"},{"name":"endTime","in":"query","required":true,"example":"2022-09-29T09:07+0800","schemaId":"schema_23"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/system-health/api-requests/failures","href":"api-health/getsystemhealthapifailurerecords","openApiOperationId":"getSystemHealthApiFailureRecords","summary":"List API failure records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApiFailureRecordResponse","exampleIds":["paths/~1system-health~1api-requests~1failures/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetApiFailureRecordResponse","exampleIds":["paths/~1system-health~1api-requests~1failures/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_91"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1failures/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1failures/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_91"}],"pointer":"/paths/~1system-health~1api-requests~1failures/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetApiFailureRecordResponse","exampleIds":["paths/~1system-health~1api-requests~1failures/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApiFailureRecordResponse","exampleIds":["paths/~1system-health~1api-requests~1failures/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1failures/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1failures/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-health/getsystemhealthapifailurerecords"}],"panels":[]}]},"httpPath":"/system-health/api-requests/failures"},{"label":"List API usage detail records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/api-health/getsystemhealthapiperformancerecords","routeSlug":"/v1-api-reference/api/api-health/getsystemhealthapiperformancerecords","metadata":{"seo":{"title":"List API usage detail records","description":"Returns records of API usage that are generated by your Zuora tenant within a specified time range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSystemHealthApiPerformanceRecords","name":"List API usage detail records","isWebhook":false,"pointer":"/paths/~1system-health~1api-requests~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List API usage detail records","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":"Returns records of API usage that are generated by your Zuora tenant within a specified time range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can filter the records by one or multiple 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":"text","inline":true,"attributes":{"content":"API path name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP method"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track ID"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"path","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by API path name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can refer to the API listed in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-apis-dashboard"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API System Health Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the path name."},"children":[]}]}]}],"example":"/v1/accounts/{account-key}"},{"name":"httpMethod","in":"query","schemaId":"schema_5","description":"Filters the volume summary by http method.\n","example":"POST"},{"name":"responseCode","in":"query","schemaId":"schema_5","description":"Filters the volume summary by response code.\n","example":"INVALID_TYPE"},{"name":"requestId","in":"query","schemaId":"schema_5","description":"Filters the volume summary by request ID.\n"},{"name":"trackId","in":"query","schemaId":"schema_5","description":"Filters the volume summary by track ID.\n"},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form: "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"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 you do not specify any sortable field, the response data is sorted by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timerange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in descending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The supported sortable fields of this operation are as below:"},"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":"timerange"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http_method"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http_status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]}]}]}]}],"example":"sort=+latency"},{"name":"startTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2022-09-22T09:07+0800"},{"name":"endTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]}]}]}],"required":true,"example":"2022-09-29T09:07+0800"}],"pointer":"/paths/~1system-health~1api-requests~1details/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1system-health~1api-requests~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/system-health/api-requests/details","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"path","in":"query","required":false,"example":"/v1/accounts/{account-key}","schemaId":"schema_5"},{"name":"httpMethod","in":"query","required":false,"example":"POST","schemaId":"schema_5"},{"name":"responseCode","in":"query","required":false,"example":"INVALID_TYPE","schemaId":"schema_5"},{"name":"requestId","in":"query","required":false,"schemaId":"schema_5"},{"name":"trackId","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort","in":"query","required":false,"example":"sort=+latency","schemaId":"schema_5"},{"name":"startTime","in":"query","required":true,"example":"2022-09-22T09:07+0800","schemaId":"schema_23"},{"name":"endTime","in":"query","required":true,"example":"2022-09-29T09:07+0800","schemaId":"schema_23"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/system-health/api-requests/details","href":"api-health/getsystemhealthapiperformancerecords","openApiOperationId":"getSystemHealthApiPerformanceRecords","summary":"List API usage detail records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApiPerformanceDetailResponse","exampleIds":["paths/~1system-health~1api-requests~1details/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetApiPerformanceDetailResponse","exampleIds":["paths/~1system-health~1api-requests~1details/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_91"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1details/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1details/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_91"}],"pointer":"/paths/~1system-health~1api-requests~1details/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetApiPerformanceDetailResponse","exampleIds":["paths/~1system-health~1api-requests~1details/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApiPerformanceDetailResponse","exampleIds":["paths/~1system-health~1api-requests~1details/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1details/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1api-requests~1details/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-health/getsystemhealthapiperformancerecords"}],"panels":[]}]},"httpPath":"/system-health/api-requests/details"}],"content":{"contentType":"group","meta":{"name":"API Health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Health","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":"Zuora System Health dashboard for API (API dashboard) collects and displays data about API usage, failure, performance, and concurrency limit in near real time. It enables you to view all the APIs in your Zuora tenant within the last 14 days. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-apis-dashboard","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/system-health/api-requests/volume-summary","summary":"List API volume summary records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-health/get_systemhealthapivolumesummary","deprecated":false},{"title":"/system-health/api-requests/failures","summary":"List API failure records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-health/getsystemhealthapifailurerecords","deprecated":false},{"title":"/system-health/api-requests/details","summary":"List API usage detail records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-health/getsystemhealthapiperformancerecords","deprecated":false}]}]}]}]}},{"type":"group","label":"Bill Run Health","link":"/v1-api-reference/api/bill-run-health","routeSlug":"/v1-api-reference/api/bill-run-health","items":[{"label":"List billing document volume summary records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bill-run-health/get_systemhealthbillingdocvolumesummary","routeSlug":"/v1-api-reference/api/bill-run-health/get_systemhealthbillingdocvolumesummary","metadata":{"seo":{"title":"List billing document volume summary records","description":"Returns a summary of billing documents generated within a specified time range, including invoices and credit memos, and the total number of accounts that failed to process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_SystemHealthBillingDocVolumeSummary","name":"List billing document volume summary records","isWebhook":false,"pointer":"/paths/~1system-health~1billing-documents~1volume-summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List billing document volume summary records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a summary of billing documents generated within a specified time range, including invoices and credit memos, and the total number of accounts that failed to process.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-09-22T09:07+0800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"endTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-09-22T09:07+0800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1system-health~1billing-documents~1volume-summary/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1system-health~1billing-documents~1volume-summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/system-health/billing-documents/volume-summary","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"startTime","in":"query","required":true,"schemaId":"schema_23"},{"name":"endTime","in":"query","required":true,"schemaId":"schema_23"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/system-health/billing-documents/volume-summary","href":"bill-run-health/get_systemhealthbillingdocvolumesummary","openApiOperationId":"GET_SystemHealthBillingDocVolumeSummary","summary":"List billing document volume summary records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillingDocVolumeSummaryResponse","exampleIds":["paths/~1system-health~1billing-documents~1volume-summary/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetBillingDocVolumeSummaryResponse","exampleIds":["paths/~1system-health~1billing-documents~1volume-summary/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1billing-documents~1volume-summary/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1billing-documents~1volume-summary/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1system-health~1billing-documents~1volume-summary/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBillingDocVolumeSummaryResponse","exampleIds":["paths/~1system-health~1billing-documents~1volume-summary/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBillingDocVolumeSummaryResponse","exampleIds":["paths/~1system-health~1billing-documents~1volume-summary/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1billing-documents~1volume-summary/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1billing-documents~1volume-summary/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bill-run-health/get_systemhealthbillingdocvolumesummary"}],"panels":[]}]},"httpPath":"/system-health/billing-documents/volume-summary"}],"content":{"contentType":"group","meta":{"name":"Bill Run Health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bill Run Health","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":"Zuora System Health dashboard for Bill Run (Bill Run dashboard) collects and displays data about bill run usage, failure, and performance in near real time. Through the Bill Run dashboard, you can view data about all the bill runs in your Zuora tenant within the last 30 days. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-bill-run-dashboard","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill Run dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/system-health/billing-documents/volume-summary","summary":"List billing document volume summary records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bill-run-health/get_systemhealthbillingdocvolumesummary","deprecated":false}]}]}]}]}},{"type":"group","label":"Electronic Payments Health","link":"/v1-api-reference/api/electronic-payments-health","routeSlug":"/v1-api-reference/api/electronic-payments-health","items":[{"label":"List payment volume summary records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/electronic-payments-health/get_systemhealthpaymentvolumesummary","routeSlug":"/v1-api-reference/api/electronic-payments-health/get_systemhealthpaymentvolumesummary","metadata":{"seo":{"title":"List payment volume summary records","description":"Returns a summary of electronic payments handled by your Zuora tenant within a specified time range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_SystemHealthPaymentVolumeSummary","name":"List payment volume summary records","isWebhook":false,"pointer":"/paths/~1system-health~1payments~1volume-summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment volume summary records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a summary of electronic payments handled by your Zuora tenant within a specified time range.\n\nYou can filter the summary by payment gateway type and payment method type.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"paymentGatewayType","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by payment gateway type. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adyen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"paymentMethodType","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by payment method type. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"startTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-09-22T09:07+0800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"endTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-09-22T09:07+0800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1system-health~1payments~1volume-summary/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1system-health~1payments~1volume-summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/system-health/payments/volume-summary","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"paymentGatewayType","in":"query","required":false,"schemaId":"schema_5"},{"name":"paymentMethodType","in":"query","required":false,"schemaId":"schema_5"},{"name":"startTime","in":"query","required":true,"schemaId":"schema_23"},{"name":"endTime","in":"query","required":true,"schemaId":"schema_23"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/system-health/payments/volume-summary","href":"electronic-payments-health/get_systemhealthpaymentvolumesummary","openApiOperationId":"GET_SystemHealthPaymentVolumeSummary","summary":"List payment volume summary records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPaymentVolumeSummaryResponse","exampleIds":["paths/~1system-health~1payments~1volume-summary/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetPaymentVolumeSummaryResponse","exampleIds":["paths/~1system-health~1payments~1volume-summary/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1payments~1volume-summary/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1payments~1volume-summary/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1system-health~1payments~1volume-summary/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPaymentVolumeSummaryResponse","exampleIds":["paths/~1system-health~1payments~1volume-summary/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPaymentVolumeSummaryResponse","exampleIds":["paths/~1system-health~1payments~1volume-summary/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1payments~1volume-summary/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1payments~1volume-summary/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/electronic-payments-health/get_systemhealthpaymentvolumesummary"}],"panels":[]}]},"httpPath":"/system-health/payments/volume-summary"},{"label":"List payment system health records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/electronic-payments-health/getsystemhealthpaymentrecords","routeSlug":"/v1-api-reference/api/electronic-payments-health/getsystemhealthpaymentrecords","metadata":{"seo":{"title":"List payment system health records","description":"Returns System Health Electronic Payments records that are generated by your Zuora tenant within a specified time range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSystemHealthPaymentRecords","name":"List payment system health records","isWebhook":false,"pointer":"/paths/~1system-health~1payments~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment system health records","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":"Returns System Health Electronic Payments records that are generated by your Zuora tenant within a specified time range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can filter the failure records by one or multiple 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":"text","inline":true,"attributes":{"content":"payment gateway type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment method type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment gateway response code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"paymentGatewayType","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by payment gateway type. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adyen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"paymentMethodType","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by payment method type. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"paymentStatus","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by Payment Status. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"paymentGatewayResponseCode","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by Payment Gateway Response Code. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"currency","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the volume summary by currency. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form: "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"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 you do not specify any sortable field, the response data is sorted by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timerange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in descending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The supported sortable fields of this operation are as below:"},"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":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http_method"},"children":[]}]}]}]}],"example":"sort=-latency"},{"name":"startTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-09-22T09:07+0800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"endTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-09-22T09:07+0800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1system-health~1payments~1details/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1system-health~1payments~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/system-health/payments/details","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"paymentGatewayType","in":"query","required":false,"schemaId":"schema_5"},{"name":"paymentMethodType","in":"query","required":false,"schemaId":"schema_5"},{"name":"paymentStatus","in":"query","required":false,"schemaId":"schema_5"},{"name":"paymentGatewayResponseCode","in":"query","required":false,"schemaId":"schema_5"},{"name":"currency","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort","in":"query","required":false,"example":"sort=-latency","schemaId":"schema_5"},{"name":"startTime","in":"query","required":true,"schemaId":"schema_23"},{"name":"endTime","in":"query","required":true,"schemaId":"schema_23"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/system-health/payments/details","href":"electronic-payments-health/getsystemhealthpaymentrecords","openApiOperationId":"getSystemHealthPaymentRecords","summary":"List payment system health records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPaymentRecordsResponse","exampleIds":["paths/~1system-health~1payments~1details/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetPaymentRecordsResponse","exampleIds":["paths/~1system-health~1payments~1details/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1payments~1details/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1payments~1details/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1system-health~1payments~1details/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPaymentRecordsResponse","exampleIds":["paths/~1system-health~1payments~1details/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPaymentRecordsResponse","exampleIds":["paths/~1system-health~1payments~1details/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1payments~1details/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1payments~1details/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/electronic-payments-health/getsystemhealthpaymentrecords"}],"panels":[]}]},"httpPath":"/system-health/payments/details"}],"content":{"contentType":"group","meta":{"name":"Electronic Payments Health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Electronic Payments Health","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":"Zuora System Health dashboard for Electronic Payments (Electronic Payment dashboard) collects and displays usage, failure, and performance data about electronic payments in near real time. It enables you to view all the electronic payments in your Zuora tenant within the last 30 days. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-electronic-payments-dashboard","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Payments dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/system-health/payments/volume-summary","summary":"List payment volume summary records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/electronic-payments-health/get_systemhealthpaymentvolumesummary","deprecated":false},{"title":"/system-health/payments/details","summary":"List payment system health records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/electronic-payments-health/getsystemhealthpaymentrecords","deprecated":false}]}]}]}]}},{"type":"group","label":"Tax Health","link":"/v1-api-reference/api/tax-health","routeSlug":"/v1-api-reference/api/tax-health","items":[{"label":"List tax system health records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/tax-health/getsystemhealthtaxrecords","routeSlug":"/v1-api-reference/api/tax-health/getsystemhealthtaxrecords","metadata":{"seo":{"title":"List tax system health records","description":"Returns System Health Electronic records that are generated by your Zuora tenant within a specified time range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSystemHealthTaxRecords","name":"List tax system health records","isWebhook":false,"pointer":"/paths/~1system-health~1tax~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tax system health records","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":"Returns System Health Electronic records that are generated by your Zuora tenant within a specified time range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can filter the failure records by one or multiple 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":"text","inline":true,"attributes":{"content":"vendorName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eventType"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"vendorName","in":"query","schemaId":"schema_5","description":"Filters the records by vendor name.\n"},{"name":"eventType","in":"query","schemaId":"schema_5","description":"Filters the tax records by event type.\n"},{"name":"status","in":"query","schemaId":"schema_5","description":"Filters the tax records by status.\n"},{"name":"sort","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sortable field uses the following form: "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"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 you do not specify any sortable field, the response data is sorted by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timerange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in descending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to mark the order of sequencing. The operator is optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you only specify the sortable field without any operator, the response data is sorted in descending order by this field."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates an ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator indicates a descending order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field_name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the name of a sortable field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The supported sortable fields of this operation are as below:"},"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":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_duration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vendor_duration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_number"},"children":[]}]}]}]}],"example":"sort=-total_duration"},{"name":"startTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-09-22T09:07+0800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"endTime","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End time of the volume summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mmZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2022-09-22T09:07+0800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1system-health~1tax~1details/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1system-health~1tax~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/system-health/tax/details","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"vendorName","in":"query","required":false,"schemaId":"schema_5"},{"name":"eventType","in":"query","required":false,"schemaId":"schema_5"},{"name":"status","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort","in":"query","required":false,"example":"sort=-total_duration","schemaId":"schema_5"},{"name":"startTime","in":"query","required":true,"schemaId":"schema_23"},{"name":"endTime","in":"query","required":true,"schemaId":"schema_23"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/system-health/tax/details","href":"tax-health/getsystemhealthtaxrecords","openApiOperationId":"getSystemHealthTaxRecords","summary":"List tax system health records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTaxRecordsResponse","exampleIds":["paths/~1system-health~1tax~1details/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetTaxRecordsResponse","exampleIds":["paths/~1system-health~1tax~1details/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1tax~1details/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1tax~1details/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1system-health~1tax~1details/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetTaxRecordsResponse","exampleIds":["paths/~1system-health~1tax~1details/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTaxRecordsResponse","exampleIds":["paths/~1system-health~1tax~1details/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1tax~1details/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SystemHealthErrorResponse","exampleIds":["paths/~1system-health~1tax~1details/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-health/getsystemhealthtaxrecords"}],"panels":[]}]},"httpPath":"/system-health/tax/details"}],"content":{"contentType":"group","meta":{"name":"Tax Health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Health","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":"Zuora System Health dashboard for Tax Health (Tax Health dashboard) collects and displays usage, failure, and performance data about Tax in near real time. It enables you to view all the tax details in your Zuora tenant within the last 30 days. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-zuora-tax-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax Health Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/system-health/tax/details","summary":"List tax system health records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tax-health/getsystemhealthtaxrecords","deprecated":false}]}]}]}]}},{"type":"separator","label":"Workflow","content":null},{"type":"group","label":"Workflows","link":"/v1-api-reference/api/workflows","routeSlug":"/v1-api-reference/api/workflows","items":[{"label":"Create an authentication provider for workflows","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/createauthproviderworkflows","routeSlug":"/v1-api-reference/api/workflows/createauthproviderworkflows","metadata":{"seo":{"title":"Create an authentication provider for workflows","description":"Creates an authentication provider for reuse in Workflow tasks and supported integrations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAuthProviderWorkflows","name":"Create an authentication provider for workflows","isWebhook":false,"pointer":"/paths/~1auth_providers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an authentication provider for workflows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an authentication provider for reuse in Workflow tasks and supported integrations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1auth_providers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAuthProviderRequest","exampleIds":["paths/~1auth_providers/post/requestBody/content/application~1json/examples/basicAuth","paths/~1auth_providers/post/requestBody/content/application~1json/examples/s3"]}},"schemaId":"components/schemas/CreateAuthProviderRequest","exampleIds":["paths/~1auth_providers/post/requestBody/content/application~1json/examples/basicAuth","paths/~1auth_providers/post/requestBody/content/application~1json/examples/s3"],"pointer":"/paths/~1auth_providers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth_providers","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAuthProviderRequest","exampleIds":["paths/~1auth_providers/post/requestBody/content/application~1json/examples/basicAuth","paths/~1auth_providers/post/requestBody/content/application~1json/examples/s3"]}},"responseCodes":["201","400","422","500"],"pointer":"/auth_providers","href":"workflows/createauthproviderworkflows","openApiOperationId":"createAuthProviderWorkflows","summary":"Create an authentication provider for workflows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateAuthProviderRequest","exampleIds":["paths/~1auth_providers/post/requestBody/content/application~1json/examples/basicAuth","paths/~1auth_providers/post/requestBody/content/application~1json/examples/s3"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAuthProviderRequest","exampleIds":["paths/~1auth_providers/post/requestBody/content/application~1json/examples/basicAuth","paths/~1auth_providers/post/requestBody/content/application~1json/examples/s3"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Authentication provider created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateAuthProviderResponse","exampleIds":["paths/~1auth_providers/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CreateAuthProviderResponse","exampleIds":["paths/~1auth_providers/post/responses/201/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/422/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/422/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1auth_providers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateAuthProviderResponse","exampleIds":["paths/~1auth_providers/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateAuthProviderResponse","exampleIds":["paths/~1auth_providers/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/400/content/application~1json/examples/response"]}}},{"code":"422","schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/422/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/422/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/createauthproviderworkflows"}],"panels":[]}]},"httpPath":"/auth_providers"},{"label":"Update an authentication provider for workflows","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/updateauthproviderworkflows","routeSlug":"/v1-api-reference/api/workflows/updateauthproviderworkflows","metadata":{"seo":{"title":"Update an authentication provider for workflows","description":"Updates an authentication provider that is used for Workflow tasks and supported integrations. Only supplied fields are changed. The auth_type field cannot be changed after creation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAuthProviderWorkflows","name":"Update an authentication provider for workflows","isWebhook":false,"pointer":"/paths/~1auth_providers~1{provider_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an authentication provider for workflows","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 an authentication provider that is used for Workflow tasks and supported integrations. Only supplied fields are changed. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be changed after creation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"provider_id","in":"path","schemaId":"schema_228","description":"Identifier of the authentication provider to update.","required":true}],"pointer":"/paths/~1auth_providers~1{provider_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1auth_providers~1{provider_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAuthProviderRequest","exampleIds":["paths/~1auth_providers~1{provider_id}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateAuthProviderRequest","exampleIds":["paths/~1auth_providers~1{provider_id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1auth_providers~1{provider_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/auth_providers/{provider_id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"provider_id","in":"path","required":true,"example":"ffdb2cd6-d55d-4401-ac52-38d9e7c1d0cd","schemaId":"schema_228"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAuthProviderRequest","exampleIds":["paths/~1auth_providers~1{provider_id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","422","500"],"pointer":"/auth_providers/{provider_id}","href":"workflows/updateauthproviderworkflows","openApiOperationId":"updateAuthProviderWorkflows","summary":"Update an authentication provider for workflows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/UpdateAuthProviderRequest","exampleIds":["paths/~1auth_providers~1{provider_id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAuthProviderRequest","exampleIds":["paths/~1auth_providers~1{provider_id}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authentication provider updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateAuthProviderResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UpdateAuthProviderResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"404","description":"Authentication provider not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/422/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/422/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1auth_providers~1{provider_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateAuthProviderResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateAuthProviderResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/404/content/application~1json/examples/response"]}}},{"code":"422","schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/422/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/422/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/put/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/updateauthproviderworkflows"}],"panels":[]}]},"httpPath":"/auth_providers/{provider_id}"},{"label":"Delete an authentication provider for workflows","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/deleteauthproviderworkflows","routeSlug":"/v1-api-reference/api/workflows/deleteauthproviderworkflows","metadata":{"seo":{"title":"Delete an authentication provider for workflows","description":"Deletes an authentication provider that is used for Workflow tasks and supported integrations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAuthProviderWorkflows","name":"Delete an authentication provider for workflows","isWebhook":false,"pointer":"/paths/~1auth_providers~1{provider_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an authentication provider for workflows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an authentication provider that is used for Workflow tasks and supported integrations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"provider_id","in":"path","schemaId":"schema_228","description":"Identifier of the authentication provider to delete.","required":true}],"pointer":"/paths/~1auth_providers~1{provider_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1auth_providers~1{provider_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/auth_providers/{provider_id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"provider_id","in":"path","required":true,"example":"ffdb2cd6-d55d-4401-ac52-38d9e7c1d0cd","schemaId":"schema_228"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/auth_providers/{provider_id}","href":"workflows/deleteauthproviderworkflows","openApiOperationId":"deleteAuthProviderWorkflows","summary":"Delete an authentication provider for workflows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authentication provider deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteAuthProviderResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteAuthProviderResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"404","description":"Authentication provider not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding"},"RateLimit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset"},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1auth_providers~1{provider_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteAuthProviderResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteAuthProviderResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/404/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthProviderErrorResponse","exampleIds":["paths/~1auth_providers~1{provider_id}/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/deleteauthproviderworkflows"}],"panels":[]}]},"httpPath":"/auth_providers/{provider_id}"},{"label":"Delete a workflow version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/delete_workflowversion","routeSlug":"/v1-api-reference/api/workflows/delete_workflowversion","metadata":{"seo":{"title":"Delete a workflow version","description":"Delete a workflow version based on the version id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_WorkflowVersion","name":"Delete a workflow version","isWebhook":false,"pointer":"/paths/~1workflows~1versions~1{version_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a workflow version","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":"Delete a workflow version based on the version id."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/delete_workflowversion/request/user-access-permission","deepLinkHash":"/workflows/delete_workflowversion#workflows/delete_workflowversion/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Manage Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"version_id","in":"path","schemaId":"schema_50","description":"The unique id of the workflow version.","required":true}],"pointer":"/paths/~1workflows~1versions~1{version_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1versions~1{version_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workflows/versions/{version_id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"version_id","in":"path","required":true,"schemaId":"schema_50"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/workflows/versions/{version_id}","href":"workflows/delete_workflowversion","openApiOperationId":"DELETE_WorkflowVersion","summary":"Delete a workflow version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteWorkflowSuccess","exampleIds":["paths/~1workflows~1versions~1{version_id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteWorkflowSuccess","exampleIds":["paths/~1workflows~1versions~1{version_id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"403","description":"Cannot delete the active version of a workflow.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1versions~1{version_id}/delete/responses/403/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1versions~1{version_id}/delete/responses/403/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1versions~1{version_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteWorkflowSuccess","exampleIds":["paths/~1workflows~1versions~1{version_id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteWorkflowSuccess","exampleIds":["paths/~1workflows~1versions~1{version_id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"403","schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1versions~1{version_id}/delete/responses/403/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1versions~1{version_id}/delete/responses/403/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/delete_workflowversion"}],"panels":[]}]},"httpPath":"/workflows/versions/{version_id}"},{"label":"List workflows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflows","routeSlug":"/v1-api-reference/api/workflows/get_workflows","metadata":{"seo":{"title":"List workflows","description":"Retrieves a list of workflow definitions available in your Zuora tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Workflows","name":"List workflows","isWebhook":false,"pointer":"/paths/~1workflows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List workflows","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 workflow definitions available in your Zuora tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/get_workflows/request/user-access-permission","deepLinkHash":"/workflows/get_workflows#workflows/get_workflows/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow View Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"callout_trigger","in":"query","schemaId":"schema_27","description":"If set to true, the operation retrieves workflows that have the callout trigger enabled. If set to false, the operation retrieves workflows that have the callout trigger disabled. If not specified, the operation will not use this filter.\n"},{"name":"interval","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A CRON expession that specifies a schedule (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0 0 * * *"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). If specified, the operation retrieves the workflow that is run based on the specified schedule."},"children":[]}]}]}]},{"name":"name","in":"query","schemaId":"schema_5","description":"If specified, the operation retrieves the workflow that is in the specified name.\n"},{"name":"ondemand_trigger","in":"query","schemaId":"schema_27","description":"If set to true, the operation retrieves workflows that have the ondemand trigger enabled. If set to false, the operation retrieves workflows that have the ondemand trigger disabled. If not specified, the operation will not use this filter.\n"},{"name":"scheduled_trigger","in":"query","schemaId":"schema_27","description":"If set to true, the operation retrieves workflows that have the scheduled trigger enabled. If set to false, the operation retrieves workflows that have the scheduled trigger disabled. If not specfied, the operation will not use this filter.\n"},{"name":"page","in":"query","schemaId":"schema_229","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to retrieve only the workflows on a specific page, you can specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number in the query."},"children":[]}]}]}]},{"name":"page_length","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of workflows shown in a single call. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is not specified, the operation will return only the first page of results. If there are multiple pages of results, use it with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to get the results on subsequent pages. The maximum value is 50."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"callout_trigger","in":"query","required":false,"schemaId":"schema_27"},{"name":"interval","in":"query","required":false,"schemaId":"schema_5"},{"name":"name","in":"query","required":false,"schemaId":"schema_5"},{"name":"ondemand_trigger","in":"query","required":false,"schemaId":"schema_27"},{"name":"scheduled_trigger","in":"query","required":false,"schemaId":"schema_27"},{"name":"page","in":"query","required":false,"schemaId":"schema_229"},{"name":"page_length","in":"query","required":false,"schemaId":"schema_90"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/workflows","href":"workflows/get_workflows","openApiOperationId":"GET_Workflows","summary":"List workflows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWorkflowsResponse","exampleIds":["paths/~1workflows/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetWorkflowsResponse","exampleIds":["paths/~1workflows/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetWorkflowsResponse","exampleIds":["paths/~1workflows/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWorkflowsResponse","exampleIds":["paths/~1workflows/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/get_workflows"}],"panels":[]}]},"httpPath":"/workflows"},{"label":"Import a workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/post_workflowimport","routeSlug":"/v1-api-reference/api/workflows/post_workflowimport","metadata":{"seo":{"title":"Import a workflow","description":"Create a new workflow definition and its first version using the exported JSON document of an existing workflow version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_WorkflowImport","name":"Import a workflow","isWebhook":false,"pointer":"/paths/~1workflows~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import a workflow","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":"Create a new workflow definition and its first version using the exported JSON document of an existing workflow version."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/post_workflowimport/request/user-access-permission","deepLinkHash":"/workflows/post_workflowimport#workflows/post_workflowimport/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Manage Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"workflow_definition_id","in":"query","schemaId":"schema_50","description":"The unique id of the workflow definition to under."},{"name":"version","in":"query","schemaId":"schema_5","description":"The version number of the new workflow version to import. Must be greater than any existing version numbers."},{"name":"activate","in":"query","schemaId":"schema_27","description":"Indicates whether the imported version is an active version. Default to be false."}],"pointer":"/paths/~1workflows~1import/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTWorkflowDefinitionImportRequest"}},"schemaId":"components/schemas/POSTWorkflowDefinitionImportRequest","pointer":"/paths/~1workflows~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/import","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"workflow_definition_id","in":"query","required":false,"schemaId":"schema_50"},{"name":"version","in":"query","required":false,"schemaId":"schema_5"},{"name":"activate","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTWorkflowDefinitionImportRequest"}},"responseCodes":["200"],"pointer":"/workflows/import","href":"workflows/post_workflowimport","openApiOperationId":"POST_WorkflowImport","summary":"Import a workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTWorkflowDefinitionImportRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTWorkflowDefinitionImportRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Workflow","exampleIds":["paths/~1workflows~1import/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/Workflow","exampleIds":["paths/~1workflows~1import/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1import/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Workflow","exampleIds":["paths/~1workflows~1import/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Workflow","exampleIds":["paths/~1workflows~1import/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/post_workflowimport"}],"panels":[]}]},"httpPath":"/workflows/import"},{"label":"Retrieve workflow task usage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflowsusages","routeSlug":"/v1-api-reference/api/workflows/get_workflowsusages","metadata":{"seo":{"title":"Retrieve workflow task usage","description":"Gets workflow task usage sorted by day within a specified time frame."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_WorkflowsUsages","name":"Retrieve workflow task usage","isWebhook":false,"pointer":"/paths/~1workflows~1metrics.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve workflow task usage","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":"Gets workflow task usage sorted by day within a specified time frame."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/get_workflowsusages/request/user-access-permission","deepLinkHash":"/workflows/get_workflowsusages#workflows/get_workflowsusages/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow View Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_32","description":"The start date of the usage data that you want to get. For example, 2019-01-01.\n","required":true},{"name":"endDate","in":"query","schemaId":"schema_32","description":"The end date of the usage data that you want to get. For example, 2019-12-31.\n","required":true},{"name":"metrics","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of metric that you want to get. Currently, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taskCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taskCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the amount of task runs."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1workflows~1metrics.json/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1metrics.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/metrics.json","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"startDate","in":"query","required":true,"schemaId":"schema_32"},{"name":"endDate","in":"query","required":true,"schemaId":"schema_32"},{"name":"metrics","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/workflows/metrics.json","href":"workflows/get_workflowsusages","openApiOperationId":"GET_WorkflowsUsages","summary":"Retrieve workflow task usage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsagesResponse","exampleIds":["paths/~1workflows~1metrics.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/UsagesResponse","exampleIds":["paths/~1workflows~1metrics.json/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1metrics.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UsagesResponse","exampleIds":["paths/~1workflows~1metrics.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsagesResponse","exampleIds":["paths/~1workflows~1metrics.json/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/get_workflowsusages"}],"panels":[]}]},"httpPath":"/workflows/metrics.json"},{"label":"List workflow tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflowstasks","routeSlug":"/v1-api-reference/api/workflows/get_workflowstasks","metadata":{"seo":{"title":"List workflow tasks","description":"Retrieves a list of workflow tasks available in your Zuora tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_WorkflowsTasks","name":"List workflow tasks","isWebhook":false,"pointer":"/paths/~1workflows~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List workflow tasks","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 workflow tasks available in your Zuora tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/get_workflowstasks/request/user-access-permission","deepLinkHash":"/workflows/get_workflowstasks#workflows/get_workflowstasks/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow View Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_5","description":"If specified, the operation retrieves the task that is with specified id.\n"},{"name":"name","in":"query","schemaId":"schema_5","description":"If specified, the operation retrieves tasks that is in the specified name.\n"},{"name":"instance","in":"query","schemaId":"schema_27","description":"If set to true, the operation retrieves workflows that have the scheduled trigger enabled. If set to false, the operation retrieves workflows that have the scheduled trigger disabled. If not specfied, the operation will not use this filter.\n"},{"name":"action_type","in":"query","schemaId":"schema_5","description":"If specified, the operation retrieves tasks that is the specified type.\n"},{"name":"object","in":"query","schemaId":"schema_5","description":"If specified, the operation retrieves tasks with the specified object.\n"},{"name":"object_id","in":"query","schemaId":"schema_5","description":"If specified, the operation retrieves tasks with the specified object id.\n"},{"name":"call_type","in":"query","schemaId":"schema_5","description":"If specified, the operation retrieves tasks with the specified api call type used.\n"},{"name":"workflow_id","in":"query","schemaId":"schema_5","description":"If specified, the operation retrieves tasks that for the specified workflow id.\n"},{"name":"tags","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, the operation retrieves tasks that with the specified filter tags. Use the following syntax to specify multiple tags: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags[]=tag_value_1&tags[]=tag_value_2"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" All the workflow tasks that have any of the specified tags will be listed in the response body."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_229","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to retrieve only the workflows on a specific page, you can specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number in the query."},"children":[]}]}]}]},{"name":"page_length","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of workflow tasks shown in a single call. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is not specified, the operation will return only the first page of results. If there are multiple pages of results, use it with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to get the results on subsequent pages. The maximum value is 100."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1tasks/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/tasks","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","required":false,"schemaId":"schema_5"},{"name":"name","in":"query","required":false,"schemaId":"schema_5"},{"name":"instance","in":"query","required":false,"schemaId":"schema_27"},{"name":"action_type","in":"query","required":false,"schemaId":"schema_5"},{"name":"object","in":"query","required":false,"schemaId":"schema_5"},{"name":"object_id","in":"query","required":false,"schemaId":"schema_5"},{"name":"call_type","in":"query","required":false,"schemaId":"schema_5"},{"name":"workflow_id","in":"query","required":false,"schemaId":"schema_5"},{"name":"tags","in":"query","required":false,"schemaId":"schema_42","style":"form","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_229"},{"name":"page_length","in":"query","required":false,"schemaId":"schema_90"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/workflows/tasks","href":"workflows/get_workflowstasks","openApiOperationId":"GET_WorkflowsTasks","summary":"List workflow tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TasksResponse","exampleIds":["paths/~1workflows~1tasks/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/TasksResponse","exampleIds":["paths/~1workflows~1tasks/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TasksResponse","exampleIds":["paths/~1workflows~1tasks/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TasksResponse","exampleIds":["paths/~1workflows~1tasks/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/get_workflowstasks"}],"panels":[]}]},"httpPath":"/workflows/tasks"},{"label":"Update workflow tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/put_workflowstasksupdate","routeSlug":"/v1-api-reference/api/workflows/put_workflowstasksupdate","metadata":{"seo":{"title":"Update workflow tasks","description":"Updates a group of workflow tasks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_WorkflowsTasksUpdate","name":"Update workflow tasks","isWebhook":false,"pointer":"/paths/~1workflows~1tasks~1batch_update/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update workflow tasks","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 group of workflow tasks."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/put_workflowstasksupdate/request/user-access-permission","deepLinkHash":"/workflows/put_workflowstasksupdate#workflows/put_workflowstasksupdate/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Manage Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1tasks~1batch_update/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutTasksRequest"}},"schemaId":"components/schemas/PutTasksRequest","pointer":"/paths/~1workflows~1tasks~1batch_update/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workflows/tasks/batch_update","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutTasksRequest"}},"responseCodes":["200","400","404"],"pointer":"/workflows/tasks/batch_update","href":"workflows/put_workflowstasksupdate","openApiOperationId":"PUT_WorkflowsTasksUpdate","summary":"Update workflow tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PutTasksRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutTasksRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TasksResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/TasksResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request for one of the following reasons:"},"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":"Data is missing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is empty or not an array"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data has more than 50 tasks"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/BadRequestResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more tasks are missing the required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/BadRequestResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1tasks~1batch_update/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TasksResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TasksResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/BadRequestResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/BadRequestResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestResponse","exampleIds":["paths/~1workflows~1tasks~1batch_update/put/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/put_workflowstasksupdate"}],"panels":[]}]},"httpPath":"/workflows/tasks/batch_update"},{"label":"Retrieve a workflow task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflowstask","routeSlug":"/v1-api-reference/api/workflows/get_workflowstask","metadata":{"seo":{"title":"Retrieve a workflow task","description":"Retrieves a specific workflow task by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_WorkflowsTask","name":"Retrieve a workflow task","isWebhook":false,"pointer":"/paths/~1workflows~1tasks~1{task_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a workflow task","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 specific workflow task by its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/get_workflowstask/request/user-access-permission","deepLinkHash":"/workflows/get_workflowstask#workflows/get_workflowstask/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow View Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_5","description":"The unique ID of the task.\n","required":true}],"pointer":"/paths/~1workflows~1tasks~1{task_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1tasks~1{task_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/tasks/{task_id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/workflows/tasks/{task_id}","href":"workflows/get_workflowstask","openApiOperationId":"GET_WorkflowsTask","summary":"Retrieve a workflow task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task","exampleIds":["paths/~1workflows~1tasks~1{task_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/Task","exampleIds":["paths/~1workflows~1tasks~1{task_id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1tasks~1{task_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Task","exampleIds":["paths/~1workflows~1tasks~1{task_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task","exampleIds":["paths/~1workflows~1tasks~1{task_id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/get_workflowstask"}],"panels":[]}]},"httpPath":"/workflows/tasks/{task_id}"},{"label":"Rerun a workflow task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/post_workflowstaskrerun","routeSlug":"/v1-api-reference/api/workflows/post_workflowstaskrerun","metadata":{"seo":{"title":"Rerun a workflow task","description":"Reruns a specific workflow task by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_WorkflowsTaskRerun","name":"Rerun a workflow task","isWebhook":false,"pointer":"/paths/~1workflows~1tasks~1{task_id}~1rerun/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rerun a workflow task","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":"Reruns a specific workflow task by its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/post_workflowstaskrerun/request/user-access-permission","deepLinkHash":"/workflows/post_workflowstaskrerun#workflows/post_workflowstaskrerun/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Run Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_5","description":"The unique ID of the task.\n","required":true}],"pointer":"/paths/~1workflows~1tasks~1{task_id}~1rerun/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1tasks~1{task_id}~1rerun/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/tasks/{task_id}/rerun","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/workflows/tasks/{task_id}/rerun","href":"workflows/post_workflowstaskrerun","openApiOperationId":"POST_WorkflowsTaskRerun","summary":"Rerun a workflow task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task","exampleIds":["paths/~1workflows~1tasks~1{task_id}~1rerun/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/Task","exampleIds":["paths/~1workflows~1tasks~1{task_id}~1rerun/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1tasks~1{task_id}~1rerun/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Task","exampleIds":["paths/~1workflows~1tasks~1{task_id}~1rerun/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task","exampleIds":["paths/~1workflows~1tasks~1{task_id}~1rerun/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/post_workflowstaskrerun"}],"panels":[]}]},"httpPath":"/workflows/tasks/{task_id}/rerun"},{"label":"Retrieve a workflow run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflow_run","routeSlug":"/v1-api-reference/api/workflows/get_workflow_run","metadata":{"seo":{"title":"Retrieve a workflow run","description":"Retrieves information about a specific workflow run by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Workflow_Run","name":"Retrieve a workflow run","isWebhook":false,"pointer":"/paths/~1workflows~1workflow_runs~1{workflow_run_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a workflow run","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 information about a specific workflow run by its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/get_workflow_run/request/user-access-permission","deepLinkHash":"/workflows/get_workflow_run#workflows/get_workflow_run/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow View Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_run_id","in":"path","schemaId":"schema_5","description":"The unique ID of a workflow run. For example, 19080.\n","required":true}],"pointer":"/paths/~1workflows~1workflow_runs~1{workflow_run_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1workflow_runs~1{workflow_run_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/workflow_runs/{workflow_run_id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"workflow_run_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/workflows/workflow_runs/{workflow_run_id}","href":"workflows/get_workflow_run","openApiOperationId":"GET_Workflow_Run","summary":"Retrieve a workflow run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWorkflowResponse","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetWorkflowResponse","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1workflow_runs~1{workflow_run_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetWorkflowResponse","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWorkflowResponse","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/get_workflow_run"}],"panels":[]}]},"httpPath":"/workflows/workflow_runs/{workflow_run_id}"},{"label":"Delete a workflow","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/delete_workflow","routeSlug":"/v1-api-reference/api/workflows/delete_workflow","metadata":{"seo":{"title":"Delete a workflow","description":"Deletes a specific workflow by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_Workflow","name":"Delete a workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflow_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a workflow","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 specific workflow by its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/delete_workflow/request/user-access-permission","deepLinkHash":"/workflows/delete_workflow#workflows/delete_workflow/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Manage Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_id","in":"path","schemaId":"schema_5","description":"The unique ID of a workflow definition. For example, 19080.\n","required":true}],"pointer":"/paths/~1workflows~1{workflow_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1{workflow_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workflows/{workflow_id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"workflow_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/workflows/{workflow_id}","href":"workflows/delete_workflow","openApiOperationId":"DELETE_Workflow","summary":"Delete a workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteWorkflowSuccess","exampleIds":["paths/~1workflows~1{workflow_id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteWorkflowSuccess","exampleIds":["paths/~1workflows~1{workflow_id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"The workflow for the given id does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1{workflow_id}/delete/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1{workflow_id}/delete/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1{workflow_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteWorkflowSuccess","exampleIds":["paths/~1workflows~1{workflow_id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteWorkflowSuccess","exampleIds":["paths/~1workflows~1{workflow_id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1{workflow_id}/delete/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1{workflow_id}/delete/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/delete_workflow"}],"panels":[]}]},"httpPath":"/workflows/{workflow_id}"},{"label":"Retrieve a workflow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflow","routeSlug":"/v1-api-reference/api/workflows/get_workflow","metadata":{"seo":{"title":"Retrieve a workflow","description":"Retrieves information about a specific workflow by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Workflow","name":"Retrieve a workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflow_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a workflow","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 information about a specific workflow by its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/get_workflow/request/user-access-permission","deepLinkHash":"/workflows/get_workflow#workflows/get_workflow/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow View Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_id","in":"path","schemaId":"schema_5","description":"The unique ID of a workflow definition. For example, 19080.\n","required":true}],"pointer":"/paths/~1workflows~1{workflow_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1{workflow_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/{workflow_id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"workflow_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/workflows/{workflow_id}","href":"workflows/get_workflow","openApiOperationId":"GET_Workflow","summary":"Retrieve a workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1{workflow_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/get_workflow"}],"panels":[]}]},"httpPath":"/workflows/{workflow_id}"},{"label":"Update a workflow","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/patch_updateworkflow","routeSlug":"/v1-api-reference/api/workflows/patch_updateworkflow","metadata":{"seo":{"title":"Update a workflow","description":"Updates a specific workflow by its ID, which allows you to configure the settings of a workflow via API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH_UpdateWorkflow","name":"Update a workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflow_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a workflow","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 specific workflow by its ID, which allows you to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-manage-access-permissions-workflow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configure the settings of a workflow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via API."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/patch_updateworkflow/request/user-access-permission","deepLinkHash":"/workflows/patch_updateworkflow#workflows/patch_updateworkflow/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Manage Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_id","in":"path","schemaId":"schema_5","description":"The unique ID of a workflow definition. For example, 19080.\n","required":true}],"pointer":"/paths/~1workflows~1{workflow_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1{workflow_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_230"}},"schemaId":"schema_230","pointer":"/paths/~1workflows~1{workflow_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/workflows/{workflow_id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"workflow_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_230"}},"responseCodes":["200","404","422"],"pointer":"/workflows/{workflow_id}","href":"workflows/patch_updateworkflow","openApiOperationId":"PATCH_UpdateWorkflow","summary":"Update a workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_230","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_230"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"The workflow for the given id does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request for one of the following reasons:"},"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 name or description fields are not strings."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ondemand_trigger, callout_trigger, or scheduled_trigger fields are not booleans."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timezone does not match one of the valid values in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.google.com/spreadsheets/d/1skhepi-q5l9LyaMUPZjU_V9gzTphNMqNyV6ST5mygEo/edit?usp=sharing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this spread sheet"},"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":"The priority is not one of High, Medium, or Low."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status is not one of Active or Inactive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled_trigger is set to true but a valid timezone and interval were not passed."},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrors","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/422/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ValidationErrors","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/422/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1{workflow_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/200/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteWorkflowError","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/404/content/application~1json/examples/response"]}}},{"code":"422","schemaId":"components/schemas/ValidationErrors","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/422/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrors","exampleIds":["paths/~1workflows~1{workflow_id}/patch/responses/422/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/patch_updateworkflow"}],"panels":[]}]},"httpPath":"/workflows/{workflow_id}"},{"label":"Export a workflow version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflowexport","routeSlug":"/v1-api-reference/api/workflows/get_workflowexport","metadata":{"seo":{"title":"Export a workflow version","description":"Exports a workflow version into a JSON file. This file can be used to create a copy of this workflow version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_WorkflowExport","name":"Export a workflow version","isWebhook":false,"pointer":"/paths/~1workflows~1{workflow_id}~1export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export a workflow version","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":"Exports a workflow version into a JSON file. This file can be used to create a copy of this workflow version."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/get_workflowexport/request/user-access-permission","deepLinkHash":"/workflows/get_workflowexport#workflows/get_workflowexport/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow View Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_id","in":"path","schemaId":"schema_50","description":"The ID of the workflow definition to export.","required":true}],"pointer":"/paths/~1workflows~1{workflow_id}~1export/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_5","description":"Default result is the active version of the workflow definition. Version number and 'latest' can be used to export a specific version of the workflow definition. \n"}],"pointer":"/paths/~1workflows~1{workflow_id}~1export/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1{workflow_id}~1export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/{workflow_id}/export","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"workflow_id","in":"path","required":true,"schemaId":"schema_50"}],"query":[{"name":"version","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/workflows/{workflow_id}/export","href":"workflows/get_workflowexport","openApiOperationId":"GET_WorkflowExport","summary":"Export a workflow version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportWorkflowVersionResponse","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ExportWorkflowVersionResponse","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"The input of version is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Workflow version is not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1{workflow_id}~1export/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExportWorkflowVersionResponse","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportWorkflowVersionResponse","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/400/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1export/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/get_workflowexport"}],"panels":[]}]},"httpPath":"/workflows/{workflow_id}/export"},{"label":"Run a workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/post_run_workflow","routeSlug":"/v1-api-reference/api/workflows/post_run_workflow","metadata":{"seo":{"title":"Run a workflow","description":"Run a specified workflow. In the request body, you can include parameters that you want to pass to the workflow. For the parameters to be recognized and picked up by tasks in the workflow, you need to define the parameters first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Run_Workflow","name":"Run a workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflow_id}~1run/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run a workflow","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":"Run a specified workflow. In the request body, you can include parameters that you want to pass to the workflow. For the parameters to be recognized and picked up by tasks in the workflow, you need to define the parameters first."},"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":": To run a workflow, do not use the following reserved words in the request body of the parameters."},"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":"controller"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/post_run_workflow/request/user-access-permission","deepLinkHash":"/workflows/post_run_workflow#workflows/post_run_workflow/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Run Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To learn about how to define parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-manage-access-permissions-workflow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure the settings of a workflow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_id","in":"path","schemaId":"schema_50","description":"The ID of the workflow definition you want to run.","required":true}],"pointer":"/paths/~1workflows~1{workflow_id}~1run/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1{workflow_id}~1run/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_232"}},"schemaId":"schema_232","pointer":"/paths/~1workflows~1{workflow_id}~1run/post/requestBody","description":"Include parameters you want to pass to the workflow."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflow_id}/run","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"workflow_id","in":"path","required":true,"schemaId":"schema_50"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_232"}},"responseCodes":["200","400","406","409"],"pointer":"/workflows/{workflow_id}/run","href":"workflows/post_run_workflow","openApiOperationId":"POST_Run_Workflow","summary":"Run a workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_232","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_232"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowInstance","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WorkflowInstance","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Callout not enabled for the workflow","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"406","description":"The provided body is missing one or more required parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/406/content/application~1json/examples/response"]}},"schemaId":"schema_233","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/406/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided workflow_id references a workflow instance"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/409/content/application~1json/examples/response"]}},"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/409/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request\nheaders, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_234"}],"pointer":"/paths/~1workflows~1{workflow_id}~1run/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowInstance","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowInstance","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/400/content/application~1json/examples/response"]}}},{"code":"406","schemaId":"schema_233","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/406/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/406/content/application~1json/examples/response"]}}},{"code":"409","schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/409/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1workflows~1{workflow_id}~1run/post/responses/409/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/post_run_workflow"}],"panels":[]}]},"httpPath":"/workflows/{workflow_id}/run"},{"label":"List all versions of a workflow definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/get_workflowversions","routeSlug":"/v1-api-reference/api/workflows/get_workflowversions","metadata":{"seo":{"title":"List all versions of a workflow definition","description":"Return a list of all workflow versions under a workflow definition"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_WorkflowVersions","name":"List all versions of a workflow definition","isWebhook":false,"pointer":"/paths/~1workflows~1{workflow_id}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all versions of a workflow definition","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":"Return a list of all workflow versions under a workflow definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/get_workflowversions/request/user-access-permission","deepLinkHash":"/workflows/get_workflowversions#workflows/get_workflowversions/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow View Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_id","in":"path","schemaId":"schema_50","description":"The unique id of the workflow definition to import a workflow version under.","required":true}],"pointer":"/paths/~1workflows~1{workflow_id}~1versions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1{workflow_id}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/{workflow_id}/versions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"workflow_id","in":"path","required":true,"schemaId":"schema_50"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/workflows/{workflow_id}/versions","href":"workflows/get_workflowversions","openApiOperationId":"GET_WorkflowVersions","summary":"List all versions of a workflow definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetVersionsResponse","exampleIds":["paths/~1workflows~1{workflow_id}~1versions/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetVersionsResponse","exampleIds":["paths/~1workflows~1{workflow_id}~1versions/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1{workflow_id}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetVersionsResponse","exampleIds":["paths/~1workflows~1{workflow_id}~1versions/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetVersionsResponse","exampleIds":["paths/~1workflows~1{workflow_id}~1versions/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/get_workflowversions"}],"panels":[]}]},"httpPath":"/workflows/{workflow_id}/versions"},{"label":"Import a workflow version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/post_workflowversionsimport","routeSlug":"/v1-api-reference/api/workflows/post_workflowversionsimport","metadata":{"seo":{"title":"Import a workflow version","description":"Create a new workflow version under a workflow definition using the exported JSON document of an existing workflow version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_WorkflowVersionsImport","name":"Import a workflow version","isWebhook":false,"pointer":"/paths/~1workflows~1{workflow_id}~1versions~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import a workflow version","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":"Create a new workflow version under a workflow definition using the exported JSON document of an existing workflow version."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/post_workflowversionsimport/request/user-access-permission","deepLinkHash":"/workflows/post_workflowversionsimport#workflows/post_workflowversionsimport/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow Manage Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_id","in":"path","schemaId":"schema_50","description":"The unique id of the workflow definition to import a workflow version under.","required":true}],"pointer":"/paths/~1workflows~1{workflow_id}~1versions~1import/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_5","description":"The version number of the new workflow version to import. Must be greater than any existing version numbers.","required":true},{"name":"activate","in":"query","schemaId":"schema_27","description":"Indicates whether the imported version is an active version. Default to be false."}],"pointer":"/paths/~1workflows~1{workflow_id}~1versions~1import/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1{workflow_id}~1versions~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTWorkflowDefinitionImportRequest"}},"schemaId":"components/schemas/POSTWorkflowDefinitionImportRequest","pointer":"/paths/~1workflows~1{workflow_id}~1versions~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflow_id}/versions/import","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"workflow_id","in":"path","required":true,"schemaId":"schema_50"}],"query":[{"name":"version","in":"query","required":true,"schemaId":"schema_5"},{"name":"activate","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTWorkflowDefinitionImportRequest"}},"responseCodes":["200"],"pointer":"/workflows/{workflow_id}/versions/import","href":"workflows/post_workflowversionsimport","openApiOperationId":"POST_WorkflowVersionsImport","summary":"Import a workflow version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTWorkflowDefinitionImportRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTWorkflowDefinitionImportRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}~1versions~1import/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}~1versions~1import/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1workflows~1{workflow_id}~1versions~1import/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}~1versions~1import/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowDefinition","exampleIds":["paths/~1workflows~1{workflow_id}~1versions~1import/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/post_workflowversionsimport"}],"panels":[]}]},"httpPath":"/workflows/{workflow_id}/versions/import"},{"label":"Stop a workflow run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/workflows/put_stopworkflowrun","routeSlug":"/v1-api-reference/api/workflows/put_stopworkflowrun","metadata":{"seo":{"title":"Stop a workflow run","description":"Stop a specific workflow run by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_StopWorkflowRun","name":"Stop a workflow run","isWebhook":false,"pointer":"/paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop a workflow run","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":"Stop a specific workflow run by its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"workflows/put_stopworkflowrun/request/user-access-permission","deepLinkHash":"/workflows/put_stopworkflowrun#workflows/put_stopworkflowrun/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow View Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflow_run_id","in":"path","schemaId":"schema_5","description":"The unique ID of a workflow run. For example, 19080.\n","required":true}],"pointer":"/paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-org"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workflows/workflow_runs/{workflow_run_id}/stop","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"workflow_run_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","schemaId":"schema_5"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/workflows/workflow_runs/{workflow_run_id}/stop","href":"workflows/put_stopworkflowrun","openApiOperationId":"PUT_StopWorkflowRun","summary":"Stop a workflow run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StopWorkflowRunSuccess","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/StopWorkflowRunSuccess","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/200/content/application~1json/example"],"headers":{"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_91"},{"code":"404","description":"Cannot find a workflow run with id provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StopWorkflowRunError","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/StopWorkflowRunError","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/404/content/application~1json/example"],"headers":{"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_91"}],"pointer":"/paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StopWorkflowRunSuccess","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StopWorkflowRunSuccess","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/StopWorkflowRunError","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StopWorkflowRunError","exampleIds":["paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/put_stopworkflowrun"}],"panels":[]}]},"httpPath":"/workflows/workflow_runs/{workflow_run_id}/stop"}],"content":{"contentType":"group","meta":{"name":"Workflows"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflows","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":"A workflow is a sequence of tasks that are performed based on predefined logic. A workflow improves efficiency and reduces errors by automating a series of complex tasks that otherwise need to be performed manually and repetitively."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-workflow-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth_providers","summary":"Create an authentication provider for workflows","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflows/createauthproviderworkflows","deprecated":false},{"title":"/auth_providers/{provider_id}","summary":"Update an authentication provider for workflows","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflows/updateauthproviderworkflows","deprecated":false},{"title":"/auth_providers/{provider_id}","summary":"Delete an authentication provider for workflows","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workflows/deleteauthproviderworkflows","deprecated":false},{"title":"/workflows/versions/{version_id}","summary":"Delete a workflow version","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workflows/delete_workflowversion","deprecated":false},{"title":"/workflows","summary":"List workflows","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflows/get_workflows","deprecated":false},{"title":"/workflows/import","summary":"Import a workflow","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflows/post_workflowimport","deprecated":false},{"title":"/workflows/metrics.json","summary":"Retrieve workflow task usage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflows/get_workflowsusages","deprecated":false},{"title":"/workflows/tasks","summary":"List workflow tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflows/get_workflowstasks","deprecated":false},{"title":"/workflows/tasks/batch_update","summary":"Update workflow tasks","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflows/put_workflowstasksupdate","deprecated":false},{"title":"/workflows/tasks/{task_id}","summary":"Retrieve a workflow task","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflows/get_workflowstask","deprecated":false},{"title":"/workflows/tasks/{task_id}/rerun","summary":"Rerun a workflow task","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflows/post_workflowstaskrerun","deprecated":false},{"title":"/workflows/workflow_runs/{workflow_run_id}","summary":"Retrieve a workflow run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflows/get_workflow_run","deprecated":false},{"title":"/workflows/{workflow_id}","summary":"Delete a workflow","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workflows/delete_workflow","deprecated":false},{"title":"/workflows/{workflow_id}","summary":"Retrieve a workflow","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflows/get_workflow","deprecated":false},{"title":"/workflows/{workflow_id}","summary":"Update a workflow","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/workflows/patch_updateworkflow","deprecated":false},{"title":"/workflows/{workflow_id}/export","summary":"Export a workflow version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflows/get_workflowexport","deprecated":false},{"title":"/workflows/{workflow_id}/run","summary":"Run a workflow","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflows/post_run_workflow","deprecated":false},{"title":"/workflows/{workflow_id}/versions","summary":"List all versions of a workflow definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflows/get_workflowversions","deprecated":false},{"title":"/workflows/{workflow_id}/versions/import","summary":"Import a workflow version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflows/post_workflowversionsimport","deprecated":false},{"title":"/workflows/workflow_runs/{workflow_run_id}/stop","summary":"Stop a workflow run","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflows/put_stopworkflowrun","deprecated":false}]}]}]}]}},{"type":"separator","label":"Data Query","content":null},{"type":"group","label":"Data Queries","link":"/v1-api-reference/api/data-queries","routeSlug":"/v1-api-reference/api/data-queries","items":[{"label":"List data query jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-queries/get_dataqueryjobs","routeSlug":"/v1-api-reference/api/data-queries/get_dataqueryjobs","metadata":{"seo":{"title":"List data query jobs","description":"Returns a list of data query jobs that have been created in your Zuora tenant. You can filter the list by status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DataQueryJobs","name":"List data query jobs","isWebhook":false,"pointer":"/paths/~1query~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List data query jobs","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":"Returns a list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-query-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" jobs that have been created in your Zuora tenant. You can filter the list by status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are an administrator, you can retrieve all the query jobs in your tenant. Otherwise, you can only retrieve your own query jobs."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"queryStatus","in":"query","schemaId":"schema_235","description":"Filters the list of query jobs by status.\n"},{"name":"pageSize","in":"query","schemaId":"schema_236","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1query~1jobs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1query~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/query/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"queryStatus","in":"query","required":false,"schemaId":"schema_235"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_236"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/query/jobs","href":"data-queries/get_dataqueryjobs","openApiOperationId":"GET_DataQueryJobs","summary":"List data query jobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDataQueryJobsResponse","exampleIds":["paths/~1query~1jobs/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetDataQueryJobsResponse","exampleIds":["paths/~1query~1jobs/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1query~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetDataQueryJobsResponse","exampleIds":["paths/~1query~1jobs/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDataQueryJobsResponse","exampleIds":["paths/~1query~1jobs/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-queries/get_dataqueryjobs"}],"panels":[]}]},"httpPath":"/query/jobs"},{"label":"Submit a data query","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-queries/post_dataqueryjob","routeSlug":"/v1-api-reference/api/data-queries/post_dataqueryjob","metadata":{"seo":{"title":"Submit a data query","description":"Submits a data query to be executed by Zuora, creating a new query job. Use the Retrieve a data query job endpoint to monitor the job status and access the results once complete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_DataQueryJob","name":"Submit a data query","isWebhook":false,"pointer":"/paths/~1query~1jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a data query","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":"Submits a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-query-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be executed by Zuora, creating a new query job. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/GET_DataQueryJob/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a data query job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to monitor the job status and access the results once complete."},"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 request must include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type: application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. If this header is missing, the request will fail with the following error: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"code\":415,\"message\":\"HTTP 415 Unsupported Media Type\"}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_237","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the media type of the request payload. You must include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type: application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header when submitting a data query."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1query~1jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmitDataQueryRequest"}},"schemaId":"components/schemas/SubmitDataQueryRequest","pointer":"/paths/~1query~1jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/query/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_237"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubmitDataQueryRequest"}},"responseCodes":["200","400","415"],"pointer":"/query/jobs","href":"data-queries/post_dataqueryjob","openApiOperationId":"POST_DataQueryJob","summary":"Submit a data query"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/SubmitDataQueryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmitDataQueryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitDataQueryResponse","exampleIds":["paths/~1query~1jobs/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SubmitDataQueryResponse","exampleIds":["paths/~1query~1jobs/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"415","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsupported Media Type. This error is returned when the request is missing the required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type: application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs/post/responses/415/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs/post/responses/415/content/application~1json/examples/response"]}],"pointer":"/paths/~1query~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubmitDataQueryResponse","exampleIds":["paths/~1query~1jobs/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitDataQueryResponse","exampleIds":["paths/~1query~1jobs/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs/post/responses/400/content/application~1json/examples/response"]}}},{"code":"415","schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs/post/responses/415/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs/post/responses/415/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-queries/post_dataqueryjob"}],"panels":[]}]},"httpPath":"/query/jobs"},{"label":"Cancel a data query job","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-queries/delete_dataqueryjob","routeSlug":"/v1-api-reference/api/data-queries/delete_dataqueryjob","metadata":{"seo":{"title":"Cancel a data query job","description":"Cancels a data query job, which prevents Zuora from performing the query. This operation is only applicable if the status of the query job is accepted or in_progress."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_DataQueryJob","name":"Cancel a data query job","isWebhook":false,"pointer":"/paths/~1query~1jobs~1{job-id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a data query job","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":"Cancels a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-query-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" job, which prevents Zuora from performing the query. This operation is only applicable if the status of the query job is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"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":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job-id","in":"path","schemaId":"schema_238","description":"Internal identifier of the query job.\n","required":true}],"pointer":"/paths/~1query~1jobs~1{job-id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1query~1jobs~1{job-id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/query/jobs/{job-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"job-id","in":"path","required":true,"schemaId":"schema_238"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/query/jobs/{job-id}","href":"data-queries/delete_dataqueryjob","openApiOperationId":"DELETE_DataQueryJob","summary":"Cancel a data query job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteDataQueryJobResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteDataQueryJobResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/delete/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1query~1jobs~1{job-id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteDataQueryJobResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteDataQueryJobResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/delete/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-queries/delete_dataqueryjob"}],"panels":[]}]},"httpPath":"/query/jobs/{job-id}"},{"label":"Retrieve a data query job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-queries/get_dataqueryjob","routeSlug":"/v1-api-reference/api/data-queries/get_dataqueryjob","metadata":{"seo":{"title":"Retrieve a data query job","description":"Retrieves a data query job. You can use this operation to track the status of the query job and obtain the URL of the query results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DataQueryJob","name":"Retrieve a data query job","isWebhook":false,"pointer":"/paths/~1query~1jobs~1{job-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a data query job","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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-query-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" job. You can use this operation to track the status of the query job and obtain the URL of the query results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are an administrator, you can retrieve every query job in your tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a non-admin user and try to retrieve a query job that you are not the owner of, you will get a 403 response indicating that you are forbidden from viewing this job. As a non-admin user, you can only retrieve your own query job."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job-id","in":"path","schemaId":"schema_223","description":"Internal identifier of the query job.\n","required":true}],"pointer":"/paths/~1query~1jobs~1{job-id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1query~1jobs~1{job-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/query/jobs/{job-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"job-id","in":"path","required":true,"schemaId":"schema_223"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/query/jobs/{job-id}","href":"data-queries/get_dataqueryjob","openApiOperationId":"GET_DataQueryJob","summary":"Retrieve a data query job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitDataQueryResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SubmitDataQueryResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/403/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/403/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1query~1jobs~1{job-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubmitDataQueryResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitDataQueryResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"403","schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/403/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/403/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataQueryErrorResponse","exampleIds":["paths/~1query~1jobs~1{job-id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-queries/get_dataqueryjob"}],"panels":[]}]},"httpPath":"/query/jobs/{job-id}"}],"content":{"contentType":"group","meta":{"name":"Data Queries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Queries","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":"The Data Query feature enables you to perform SQL queries in your Zuora tenant. To learn how to get started with Data Query, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-query-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Data Query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/query/jobs","summary":"List data query jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-queries/get_dataqueryjobs","deprecated":false},{"title":"/query/jobs","summary":"Submit a data query","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-queries/post_dataqueryjob","deprecated":false},{"title":"/query/jobs/{job-id}","summary":"Cancel a data query job","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/data-queries/delete_dataqueryjob","deprecated":false},{"title":"/query/jobs/{job-id}","summary":"Retrieve a data query job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-queries/get_dataqueryjob","deprecated":false}]}]}]}]}},{"type":"separator","label":"AQuA","content":null},{"type":"group","label":"Aggregate Queries","link":"/v1-api-reference/api/aggregate-queries","routeSlug":"/v1-api-reference/api/aggregate-queries","items":[{"label":"Submit an aggregate query job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/aggregate-queries/post_batchqueryjob","routeSlug":"/v1-api-reference/api/aggregate-queries/post_batchqueryjob","metadata":{"seo":{"title":"Submit an aggregate query job","description":"Submits an AQuA job that contains an aggregated list of ZOQL and Export ZOQL queries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_BatchQueryJob","name":"Submit an aggregate query job","isWebhook":false,"pointer":"/paths/~1v1~1batch-query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit an aggregate query job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submits an AQuA job that contains an aggregated list of ZOQL and Export ZOQL queries.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1batch-query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmitBatchQueryRequest"}},"schemaId":"components/schemas/SubmitBatchQueryRequest","pointer":"/paths/~1v1~1batch-query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/batch-query","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubmitBatchQueryRequest"}},"responseCodes":["200"],"pointer":"/v1/batch-query","href":"aggregate-queries/post_batchqueryjob","openApiOperationId":"POST_BatchQueryJob","summary":"Submit an aggregate query job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/SubmitBatchQueryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmitBatchQueryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitBatchQueryResponse","exampleIds":["paths/~1v1~1batch-query/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SubmitBatchQueryResponse","exampleIds":["paths/~1v1~1batch-query/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_239"}],"pointer":"/paths/~1v1~1batch-query/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubmitBatchQueryResponse","exampleIds":["paths/~1v1~1batch-query/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitBatchQueryResponse","exampleIds":["paths/~1v1~1batch-query/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aggregate-queries/post_batchqueryjob"}],"panels":[]}]},"httpPath":"/v1/batch-query"},{"label":"Retrieve the last completed aggregate query job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/aggregate-queries/get_lastbatchqueryjob","routeSlug":"/v1-api-reference/api/aggregate-queries/get_lastbatchqueryjob","metadata":{"seo":{"title":"Retrieve the last completed aggregate query job","description":"Returns the details of the last completed job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_LastBatchQueryJob","name":"Retrieve the last completed aggregate query job","isWebhook":false,"pointer":"/paths/~1v1~1batch-query~1jobs~1partner~1{partner}~1project~1{project}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the last completed aggregate query job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the details of the last completed job.\n\nThe completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partner","in":"path","schemaId":"schema_5","description":"The unique ID of a data integration partner. \n","required":true},{"name":"project","in":"path","schemaId":"schema_5","description":"The unique ID of a data integration project for a particular partner.\n","required":true}],"pointer":"/paths/~1v1~1batch-query~1jobs~1partner~1{partner}~1project~1{project}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1batch-query~1jobs~1partner~1{partner}~1project~1{project}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/batch-query/jobs/partner/{partner}/project/{project}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"partner","in":"path","required":true,"schemaId":"schema_5"},{"name":"project","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/batch-query/jobs/partner/{partner}/project/{project}","href":"aggregate-queries/get_lastbatchqueryjob","openApiOperationId":"GET_LastBatchQueryJob","summary":"Retrieve the last completed aggregate query job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAggregateQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1partner~1{partner}~1project~1{project}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetAggregateQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1partner~1{partner}~1project~1{project}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_239"}],"pointer":"/paths/~1v1~1batch-query~1jobs~1partner~1{partner}~1project~1{project}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAggregateQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1partner~1{partner}~1project~1{project}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAggregateQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1partner~1{partner}~1project~1{project}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aggregate-queries/get_lastbatchqueryjob"}],"panels":[]}]},"httpPath":"/v1/batch-query/jobs/partner/{partner}/project/{project}"},{"label":"Cancel a running aggregate query job","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/aggregate-queries/delete_batchqueryjob","routeSlug":"/v1-api-reference/api/aggregate-queries/delete_batchqueryjob","metadata":{"seo":{"title":"Cancel a running aggregate query job","description":"Cancels the current AQuA job, only if the job is not complete. If the job is complete, an error is thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_BatchQueryJob","name":"Cancel a running aggregate query job","isWebhook":false,"pointer":"/paths/~1v1~1batch-query~1jobs~1{jobid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a running aggregate query job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels the current AQuA job, only if the job is not complete. If the job is complete, an error is thrown.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobid","in":"path","schemaId":"schema_5","description":"Internal identifier of the query job.\n","required":true}],"pointer":"/paths/~1v1~1batch-query~1jobs~1{jobid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1batch-query~1jobs~1{jobid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/batch-query/jobs/{jobid}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobid","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/batch-query/jobs/{jobid}","href":"aggregate-queries/delete_batchqueryjob","openApiOperationId":"DELETE_BatchQueryJob","summary":"Cancel a running aggregate query job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteBatchQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1{jobid}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DeleteBatchQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1{jobid}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1batch-query~1jobs~1{jobid}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteBatchQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1{jobid}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteBatchQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1{jobid}/delete/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aggregate-queries/delete_batchqueryjob"}],"panels":[]}]},"httpPath":"/v1/batch-query/jobs/{jobid}"},{"label":"Retrieve an aggregate query job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/aggregate-queries/get_batchqueryjob","routeSlug":"/v1-api-reference/api/aggregate-queries/get_batchqueryjob","metadata":{"seo":{"title":"Retrieve an aggregate query job","description":"Retrieves an aggregate query using the Job ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_BatchQueryJob","name":"Retrieve an aggregate query job","isWebhook":false,"pointer":"/paths/~1v1~1batch-query~1jobs~1{jobid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an aggregate query job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an aggregate query using the Job ID.\n\nNote that the completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobid","in":"path","schemaId":"schema_5","description":"Internal identifier of the query job.\n","required":true}],"pointer":"/paths/~1v1~1batch-query~1jobs~1{jobid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1batch-query~1jobs~1{jobid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/batch-query/jobs/{jobid}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobid","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/batch-query/jobs/{jobid}","href":"aggregate-queries/get_batchqueryjob","openApiOperationId":"GET_BatchQueryJob","summary":"Retrieve an aggregate query job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAggregateQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1{jobid}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetAggregateQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1{jobid}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_239"}],"pointer":"/paths/~1v1~1batch-query~1jobs~1{jobid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAggregateQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1{jobid}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAggregateQueryJobResponse","exampleIds":["paths/~1v1~1batch-query~1jobs~1{jobid}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aggregate-queries/get_batchqueryjob"}],"panels":[]}]},"httpPath":"/v1/batch-query/jobs/{jobid}"}],"content":{"contentType":"group","meta":{"name":"Aggregate Queries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Aggregate Queries","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":"The Aggregate Query API (AQuA) is a REST API that executes multiple "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-export-zoql","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export ZOQL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-zoql","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZOQL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queries. The queries are performed in a sequential order and in a single read-only database transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AQuA enforces the following limits:"},"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":"The maximum processing time per query is 3 hours. If a query in an AQuA job is executed for longer than 3 hours, this job will be killed automatically. See the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-bulk-data-extraction-from-zuora-using-aqua","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"best practices for bulk data extraction with AQuA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"AQuA enforces limits on both the stateful concurrent AQuA jobs and the stateless concurrent AQuA jobs per tenant:"},"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 maximum number of stateful concurrent AQuA jobs per tenant is 50.  - The maximum number of stateless concurrent AQuA jobs per tenant is 50."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AQuA jobs in the following status are counted towards your concurrent AQuA job limits:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submitted  - Executing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora system will reject the subsequent stateful or stateless job requests once the corresponding concurrent job limit is reached."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about the Aggregate Query API(AQuA), see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-aqua-api-introduction","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aggregate Query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/batch-query","summary":"Submit an aggregate query job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aggregate-queries/post_batchqueryjob","deprecated":false},{"title":"/v1/batch-query/jobs/partner/{partner}/project/{project}","summary":"Retrieve the last completed aggregate query job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aggregate-queries/get_lastbatchqueryjob","deprecated":false},{"title":"/v1/batch-query/jobs/{jobid}","summary":"Cancel a running aggregate query job","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/aggregate-queries/delete_batchqueryjob","deprecated":false},{"title":"/v1/batch-query/jobs/{jobid}","summary":"Retrieve an aggregate query job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aggregate-queries/get_batchqueryjob","deprecated":false}]}]}]}]}},{"type":"separator","label":"Deployment Manager","content":null},{"type":"group","label":"Configuration Templates","link":"/v1-api-reference/api/configuration-templates","routeSlug":"/v1-api-reference/api/configuration-templates","items":[{"label":"Download a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/get_downloaddeploymenttemplate","routeSlug":"/v1-api-reference/api/configuration-templates/get_downloaddeploymenttemplate","metadata":{"seo":{"title":"Download a template","description":"Download a template for migration in the Deployment manager from the source tenant to the target tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DownloadDeploymentTemplate","name":"Download a template","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployment_artifacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download a template for migration in the Deployment manager from the source tenant to the target tenant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"deployment_template_id","in":"query","schemaId":"schema_5","description":"Id which template needs to be downloaded.","required":true}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deployment-manager/deployment_artifacts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"deployment_template_id","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/deployment-manager/deployment_artifacts","href":"configuration-templates/get_downloaddeploymenttemplate","openApiOperationId":"GET_DownloadDeploymentTemplate","summary":"Download a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully downloaded the template.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonNode","exampleIds":["paths/~1deployment-manager~1deployment_artifacts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/JsonNode","exampleIds":["paths/~1deployment-manager~1deployment_artifacts/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"404","description":"Id is invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JsonNode","exampleIds":["paths/~1deployment-manager~1deployment_artifacts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JsonNode","exampleIds":["paths/~1deployment-manager~1deployment_artifacts/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration-templates/get_downloaddeploymenttemplate"}],"panels":[]}]},"httpPath":"/deployment-manager/deployment_artifacts"},{"label":"Compare settings between a source tenant and a target tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/post_comparetemplate","routeSlug":"/v1-api-reference/api/configuration-templates/post_comparetemplate","metadata":{"seo":{"title":"Compare settings between a source tenant and a target tenant","description":"To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CompareTemplate","name":"Compare settings between a source tenant and a target tenant","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1compare/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compare settings between a source tenant and a target tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tenant","in":"query","schemaId":"schema_5","description":"Customers need to specify tenant ID.","required":true}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1compare/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1compare/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_241"}},"schemaId":"schema_241","pointer":"/paths/~1deployment-manager~1deployment_artifacts~1compare/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deployment-manager/deployment_artifacts/compare","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"tenant","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_241"}},"responseCodes":["200","201","401","403","404"],"pointer":"/deployment-manager/deployment_artifacts/compare","href":"configuration-templates/post_comparetemplate","openApiOperationId":"POST_CompareTemplate","summary":"Compare settings between a source tenant and a target tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_241","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_241"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompareSchemaInfoResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1compare/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CompareSchemaInfoResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1compare/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"201","description":"created.\nThe request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URL(s) returned in the entity of the response, with the most specific URL for the resource given by a Location header field.\n","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1compare/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompareSchemaInfoResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1compare/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompareSchemaInfoResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1compare/post/responses/200/content/application~1json/examples/response"]}}},{"code":"201"},{"code":"401","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration-templates/post_comparetemplate"}],"panels":[]}]},"httpPath":"/deployment-manager/deployment_artifacts/compare"},{"label":"Migrate settings from source tenant to target tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/post_migratetenantsettings","routeSlug":"/v1-api-reference/api/configuration-templates/post_migratetenantsettings","metadata":{"seo":{"title":"Migrate settings from source tenant to target tenant","description":"To migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_MigrateTenantSettings","name":"Migrate settings from source tenant to target tenant","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1deploy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Migrate settings from source tenant to target tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"To migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tenant","in":"query","schemaId":"schema_5","description":"Customers need to specify tenant ID in query parameter.","required":true}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1deploy/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1deploy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TemplateMigrationClientRequest"}},"schemaId":"components/schemas/TemplateMigrationClientRequest","pointer":"/paths/~1deployment-manager~1deployment_artifacts~1deploy/post/requestBody","description":"Request Details."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deployment-manager/deployment_artifacts/deploy","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"tenant","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TemplateMigrationClientRequest"}},"responseCodes":["200","201","400","401","403","404"],"pointer":"/deployment-manager/deployment_artifacts/deploy","href":"configuration-templates/post_migratetenantsettings","openApiOperationId":"POST_MigrateTenantSettings","summary":"Migrate settings from source tenant to target tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/TemplateMigrationClientRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TemplateMigrationClientRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully migrated from source to target.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationClientResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1deploy/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/MigrationClientResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1deploy/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"201","description":"created.\nThe request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URL(s) returned in the entity of the response, with the most specific URL for the resource given by a Location header field.\n","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1deploy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MigrationClientResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1deploy/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MigrationClientResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1deploy/post/responses/200/content/application~1json/examples/response"]}}},{"code":"201"},{"code":"400","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration-templates/post_migratetenantsettings"}],"panels":[]}]},"httpPath":"/deployment-manager/deployment_artifacts/deploy"},{"label":"List all details of source components","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/get_sourcecomponentdetails","routeSlug":"/v1-api-reference/api/configuration-templates/get_sourcecomponentdetails","metadata":{"seo":{"title":"List all details of source components","description":"When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_SourceComponentDetails","name":"List all details of source components","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1retrieve-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all details of source components","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1retrieve-settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deployment-manager/deployment_artifacts/retrieve-settings","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/deployment-manager/deployment_artifacts/retrieve-settings","href":"configuration-templates/get_sourcecomponentdetails","openApiOperationId":"GET_SourceComponentDetails","summary":"List all details of source components"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved the template metadata.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettingSourceComponentResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1retrieve-settings/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SettingSourceComponentResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1retrieve-settings/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"404","description":"Id is invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"}],"pointer":"/paths/~1deployment-manager~1deployment_artifacts~1retrieve-settings/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SettingSourceComponentResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1retrieve-settings/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettingSourceComponentResponse","exampleIds":["paths/~1deployment-manager~1deployment_artifacts~1retrieve-settings/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration-templates/get_sourcecomponentdetails"}],"panels":[]}]},"httpPath":"/deployment-manager/deployment_artifacts/retrieve-settings"},{"label":"List all templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/get_templates","routeSlug":"/v1-api-reference/api/configuration-templates/get_templates","metadata":{"seo":{"title":"List all templates","description":"Retrieves all the templates and their details which are created already."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Templates","name":"List all templates","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployment_templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all the templates and their details which are created already.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployment_templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deployment-manager/deployment_templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/deployment-manager/deployment_templates","href":"configuration-templates/get_templates","openApiOperationId":"GET_Templates","summary":"List all templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully received all templates throught Template Response Object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/TemplateResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"}],"pointer":"/paths/~1deployment-manager~1deployment_templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration-templates/get_templates"}],"panels":[]}]},"httpPath":"/deployment-manager/deployment_templates"},{"label":"Create a deployment template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/post_deploymenttemplate","routeSlug":"/v1-api-reference/api/configuration-templates/post_deploymenttemplate","metadata":{"seo":{"title":"Create a deployment template","description":"Creates templates based on user preference.There are 2 ways to select components."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_DeploymentTemplate","name":"Create a deployment template","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployment_templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a deployment template","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 templates based on user preference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are 2 ways to select components."},"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":"Selecting the whole component."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced Options -> which helps user to select specific components to be migrated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It takes the enviroment details from the logged in user automatically, while creating the template."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployment_templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTemplateRequestContent"}},"schemaId":"components/schemas/CreateTemplateRequestContent","pointer":"/paths/~1deployment-manager~1deployment_templates/post/requestBody","description":"CreateTemplateRequestContent JSON object which contains the details to create a template."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deployment-manager/deployment_templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTemplateRequestContent"}},"responseCodes":["200","201","400","401","403","404"],"pointer":"/deployment-manager/deployment_templates","href":"configuration-templates/post_deploymenttemplate","openApiOperationId":"POST_DeploymentTemplate","summary":"Create a deployment template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/CreateTemplateRequestContent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTemplateRequestContent"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created the template.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDetailResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/TemplateDetailResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"201","description":"created.\nThe request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URL(s) returned in the entity of the response, with the most specific URL for the resource given by a Location header field.\n","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"}],"pointer":"/paths/~1deployment-manager~1deployment_templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateDetailResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDetailResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates/post/responses/200/content/application~1json/examples/response"]}}},{"code":"201"},{"code":"400","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration-templates/post_deploymenttemplate"}],"panels":[]}]},"httpPath":"/deployment-manager/deployment_templates"},{"label":"Delete a template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/delete_deploymenttemplate","routeSlug":"/v1-api-reference/api/configuration-templates/delete_deploymenttemplate","metadata":{"seo":{"title":"Delete a template","description":"Deletes a specific template by passing the ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_DeploymentTemplate","name":"Delete a template","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployment_templates~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific template by passing the ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the template that needs to be deleted.","required":true}],"pointer":"/paths/~1deployment-manager~1deployment_templates~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployment_templates~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/deployment-manager/deployment_templates/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","404"],"pointer":"/deployment-manager/deployment_templates/{id}","href":"configuration-templates/delete_deploymenttemplate","openApiOperationId":"DELETE_DeploymentTemplate","summary":"Delete a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the template.","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"204","description":"No Content","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"404","description":"Id is invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"}],"pointer":"/paths/~1deployment-manager~1deployment_templates~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"204"},{"code":"400","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration-templates/delete_deploymenttemplate"}],"panels":[]}]},"httpPath":"/deployment-manager/deployment_templates/{id}"},{"label":"List all details of a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/get_deploymenttemplatedetail","routeSlug":"/v1-api-reference/api/configuration-templates/get_deploymenttemplatedetail","metadata":{"seo":{"title":"List all details of a template","description":"Returns the detailed information of a specific template by passing its template ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DeploymentTemplateDetail","name":"List all details of a template","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployment_templates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all details of a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the detailed information of a specific template by passing its template ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the template that needs to be retrieved.","required":true}],"pointer":"/paths/~1deployment-manager~1deployment_templates~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployment_templates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deployment-manager/deployment_templates/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/deployment-manager/deployment_templates/{id}","href":"configuration-templates/get_deploymenttemplatedetail","openApiOperationId":"GET_DeploymentTemplateDetail","summary":"List all details of a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully received the template.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDetailResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/TemplateDetailResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_240"}],"pointer":"/paths/~1deployment-manager~1deployment_templates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateDetailResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDetailResponse","exampleIds":["paths/~1deployment-manager~1deployment_templates~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration-templates/get_deploymenttemplatedetail"}],"panels":[]}]},"httpPath":"/deployment-manager/deployment_templates/{id}"},{"label":"Sync a deployment template with latest changes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/configuration-templates/syncdeploymenttemplate","routeSlug":"/v1-api-reference/api/configuration-templates/syncdeploymenttemplate","metadata":{"seo":{"title":"Sync a deployment template with latest changes","description":"Synchronizes an existing deployment template with the latest changes in the source tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"syncDeploymentTemplate","name":"Sync a deployment template with latest changes","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployment_templates~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync a deployment template with latest changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Synchronizes an existing deployment template with the latest changes in the source tenant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_51","description":"Specify the content type of the request. Use multipart/form-data.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployment_templates~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/SyncDeploymentTemplateRequest"}},"schemaId":"components/schemas/SyncDeploymentTemplateRequest","pointer":"/paths/~1deployment-manager~1deployment_templates~1sync/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deployment-manager/deployment_templates/sync","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"example":"multipart/form-data","schemaId":"schema_51"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/SyncDeploymentTemplateRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/deployment-manager/deployment_templates/sync","href":"configuration-templates/syncdeploymenttemplate","openApiOperationId":"syncDeploymentTemplate","summary":"Sync a deployment template with latest changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/SyncDeploymentTemplateRequest","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/SyncDeploymentTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully synced the template.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDetailResponse"}},"schemaId":"components/schemas/TemplateDetailResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}},"schemaId":"components/schemas/ConfigTemplateErrorResponse"}],"pointer":"/paths/~1deployment-manager~1deployment_templates~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateDetailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDetailResponse"}}},{"code":"400","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ConfigTemplateErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfigTemplateErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration-templates/syncdeploymenttemplate"}],"panels":[]}]},"httpPath":"/deployment-manager/deployment_templates/sync"}],"content":{"contentType":"group","meta":{"name":"Configuration Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configuration Templates","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":"Configuration Templates in Zuora Deployment Manager enable you to configure your tenants in minutes by importing a templated metadata configuration file. This feature eliminates the need for long manual configuration processes that would have previously taken hours. You will be able to access a comprehensive repository of industry-specific templates. It will be easier for you to deploy and release. To use this API  for migrating metadata from a source tenant to a destination tenant,   you should authenticate using credentials of the source tenant   The user will have to provide the client id and secret key from the sou.rce tenant.   To understand the known behavior of configuration templates and APIs, see the following sections: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-product-catalog-deployment-reference-facts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Catalog deployment known facts and system behavior"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-product-catalog-deployment-faq"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Catalog deployment FAQs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-deployment-manager-scope"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deployment Manager Known Facts and Limitations"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/deployment-manager/deployment_artifacts","summary":"Download a template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration-templates/get_downloaddeploymenttemplate","deprecated":false},{"title":"/deployment-manager/deployment_artifacts/compare","summary":"Compare settings between a source tenant and a target tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/configuration-templates/post_comparetemplate","deprecated":false},{"title":"/deployment-manager/deployment_artifacts/deploy","summary":"Migrate settings from source tenant to target tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/configuration-templates/post_migratetenantsettings","deprecated":false},{"title":"/deployment-manager/deployment_artifacts/retrieve-settings","summary":"List all details of source components","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration-templates/get_sourcecomponentdetails","deprecated":false},{"title":"/deployment-manager/deployment_templates","summary":"List all templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration-templates/get_templates","deprecated":false},{"title":"/deployment-manager/deployment_templates","summary":"Create a deployment template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/configuration-templates/post_deploymenttemplate","deprecated":false},{"title":"/deployment-manager/deployment_templates/{id}","summary":"Delete a template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/configuration-templates/delete_deploymenttemplate","deprecated":false},{"title":"/deployment-manager/deployment_templates/{id}","summary":"List all details of a template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration-templates/get_deploymenttemplatedetail","deprecated":false},{"title":"/deployment-manager/deployment_templates/sync","summary":"Sync a deployment template with latest changes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/configuration-templates/syncdeploymenttemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Metadata Deployment","link":"/v1-api-reference/api/metadata-deployment","routeSlug":"/v1-api-reference/api/metadata-deployment","items":[{"label":"Compare and deploy a source tenant to a target tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/comparedeploytenant","routeSlug":"/v1-api-reference/api/metadata-deployment/comparedeploytenant","metadata":{"seo":{"title":"Compare and deploy a source tenant to a target tenant","description":"Compare and deploy a source tenant to a target tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CompareDeployTenant","name":"Compare and deploy a source tenant to a target tenant","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployments~1tenants/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compare and deploy a source tenant to a target tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Compare and deploy a source tenant to a target tenant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployments~1tenants/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_242"}},"schemaId":"schema_242","pointer":"/paths/~1deployment-manager~1deployments~1tenants/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deployment-manager/deployments/tenants","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_242"}},"responseCodes":["200","400"],"pointer":"/deployment-manager/deployments/tenants","href":"metadata-deployment/comparedeploytenant","openApiOperationId":"CompareDeployTenant","summary":"Compare and deploy a source tenant to a target tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_242","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_242"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1tenants/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1tenants/post/responses/200/content/application~1json/example"],"headers":{"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_243"},{"code":"400","description":"Validation of dependent module error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1deployment-manager~1deployments~1tenants/post/responses/400/content/application~1json/example"]}},"exampleIds":["paths/~1deployment-manager~1deployments~1tenants/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1deployment-manager~1deployments~1tenants/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1tenants/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1tenants/post/responses/200/content/application~1json/example"]}}},{"code":"400","exampleIds":["paths/~1deployment-manager~1deployments~1tenants/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1deployment-manager~1deployments~1tenants/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata-deployment/comparedeploytenant"}],"panels":[]}]},"httpPath":"/deployment-manager/deployments/tenants"},{"label":"Compare and deploy a template to a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/comparedeploytemplate","routeSlug":"/v1-api-reference/api/metadata-deployment/comparedeploytemplate","metadata":{"seo":{"title":"Compare and deploy a template to a tenant","description":"Compare and deploy a template to a tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CompareDeployTemplate","name":"Compare and deploy a template to a tenant","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployments~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compare and deploy a template to a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Compare and deploy a template to a tenant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployments~1templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_244"}},"schemaId":"schema_244","pointer":"/paths/~1deployment-manager~1deployments~1templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deployment-manager/deployments/templates","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_244"}},"responseCodes":["200"],"pointer":"/deployment-manager/deployments/templates","href":"metadata-deployment/comparedeploytemplate","openApiOperationId":"CompareDeployTemplate","summary":"Compare and deploy a template to a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_244","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_244"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1templates/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1templates/post/responses/200/content/application~1json/example"],"headers":{"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_243"}],"pointer":"/paths/~1deployment-manager~1deployments~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1templates/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1templates/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata-deployment/comparedeploytemplate"}],"panels":[]}]},"httpPath":"/deployment-manager/deployments/templates"},{"label":"Revert a deployment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/revertdeployment","routeSlug":"/v1-api-reference/api/metadata-deployment/revertdeployment","metadata":{"seo":{"title":"Revert a deployment","description":"Revert a deployment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RevertDeployment","name":"Revert a deployment","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployments~1{migrationId}~1revert/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revert a deployment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revert a deployment.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"migrationId","in":"path","schemaId":"schema_5","description":"The unique ID of a migration.\n","required":true}],"pointer":"/paths/~1deployment-manager~1deployments~1{migrationId}~1revert/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployments~1{migrationId}~1revert/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deployment-manager/deployments/{migrationId}/revert","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"migrationId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/deployment-manager/deployments/{migrationId}/revert","href":"metadata-deployment/revertdeployment","openApiOperationId":"RevertDeployment","summary":"Revert a deployment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_245","exampleIds":["paths/~1deployment-manager~1deployments~1{migrationId}~1revert/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_245","exampleIds":["paths/~1deployment-manager~1deployments~1{migrationId}~1revert/post/responses/200/content/application~1json/example"],"headers":{"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_243"}],"pointer":"/paths/~1deployment-manager~1deployments~1{migrationId}~1revert/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_245","exampleIds":["paths/~1deployment-manager~1deployments~1{migrationId}~1revert/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_245","exampleIds":["paths/~1deployment-manager~1deployments~1{migrationId}~1revert/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata-deployment/revertdeployment"}],"panels":[]}]},"httpPath":"/deployment-manager/deployments/{migrationId}/revert"},{"label":"Retrieve a deployment log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/fetchdeploymentlogs","routeSlug":"/v1-api-reference/api/metadata-deployment/fetchdeploymentlogs","metadata":{"seo":{"title":"Retrieve a deployment log","description":"Retrieve a deployment log."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"FetchDeploymentLogs","name":"Retrieve a deployment log","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployments~1{migrationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a deployment log","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a deployment log.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"migrationId","in":"path","schemaId":"schema_5","description":"The unique ID of a migration.\n","required":true}],"pointer":"/paths/~1deployment-manager~1deployments~1{migrationId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployments~1{migrationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deployment-manager/deployments/{migrationId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"migrationId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/deployment-manager/deployments/{migrationId}","href":"metadata-deployment/fetchdeploymentlogs","openApiOperationId":"FetchDeploymentLogs","summary":"Retrieve a deployment log"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_246","exampleIds":["paths/~1deployment-manager~1deployments~1{migrationId}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_246","exampleIds":["paths/~1deployment-manager~1deployments~1{migrationId}/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1deployment-manager~1deployments~1{migrationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_246","exampleIds":["paths/~1deployment-manager~1deployments~1{migrationId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_246","exampleIds":["paths/~1deployment-manager~1deployments~1{migrationId}/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata-deployment/fetchdeploymentlogs"}],"panels":[]}]},"httpPath":"/deployment-manager/deployments/{migrationId}"},{"label":"Compare and deploy the product catalog of a tenant to a target tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/comparedeploytenantproductcatalog","routeSlug":"/v1-api-reference/api/metadata-deployment/comparedeploytenantproductcatalog","metadata":{"seo":{"title":"Compare and deploy the product catalog of a tenant to a target tenant","description":"Compare and deploy the product catalog of a tenant to a target tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CompareDeployTenantProductCatalog","name":"Compare and deploy the product catalog of a tenant to a target tenant","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compare and deploy the product catalog of a tenant to a target tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Compare and deploy the product catalog of a tenant to a target tenant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_247"}},"schemaId":"schema_247","pointer":"/paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deployment-manager/deployments/tenant/product_catalog","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_247"}},"responseCodes":["200","400"],"pointer":"/deployment-manager/deployments/tenant/product_catalog","href":"metadata-deployment/comparedeploytenantproductcatalog","openApiOperationId":"CompareDeployTenantProductCatalog","summary":"Compare and deploy the product catalog of a tenant to a target tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_247","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_247"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/200/content/application~1json/example"],"headers":{"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_243"},{"code":"400","description":"Validation of dependent module error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/400/content/application~1json/example"]}},"exampleIds":["paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/200/content/application~1json/example"]}}},{"code":"400","exampleIds":["paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata-deployment/comparedeploytenantproductcatalog"}],"panels":[]}]},"httpPath":"/deployment-manager/deployments/tenant/product_catalog"},{"label":"Compare and deploy a template for product catalog to a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata-deployment/comparedeploytemplateproductcatalog","routeSlug":"/v1-api-reference/api/metadata-deployment/comparedeploytemplateproductcatalog","metadata":{"seo":{"title":"Compare and deploy a template for product catalog to a tenant","description":"Compare and deploy a template for product catalog to a tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CompareDeployTemplateProductCatalog","name":"Compare and deploy a template for product catalog to a tenant","isWebhook":false,"pointer":"/paths/~1deployment-manager~1deployments~1template~1product_catalog/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compare and deploy a template for product catalog to a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Compare and deploy a template for product catalog to a tenant.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1deployment-manager~1deployments~1template~1product_catalog/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_248"}},"schemaId":"schema_248","pointer":"/paths/~1deployment-manager~1deployments~1template~1product_catalog/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deployment-manager/deployments/template/product_catalog","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_248"}},"responseCodes":["200"],"pointer":"/deployment-manager/deployments/template/product_catalog","href":"metadata-deployment/comparedeploytemplateproductcatalog","openApiOperationId":"CompareDeployTemplateProductCatalog","summary":"Compare and deploy a template for product catalog to a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_248","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_248"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1template~1product_catalog/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1template~1product_catalog/post/responses/200/content/application~1json/example"],"headers":{"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_243"}],"pointer":"/paths/~1deployment-manager~1deployments~1template~1product_catalog/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1template~1product_catalog/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeploymentManagerResponse","exampleIds":["paths/~1deployment-manager~1deployments~1template~1product_catalog/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata-deployment/comparedeploytemplateproductcatalog"}],"panels":[]}]},"httpPath":"/deployment-manager/deployments/template/product_catalog"}],"content":{"contentType":"group","meta":{"name":"Metadata Deployment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Metadata Deployment","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":"The Metadata Deployment API in Zuora promotes a programmatic way to retrieve, compare, and validate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"metadata within Zuora tenants for performing create and update actions between the source and the target."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this API  for migrating metadata from a source tenant to a destination tenant,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you should authenticate using credentials of the source tenant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user will have to provide the client id and secret key from the source tenant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To understand the known behavior of configuration templates and APIs, see the following sections:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-product-catalog-deployment-reference-facts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Catalog deployment known facts and system behavior"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-product-catalog-deployment-faq"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Catalog deployment FAQs"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-deployment-manager-scope"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deployment Manager Known Facts and Limitations"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/deployment-manager/deployments/tenants","summary":"Compare and deploy a source tenant to a target tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/metadata-deployment/comparedeploytenant","deprecated":false},{"title":"/deployment-manager/deployments/templates","summary":"Compare and deploy a template to a tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/metadata-deployment/comparedeploytemplate","deprecated":false},{"title":"/deployment-manager/deployments/{migrationId}/revert","summary":"Revert a deployment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/metadata-deployment/revertdeployment","deprecated":false},{"title":"/deployment-manager/deployments/{migrationId}","summary":"Retrieve a deployment log","prefix":{"name":"get","color":"get"},"badges":[],"link":"/metadata-deployment/fetchdeploymentlogs","deprecated":false},{"title":"/deployment-manager/deployments/tenant/product_catalog","summary":"Compare and deploy the product catalog of a tenant to a target tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/metadata-deployment/comparedeploytenantproductcatalog","deprecated":false},{"title":"/deployment-manager/deployments/template/product_catalog","summary":"Compare and deploy a template for product catalog to a tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/metadata-deployment/comparedeploytemplateproductcatalog","deprecated":false}]}]}]}]}},{"type":"separator","label":"Data Loader","content":null},{"type":"group","label":"Bulk Data","link":"/v1-api-reference/api/bulk-data","routeSlug":"/v1-api-reference/api/bulk-data","items":[{"label":"Create a bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/createbulkjob","routeSlug":"/v1-api-reference/api/bulk-data/createbulkjob","metadata":{"seo":{"title":"Create a bulk job","description":"Creates a new bulk job. The job type can be one of Import, Delete, Update, or Cancel.The response includes the job ID and information needed to upload your data file to S3."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBulkJob","name":"Create a bulk job","isWebhook":false,"pointer":"/paths/~1bulk-data~1bulk-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a bulk job","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 bulk job. The job type can be one of Import, Delete, Update, or Cancel."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes the job ID and information needed to upload your data file to S3."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"bulk-data/createbulkjob/request/next-step:-upload-the-file-to-s3","deepLinkHash":"/bulk-data/createbulkjob#bulk-data/createbulkjob/request/next-step:-upload-the-file-to-s3"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Next Step: Upload the File to S3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After creating a bulk job, you must upload the data file to Amazon S3 using the information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadFileInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. This includes:"},"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":"uploadUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The S3 endpoint to which the file must be uploaded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"formFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Key-value pairs to include in a multipart/form-data POST request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The ID of the job, used for later submission."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the following cURL command to upload the file:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --request POST \\\n  --url '<uploadUrl>' \\\n  --header 'Content-Type: multipart/form-data' \\\n  --form 'key=<formFields.key>' \\\n  --form 'bucket=<formFields.bucket>' \\\n  --form 'x-amz-algorithm=<formFields[\"x-amz-algorithm\"]>' \\\n  --form 'x-amz-credential=<formFields[\"x-amz-credential\"]>' \\\n  --form 'x-amz-date=<formFields[\"x-amz-date\"]>' \\\n  --form 'Policy=<formFields.Policy>' \\\n  --form 'x-amz-signature=<formFields[\"x-amz-signature\"]>' \\\n  --form 'x-amz-security-token=<formFields[\"x-amz-security-token\"]>' \\\n  --form 'file=@/path/to/your/file.csv'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --request POST \\\n  --url '<uploadUrl>' \\\n  --header 'Content-Type: multipart/form-data' \\\n  --form 'key=<formFields.key>' \\\n  --form 'bucket=<formFields.bucket>' \\\n  --form 'x-amz-algorithm=<formFields[\"x-amz-algorithm\"]>' \\\n  --form 'x-amz-credential=<formFields[\"x-amz-credential\"]>' \\\n  --form 'x-amz-date=<formFields[\"x-amz-date\"]>' \\\n  --form 'Policy=<formFields.Policy>' \\\n  --form 'x-amz-signature=<formFields[\"x-amz-signature\"]>' \\\n  --form 'x-amz-security-token=<formFields[\"x-amz-security-token\"]>' \\\n  --form 'file=@/path/to/your/file.csv'\n"},"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":": Always use the exact form field keys returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"formFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object of the API response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a presigned Amazon S3 POST operation and not a Zuora endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After uploading the file, you must call the \"Submit a bulk job for processing\" operation endpoint"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to start processing the job."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1bulk-data~1bulk-jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkJobRequest"}},"schemaId":"components/schemas/BulkJobRequest","pointer":"/paths/~1bulk-data~1bulk-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulk-data/bulk-jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkJobRequest"}},"responseCodes":["200"],"pointer":"/bulk-data/bulk-jobs","href":"bulk-data/createbulkjob","openApiOperationId":"createBulkJob","summary":"Create a bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/BulkJobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Job creation successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateResponse"}},"schemaId":"components/schemas/CreateResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":"The request limit quota for the time window closest to exhaustion.","schema":{"type":"string"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the time window closest to quota exhaustion.","schema":{"type":"number"}},"RateLimit-Reset":{"description":"The number of seconds until the quota resets for the time window closest to quota exhaustion.","schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call.","schema":{"type":"string","minLength":36,"maxLength":36}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_249"}],"pointer":"/paths/~1bulk-data~1bulk-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-data/createbulkjob"}],"panels":[]}]},"httpPath":"/bulk-data/bulk-jobs"},{"label":"Submit a bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/submitbulkjob","routeSlug":"/v1-api-reference/api/bulk-data/submitbulkjob","metadata":{"seo":{"title":"Submit a bulk job","description":"Submits a previously created bulk job for processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitBulkJob","name":"Submit a bulk job","isWebhook":false,"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1submissions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a bulk job","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":"Submits a previously created bulk job for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint must be called "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the file has been successfully uploaded to the S3 URL using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadFileInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details from the create job response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the job has not been uploaded properly before calling this endpoint, submission will fail."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Bulk Job ID.","required":true}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1submissions/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1submissions/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulk-data/bulk-jobs/{id}/submissions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/bulk-data/bulk-jobs/{id}/submissions","href":"bulk-data/submitbulkjob","openApiOperationId":"submitBulkJob","summary":"Submit a bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Job successfully submitted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitBulkJobResponse"}},"schemaId":"components/schemas/SubmitBulkJobResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.","schema":{"type":"string","maxLength":36,"minLength":36}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_250"}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1submissions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubmitBulkJobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitBulkJobResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-data/submitbulkjob"}],"panels":[]}]},"httpPath":"/bulk-data/bulk-jobs/{id}/submissions"},{"label":"Retrieve the summary of a bulk job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/getbulkjobsummary","routeSlug":"/v1-api-reference/api/bulk-data/getbulkjobsummary","metadata":{"seo":{"title":"Retrieve the summary of a bulk job","description":"Get the summary of a specific job by its ID. This operation returns a summary of the specified bulk job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBulkJobSummary","name":"Retrieve the summary of a bulk job","isWebhook":false,"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the summary of a bulk job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the summary of a specific job by its ID.\nThis operation returns a summary of the specified bulk job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_238","description":"The unique identifier of the job whose summary is being queried.","required":true}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1summary/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bulk-data/bulk-jobs/{id}/summary","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_238"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/bulk-data/bulk-jobs/{id}/summary","href":"bulk-data/getbulkjobsummary","openApiOperationId":"getBulkJobSummary","summary":"Retrieve the summary of a bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Job summary retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryJobSummaryResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1summary/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/QueryJobSummaryResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1summary/get/responses/200/content/application~1json/examples/response"]},{"code":"404","description":"Job not found"},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueryJobSummaryResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1summary/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryJobSummaryResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1summary/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-data/getbulkjobsummary"}],"panels":[]}]},"httpPath":"/bulk-data/bulk-jobs/{id}/summary"},{"label":"Cancel a bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/cancelbulkjob","routeSlug":"/v1-api-reference/api/bulk-data/cancelbulkjob","metadata":{"seo":{"title":"Cancel a bulk job","description":"Cancels an existing bulk job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelBulkJob","name":"Cancel a bulk job","isWebhook":false,"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1cancellations/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a bulk job","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":"Cancels an existing bulk job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once a job is cancelled, no further processing can be done, and its status will be marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cancellation of a job is only allowed before it reaches the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"In Progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Once a job is in progress, it cannot be cancelled but only be aborted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_238","description":"Internal identifier of the job to cancel.","required":true}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1cancellations/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1cancellations/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulk-data/bulk-jobs/{id}/cancellations","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_238"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/bulk-data/bulk-jobs/{id}/cancellations","href":"bulk-data/cancelbulkjob","openApiOperationId":"cancelBulkJob","summary":"Cancel a bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdStatusResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1cancellations/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/IdStatusResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1cancellations/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":"This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The request limit quota for the time window closest to exhaustion.","schema":{"type":"string"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the time window closest to quota exhaustion.","schema":{"type":"number"}},"RateLimit-Reset":{"description":"The number of seconds until the quota resets for the time window closest to quota exhaustion.","schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_251"}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1cancellations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdStatusResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1cancellations/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdStatusResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1cancellations/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-data/cancelbulkjob"}],"panels":[]}]},"httpPath":"/bulk-data/bulk-jobs/{id}/cancellations"},{"label":"Abort a bulk job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/deleteabortjob","routeSlug":"/v1-api-reference/api/bulk-data/deleteabortjob","metadata":{"seo":{"title":"Abort a bulk job","description":"Aborts an existing job by sending a POST request to this URI. The request URI identifies the job to abort. When a job is aborted, no more records are processed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAbortJob","name":"Abort a bulk job","isWebhook":false,"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1aborts/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Abort a bulk job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Aborts an existing job by sending a POST request to this URI. The request URI identifies the job to abort.\nWhen a job is aborted, no more records are processed.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_238","description":"Internal identifier of the job to abort.\n","required":true}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1aborts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1aborts/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulk-data/bulk-jobs/{id}/aborts","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_238"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/bulk-data/bulk-jobs/{id}/aborts","href":"bulk-data/deleteabortjob","openApiOperationId":"deleteAbortJob","summary":"Abort a bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdStatusResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1aborts/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/IdStatusResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1aborts/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_250"}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1aborts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdStatusResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1aborts/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdStatusResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1aborts/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-data/deleteabortjob"}],"panels":[]}]},"httpPath":"/bulk-data/bulk-jobs/{id}/aborts"},{"label":"List download links for a bulk job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/getdownloadlinksforjob","routeSlug":"/v1-api-reference/api/bulk-data/getdownloadlinksforjob","metadata":{"seo":{"title":"List download links for a bulk job","description":"Retrieves the download links for the files associated with a completed job. These files include success rows, error rows, and logs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDownloadLinksForJob","name":"List download links for a bulk job","isWebhook":false,"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1downloads/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List download links for a bulk job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the download links for the files associated with a completed job.\nThese files include success rows, error rows, and logs.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_238","description":"The unique identifier of the job whose download links are being queried.","required":true}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1downloads/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1downloads/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bulk-data/bulk-jobs/{id}/downloads","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_238"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/bulk-data/bulk-jobs/{id}/downloads","href":"bulk-data/getdownloadlinksforjob","openApiOperationId":"getDownloadLinksForJob","summary":"List download links for a bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Get download links for a bulk job","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadsResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1downloads/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DownloadsResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1downloads/get/responses/200/content/application~1json/examples/response"]},{"code":"404","description":"Job not found or not completed"},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1downloads/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DownloadsResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1downloads/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadsResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1downloads/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-data/getdownloadlinksforjob"}],"panels":[]}]},"httpPath":"/bulk-data/bulk-jobs/{id}/downloads"},{"label":"List job summaries for bulk jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/getbulkjobsummaries","routeSlug":"/v1-api-reference/api/bulk-data/getbulkjobsummaries","metadata":{"seo":{"title":"List job summaries for bulk jobs","description":"Lists summaries for bulk jobs. You can filter the results using query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBulkJobSummaries","name":"List job summaries for bulk jobs","isWebhook":false,"pointer":"/paths/~1bulk-data~1bulk-jobs~1summaries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List job summaries for bulk jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists summaries for bulk jobs. You can filter the results using query parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_252","description":"Maximum number of job summaries to retrieve."},{"name":"cursor","in":"query","schemaId":"schema_5","description":"Cursor for pagination to get the next page of results."},{"name":"status","in":"query","schemaId":"schema_253","description":"Filter job summaries by job status."}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1summaries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1summaries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bulk-data/bulk-jobs/summaries","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_252"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_5"},{"name":"status","in":"query","required":false,"schemaId":"schema_253"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/bulk-data/bulk-jobs/summaries","href":"bulk-data/getbulkjobsummaries","openApiOperationId":"getBulkJobSummaries","summary":"List job summaries for bulk jobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Job summaries retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetSummariesResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1summaries/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetSummariesResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1summaries/get/responses/200/content/application~1json/examples/response"]},{"code":"404","description":"No job summaries found"},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1summaries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetSummariesResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1summaries/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetSummariesResponse","exampleIds":["paths/~1bulk-data~1bulk-jobs~1summaries/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-data/getbulkjobsummaries"}],"panels":[]}]},"httpPath":"/bulk-data/bulk-jobs/summaries"},{"label":"List mappings for a bulk job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/bulk-data/getmappingsforjob","routeSlug":"/v1-api-reference/api/bulk-data/getmappingsforjob","metadata":{"seo":{"title":"List mappings for a bulk job","description":"Retrieves the mappings for an existing bulk job. The mappings define how columns in the source file correspond to fields in the object type template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMappingsForJob","name":"List mappings for a bulk job","isWebhook":false,"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1mappings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List mappings for a bulk job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the mappings for an existing bulk job. The mappings define how columns in the source file correspond to fields in the object type template.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_238","description":"Internal identifier of the job whose mappings are to be retrieved.","required":true}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1mappings/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1mappings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bulk-data/bulk-jobs/{id}/mappings","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_238"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/bulk-data/bulk-jobs/{id}/mappings","href":"bulk-data/getmappingsforjob","openApiOperationId":"getMappingsForJob","summary":"List mappings for a bulk job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1mappings/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_254","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1mappings/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":"This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The request limit quota for the time window closest to exhaustion.","schema":{"type":"string"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the time window closest to quota exhaustion.","schema":{"type":"number"}},"RateLimit-Reset":{"description":"The number of seconds until the quota resets for the time window closest to quota exhaustion.","schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_251"}],"pointer":"/paths/~1bulk-data~1bulk-jobs~1{id}~1mappings/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_254","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1mappings/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254","exampleIds":["paths/~1bulk-data~1bulk-jobs~1{id}~1mappings/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-data/getmappingsforjob"}],"panels":[]}]},"httpPath":"/bulk-data/bulk-jobs/{id}/mappings"}],"content":{"contentType":"group","meta":{"name":"Bulk Data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Data","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":"The Bulk Data API operations allow you to manage bulk data loader services and perform programmatic CRUD (Create, Update, Read/export, Delete) operations. "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To perform data ingestion with a CSV file in Zuora Billing using the Data Loader Bulk Data APIs, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-data-ingestion-using-bulk-job-api","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tutorial for Bulk job API with CSV"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-process-bulk-job-with-json","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process Bulk Job with JSON-lines in Data Loader"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/bulk-data/bulk-jobs","summary":"Create a bulk job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-data/createbulkjob","deprecated":false},{"title":"/bulk-data/bulk-jobs/{id}/submissions","summary":"Submit a bulk job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-data/submitbulkjob","deprecated":false},{"title":"/bulk-data/bulk-jobs/{id}/summary","summary":"Retrieve the summary of a bulk job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-data/getbulkjobsummary","deprecated":false},{"title":"/bulk-data/bulk-jobs/{id}/cancellations","summary":"Cancel a bulk job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-data/cancelbulkjob","deprecated":false},{"title":"/bulk-data/bulk-jobs/{id}/aborts","summary":"Abort a bulk job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-data/deleteabortjob","deprecated":false},{"title":"/bulk-data/bulk-jobs/{id}/downloads","summary":"List download links for a bulk job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-data/getdownloadlinksforjob","deprecated":false},{"title":"/bulk-data/bulk-jobs/summaries","summary":"List job summaries for bulk jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-data/getbulkjobsummaries","deprecated":false},{"title":"/bulk-data/bulk-jobs/{id}/mappings","summary":"List mappings for a bulk job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bulk-data/getmappingsforjob","deprecated":false}]}]}]}]}},{"type":"separator","label":"OneID","content":null},{"type":"group","label":"SCIM","link":"/v1-api-reference/api/scim","routeSlug":"/v1-api-reference/api/scim","items":[{"type":"link","label":"Prerequisites","link":"/v1-api-reference/api/scim/prerequisites","routeSlug":"/v1-api-reference/api/scim/prerequisites","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Prerequisites"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"scim/prerequisites"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to have a One-ID account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to create OAuth 2.0 Clients."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the client credentials to generate the bearer token."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate the authentication token by hitting the endpoint."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Steps to generate the bearer token","link":"/v1-api-reference/api/scim/steps-to-generate-the-bearer-token","routeSlug":"/v1-api-reference/api/scim/steps-to-generate-the-bearer-token","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Steps to generate the bearer token"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"scim/steps-to-generate-the-bearer-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Steps to generate the bearer token"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"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":"Hit the endpoint to get the token:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://one.zuora.com/oauth2/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id=52a1d024-b7cc-4d3d-8d0b-dd7b23959e10' \\\n  --data-urlencode 'client_secret=aQWDDjn3x9JXbMUQaddvBa2vQQMDCHXL8BgeER8' \\\n  --data-urlencode 'grant_type=client_credentials'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://one.zuora.com/oauth2/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id=52a1d024-b7cc-4d3d-8d0b-dd7b23959e10' \\\n  --data-urlencode 'client_secret=aQWDDjn3x9JXbMUQaddvBa2vQQMDCHXL8BgeER8' \\\n  --data-urlencode 'grant_type=client_credentials'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You will get the response as below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"access_token\": \"eyJraWQiOiIxNTYwMDBkMi1lY2FjLTQxMGYtOTJmYy02Y2IxMjU1YjQ3NTAiLCJhbGciOiJSUzI1NiJ9.eyIzdWIiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJhdWQiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJuYmYiOjE2OTA1MzcyODksInNjb3BlIjpbImFkbWluIiwiZWMxNDFkYzItOTAxZS00ODEzLWEyNWQtZWY0ODBjZmYxZTI2Il0sImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdDo5OTAwIiwiZXhwIjoxNjkwNTQwODg5LCJpYXQiOjE2OTA1MzcyODl9.NMZV-aERA8lTKPPsMtk_WK9ApvX-Bj-6FEIF9GP_duObzdReQkCA2ykcsPSmimw3IbJu7F4XbjZkwTCZL_vBiTaJlnQ7k3hXUzw30b3olDP2Dwc_W6Eh-CvT6s5ZxsFURCZJitfuqh82ezxHdT2lUdcDEMbELw9VpqUSBz0Dqh0tmfnFQyw4yX1be-jflT_0c8SvjyOFGRFScoxcPLq8TrrmpFvgxhT3MqowvQ9butxX6_4mTc3831FnJ6tQIihlBLH4DY11k38x3BBPzb0s9iVcEn7iczWbT0VrSr4A6g1ltATAHNChdzGTqGrhSN8JGG_PPCjJnHY_edaCmcPrUg\",\n  \"scope\": \"admin rc141dc2-901e-4813-a25d-ef480cff1e26\",\n  \"token_type\": \"Bearer\",\n  \"expires_in\": 3600\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"access_token\": \"eyJraWQiOiIxNTYwMDBkMi1lY2FjLTQxMGYtOTJmYy02Y2IxMjU1YjQ3NTAiLCJhbGciOiJSUzI1NiJ9.eyIzdWIiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJhdWQiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJuYmYiOjE2OTA1MzcyODksInNjb3BlIjpbImFkbWluIiwiZWMxNDFkYzItOTAxZS00ODEzLWEyNWQtZWY0ODBjZmYxZTI2Il0sImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdDo5OTAwIiwiZXhwIjoxNjkwNTQwODg5LCJpYXQiOjE2OTA1MzcyODl9.NMZV-aERA8lTKPPsMtk_WK9ApvX-Bj-6FEIF9GP_duObzdReQkCA2ykcsPSmimw3IbJu7F4XbjZkwTCZL_vBiTaJlnQ7k3hXUzw30b3olDP2Dwc_W6Eh-CvT6s5ZxsFURCZJitfuqh82ezxHdT2lUdcDEMbELw9VpqUSBz0Dqh0tmfnFQyw4yX1be-jflT_0c8SvjyOFGRFScoxcPLq8TrrmpFvgxhT3MqowvQ9butxX6_4mTc3831FnJ6tQIihlBLH4DY11k38x3BBPzb0s9iVcEn7iczWbT0VrSr4A6g1ltATAHNChdzGTqGrhSN8JGG_PPCjJnHY_edaCmcPrUg\",\n  \"scope\": \"admin rc141dc2-901e-4813-a25d-ef480cff1e26\",\n  \"token_type\": \"Bearer\",\n  \"expires_in\": 3600\n}\n"},"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":"Use the access token in all the following API calls. Sample curl request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location --request GET 'https://one.zuora.com/scim/v2/Schemas' \\\n  --header 'Authorization: Bearer eyJraWQiOiIxNTYwMDBkMi1lY2FjLTQxMGYtOTJmYy02Y2IxMjU1YjQ3NTAiLCJhbGciOiJSUzI1NiJ9.eyIzdWIiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJhdWQiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJuYmYiOjE2OTA1MzcyODksInNjb3BlIjpbImFkbWluIiwiZWMxNDFkYzItOTAxZS00ODEzLWEyNWQtZWY0ODBjZmYxZTI2Il0sImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdDo5OTAwIiwiZXhwIjoxNjkwNTQwODg5LCJpYXQiOjE2OTA1MzcyODl9.NMZV-aERA8lTKPPsMtk_WK9ApvX-Bj-6FEIF9GP_duObzdReQkCA2ykcsPSmimw3IbJu7F4XbjZkwTCZL_vBiTaJlnQ7k3hXUzw30b3olDP2Dwc_W6Eh-CvT6s5ZxsFURCZJitfuqh82ezxHdT2lUdcDEMbELw9VpqUSBz0Dqh0tmfnFQyw4yX1be-jflT_0c8SvjyOFGRFScoxcPLq8TrrmpFvgxhT3MqowvQ9butxX6_4mTc3831FnJ6tQIihlBLH4DY11k38x3BBPzb0s9iVcEn7iczWbT0VrSr4A6g1ltATAHNChdzGTqGrhSN8JGG_PPCjJnHY_edaCmcPrUg' \\\n  --header 'Content-Type: application/json'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location --request GET 'https://one.zuora.com/scim/v2/Schemas' \\\n  --header 'Authorization: Bearer eyJraWQiOiIxNTYwMDBkMi1lY2FjLTQxMGYtOTJmYy02Y2IxMjU1YjQ3NTAiLCJhbGciOiJSUzI1NiJ9.eyIzdWIiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJhdWQiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJuYmYiOjE2OTA1MzcyODksInNjb3BlIjpbImFkbWluIiwiZWMxNDFkYzItOTAxZS00ODEzLWEyNWQtZWY0ODBjZmYxZTI2Il0sImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdDo5OTAwIiwiZXhwIjoxNjkwNTQwODg5LCJpYXQiOjE2OTA1MzcyODl9.NMZV-aERA8lTKPPsMtk_WK9ApvX-Bj-6FEIF9GP_duObzdReQkCA2ykcsPSmimw3IbJu7F4XbjZkwTCZL_vBiTaJlnQ7k3hXUzw30b3olDP2Dwc_W6Eh-CvT6s5ZxsFURCZJitfuqh82ezxHdT2lUdcDEMbELw9VpqUSBz0Dqh0tmfnFQyw4yX1be-jflT_0c8SvjyOFGRFScoxcPLq8TrrmpFvgxhT3MqowvQ9butxX6_4mTc3831FnJ6tQIihlBLH4DY11k38x3BBPzb0s9iVcEn7iczWbT0VrSr4A6g1ltATAHNChdzGTqGrhSN8JGG_PPCjJnHY_edaCmcPrUg' \\\n  --header 'Content-Type: application/json'\n"},"children":[]}]}]}]}]}],"panels":[]}]}},{"label":"List groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getlistgroups","routeSlug":"/v1-api-reference/api/scim/getlistgroups","metadata":{"seo":{"title":"List groups","description":"Returns a paginated list of groups, ten groups per page by default. Use the startIndex and count (max 100) query parameters to paginate long lists of groups. It's possible to return a list of specific types of groups using the filter parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListGroups","name":"List groups","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of groups, ten groups per page by default. Use the startIndex and count (max 100) query parameters to paginate long lists of groups. It's possible to return a list of specific types of groups using the filter parameter."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"count","in":"query","schemaId":"schema_252","description":"The number of records returned per page in the response."},{"name":"filter","in":"query","schemaId":"schema_5","description":"The filter used to filter the group, either by organization id."},{"name":"startIndex","in":"query","schemaId":"schema_252","description":"The index number of the page that you want to retrieve. You must set count before specifying startIndex. For example, if you set count to 20 and startIndex to 2, the 21st to 40th records are returned in the response."}],"pointer":"/paths/~1scim~1v2~1Groups/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_5","description":[{"$$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":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the request must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1scim~1v2~1Groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Groups","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"count","in":"query","required":false,"schemaId":"schema_252"},{"name":"filter","in":"query","required":false,"schemaId":"schema_5"},{"name":"startIndex","in":"query","required":false,"schemaId":"schema_252"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/Groups","href":"scim/getlistgroups","openApiOperationId":"getListGroups","summary":"List groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255","exampleIds":["paths/~1scim~1v2~1Groups/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_255","exampleIds":["paths/~1scim~1v2~1Groups/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]}},"RateLimit-Limit":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Remaining":{"schema":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Reset":{"schema":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"}},"Zuora-Track-Id":{"schema":{"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"headerSchemaId":"schema_256"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_257"}},"schemaId":"schema_257"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258"}},"schemaId":"schema_258"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_259"}},"schemaId":"schema_259"}],"pointer":"/paths/~1scim~1v2~1Groups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_255","exampleIds":["paths/~1scim~1v2~1Groups/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255","exampleIds":["paths/~1scim~1v2~1Groups/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_257","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_257"}}},{"code":"403","schemaId":"schema_258","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258"}}},{"code":"404","schemaId":"schema_259","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_259"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/getlistgroups"}],"panels":[]}]},"httpPath":"/scim/v2/Groups"},{"label":"Create a group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/createanewgroup","routeSlug":"/v1-api-reference/api/scim/createanewgroup","metadata":{"seo":{"title":"Create a group","description":"Creates a new group. Must include the displayName attribute. Users can be added to the group during creation by supplying the user ID values in the members array attribute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createANewGroup","name":"Create a group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new group. Must include the displayName attribute. Users can be added to the group during creation by supplying the user ID values in the members array attribute."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"count","in":"query","schemaId":"schema_252","description":"The number of records returned per page in the response."},{"name":"filter","in":"query","schemaId":"schema_5","description":"The filter used to filter the group, either by organization id."},{"name":"startIndex","in":"query","schemaId":"schema_252","description":"The index number of the page that you want to retrieve. You must set count before specifying startIndex. For example, if you set count to 20 and startIndex to 2, the 21st to 40th records are returned in the response."}],"pointer":"/paths/~1scim~1v2~1Groups/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_5","description":[{"$$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":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the request must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1scim~1v2~1Groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_260","exampleIds":["paths/~1scim~1v2~1Groups/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_260","exampleIds":["paths/~1scim~1v2~1Groups/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1scim~1v2~1Groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Groups","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"count","in":"query","required":false,"schemaId":"schema_252"},{"name":"filter","in":"query","required":false,"schemaId":"schema_5"},{"name":"startIndex","in":"query","required":false,"schemaId":"schema_252"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_260","exampleIds":["paths/~1scim~1v2~1Groups/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","401","403","404"],"pointer":"/scim/v2/Groups","href":"scim/createanewgroup","openApiOperationId":"createANewGroup","summary":"Create a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_260","exampleIds":["paths/~1scim~1v2~1Groups/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_260","exampleIds":["paths/~1scim~1v2~1Groups/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_261","exampleIds":["paths/~1scim~1v2~1Groups/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_261","exampleIds":["paths/~1scim~1v2~1Groups/post/responses/201/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}]}},"RateLimit-Limit":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Remaining":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Reset":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"}},"Zuora-Track-Id":{"schema":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"headerSchemaId":"schema_262"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263"}},"schemaId":"schema_263"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264"}},"schemaId":"schema_264"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265"}},"schemaId":"schema_265"}],"pointer":"/paths/~1scim~1v2~1Groups/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_261","exampleIds":["paths/~1scim~1v2~1Groups/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_261","exampleIds":["paths/~1scim~1v2~1Groups/post/responses/201/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_263","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263"}}},{"code":"403","schemaId":"schema_264","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264"}}},{"code":"404","schemaId":"schema_265","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/createanewgroup"}],"panels":[]}]},"httpPath":"/scim/v2/Groups"},{"label":"Bulk create groups","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/postbulkcreategroups","routeSlug":"/v1-api-reference/api/scim/postbulkcreategroups","metadata":{"seo":{"title":"Bulk create groups","description":"Creates multiple Groups within an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postBulkCreateGroups","name":"Bulk create groups","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk create groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates multiple Groups within an organization.\n\nMust include the displayName attribute. Users can be added to the group during creation by supplying the user ID values in the members array attribute.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_266","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1scim~1v2~1Groups~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Groups/bulk","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","201","401","403","404"],"pointer":"/scim/v2/Groups/bulk","href":"scim/postbulkcreategroups","openApiOperationId":"postBulkCreateGroups","summary":"Bulk create groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_266","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_267","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]}},"RateLimit-Limit":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Remaining":{"schema":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Reset":{"schema":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"}},"Zuora-Track-Id":{"schema":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"headerSchemaId":"schema_268"},{"code":"201","description":"Created"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_269"}},"schemaId":"schema_269"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}},"schemaId":"schema_270"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_271"}},"schemaId":"schema_271"}],"pointer":"/paths/~1scim~1v2~1Groups~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_267","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/post/responses/200/content/application~1json/example"]}}},{"code":"201"},{"code":"401","schemaId":"schema_269","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_269"}}},{"code":"403","schemaId":"schema_270","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}}},{"code":"404","schemaId":"schema_271","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_271"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/postbulkcreategroups"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/bulk"},{"label":"Bulk update groups","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/patchbulkpatchgroups","routeSlug":"/v1-api-reference/api/scim/patchbulkpatchgroups","metadata":{"seo":{"title":"Bulk update groups","description":"Updates an existing group resource, allowing individual (or groups of) users to be added or removed from the group with a single operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBulkPatchGroups","name":"Bulk update groups","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1bulk/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk update groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing group resource, allowing individual (or groups of) users to be added or removed from the group with a single operation.\n\nSetting the operation attribute of a member object to delete will remove members from a group; add is the default operation for PATCH.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_272","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1scim~1v2~1Groups~1bulk/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/scim/v2/Groups/bulk","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","204","401","403"],"pointer":"/scim/v2/Groups/bulk","href":"scim/patchbulkpatchgroups","openApiOperationId":"patchBulkPatchGroups","summary":"Bulk update groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_272","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_273","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/patch/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]}},"RateLimit-Limit":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Remaining":{"schema":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Reset":{"schema":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"}},"Zuora-Track-Id":{"schema":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"headerSchemaId":"schema_268"},{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_274"}},"schemaId":"schema_274"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275"}},"schemaId":"schema_275"}],"pointer":"/paths/~1scim~1v2~1Groups~1bulk/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_273","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1scim~1v2~1Groups~1bulk/patch/responses/200/content/application~1json/example"]}}},{"code":"204"},{"code":"401","schemaId":"schema_274","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_274"}}},{"code":"403","schemaId":"schema_275","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/patchbulkpatchgroups"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/bulk"},{"label":"Bulk delete groups","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/postbulkdeletegroups","routeSlug":"/v1-api-reference/api/scim/postbulkdeletegroups","metadata":{"seo":{"title":"Bulk delete groups","description":"Permanently removes groups from an organization (members are not deleted, only the group)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postBulkDeleteGroups","name":"Bulk delete groups","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk delete groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently removes groups from an organization (members are not deleted, only the group).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_276"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_277"},{"name":"Content-Encoding","in":"header","schemaId":"schema_278"},{"name":"Authorization","in":"header","schemaId":"schema_279"},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_280"},{"name":"Zuora-Entity-Ids-Single","in":"header","schemaId":"schema_5"}],"pointer":"/paths/~1scim~1v2~1Groups~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_281","exampleIds":["paths/~1scim~1v2~1Groups~1delete/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_281","exampleIds":["paths/~1scim~1v2~1Groups~1delete/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1scim~1v2~1Groups~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Groups/delete","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_276"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_277"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_278"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_279"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_280"},{"name":"Zuora-Entity-Ids-Single","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_281","exampleIds":["paths/~1scim~1v2~1Groups~1delete/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","201","401","403","404"],"pointer":"/scim/v2/Groups/delete","href":"scim/postbulkdeletegroups","openApiOperationId":"postBulkDeleteGroups","summary":"Bulk delete groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_281","exampleIds":["paths/~1scim~1v2~1Groups~1delete/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_281","exampleIds":["paths/~1scim~1v2~1Groups~1delete/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_282","exampleIds":["paths/~1scim~1v2~1Groups~1delete/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_282","exampleIds":["paths/~1scim~1v2~1Groups~1delete/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]}},"RateLimit-Limit":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Remaining":{"schema":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Reset":{"schema":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"}},"Zuora-Track-Id":{"schema":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"headerSchemaId":"schema_268"},{"code":"201","description":"Created"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_283"}},"schemaId":"schema_283"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284"}},"schemaId":"schema_284"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_285"}},"schemaId":"schema_285"}],"pointer":"/paths/~1scim~1v2~1Groups~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_282","exampleIds":["paths/~1scim~1v2~1Groups~1delete/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_282","exampleIds":["paths/~1scim~1v2~1Groups~1delete/post/responses/200/content/application~1json/example"]}}},{"code":"201"},{"code":"401","schemaId":"schema_283","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_283"}}},{"code":"403","schemaId":"schema_284","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284"}}},{"code":"404","schemaId":"schema_285","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_285"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/postbulkdeletegroups"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/delete"},{"label":"Retrieve a group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getaspecificgroup","routeSlug":"/v1-api-reference/api/scim/getaspecificgroup","metadata":{"seo":{"title":"Retrieve a group","description":"Retrieves a single group resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getASpecificGroup","name":"Retrieve a group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single group resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the group to retrieve.","required":true,"example":"78faa61b-4e3b-4799-9579-210fd4d80aca"}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Groups/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"78faa61b-4e3b-4799-9579-210fd4d80aca","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/Groups/{id}","href":"scim/getaspecificgroup","openApiOperationId":"getASpecificGroup","summary":"Retrieve a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_286","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_286","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}},"headerSchemaId":"schema_287"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/401/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/403/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_286","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_286","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/getaspecificgroup"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/{id}"},{"label":"Update a group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/updateaspecificgroup","routeSlug":"/v1-api-reference/api/scim/updateaspecificgroup","metadata":{"seo":{"title":"Update a group","description":"Updates an existing group resource, overwriting all values for a group even if an attribute is empty or not provided. PUT will replace all members of a group with those members provided via the members attribute. If an attribute that had been set previously is left blank during a PUT operation, the new value will be blank in accordance with the data type of the attribute and the storage provider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateASpecificGroup","name":"Update a group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing group resource, overwriting all values for a group even if an attribute is empty or not provided.\nPUT will replace all members of a group with those members provided via the members attribute. If an attribute that had been set previously is left blank during a PUT operation, the new value will be blank in accordance with the data type of the attribute and the storage provider.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the group to update.","required":true,"example":"78faa61b-4e3b-4799-9579-210fd4d80aca"}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_288","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_288","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scim/v2/Groups/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"78faa61b-4e3b-4799-9579-210fd4d80aca","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_288","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","201","401","403","404"],"pointer":"/scim/v2/Groups/{id}","href":"scim/updateaspecificgroup","openApiOperationId":"updateASpecificGroup","summary":"Update a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_288","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_288","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_289","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/200/content/application~1json/example"]}},"schemaId":"schema_289","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}},"headerSchemaId":"schema_287"},{"code":"201","description":"Created"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/401/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/403/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_289","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_289","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/200/content/application~1json/example"]}}},{"code":"201"},{"code":"401","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/401/content/application~1json/example"]}}},{"code":"403","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/403/content/application~1json/example"]}}},{"code":"404","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/updateaspecificgroup"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/{id}"},{"label":"Delete a group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/deleteaspecificgroup","routeSlug":"/v1-api-reference/api/scim/deleteaspecificgroup","metadata":{"seo":{"title":"Delete a group","description":"Permanently removes a group (members are not deleted, only the group)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteASpecificGroup","name":"Delete a group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently removes a group (members are not deleted, only the group).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the group to delete.","required":true,"example":"78faa61b-4e3b-4799-9579-210fd4d80aca"}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/scim/v2/Groups/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"78faa61b-4e3b-4799-9579-210fd4d80aca","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/Groups/{id}","href":"scim/deleteaspecificgroup","openApiOperationId":"deleteASpecificGroup","summary":"Delete a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_290","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string"},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}},"headerSchemaId":"schema_291"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/401/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/403/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_290","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/200/content/application~1json/example"]}}},{"code":"401","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/deleteaspecificgroup"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/{id}"},{"label":"Partially update a group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/partiallyupdateaspecificgroup","routeSlug":"/v1-api-reference/api/scim/partiallyupdateaspecificgroup","metadata":{"seo":{"title":"Partially update a group","description":"Updates an existing group resource, allowing individual (or groups of) users to be added or removed from the group with a single operation. Setting the operation attribute of a member object to delete will remove members from a group; add is the default operation for PATCH."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partiallyUpdateAspecificGroup","name":"Partially update a group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing group resource, allowing individual (or groups of) users to be added or removed from the group with a single operation.\nSetting the operation attribute of a member object to delete will remove members from a group; add is the default operation for PATCH.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the group to partially update.","required":true,"example":"78faa61b-4e3b-4799-9579-210fd4d80aca"}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_292","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_292","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/scim/v2/Groups/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"78faa61b-4e3b-4799-9579-210fd4d80aca","schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_292","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","204","401","403"],"pointer":"/scim/v2/Groups/{id}","href":"scim/partiallyupdateaspecificgroup","openApiOperationId":"partiallyUpdateAspecificGroup","summary":"Partially update a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_292","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_292","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_293","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_293","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string"},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}},"headerSchemaId":"schema_294"},{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/401/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/403/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1scim~1v2~1Groups~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_293","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_293","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/200/content/application~1json/example"]}}},{"code":"204"},{"code":"401","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/401/content/application~1json/example"]}}},{"code":"403","exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Groups~1{id}/patch/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/partiallyupdateaspecificgroup"}],"panels":[]}]},"httpPath":"/scim/v2/Groups/{id}"},{"label":"List all resource types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/gettheressourcetype","routeSlug":"/v1-api-reference/api/scim/gettheressourcetype","metadata":{"seo":{"title":"List all resource types","description":"Retrieves all Resource Types managed by OneId. Resource Types define the resource name, endpoint URL, schemas, and other metadata that indicate where a resource is managed and how it is composed, e.g., \"User\" or \"Group\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTheRessourceType","name":"List all resource types","isWebhook":false,"pointer":"/paths/~1scim~1v2~1ResourceTypes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all resource types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all Resource Types managed by OneId. Resource Types define the resource name, endpoint URL, schemas, and other metadata that indicate where a resource is managed and how it is composed, e.g., \"User\" or \"Group\".\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1ResourceTypes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/ResourceTypes","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/ResourceTypes","href":"scim/gettheressourcetype","openApiOperationId":"getTheRessourceType","summary":"List all resource types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_295","exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_295","exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string"},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}},"headerSchemaId":"schema_291"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/401/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/403/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1scim~1v2~1ResourceTypes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_295","exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_295","exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/200/content/application~1json/example"]}}},{"code":"401","exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/401/content/application~1json/example"]}}},{"code":"403","exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/403/content/application~1json/example"]}}},{"code":"404","exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/gettheressourcetype"}],"panels":[]}]},"httpPath":"/scim/v2/ResourceTypes"},{"label":"Retrieve a resource type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getaspecificresourcetype","routeSlug":"/v1-api-reference/api/scim/getaspecificresourcetype","metadata":{"seo":{"title":"Retrieve a resource type","description":"Get related information on a single resource type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getASpecificResourceType","name":"Retrieve a resource type","isWebhook":false,"pointer":"/paths/~1scim~1v2~1ResourceTypes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a resource type","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":"Get related information on a single resource type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"/scim/v2/ResourceTypes/User\n/scim/v2/ResourceTypes/Group\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"/scim/v2/ResourceTypes/User\n/scim/v2/ResourceTypes/Group\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","required":true}],"pointer":"/paths/~1scim~1v2~1ResourceTypes~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1ResourceTypes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/ResourceTypes/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/ResourceTypes/{id}","href":"scim/getaspecificresourcetype","openApiOperationId":"getASpecificResourceType","summary":"Retrieve a resource type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_296","exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_296","exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"schema":{"type":"string","maxLength":64},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}},"headerSchemaId":"schema_243"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/401/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/403/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_296","exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_296","exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/getaspecificresourcetype"}],"panels":[]}]},"httpPath":"/scim/v2/ResourceTypes/{id}"},{"label":"List all schemas of resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getschemaofscim","routeSlug":"/v1-api-reference/api/scim/getschemaofscim","metadata":{"seo":{"title":"List all schemas of resources","description":"Lists all schemas for all supported resources. A schema is a collection of attribute definitions that describe the contents of an entire or partial resource, e.g., \"urn:ietf:params:scim:schemas:core:2.0:User\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSchemaOfSCIM","name":"List all schemas of resources","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Schemas/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all schemas of resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all schemas for all supported resources. A schema is a collection of attribute definitions that describe the contents of an entire or partial resource, e.g., \"urn:ietf:params:scim:schemas:core:2.0:User\".  \n\nThe attribute definitions specify the name of the attribute, and metadata such as type (e.g., string, binary), cardinality (singular, multi, complex), mutability, and returnability.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_5","description":"Unique key used to ensure idempotent behavior."},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the response's preferred content encoding. Supported values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}]},{"name":"Authorization","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids-Single","in":"header","schemaId":"schema_5"}],"pointer":"/paths/~1scim~1v2~1Schemas/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Schemas","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_5"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Authorization","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids-Single","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/Schemas","href":"scim/getschemaofscim","openApiOperationId":"getSchemaOfSCIM","summary":"List all schemas of resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_297","exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_297","exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]}},"RateLimit-Limit":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Remaining":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Reset":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"}},"Zuora-Track-Id":{"schema":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header\n"}}},"headerSchemaId":"schema_298"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/401/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/403/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1scim~1v2~1Schemas/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_297","exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_297","exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/200/content/application~1json/example"]}}},{"code":"401","exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/401/content/application~1json/example"]}}},{"code":"403","exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/403/content/application~1json/example"]}}},{"code":"404","exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Schemas/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/getschemaofscim"}],"panels":[]}]},"httpPath":"/scim/v2/Schemas"},{"label":"List schemas of a resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/gettheschemaofspecificscim","routeSlug":"/v1-api-reference/api/scim/gettheschemaofspecificscim","metadata":{"seo":{"title":"List schemas of a resource","description":"Gets a specific resource schema by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTheSchemaOfSpecificSCIM","name":"List schemas of a resource","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Schemas~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List schemas of a resource","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":"Gets a specific resource schema by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group\n/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User\n\n/scim/v2/Schemas/urn:zuora:scim:schemas:1.0:UserExtension\n/scim/v2/Schemas/urn:zuora:scim:schemas:1.0:GroupExtension\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group\n/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User\n\n/scim/v2/Schemas/urn:zuora:scim:schemas:1.0:UserExtension\n/scim/v2/Schemas/urn:zuora:scim:schemas:1.0:GroupExtension\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","required":true}],"pointer":"/paths/~1scim~1v2~1Schemas~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Schemas~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Schemas/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/Schemas/{id}","href":"scim/gettheschemaofspecificscim","openApiOperationId":"getTheSchemaOfSpecificSCIM","summary":"List schemas of a resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_299"}},"schemaId":"schema_299","headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}]}}},"headerSchemaId":"schema_300"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_301"}},"schemaId":"schema_301"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_302"}},"schemaId":"schema_302"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_303"}},"schemaId":"schema_303"}],"pointer":"/paths/~1scim~1v2~1Schemas~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_299","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_299"}}},{"code":"401","schemaId":"schema_301","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_301"}}},{"code":"403","schemaId":"schema_302","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_302"}}},{"code":"404","schemaId":"schema_303","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_303"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/gettheschemaofspecificscim"}],"panels":[]}]},"httpPath":"/scim/v2/Schemas/{id}"},{"label":"Retrieve the service provider configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/gettheserviceproviderconfig","routeSlug":"/v1-api-reference/api/scim/gettheserviceproviderconfig","metadata":{"seo":{"title":"Retrieve the service provider configuration","description":"Returns Zuora’s service provider configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTheServiceProviderConfig","name":"Retrieve the service provider configuration","isWebhook":false,"pointer":"/paths/~1scim~1v2~1ServiceProviderConfig/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the service provider configuration","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":"Returns Zuora’s service provider configuration."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/ServiceProviderConfig","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/ServiceProviderConfig","href":"scim/gettheserviceproviderconfig","openApiOperationId":"getTheServiceProviderConfig","summary":"Retrieve the service provider configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_304"}},"schemaId":"schema_304","headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}]}},"RateLimit-Limit":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Remaining":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Reset":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"}},"Zuora-Track-Id":{"schema":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"headerSchemaId":"schema_262"},{"code":"401","description":"Unauthorized - The request requires user authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_305"}},"schemaId":"schema_305"},{"code":"403","description":"Forbidden - The server understands the request but refuses to authorize it.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_306"}},"schemaId":"schema_306"},{"code":"404","description":"Not Found - The requested resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307"}},"schemaId":"schema_307"}],"pointer":"/paths/~1scim~1v2~1ServiceProviderConfig/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_304","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_304"}}},{"code":"401","schemaId":"schema_305","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_305"}}},{"code":"403","schemaId":"schema_306","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_306"}}},{"code":"404","schemaId":"schema_307","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/gettheserviceproviderconfig"}],"panels":[]}]},"httpPath":"/scim/v2/ServiceProviderConfig"},{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getlistofusers","routeSlug":"/v1-api-reference/api/scim/getlistofusers","metadata":{"seo":{"title":"List users","description":"Returns a paginated list of users, 100 users per page by default.When querying larger instances, reduce the count parameter to 1,000 or less, and use the startIndex parameter to paginate through users.It's possible to return a list of specific types of users with the filter parameter.Examples:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfUsers","name":"List users","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List users","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":"Returns a paginated list of users, 100 users per page by default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When querying larger instances, reduce the count parameter to 1,000 or less, and use the startIndex parameter to paginate through users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's possible to return a list of specific types of users with the filter parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  /list?filter=userName eq \"testuser\"\n  /list??filter=status eq \"PENDING_ACTIVATION\"\n  /list??filter=id eq \"91f659cd-6ded-4d92-aa5c-144c3b5455c3\" and status eq \"PENDING_ACTIVATION\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  /list?filter=userName eq \"testuser\"\n  /list??filter=status eq \"PENDING_ACTIVATION\"\n  /list??filter=id eq \"91f659cd-6ded-4d92-aa5c-144c3b5455c3\" and status eq \"PENDING_ACTIVATION\"\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Users","servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/Users","href":"scim/getlistofusers","openApiOperationId":"getListOfUsers","summary":"List users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_308"}},"schemaId":"schema_308","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion."},"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://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion."},"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://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion."},"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://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"type":"string","minLength":36,"maxLength":36}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call.\nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier.\nOtherwise, Zuora does not set this header.\n","schema":{"type":"string","maxLength":64}}},"headerSchemaId":"schema_309"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_310"}},"schemaId":"schema_310"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_311"}},"schemaId":"schema_311"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_312"}},"schemaId":"schema_312"}],"pointer":"/paths/~1scim~1v2~1Users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_308","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_308"}}},{"code":"401","schemaId":"schema_310","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_310"}}},{"code":"403","schemaId":"schema_311","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_311"}}},{"code":"404","schemaId":"schema_312","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_312"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/getlistofusers"}],"panels":[]}]},"httpPath":"/scim/v2/Users"},{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/createauser","routeSlug":"/v1-api-reference/api/scim/createauser","metadata":{"seo":{"title":"Create a user","description":"Creates a user. Must include the userName attribute and an email address. User will be created as an SSO user by default and a federated ID must be provided for the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAUser","name":"Create a user","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a user. Must include the userName attribute and an email address. User will be created as an SSO user by default and a federated ID must be provided for the user.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Users/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_313","exampleIds":["paths/~1scim~1v2~1Users/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_313","exampleIds":["paths/~1scim~1v2~1Users/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1scim~1v2~1Users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Users","servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_313","exampleIds":["paths/~1scim~1v2~1Users/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","201","401","403","404"],"pointer":"/scim/v2/Users","href":"scim/createauser","openApiOperationId":"createAUser","summary":"Create a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"schemaId":"schema_313","exampleIds":["paths/~1scim~1v2~1Users/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_313","exampleIds":["paths/~1scim~1v2~1Users/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314","exampleIds":["paths/~1scim~1v2~1Users/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_314","exampleIds":["paths/~1scim~1v2~1Users/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}]}},"RateLimit-Limit":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Remaining":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Reset":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"}},"Zuora-Track-Id":{"schema":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"headerSchemaId":"schema_262"},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_315"}},"schemaId":"schema_315","headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}]}},"RateLimit-Limit":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Remaining":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Reset":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"}},"Zuora-Track-Id":{"schema":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"headerSchemaId":"schema_262"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_316"}},"schemaId":"schema_316"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_317"}},"schemaId":"schema_317"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318"}},"schemaId":"schema_318"}],"pointer":"/paths/~1scim~1v2~1Users/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_314","exampleIds":["paths/~1scim~1v2~1Users/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314","exampleIds":["paths/~1scim~1v2~1Users/post/responses/200/content/application~1json/example"]}}},{"code":"201","schemaId":"schema_315","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_315"}}},{"code":"401","schemaId":"schema_316","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_316"}}},{"code":"403","schemaId":"schema_317","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_317"}}},{"code":"404","schemaId":"schema_318","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/createauser"}],"panels":[]}]},"httpPath":"/scim/v2/Users"},{"label":"Bulk create users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/bulkcreateusers","routeSlug":"/v1-api-reference/api/scim/bulkcreateusers","metadata":{"seo":{"title":"Bulk create users","description":"Creates multiple users within an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkCreateUsers","name":"Bulk create users","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk create users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates multiple users within an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_319","exampleIds":["paths/~1scim~1v2~1Users~1bulk/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_319","exampleIds":["paths/~1scim~1v2~1Users~1bulk/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1scim~1v2~1Users~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Users/bulk","servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_319","exampleIds":["paths/~1scim~1v2~1Users~1bulk/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","201","401","403","404"],"pointer":"/scim/v2/Users/bulk","href":"scim/bulkcreateusers","openApiOperationId":"bulkCreateUsers","summary":"Bulk create users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"schemaId":"schema_319","exampleIds":["paths/~1scim~1v2~1Users~1bulk/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_319","exampleIds":["paths/~1scim~1v2~1Users~1bulk/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_320","exampleIds":["paths/~1scim~1v2~1Users~1bulk/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_320","exampleIds":["paths/~1scim~1v2~1Users~1bulk/post/responses/200/content/application~1json/example"]},{"code":"201","description":"Created"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_321"}},"schemaId":"schema_321"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_322"}},"schemaId":"schema_322"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"}],"pointer":"/paths/~1scim~1v2~1Users~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_320","exampleIds":["paths/~1scim~1v2~1Users~1bulk/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_320","exampleIds":["paths/~1scim~1v2~1Users~1bulk/post/responses/200/content/application~1json/example"]}}},{"code":"201"},{"code":"401","schemaId":"schema_321","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_321"}}},{"code":"403","schemaId":"schema_322","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_322"}}},{"code":"404","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/bulkcreateusers"}],"panels":[]}]},"httpPath":"/scim/v2/Users/bulk"},{"label":"Bulk update users","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/bulkupdateusers","routeSlug":"/v1-api-reference/api/scim/bulkupdateusers","metadata":{"seo":{"title":"Bulk update users","description":"Updates an existing multiple user resource, overwriting values for specified attributes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkUpdateUsers","name":"Bulk update users","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1bulk/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk update users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing multiple user resource, overwriting values for specified attributes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_324"}},"schemaId":"schema_324","pointer":"/paths/~1scim~1v2~1Users~1bulk/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/scim/v2/Users/bulk","servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_324"}},"responseCodes":["200","204","401","403"],"pointer":"/scim/v2/Users/bulk","href":"scim/bulkupdateusers","openApiOperationId":"bulkUpdateUsers","summary":"Bulk update users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"schemaId":"schema_324","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_324"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_325","exampleIds":["paths/~1scim~1v2~1Users~1bulk/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_325","exampleIds":["paths/~1scim~1v2~1Users~1bulk/patch/responses/200/content/application~1json/example"]},{"code":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326"}},"schemaId":"schema_326"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}},"schemaId":"schema_327"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"}],"pointer":"/paths/~1scim~1v2~1Users~1bulk/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_325","exampleIds":["paths/~1scim~1v2~1Users~1bulk/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_325","exampleIds":["paths/~1scim~1v2~1Users~1bulk/patch/responses/200/content/application~1json/example"]}}},{"code":"204","schemaId":"schema_326","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326"}}},{"code":"401","schemaId":"schema_327","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}}},{"code":"403","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/bulkupdateusers"}],"panels":[]}]},"httpPath":"/scim/v2/Users/bulk"},{"label":"Delete a list of users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/deletealistofusers","routeSlug":"/v1-api-reference/api/scim/deletealistofusers","metadata":{"seo":{"title":"Delete a list of users","description":"Sets multiple users to deactivate.The value of the id should be the user's corresponding user ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAListOfUsers","name":"Delete a list of users","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a list of users","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":"Sets multiple users to deactivate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be the user's corresponding user ID."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Users~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329","pointer":"/paths/~1scim~1v2~1Users~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Users/delete","servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_329"}},"responseCodes":["200","201","401","403","404"],"pointer":"/scim/v2/Users/delete","href":"scim/deletealistofusers","openApiOperationId":"deleteAListOfUsers","summary":"Delete a list of users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_329"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_330","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_330","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}},"headerSchemaId":"schema_331"},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}},"schemaId":"schema_332"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/401/content/application~1json/example"]}},"schemaId":"schema_333","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_334","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_334","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_335","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1scim~1v2~1Users~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_330","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_330","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/200/content/application~1json/example"]}}},{"code":"201","schemaId":"schema_332","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}}},{"code":"401","schemaId":"schema_333","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_334","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_334","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_335","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335","exampleIds":["paths/~1scim~1v2~1Users~1delete/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/deletealistofusers"}],"panels":[]}]},"httpPath":"/scim/v2/Users/delete"},{"label":"Retrieve a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/getaspecificuser","routeSlug":"/v1-api-reference/api/scim/getaspecificuser","metadata":{"seo":{"title":"Retrieve a user","description":"Retrieves a single user resource.The value of the  should be the user's corresponding user ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getASpecificUser","name":"Retrieve a user","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a user","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 single user resource."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"id","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be the user's corresponding user ID."},"children":[]},{"$$mdtype":"Node","type":"error","inline":true,"errors":[{"id":"parse-error","level":"critical","message":"HTML tag <id> is not closed, opened at"}],"attributes":{},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the user to retrieve.","required":true}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Users/{id}","servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/Users/{id}","href":"scim/getaspecificuser","openApiOperationId":"getASpecificUser","summary":"Retrieve a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336","exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/200/content/application~1json/examples/user"]}},"schemaId":"schema_336","exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/200/content/application~1json/examples/user"],"headers":{"Content-Encoding":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]}},"RateLimit-Limit":{"schema":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Remaining":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"RateLimit-Reset":{"schema":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"}},"Zuora-Track-Id":{"schema":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"headerSchemaId":"schema_243"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/401/content/application~1json/examples/UnauthorizedError"]}},"exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/401/content/application~1json/examples/UnauthorizedError"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/403/content/application~1json/examples/ForbiddenError"]}},"exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/403/content/application~1json/examples/ForbiddenError"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/404/content/application~1json/examples/NotFoundError"]}},"exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/404/content/application~1json/examples/NotFoundError"]}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_336","exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/200/content/application~1json/examples/user"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336","exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/200/content/application~1json/examples/user"]}}},{"code":"401","exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/401/content/application~1json/examples/UnauthorizedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/401/content/application~1json/examples/UnauthorizedError"]}}},{"code":"403","exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/403/content/application~1json/examples/ForbiddenError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/403/content/application~1json/examples/ForbiddenError"]}}},{"code":"404","exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/404/content/application~1json/examples/NotFoundError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/get/responses/404/content/application~1json/examples/NotFoundError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/getaspecificuser"}],"panels":[]}]},"httpPath":"/scim/v2/Users/{id}"},{"label":"Update a user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/updateaspecificuser","routeSlug":"/v1-api-reference/api/scim/updateaspecificuser","metadata":{"seo":{"title":"Update a user","description":"Updates an existing user resource, overwriting all values for a user even if an attribute is empty or not provided.If an attribute that had been set previously is left blank during a PUT operation, the new value will be blank in accordance with the data type of the attribute and the storage provider.Deactivated users can be re-enabled by setting the active attribute to true. The value of the  should be the user's corresponding user ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateASpecificUser","name":"Update a user","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user","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 an existing user resource, overwriting all values for a user even if an attribute is empty or not provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an attribute that had been set previously is left blank during a PUT operation, the new value will be blank in accordance with the data type of the attribute and the storage provider."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivated users can be re-enabled by setting the active attribute to true. The value of the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"id","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be the user's corresponding user ID."},"children":[]},{"$$mdtype":"Node","type":"error","inline":true,"errors":[{"id":"parse-error","level":"critical","message":"HTML tag <id> is not closed, opened at"}],"attributes":{},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the user to be updated.","required":true}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_337","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_337","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1scim~1v2~1Users~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scim/v2/Users/{id}","servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_337","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/Users/{id}","href":"scim/updateaspecificuser","openApiOperationId":"updateASpecificUser","summary":"Update a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"schemaId":"schema_337","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_337","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/200/content/application~1json/example"]}},"schemaId":"schema_338","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/401/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/403/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_338","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/200/content/application~1json/example"]}}},{"code":"401","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/401/content/application~1json/example"]}}},{"code":"403","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/403/content/application~1json/example"]}}},{"code":"404","exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1scim~1v2~1Users~1{id}/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/updateaspecificuser"}],"panels":[]}]},"httpPath":"/scim/v2/Users/{id}"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/deleteaspecificuser","routeSlug":"/v1-api-reference/api/scim/deleteaspecificuser","metadata":{"seo":{"title":"Delete a user","description":"Deactivates a specific user identified by the user ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteASpecificUser","name":"Delete a user","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivates a specific user identified by the user ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the user to delete.","required":true}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_5","description":"Unique key used to ensure idempotent behavior.","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the response's preferred content encoding. Supported values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/scim/v2/Users/{id}","servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_5"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204","401","403"],"pointer":"/scim/v2/Users/{id}","href":"scim/deleteaspecificuser","openApiOperationId":"deleteASpecificUser","summary":"Delete a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_339","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"number"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string"},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}},"headerSchemaId":"schema_294"},{"code":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/204/content/application~1json/example"]}},"schemaId":"schema_340","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/204/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"schema_341","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/403/content/application~1json/example"]}},"schemaId":"schema_342","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_339","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/200/content/application~1json/example"]}}},{"code":"204","schemaId":"schema_340","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/204/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/204/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_341","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_342","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342","exampleIds":["paths/~1scim~1v2~1Users~1{id}/delete/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/deleteaspecificuser"}],"panels":[]}]},"httpPath":"/scim/v2/Users/{id}"},{"label":"Partially update a user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/scim/partialupdateaspecificuser","routeSlug":"/v1-api-reference/api/scim/partialupdateaspecificuser","metadata":{"seo":{"title":"Partially update a user","description":"Updates an existing user resource, overwriting values for specified attributes.The value of the {id} should be the user's corresponding user ID. Attributes that are not provided in the request will remain unchanged. Updating a value to \" \" will clear and remove the field from the user's profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partialUpdateASpecificUser","name":"Partially update a user","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a user","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 an existing user resource, overwriting values for specified attributes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the {id} should be the user's corresponding user ID. Attributes that are not provided in the request will remain unchanged. Updating a value to \" \" will clear and remove the field from the user's profile."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"User ID to update","required":true}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_343"}},"schemaId":"schema_343","pointer":"/paths/~1scim~1v2~1Users~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/scim/v2/Users/{id}","servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_343"}},"responseCodes":["200","204","401","403"],"pointer":"/scim/v2/Users/{id}","href":"scim/partialupdateaspecificuser","openApiOperationId":"partialUpdateASpecificUser","summary":"Partially update a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"OneID SCIM API Server"}],"schemaId":"schema_343","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_343"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344","exampleIds":["paths/~1scim~1v2~1Users~1{id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_344","exampleIds":["paths/~1scim~1v2~1Users~1{id}/patch/responses/200/content/application~1json/example"]},{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized - The request lacks valid authentication credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_345"}},"schemaId":"schema_345"},{"code":"403","description":"Forbidden - The server understands the request but refuses to authorize it.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346"}},"schemaId":"schema_346"}],"pointer":"/paths/~1scim~1v2~1Users~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_344","exampleIds":["paths/~1scim~1v2~1Users~1{id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344","exampleIds":["paths/~1scim~1v2~1Users~1{id}/patch/responses/200/content/application~1json/example"]}}},{"code":"204"},{"code":"401","schemaId":"schema_345","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_345"}}},{"code":"403","schemaId":"schema_346","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scim/partialupdateaspecificuser"}],"panels":[]}]},"httpPath":"/scim/v2/Users/{id}"}],"content":{"contentType":"group","meta":{"name":"SCIM"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SCIM","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":"System for Cross-domain Identity Management, or SCIM, is an API specification created to facilitate the management of people and groups of people in cloud-based applications and services."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Universal Identity SCIM API is built on top of the SCIM 2.0 specification and can be integrated with major Identity Providers like Okta, Microsoft Entra ID and OneLogin."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must first create an OAuth client in the Zuora UI before using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to create an OAuth token. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/rest-api/general-concepts/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scim/v2/Groups","summary":"List groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scim/getlistgroups","deprecated":false},{"title":"/scim/v2/Groups","summary":"Create a group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scim/createanewgroup","deprecated":false},{"title":"/scim/v2/Groups/bulk","summary":"Bulk create groups","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scim/postbulkcreategroups","deprecated":false},{"title":"/scim/v2/Groups/bulk","summary":"Bulk update groups","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/scim/patchbulkpatchgroups","deprecated":false},{"title":"/scim/v2/Groups/delete","summary":"Bulk delete groups","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scim/postbulkdeletegroups","deprecated":false},{"title":"/scim/v2/Groups/{id}","summary":"Retrieve a group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scim/getaspecificgroup","deprecated":false},{"title":"/scim/v2/Groups/{id}","summary":"Update a group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/scim/updateaspecificgroup","deprecated":false},{"title":"/scim/v2/Groups/{id}","summary":"Delete a group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/scim/deleteaspecificgroup","deprecated":false},{"title":"/scim/v2/Groups/{id}","summary":"Partially update a group","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/scim/partiallyupdateaspecificgroup","deprecated":false},{"title":"/scim/v2/ResourceTypes","summary":"List all resource types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scim/gettheressourcetype","deprecated":false},{"title":"/scim/v2/ResourceTypes/{id}","summary":"Retrieve a resource type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scim/getaspecificresourcetype","deprecated":false},{"title":"/scim/v2/Schemas","summary":"List all schemas of resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scim/getschemaofscim","deprecated":false},{"title":"/scim/v2/Schemas/{id}","summary":"List schemas of a resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scim/gettheschemaofspecificscim","deprecated":false},{"title":"/scim/v2/ServiceProviderConfig","summary":"Retrieve the service provider configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scim/gettheserviceproviderconfig","deprecated":false},{"title":"/scim/v2/Users","summary":"List users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scim/getlistofusers","deprecated":false},{"title":"/scim/v2/Users","summary":"Create a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scim/createauser","deprecated":false},{"title":"/scim/v2/Users/bulk","summary":"Bulk create users","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scim/bulkcreateusers","deprecated":false},{"title":"/scim/v2/Users/bulk","summary":"Bulk update users","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/scim/bulkupdateusers","deprecated":false},{"title":"/scim/v2/Users/delete","summary":"Delete a list of users","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scim/deletealistofusers","deprecated":false},{"title":"/scim/v2/Users/{id}","summary":"Retrieve a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scim/getaspecificuser","deprecated":false},{"title":"/scim/v2/Users/{id}","summary":"Update a user","prefix":{"name":"put","color":"put"},"badges":[],"link":"/scim/updateaspecificuser","deprecated":false},{"title":"/scim/v2/Users/{id}","summary":"Delete a user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/scim/deleteaspecificuser","deprecated":false},{"title":"/scim/v2/Users/{id}","summary":"Partially update a user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/scim/partialupdateaspecificuser","deprecated":false}]}]}]}]}},{"type":"group","label":"Audit Logs","link":"/v1-api-reference/api/audit-logs","routeSlug":"/v1-api-reference/api/audit-logs","items":[{"label":"Search global login events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-logs/searchgloballogins","routeSlug":"/v1-api-reference/api/audit-logs/searchgloballogins","metadata":{"seo":{"title":"Search global login events","description":"Searches for global login events with page-number based pagination. Returns totalPages and totalElements for direct page navigation. No filter is required for global login queries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchGlobalLogins","name":"Search global login events","isWebhook":false,"pointer":"/paths/~1admin~1audit~1v2~1global-logins/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search global login events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for global login events with page-number based pagination. Returns totalPages and totalElements for direct page navigation. No filter is required for global login queries."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_5","description":[{"$$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":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the request must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_5","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":"An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in."},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in."}],"pointer":"/paths/~1admin~1audit~1v2~1global-logins/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1global-logins/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1global-logins/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1admin~1audit~1v2~1global-logins/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/admin/audit/v2/global-logins","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_5"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1global-logins/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403"],"pointer":"/admin/audit/v2/global-logins","href":"audit-logs/searchgloballogins","openApiOperationId":"searchGlobalLogins","summary":"Search global login events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1global-logins/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1global-logins/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348","exampleIds":["paths/~1admin~1audit~1v2~1global-logins/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_348","exampleIds":["paths/~1admin~1audit~1v2~1global-logins/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},"Concurrency-Limit-Type":{"schema":{"type":"string"},"description":"The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query."},"Concurrency-Limit-Limit":{"schema":{"type":"integer"},"description":"The total number of the permitted concurrent requests."},"Concurrency-Limit-Remaining":{"schema":{"type":"integer"},"description":"The remaining number of the permitted concurrent requests."}},"headerSchemaId":"schema_349"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350"}},"schemaId":"schema_350"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}},"schemaId":"schema_352"}],"pointer":"/paths/~1admin~1audit~1v2~1global-logins/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_348","exampleIds":["paths/~1admin~1audit~1v2~1global-logins/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348","exampleIds":["paths/~1admin~1audit~1v2~1global-logins/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_350","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350"}}},{"code":"401","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}},{"code":"403","schemaId":"schema_352","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-logs/searchgloballogins"}],"panels":[]}]},"httpPath":"/admin/audit/v2/global-logins"},{"label":"Search global setting change events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-logs/searchglobalsettings","routeSlug":"/v1-api-reference/api/audit-logs/searchglobalsettings","metadata":{"seo":{"title":"Search global setting change events","description":"Searches for global setting change events with page-number based pagination. Returns totalPages and totalElements for direct page navigation. No filter is required for global setting queries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchGlobalSettings","name":"Search global setting change events","isWebhook":false,"pointer":"/paths/~1admin~1audit~1v2~1global-settings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search global setting change events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for global setting change events with page-number based pagination. Returns totalPages and totalElements for direct page navigation. No filter is required for global setting queries."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_5","description":[{"$$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":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the request must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_5","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":"An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in."},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in."}],"pointer":"/paths/~1admin~1audit~1v2~1global-settings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1global-settings/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1global-settings/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1admin~1audit~1v2~1global-settings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/admin/audit/v2/global-settings","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_5"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1global-settings/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403"],"pointer":"/admin/audit/v2/global-settings","href":"audit-logs/searchglobalsettings","openApiOperationId":"searchGlobalSettings","summary":"Search global setting change events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1global-settings/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1global-settings/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353","exampleIds":["paths/~1admin~1audit~1v2~1global-settings/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_353","exampleIds":["paths/~1admin~1audit~1v2~1global-settings/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},"Concurrency-Limit-Type":{"schema":{"type":"string"},"description":"The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query."},"Concurrency-Limit-Limit":{"schema":{"type":"integer"},"description":"The total number of the permitted concurrent requests."},"Concurrency-Limit-Remaining":{"schema":{"type":"integer"},"description":"The remaining number of the permitted concurrent requests."}},"headerSchemaId":"schema_349"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350"}},"schemaId":"schema_350"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}},"schemaId":"schema_352"}],"pointer":"/paths/~1admin~1audit~1v2~1global-settings/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_353","exampleIds":["paths/~1admin~1audit~1v2~1global-settings/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353","exampleIds":["paths/~1admin~1audit~1v2~1global-settings/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_350","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350"}}},{"code":"401","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}},{"code":"403","schemaId":"schema_352","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-logs/searchglobalsettings"}],"panels":[]}]},"httpPath":"/admin/audit/v2/global-settings"},{"label":"Search tenant login events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-logs/searchtenantlogins","routeSlug":"/v1-api-reference/api/audit-logs/searchtenantlogins","metadata":{"seo":{"title":"Search tenant login events","description":"Searches for tenant-level login events with page-number based pagination. Requires a tenantId filter in filter.must. Returns totalPages and totalElements for direct page navigation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchTenantLogins","name":"Search tenant login events","isWebhook":false,"pointer":"/paths/~1admin~1audit~1v2~1tenant-logins/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search tenant login events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for tenant-level login events with page-number based pagination. Requires a tenantId filter in filter.must. Returns totalPages and totalElements for direct page navigation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_5","description":[{"$$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":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the request must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_5","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":"An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in."},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in."}],"pointer":"/paths/~1admin~1audit~1v2~1tenant-logins/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-logins/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-logins/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1admin~1audit~1v2~1tenant-logins/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/admin/audit/v2/tenant-logins","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_5"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-logins/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403"],"pointer":"/admin/audit/v2/tenant-logins","href":"audit-logs/searchtenantlogins","openApiOperationId":"searchTenantLogins","summary":"Search tenant login events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-logins/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-logins/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_354","exampleIds":["paths/~1admin~1audit~1v2~1tenant-logins/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_354","exampleIds":["paths/~1admin~1audit~1v2~1tenant-logins/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},"Concurrency-Limit-Type":{"schema":{"type":"string"},"description":"The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query."},"Concurrency-Limit-Limit":{"schema":{"type":"integer"},"description":"The total number of the permitted concurrent requests."},"Concurrency-Limit-Remaining":{"schema":{"type":"integer"},"description":"The remaining number of the permitted concurrent requests."}},"headerSchemaId":"schema_349"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_355"}},"schemaId":"schema_355"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}},"schemaId":"schema_352"}],"pointer":"/paths/~1admin~1audit~1v2~1tenant-logins/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_354","exampleIds":["paths/~1admin~1audit~1v2~1tenant-logins/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_354","exampleIds":["paths/~1admin~1audit~1v2~1tenant-logins/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_355","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_355"}}},{"code":"401","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}},{"code":"403","schemaId":"schema_352","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-logs/searchtenantlogins"}],"panels":[]}]},"httpPath":"/admin/audit/v2/tenant-logins"},{"label":"Search tenant setting change events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-logs/searchtenantsettings","routeSlug":"/v1-api-reference/api/audit-logs/searchtenantsettings","metadata":{"seo":{"title":"Search tenant setting change events","description":"Searches for tenant-level setting change events with page-number based pagination. Requires a tenantId filter in filter.must. Returns totalPages and totalElements for direct page navigation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchTenantSettings","name":"Search tenant setting change events","isWebhook":false,"pointer":"/paths/~1admin~1audit~1v2~1tenant-settings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search tenant setting change events","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":"Searches for tenant-level setting change events with page-number based pagination. Requires a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter.must"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalElements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for direct page navigation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_5","description":[{"$$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":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the request must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_5","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":"An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in."},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in."}],"pointer":"/paths/~1admin~1audit~1v2~1tenant-settings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-settings/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-settings/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1admin~1audit~1v2~1tenant-settings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/admin/audit/v2/tenant-settings","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_5"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-settings/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403"],"pointer":"/admin/audit/v2/tenant-settings","href":"audit-logs/searchtenantsettings","openApiOperationId":"searchTenantSettings","summary":"Search tenant setting change events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-settings/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-settings/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356","exampleIds":["paths/~1admin~1audit~1v2~1tenant-settings/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_356","exampleIds":["paths/~1admin~1audit~1v2~1tenant-settings/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},"Concurrency-Limit-Type":{"schema":{"type":"string"},"description":"The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query."},"Concurrency-Limit-Limit":{"schema":{"type":"integer"},"description":"The total number of the permitted concurrent requests."},"Concurrency-Limit-Remaining":{"schema":{"type":"integer"},"description":"The remaining number of the permitted concurrent requests."}},"headerSchemaId":"schema_349"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_355"}},"schemaId":"schema_355"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}},"schemaId":"schema_352"}],"pointer":"/paths/~1admin~1audit~1v2~1tenant-settings/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_356","exampleIds":["paths/~1admin~1audit~1v2~1tenant-settings/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356","exampleIds":["paths/~1admin~1audit~1v2~1tenant-settings/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_355","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_355"}}},{"code":"401","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}},{"code":"403","schemaId":"schema_352","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-logs/searchtenantsettings"}],"panels":[]}]},"httpPath":"/admin/audit/v2/tenant-settings"},{"label":"Search tenant object change events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/audit-logs/searchtenantobjects","routeSlug":"/v1-api-reference/api/audit-logs/searchtenantobjects","metadata":{"seo":{"title":"Search tenant object change events","description":"Searches for tenant-level object change events with page-number based pagination. Requires a tenantId filter in filter.must. Optionally accepts an objectType filter with values such as USER, ROLE, and PERMISSION. Returns totalPages and totalElements for direct page navigation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchTenantObjects","name":"Search tenant object change events","isWebhook":false,"pointer":"/paths/~1admin~1audit~1v2~1tenant-objects/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search tenant object change events","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":"Searches for tenant-level object change events with page-number based pagination. Requires a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter.must"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optionally accepts an objectType filter with values such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERMISSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalElements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for direct page navigation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_5","description":[{"$$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":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the request must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_5","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":"An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in."},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in."}],"pointer":"/paths/~1admin~1audit~1v2~1tenant-objects/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-objects/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-objects/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1admin~1audit~1v2~1tenant-objects/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/admin/audit/v2/tenant-objects","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_5"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-objects/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403"],"pointer":"/admin/audit/v2/tenant-objects","href":"audit-logs/searchtenantobjects","openApiOperationId":"searchTenantObjects","summary":"Search tenant object change events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-objects/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1admin~1audit~1v2~1tenant-objects/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1admin~1audit~1v2~1tenant-objects/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_357","exampleIds":["paths/~1admin~1audit~1v2~1tenant-objects/post/responses/200/content/application~1json/example"],"headers":{"Content-Encoding":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"schema":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"schema":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"schema":{"type":"string","minLength":36,"maxLength":36},"description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"schema":{"type":"string"},"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},"Concurrency-Limit-Type":{"schema":{"type":"string"},"description":"The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query."},"Concurrency-Limit-Limit":{"schema":{"type":"integer"},"description":"The total number of the permitted concurrent requests."},"Concurrency-Limit-Remaining":{"schema":{"type":"integer"},"description":"The remaining number of the permitted concurrent requests."}},"headerSchemaId":"schema_349"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_355"}},"schemaId":"schema_355"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}},"schemaId":"schema_352"}],"pointer":"/paths/~1admin~1audit~1v2~1tenant-objects/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_357","exampleIds":["paths/~1admin~1audit~1v2~1tenant-objects/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1admin~1audit~1v2~1tenant-objects/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_355","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_355"}}},{"code":"401","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}},{"code":"403","schemaId":"schema_352","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-logs/searchtenantobjects"}],"panels":[]}]},"httpPath":"/admin/audit/v2/tenant-objects"}],"content":{"contentType":"group","meta":{"name":"Audit Logs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit Logs","showPageActions":true},{"nodeType":"markdoc","content":"Audit Logs provides audit trail APIs for searching global and tenant-level login events, setting changes, and object changes. These endpoints support paginated search results for administrative audit activity."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/admin/audit/v2/global-logins","summary":"Search global login events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-logs/searchgloballogins","deprecated":false},{"title":"/admin/audit/v2/global-settings","summary":"Search global setting change events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-logs/searchglobalsettings","deprecated":false},{"title":"/admin/audit/v2/tenant-logins","summary":"Search tenant login events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-logs/searchtenantlogins","deprecated":false},{"title":"/admin/audit/v2/tenant-settings","summary":"Search tenant setting change events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-logs/searchtenantsettings","deprecated":false},{"title":"/admin/audit/v2/tenant-objects","summary":"Search tenant object change events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-logs/searchtenantobjects","deprecated":false}]}]}]}]}},{"type":"group","label":"Admin Integrations","link":"/v1-api-reference/api/admin-integrations","routeSlug":"/v1-api-reference/api/admin-integrations","items":[{"label":"List global users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/admin-integrations/getglobalusersdata","routeSlug":"/v1-api-reference/api/admin-integrations/getglobalusersdata","metadata":{"seo":{"title":"List global users","description":"Returns paginated global user data for an organization. Supports filtering by status and standard Spring pagination parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGlobalUsersData","name":"List global users","isWebhook":false,"pointer":"/paths/~1admin~1integrations~1data~1global-users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List global users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns paginated global user data for an organization.\nSupports filtering by status and standard Spring pagination parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_358","description":"Filters the response by user status."},{"name":"page","in":"query","schemaId":"schema_216","description":"Specifies the zero-based page number.","example":0},{"name":"size","in":"query","schemaId":"schema_90","description":"Specifies the number of items per page.","example":20},{"name":"sort","in":"query","schemaId":"schema_5","description":"Specifies the sort field and direction.","example":"createdOn,desc"}],"pointer":"/paths/~1admin~1integrations~1data~1global-users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admin/integrations/data/global-users","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","required":false,"schemaId":"schema_358"},{"name":"page","in":"query","required":false,"example":0,"schemaId":"schema_216"},{"name":"size","in":"query","required":false,"example":20,"schemaId":"schema_90"},{"name":"sort","in":"query","required":false,"example":"createdOn,desc","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/admin/integrations/data/global-users","href":"admin-integrations/getglobalusersdata","openApiOperationId":"getGlobalUsersData","summary":"List global users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359","exampleIds":["paths/~1admin~1integrations~1data~1global-users/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_359","exampleIds":["paths/~1admin~1integrations~1data~1global-users/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}},"schemaId":"schema_352"}],"pointer":"/paths/~1admin~1integrations~1data~1global-users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_359","exampleIds":["paths/~1admin~1integrations~1data~1global-users/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359","exampleIds":["paths/~1admin~1integrations~1data~1global-users/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}},{"code":"403","schemaId":"schema_352","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-integrations/getglobalusersdata"}],"panels":[]}]},"httpPath":"/admin/integrations/data/global-users"},{"label":"List global roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/admin-integrations/getglobalrolesdata","routeSlug":"/v1-api-reference/api/admin-integrations/getglobalrolesdata","metadata":{"seo":{"title":"List global roles","description":"Returns paginated global roles at the organization level. Supports standard Spring pagination parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGlobalRolesData","name":"List global roles","isWebhook":false,"pointer":"/paths/~1admin~1integrations~1data~1global-roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List global roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns paginated global roles at the organization level.\nSupports standard Spring pagination parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_216","description":"Specifies the zero-based page number.","example":0},{"name":"size","in":"query","schemaId":"schema_90","description":"Specifies the number of items per page.","example":20},{"name":"sort","in":"query","schemaId":"schema_5","description":"Specifies the sort field and direction.","example":"createdOn,desc"}],"pointer":"/paths/~1admin~1integrations~1data~1global-roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admin/integrations/data/global-roles","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":0,"schemaId":"schema_216"},{"name":"size","in":"query","required":false,"example":20,"schemaId":"schema_90"},{"name":"sort","in":"query","required":false,"example":"createdOn,desc","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/admin/integrations/data/global-roles","href":"admin-integrations/getglobalrolesdata","openApiOperationId":"getGlobalRolesData","summary":"List global roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360","exampleIds":["paths/~1admin~1integrations~1data~1global-roles/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_360","exampleIds":["paths/~1admin~1integrations~1data~1global-roles/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1admin~1integrations~1data~1global-roles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_360","exampleIds":["paths/~1admin~1integrations~1data~1global-roles/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360","exampleIds":["paths/~1admin~1integrations~1data~1global-roles/get/responses/200/content/application~1json/example"]}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-integrations/getglobalrolesdata"}],"panels":[]}]},"httpPath":"/admin/integrations/data/global-roles"},{"label":"List tenant-specific roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/admin-integrations/gettenantrolesdata","routeSlug":"/v1-api-reference/api/admin-integrations/gettenantrolesdata","metadata":{"seo":{"title":"List tenant-specific roles","description":"Returns paginated roles for a specific tenant entity. Supports standard Spring pagination parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTenantRolesData","name":"List tenant-specific roles","isWebhook":false,"pointer":"/paths/~1admin~1integrations~1data~1tenant-roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tenant-specific roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns paginated roles for a specific tenant entity.\nSupports standard Spring pagination parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"entityId","in":"query","schemaId":"schema_96","description":"Specifies the entity ID of the tenant.","required":true,"example":"ent-98765432-dcba-hgfe-lkji-210987654321"},{"name":"page","in":"query","schemaId":"schema_216","description":"Specifies the zero-based page number.","example":0},{"name":"size","in":"query","schemaId":"schema_90","description":"Specifies the number of items per page.","example":20},{"name":"sort","in":"query","schemaId":"schema_5","description":"Specifies the sort field and direction.","example":"createdOn,desc"}],"pointer":"/paths/~1admin~1integrations~1data~1tenant-roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admin/integrations/data/tenant-roles","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"entityId","in":"query","required":true,"example":"ent-98765432-dcba-hgfe-lkji-210987654321","schemaId":"schema_96"},{"name":"page","in":"query","required":false,"example":0,"schemaId":"schema_216"},{"name":"size","in":"query","required":false,"example":20,"schemaId":"schema_90"},{"name":"sort","in":"query","required":false,"example":"createdOn,desc","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/admin/integrations/data/tenant-roles","href":"admin-integrations/gettenantrolesdata","openApiOperationId":"getTenantRolesData","summary":"List tenant-specific roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361","exampleIds":["paths/~1admin~1integrations~1data~1tenant-roles/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_361","exampleIds":["paths/~1admin~1integrations~1data~1tenant-roles/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1admin~1integrations~1data~1tenant-roles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_361","exampleIds":["paths/~1admin~1integrations~1data~1tenant-roles/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361","exampleIds":["paths/~1admin~1integrations~1data~1tenant-roles/get/responses/200/content/application~1json/example"]}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-integrations/gettenantrolesdata"}],"panels":[]}]},"httpPath":"/admin/integrations/data/tenant-roles"},{"label":"List tenant-specific roles with permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/admin-integrations/gettenantrolespermissionsdata","routeSlug":"/v1-api-reference/api/admin-integrations/gettenantrolespermissionsdata","metadata":{"seo":{"title":"List tenant-specific roles with permissions","description":"Returns paginated tenant roles with their full permission details. Supports standard Spring pagination parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTenantRolesPermissionsData","name":"List tenant-specific roles with permissions","isWebhook":false,"pointer":"/paths/~1admin~1integrations~1data~1tenant-roles-permissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tenant-specific roles with permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns paginated tenant roles with their full permission details.\nSupports standard Spring pagination parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"entityId","in":"query","schemaId":"schema_96","description":"Specifies the entity ID of the tenant.","required":true,"example":"ent-98765432-dcba-hgfe-lkji-210987654321"},{"name":"page","in":"query","schemaId":"schema_216","description":"Specifies the zero-based page number.","example":0},{"name":"size","in":"query","schemaId":"schema_90","description":"Specifies the number of items per page.","example":20},{"name":"sort","in":"query","schemaId":"schema_5","description":"Specifies the sort field and direction.","example":"createdOn,desc"}],"pointer":"/paths/~1admin~1integrations~1data~1tenant-roles-permissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admin/integrations/data/tenant-roles-permissions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"entityId","in":"query","required":true,"example":"ent-98765432-dcba-hgfe-lkji-210987654321","schemaId":"schema_96"},{"name":"page","in":"query","required":false,"example":0,"schemaId":"schema_216"},{"name":"size","in":"query","required":false,"example":20,"schemaId":"schema_90"},{"name":"sort","in":"query","required":false,"example":"createdOn,desc","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/admin/integrations/data/tenant-roles-permissions","href":"admin-integrations/gettenantrolespermissionsdata","openApiOperationId":"getTenantRolesPermissionsData","summary":"List tenant-specific roles with permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362","exampleIds":["paths/~1admin~1integrations~1data~1tenant-roles-permissions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_362","exampleIds":["paths/~1admin~1integrations~1data~1tenant-roles-permissions/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1admin~1integrations~1data~1tenant-roles-permissions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_362","exampleIds":["paths/~1admin~1integrations~1data~1tenant-roles-permissions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362","exampleIds":["paths/~1admin~1integrations~1data~1tenant-roles-permissions/get/responses/200/content/application~1json/example"]}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-integrations/gettenantrolespermissionsdata"}],"panels":[]}]},"httpPath":"/admin/integrations/data/tenant-roles-permissions"}],"content":{"contentType":"group","meta":{"name":"Admin Integrations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admin Integrations","showPageActions":true},{"nodeType":"markdoc","content":"Admin Integrations provides structured JSON APIs for retrieving organization- level and tenant-level administrative data, including users, roles, and role permissions. These endpoints support standard pagination and sorting parameters for integration use cases."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/admin/integrations/data/global-users","summary":"List global users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin-integrations/getglobalusersdata","deprecated":false},{"title":"/admin/integrations/data/global-roles","summary":"List global roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin-integrations/getglobalrolesdata","deprecated":false},{"title":"/admin/integrations/data/tenant-roles","summary":"List tenant-specific roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin-integrations/gettenantrolesdata","deprecated":false},{"title":"/admin/integrations/data/tenant-roles-permissions","summary":"List tenant-specific roles with permissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin-integrations/gettenantrolespermissionsdata","deprecated":false}]}]}]}]}},{"type":"separator","label":"Multiple Organizations","content":null},{"type":"group","label":"Data Labeling","link":"/v1-api-reference/api/data-labeling","routeSlug":"/v1-api-reference/api/data-labeling","items":[{"type":"link","label":"General guidelines","link":"/v1-api-reference/api/data-labeling/general-guidelines","routeSlug":"/v1-api-reference/api/data-labeling/general-guidelines","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"General guidelines"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"data-labeling/general-guidelines"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"General guidelines"},"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":"Firstly, create the org hierarchy and determine the data categorization strategy, for example, by currency, by region, by custom fields etc."},"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":"You have to migrate all customer accounts before labeling products in the product catalog"},"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":"You can leave the users at the root, just so long as you understand that the user would have access to all the Org Units within the Multi-org enabled tenant."},"children":[]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Order of object labeling","link":"/v1-api-reference/api/data-labeling/order-of-object-labeling","routeSlug":"/v1-api-reference/api/data-labeling/order-of-object-labeling","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Order of object labeling"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"data-labeling/order-of-object-labeling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order of object labeling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Except for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there are no dependencies between objects, users can label them in parallel."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"But please keep in mind that the data access control ensues from the object labeling. For example, if you label a scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillRun"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" org, when it's triggered next time, the bill run will only pick up customer accounts of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" org, not others."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Likewise, labeling a user will change the user's visible data scope, for example, an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user won't be able to see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accounts anymore."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Caveats⚠️","link":"/v1-api-reference/api/data-labeling/caveats","routeSlug":"/v1-api-reference/api/data-labeling/caveats","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Caveats⚠️"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"data-labeling/caveats"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caveats⚠️"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is primarily designed for data migration to assist in  labeling existing datasets."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It may also serve for data corrections, such as  reassigning an account's organizational label,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"thereby transferring the account  and its transaction data from one organization to another."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's important  to note that this process does not include business logic validation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users  should exercise caution and judgment when employing this API for data labeling tasks."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Submit a data labeling job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-labeling/post_datalabelingjob","routeSlug":"/v1-api-reference/api/data-labeling/post_datalabelingjob","metadata":{"seo":{"title":"Submit a data labeling job","description":"Submits a data labeling job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_DataLabelingJob","name":"Submit a data labeling job","isWebhook":false,"pointer":"/paths/~1v1~1multi-organizations~1data-labeling-job/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a data labeling job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submits a data labeling job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1multi-organizations~1data-labeling-job/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmitDataLabelingJobRequest"}},"schemaId":"components/schemas/SubmitDataLabelingJobRequest","pointer":"/paths/~1v1~1multi-organizations~1data-labeling-job/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/multi-organizations/data-labeling-job","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubmitDataLabelingJobRequest"}},"responseCodes":["200","400"],"pointer":"/v1/multi-organizations/data-labeling-job","href":"data-labeling/post_datalabelingjob","openApiOperationId":"POST_DataLabelingJob","summary":"Submit a data labeling job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/SubmitDataLabelingJobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmitDataLabelingJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitDataLabelingJobResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SubmitDataLabelingJobResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1multi-organizations~1data-labeling-job/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubmitDataLabelingJobResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitDataLabelingJobResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-labeling/post_datalabelingjob"}],"panels":[]}]},"httpPath":"/v1/multi-organizations/data-labeling-job"},{"label":"Retrieve a data labeling job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-labeling/get_datalabelingjob","routeSlug":"/v1-api-reference/api/data-labeling/get_datalabelingjob","metadata":{"seo":{"title":"Retrieve a data labeling job","description":"Retrieves a data labeling job. You can use this operation to track the status of the data labeling job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DataLabelingJob","name":"Retrieve a data labeling job","isWebhook":false,"pointer":"/paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a data labeling job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a data labeling job. You can use this operation to track the status of the data labeling job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job-id","in":"path","schemaId":"schema_363","description":"Identifier of the data labeling job.\n","required":true}],"pointer":"/paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/multi-organizations/data-labeling-job/{job-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"job-id","in":"path","required":true,"schemaId":"schema_363"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/multi-organizations/data-labeling-job/{job-id}","href":"data-labeling/get_datalabelingjob","openApiOperationId":"GET_DataLabelingJob","summary":"Retrieve a data labeling job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDataLabelingJobResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GetDataLabelingJobResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetDataLabelingJobResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDataLabelingJobResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-labeling/get_datalabelingjob"}],"panels":[]}]},"httpPath":"/v1/multi-organizations/data-labeling-job/{job-id}"}],"content":{"contentType":"group","meta":{"name":"Data Labeling"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Labeling","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":"The Data Labeling APIs help you to label your existing data with organization(s) in Zuora."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you turned on Multi Org feature, if you don't label your existing data, they are simply unlabeled, and unlabeled data can be accessed by all organizations in your tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To limit the access of your existing data, you need to label them with organization(s) you defined in the organization hierarchy management setting page. Once labeled, the data can only be accessed by users who have been granted with the labeled organization(s)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that you have to enable the \"Multi Org\" feature before using the Data Labeling APIs."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/multi-organizations/data-labeling-job","summary":"Submit a data labeling job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-labeling/post_datalabelingjob","deprecated":false},{"title":"/v1/multi-organizations/data-labeling-job/{job-id}","summary":"Retrieve a data labeling job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-labeling/get_datalabelingjob","deprecated":false}]}]}]}]}},{"type":"separator","label":"Order to Revenue","content":null},{"type":"group","label":"Data Backfill","link":"/v1-api-reference/api/data-backfill","routeSlug":"/v1-api-reference/api/data-backfill","items":[{"label":"Create a booking date backfill job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/post_createbookingdatebackfilljob","routeSlug":"/v1-api-reference/api/data-backfill/post_createbookingdatebackfilljob","metadata":{"seo":{"title":"Create a booking date backfill job","description":"Creates a booking date backfill job to update the booking date with your charge's original created-on date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateBookingDateBackfillJob","name":"Create a booking date backfill job","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a booking date backfill job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a booking date backfill job to update the booking date with your charge's original created-on date.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/uno/data-backfill/bookingdate/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/bookingdate/jobs","href":"data-backfill/post_createbookingdatebackfilljob","openApiOperationId":"POST_CreateBookingDateBackfillJob","summary":"Create a booking date backfill job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/fail"]}},"schemaId":"schema_364","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/fail"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_364","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/fail"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/fail"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/post_createbookingdatebackfilljob"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/bookingdate/jobs"},{"label":"List all booking date backfill jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_listbookingdatebackfilljobs","routeSlug":"/v1-api-reference/api/data-backfill/get_listbookingdatebackfilljobs","metadata":{"seo":{"title":"List all booking date backfill jobs","description":"Use this operation to list all booking date backfill jobs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ListBookingDateBackfillJobs","name":"List all booking date backfill jobs","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all booking date backfill jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this operation to list all booking date backfill jobs.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/uno/data-backfill/bookingdate/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/bookingdate/jobs","href":"data-backfill/get_listbookingdatebackfilljobs","openApiOperationId":"GET_ListBookingDateBackfillJobs","summary":"List all booking date backfill jobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/fail"]}},"schemaId":"schema_365","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/fail"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_365","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/fail"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/fail"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/get_listbookingdatebackfilljobs"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/bookingdate/jobs"},{"label":"Retrieve a booking date backfill job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_bookingdatebackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/get_bookingdatebackfilljobbyid","metadata":{"seo":{"title":"Retrieve a booking date backfill job","description":"Use this operation to retrieve a specific booking date backfill job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_BookingDateBackfillJobById","name":"Retrieve a booking date backfill job","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a booking date backfill job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this operation to retrieve a specific booking date backfill job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_366","description":"ID of the job to retrieve\n","required":true}],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/uno/data-backfill/bookingdate/jobs/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/bookingdate/jobs/{jobId}","href":"data-backfill/get_bookingdatebackfilljobbyid","openApiOperationId":"GET_BookingDateBackfillJobById","summary":"Retrieve a booking date backfill job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"]}},"schemaId":"schema_367","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_367","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/get_bookingdatebackfilljobbyid"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/bookingdate/jobs/{jobId}"},{"label":"Stop a booking date backfill job","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/put_stopbookingdatebackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/put_stopbookingdatebackfilljobbyid","metadata":{"seo":{"title":"Stop a booking date backfill job","description":"Use this operation to stop a booking date backfill job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_StopBookingDateBackfillJobById","name":"Stop a booking date backfill job","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop a booking date backfill job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this operation to stop a booking date backfill job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_366","description":"ID of the job to stop\n","required":true}],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/uno/data-backfill/bookingdate/jobs/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/bookingdate/jobs/{jobId}","href":"data-backfill/put_stopbookingdatebackfilljobbyid","openApiOperationId":"PUT_StopBookingDateBackfillJobById","summary":"Stop a booking date backfill job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/put_stopbookingdatebackfilljobbyid"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/bookingdate/jobs/{jobId}"},{"label":"Create a data backfill job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/post_createdatabackfilljob","routeSlug":"/v1-api-reference/api/data-backfill/post_createdatabackfilljob","metadata":{"seo":{"title":"Create a data backfill job","description":"Use this operation to perform the following types of data backfill actions. Also, you need to upload a corresponding file to perform a data backfill action."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateDataBackfillJob","name":"Create a data backfill job","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a data backfill job","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":"Use this operation to perform the following types of data backfill actions. Also, you need to upload a corresponding file to perform a data backfill action."},"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":"Update Product Rate Plan Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Rate Plan Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Invoice Item"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Credit Memo Detail"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Debit Memo Detail"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Invoice Item Adjustment"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform data backfill"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1v1~1uno~1data-backfill~1jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/uno/data-backfill/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_369"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/jobs","href":"data-backfill/post_createdatabackfilljob","openApiOperationId":"POST_CreateDataBackfillJob","summary":"Create a data backfill job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_369","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/fail"]}},"schemaId":"schema_370","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/fail"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_370","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/fail"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/fail"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/post_createdatabackfilljob"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/jobs"},{"label":"Retrieve a data backfill job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_databackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/get_databackfilljobbyid","metadata":{"seo":{"title":"Retrieve a data backfill job","description":"Returns a single Data Backfill job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DataBackfillJobById","name":"Retrieve a data backfill job","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a data backfill job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single Data Backfill job"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_366","description":"ID of the job to retrieve\n","required":true}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/uno/data-backfill/jobs/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/jobs/{jobId}","href":"data-backfill/get_databackfilljobbyid","openApiOperationId":"GET_DataBackfillJobById","summary":"Retrieve a data backfill job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"]}},"schemaId":"schema_371","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_371","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/get_databackfilljobbyid"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/jobs/{jobId}"},{"label":"Stop a data backfill job","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/put_stopdatabackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/put_stopdatabackfilljobbyid","metadata":{"seo":{"title":"Stop a data backfill job","description":"Use this operation to stop a data backfill job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_StopDataBackfillJobById","name":"Stop a data backfill job","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop a data backfill job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this operation to stop a data backfill job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_366","description":"ID of the job to stop\n","required":true}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/uno/data-backfill/jobs/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/jobs/{jobId}","href":"data-backfill/put_stopdatabackfilljobbyid","openApiOperationId":"PUT_StopDataBackfillJobById","summary":"Stop a data backfill job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/put_stopdatabackfilljobbyid"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/jobs/{jobId}"},{"label":"List all data backfill jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_listdatabackfilljobs","routeSlug":"/v1-api-reference/api/data-backfill/get_listdatabackfilljobs","metadata":{"seo":{"title":"List all data backfill jobs","description":"List all data backfill jobs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ListDataBackfillJobs","name":"List all data backfill jobs","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1listjobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all data backfill jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1listjobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/uno/data-backfill/listjobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/listjobs","href":"data-backfill/get_listdatabackfilljobs","openApiOperationId":"GET_ListDataBackfillJobs","summary":"List all data backfill jobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/fail"]}},"schemaId":"schema_372","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/fail"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1listjobs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_372","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/fail"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/fail"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/get_listdatabackfilljobs"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/listjobs"},{"label":"Download a data backfill template file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_databackfilltemplate","routeSlug":"/v1-api-reference/api/data-backfill/get_databackfilltemplate","metadata":{"seo":{"title":"Download a data backfill template file","description":"Use this operation to download a data backfill template file of the specific type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_DataBackfillTemplate","name":"Download a data backfill template file","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a data backfill template file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this operation to download a data backfill template file of the specific type.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type","in":"path","schemaId":"schema_373","description":"Type of the template file that you want to download for data backfill\n","required":true}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/uno/data-backfill/jobs/{type}/template","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"type","in":"path","required":true,"schemaId":"components/schemas/DataBackfillJobType"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/jobs/{type}/template","href":"data-backfill/get_databackfilltemplate","openApiOperationId":"GET_DataBackfillTemplate","summary":"Download a data backfill template file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_5","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/success","paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/fail"]}},"schemaId":"schema_5","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/success","paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/fail"],"headers":{"Content-Disposition":{"description":"Indicating it should be downloaded, prefilled with the value of the filename parameters if present.\n","schema":{"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_374"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_5","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/success","paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/fail"],"mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_5","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/success","paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/fail"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/get_databackfilltemplate"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/jobs/{type}/template"},{"label":"List all auto backfill jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_listautobackfilljob","routeSlug":"/v1-api-reference/api/data-backfill/get_listautobackfilljob","metadata":{"seo":{"title":"List all auto backfill jobs","description":"Use this operation to list all auto backfill jobs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_listAutoBackfillJob","name":"List all auto backfill jobs","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all auto backfill jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this operation to list all auto backfill jobs.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/uno/data-backfill/propagation/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/propagation/jobs","href":"data-backfill/get_listautobackfilljob","openApiOperationId":"GET_listAutoBackfillJob","summary":"List all auto backfill jobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/fail"]}},"schemaId":"schema_365","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/fail"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_365","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/fail"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/fail"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/get_listautobackfilljob"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/propagation/jobs"},{"label":"Create an auto backfill job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/post_createautobackfilljob","routeSlug":"/v1-api-reference/api/data-backfill/post_createautobackfilljob","metadata":{"seo":{"title":"Create an auto backfill job","description":"Creates an autobackfill job to update the rate plan charge and order line item with product rate plan charge."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateAutoBackfillJob","name":"Create an auto backfill job","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an auto backfill job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an autobackfill job to update the rate plan charge and order line item with product rate plan charge.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375","pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/uno/data-backfill/propagation/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_375"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/propagation/jobs","href":"data-backfill/post_createautobackfilljob","openApiOperationId":"POST_CreateAutoBackfillJob","summary":"Create an auto backfill job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/fail"]}},"schemaId":"schema_376","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/fail"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_376","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/fail"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/fail"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/post_createautobackfilljob"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/propagation/jobs"},{"label":"Retrieve an auto backfill job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/get_autobackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/get_autobackfilljobbyid","metadata":{"seo":{"title":"Retrieve an auto backfill job","description":"Use this operation to retrieve a specific auto backfill job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AutoBackfillJobById","name":"Retrieve an auto backfill job","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an auto backfill job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this operation to retrieve a specific auto backfill job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_366","description":"ID of the job to retrieve\n","required":true}],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/uno/data-backfill/propagation/jobs/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/propagation/jobs/{jobId}","href":"data-backfill/get_autobackfilljobbyid","openApiOperationId":"GET_AutoBackfillJobById","summary":"Retrieve an auto backfill job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"]}},"schemaId":"schema_367","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_367","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success","paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/get_autobackfilljobbyid"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/propagation/jobs/{jobId}"},{"label":"Stop an auto backfill job","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/data-backfill/put_stopautobackfilljobbyid","routeSlug":"/v1-api-reference/api/data-backfill/put_stopautobackfilljobbyid","metadata":{"seo":{"title":"Stop an auto backfill job","description":"Use this operation to stop an auto backfill job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_StopAutoBackfillJobById","name":"Stop an auto backfill job","isWebhook":false,"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop an auto backfill job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this operation to stop an auto backfill job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_366","description":"ID of the job to stop\n","required":true}],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/uno/data-backfill/propagation/jobs/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","500","4XX"],"pointer":"/v1/uno/data-backfill/propagation/jobs/{jobId}","href":"data-backfill/put_stopautobackfilljobbyid","openApiOperationId":"PUT_StopAutoBackfillJobById","summary":"Stop an auto backfill job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-backfill/put_stopautobackfilljobbyid"}],"panels":[]}]},"httpPath":"/v1/uno/data-backfill/propagation/jobs/{jobId}"}],"content":{"contentType":"group","meta":{"name":"Data Backfill"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Backfill","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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user, you can use the data backfill operations to perform, view or stop data backfill tasks."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/uno/data-backfill/bookingdate/jobs","summary":"Create a booking date backfill job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-backfill/post_createbookingdatebackfilljob","deprecated":false},{"title":"/v1/uno/data-backfill/bookingdate/jobs","summary":"List all booking date backfill jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-backfill/get_listbookingdatebackfilljobs","deprecated":false},{"title":"/v1/uno/data-backfill/bookingdate/jobs/{jobId}","summary":"Retrieve a booking date backfill job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-backfill/get_bookingdatebackfilljobbyid","deprecated":false},{"title":"/v1/uno/data-backfill/bookingdate/jobs/{jobId}","summary":"Stop a booking date backfill job","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-backfill/put_stopbookingdatebackfilljobbyid","deprecated":false},{"title":"/v1/uno/data-backfill/jobs","summary":"Create a data backfill job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-backfill/post_createdatabackfilljob","deprecated":false},{"title":"/v1/uno/data-backfill/jobs/{jobId}","summary":"Retrieve a data backfill job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-backfill/get_databackfilljobbyid","deprecated":false},{"title":"/v1/uno/data-backfill/jobs/{jobId}","summary":"Stop a data backfill job","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-backfill/put_stopdatabackfilljobbyid","deprecated":false},{"title":"/v1/uno/data-backfill/listjobs","summary":"List all data backfill jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-backfill/get_listdatabackfilljobs","deprecated":false},{"title":"/v1/uno/data-backfill/jobs/{type}/template","summary":"Download a data backfill template file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-backfill/get_databackfilltemplate","deprecated":false},{"title":"/v1/uno/data-backfill/propagation/jobs","summary":"List all auto backfill jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-backfill/get_listautobackfilljob","deprecated":false},{"title":"/v1/uno/data-backfill/propagation/jobs","summary":"Create an auto backfill job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-backfill/post_createautobackfilljob","deprecated":false},{"title":"/v1/uno/data-backfill/propagation/jobs/{jobId}","summary":"Retrieve an auto backfill job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-backfill/get_autobackfilljobbyid","deprecated":false},{"title":"/v1/uno/data-backfill/propagation/jobs/{jobId}","summary":"Stop an auto backfill job","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-backfill/put_stopautobackfilljobbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Regenerate","link":"/v1-api-reference/api/regenerate","routeSlug":"/v1-api-reference/api/regenerate","items":[{"label":"Regenerate booking transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/regenerate/post_regeneratebookingtransaction","routeSlug":"/v1-api-reference/api/regenerate/post_regeneratebookingtransaction","metadata":{"seo":{"title":"Regenerate booking transactions","description":"Use this operation to generate booking transactions. This call is useful in the following two use cases:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_RegenerateBookingTransaction","name":"Regenerate booking transactions","isWebhook":false,"pointer":"/paths/~1v1~1uno-regenerate~1booking-transaction/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate booking transactions","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":"Use this operation to generate booking transactions. This call is useful in the following two use cases:"},"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":"During customer onboarding, there is a common scenario when customers perform data backfill or data fixes. To synchronize these changes from Billing to Revenue, use this API operation to regenerate booking transaction objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers choose to experiment with their use cases in the Sandbox environment before implementing them in the Production environment. During this experimentation phase, customers not only interact with data but also use this API operation to regenerate booking transaction objects."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"onlyReSend","in":"query","schemaId":"schema_27","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":"onlyReSend"},"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":", existing records are not overwritten; they are resent with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regenerate_flag = Y"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyReSend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", transactions are recalculated from source; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regenerate_flag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate=false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyReSend"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"'"},"children":[]}]}]}]},{"name":"reMigrate","in":"query","schemaId":"schema_27","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":"reMigrate"},"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":", transactions are recalculated from source and sent with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regenerate_flag = Y"},"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":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyReSend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", transactions are still recalculated from source and sent,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regenerate_flag = N"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyResend"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be "},"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":"'"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyReSend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter names are case-sensitive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values must be "},"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":", not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"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":"Unrecognized names are ignored, and defaults are used. The API may still return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"code","inline":true,"attributes":{"content":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyReSend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot both be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1uno-regenerate~1booking-transaction/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno-regenerate~1booking-transaction/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegenerateBookingRequest"}},"schemaId":"components/schemas/RegenerateBookingRequest","pointer":"/paths/~1v1~1uno-regenerate~1booking-transaction/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/uno-regenerate/booking-transaction","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"onlyReSend","in":"query","required":false,"schemaId":"schema_27"},{"name":"reMigrate","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RegenerateBookingRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/uno-regenerate/booking-transaction","href":"regenerate/post_regeneratebookingtransaction","openApiOperationId":"POST_RegenerateBookingTransaction","summary":"Regenerate booking transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/RegenerateBookingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegenerateBookingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegenerateTransactionObjectResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RegenerateTransactionObjectResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno-regenerate~1booking-transaction/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegenerateTransactionObjectResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegenerateTransactionObjectResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regenerate/post_regeneratebookingtransaction"}],"panels":[]}]},"httpPath":"/v1/uno-regenerate/booking-transaction"},{"label":"Regenerate billing transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/regenerate/post_regeneratebillingtransaction","routeSlug":"/v1-api-reference/api/regenerate/post_regeneratebillingtransaction","metadata":{"seo":{"title":"Regenerate billing transactions","description":"Use this operation to generate billing transactions. This call is useful in the following two use cases:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_RegenerateBillingTransaction","name":"Regenerate billing transactions","isWebhook":false,"pointer":"/paths/~1v1~1uno-regenerate~1billing-transaction/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate billing transactions","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":"Use this operation to generate billing transactions. This call is useful in the following two use cases:"},"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":"During customer onboarding, there is a common scenario when customers perform data backfill or data fixes. To synchronize these changes from Billing to Revenue, use this API operation to regenerate billing transaction objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers choose to experiment with their use cases in the Sandbox environment before implementing them in the Production environment. During this experimentation phase, customers not only interact with data but also use this API operation to regenerate transaction objects."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"onlyReSend","in":"query","schemaId":"schema_27","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":"onlyReSend"},"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":", existing billing transaction records are not overwritten; they are resent with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regenerate_flag = Y"},"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":"onlyReSend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", behaviour depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> recalculate, overwrite, send"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regenerate_flag = Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate = false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> do not overwrite, and may resend existing records with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regenerate_flag = N"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyReSend"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"'"},"children":[]}]}]}]},{"name":"reMigrate","in":"query","schemaId":"schema_27","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":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", existing billing transaction records are not overwritten. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyReSend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", existing records may still be resent to Zuora Revenue with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regenerate_flag = N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are not recalculated from updated source documents."},"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":"reMigrate"},"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":", records are recalculated from source, overwritten in the database, and sent with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regenerate_flag = Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (unless exclusion flags prevent the send)."},"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":" If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyReSend"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"'"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyReSend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter names are case-sensitive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values must be "},"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":", not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"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":"Unrecognized names are ignored, and defaults are used. The API may still return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"code","inline":true,"attributes":{"content":"reMigrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyReSend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot both be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1uno-regenerate~1billing-transaction/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno-regenerate~1billing-transaction/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegenerateBillingRequest"}},"schemaId":"components/schemas/RegenerateBillingRequest","pointer":"/paths/~1v1~1uno-regenerate~1billing-transaction/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/uno-regenerate/billing-transaction","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"onlyReSend","in":"query","required":false,"schemaId":"schema_27"},{"name":"reMigrate","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RegenerateBillingRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/uno-regenerate/billing-transaction","href":"regenerate/post_regeneratebillingtransaction","openApiOperationId":"POST_RegenerateBillingTransaction","summary":"Regenerate billing transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/RegenerateBillingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegenerateBillingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegenerateTransactionObjectResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RegenerateTransactionObjectResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno-regenerate~1billing-transaction/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegenerateTransactionObjectResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegenerateTransactionObjectResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regenerate/post_regeneratebillingtransaction"}],"panels":[]}]},"httpPath":"/v1/uno-regenerate/billing-transaction"},{"label":"Regenerate revenue recognition events transactions for Delivery Schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/regenerate/post_createrevrecevents","routeSlug":"/v1-api-reference/api/regenerate/post_createrevrecevents","metadata":{"seo":{"title":"Regenerate revenue recognition events transactions for Delivery Schedule","description":"Use this operation to generate Delivery Schedule based revenue recognition events transactions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateRevRecEvents","name":"Regenerate revenue recognition events transactions for Delivery Schedule","isWebhook":false,"pointer":"/paths/~1v1~1uno-regenerate~1rev-rec-events/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate revenue recognition events transactions for Delivery Schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this operation to generate Delivery Schedule based revenue recognition events transactions.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subscriptionNumber","in":"query","schemaId":"schema_5","description":"The subcription number.\n"},{"name":"mode","in":"query","schemaId":"schema_377","description":"The generation mode."},{"name":"forRevenueRecollect","in":"query","schemaId":"schema_27","description":"Indicates whether the data regenerated is for Zuora Revenue to recollect."}],"pointer":"/paths/~1v1~1uno-regenerate~1rev-rec-events/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno-regenerate~1rev-rec-events/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/uno-regenerate/rev-rec-events","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"subscriptionNumber","in":"query","schemaId":"schema_5"},{"name":"mode","in":"query","schemaId":"schema_377"},{"name":"forRevenueRecollect","in":"query","schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/uno-regenerate/rev-rec-events","href":"regenerate/post_createrevrecevents","openApiOperationId":"POST_CreateRevRecEvents","summary":"Regenerate revenue recognition events transactions for Delivery Schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegenerateRevRecEventsResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RegenerateRevRecEventsResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegenerateRevRecEventsResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegenerateRevRecEventsResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regenerate/post_createrevrecevents"}],"panels":[]}]},"httpPath":"/v1/uno-regenerate/rev-rec-events"},{"label":"Regenerate revenue recognition events transactions for Daily Consumption","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/regenerate/post_generaterevreceventsfordailyconsumption","routeSlug":"/v1-api-reference/api/regenerate/post_generaterevreceventsfordailyconsumption","metadata":{"seo":{"title":"Regenerate revenue recognition events transactions for Daily Consumption","description":"Use this operation to generate Daily Consumption based revenue recognition events transactions when the Prepaid with Drawdown feature is enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_GenerateRevRecEventsForDailyConsumption","name":"Regenerate revenue recognition events transactions for Daily Consumption","isWebhook":false,"pointer":"/paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate revenue recognition events transactions for Daily Consumption","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":"Use this operation to generate Daily Consumption based revenue recognition events transactions when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"forRevenueRecollect","in":"query","schemaId":"schema_27","description":"Indicates whether the data regenerated is for Zuora Revenue to recollect."}],"pointer":"/paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DailyConsumptionRevRecRequest"}},"schemaId":"components/schemas/DailyConsumptionRevRecRequest","pointer":"/paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/uno-regenerate/rev-rec-events/daily-consumption","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"forRevenueRecollect","in":"query","schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DailyConsumptionRevRecRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/uno-regenerate/rev-rec-events/daily-consumption","href":"regenerate/post_generaterevreceventsfordailyconsumption","openApiOperationId":"POST_GenerateRevRecEventsForDailyConsumption","summary":"Regenerate revenue recognition events transactions for Daily Consumption"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/DailyConsumptionRevRecRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DailyConsumptionRevRecRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegenerateRevRecEventsResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RegenerateRevRecEventsResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegenerateRevRecEventsResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegenerateRevRecEventsResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regenerate/post_generaterevreceventsfordailyconsumption"}],"panels":[]}]},"httpPath":"/v1/uno-regenerate/rev-rec-events/daily-consumption"}],"content":{"contentType":"group","meta":{"name":"Regenerate"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate","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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user, you can use the Regenerate operations to regenerate transactions objects."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/uno-regenerate/booking-transaction","summary":"Regenerate booking transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/regenerate/post_regeneratebookingtransaction","deprecated":false},{"title":"/v1/uno-regenerate/billing-transaction","summary":"Regenerate billing transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/regenerate/post_regeneratebillingtransaction","deprecated":false},{"title":"/v1/uno-regenerate/rev-rec-events","summary":"Regenerate revenue recognition events transactions for Delivery Schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/regenerate/post_createrevrecevents","deprecated":false},{"title":"/v1/uno-regenerate/rev-rec-events/daily-consumption","summary":"Regenerate revenue recognition events transactions for Daily Consumption","prefix":{"name":"post","color":"post"},"badges":[],"link":"/regenerate/post_generaterevreceventsfordailyconsumption","deprecated":false}]}]}]}]}},{"type":"separator","label":"Test Environments","content":null},{"type":"group","label":"Test Environments","link":"/v1-api-reference/api/test-environments","routeSlug":"/v1-api-reference/api/test-environments","items":[{"label":"List all test environments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environments/getalltestenvironments","routeSlug":"/v1-api-reference/api/test-environments/getalltestenvironments","metadata":{"seo":{"title":"List all test environments","description":"Use this operation to retrieves a list of all Test Environments.It returns an ArrayResponse containing TestEnvironmentResponse objects,representing the available Test Environments in the system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllTestEnvironments","name":"List all test environments","isWebhook":false,"pointer":"/paths/~1test-environments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all test environments","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":"Use this operation to retrieves a list of all Test Environments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns an ArrayResponse containing TestEnvironmentResponse objects,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"representing the available Test Environments in the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environments/getalltestenvironments/request/user-access-permission","deepLinkHash":"/test-environments/getalltestenvironments#test-environments/getalltestenvironments/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/test-environments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/test-environments","href":"test-environments/getalltestenvironments","openApiOperationId":"getAllTestEnvironments","summary":"List all test environments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved a list of Test Environment responses","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentArrayResponse"}},"schemaId":"components/schemas/TestEnvironmentArrayResponse"},{"code":"400","description":"Bad request"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestEnvironmentArrayResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentArrayResponse"}}},{"code":"400"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environments/getalltestenvironments"}],"panels":[]}]},"httpPath":"/test-environments"},{"label":"Retrieve a test environment response","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environments/gettestenvironment","routeSlug":"/v1-api-reference/api/test-environments/gettestenvironment","metadata":{"seo":{"title":"Retrieve a test environment response","description":"Use this operation to retrieves a specific Test Environment by its unique identifier.It returns a TestEnvironmentResponse object if the environment is found. If the specifiedTest Environment does not exist, it returns a 404 error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTestEnvironment","name":"Retrieve a test environment response","isWebhook":false,"pointer":"/paths/~1test-environments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a test environment response","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":"Use this operation to retrieves a specific Test Environment by its unique identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a TestEnvironmentResponse object if the environment is found. If the specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test Environment does not exist, it returns a 404 error."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environments/gettestenvironment/request/user-access-permission","deepLinkHash":"/test-environments/gettestenvironment#test-environments/gettestenvironment/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Test Environment ID","required":true}],"pointer":"/paths/~1test-environments~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/test-environments/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/test-environments/{id}","href":"test-environments/gettestenvironment","openApiOperationId":"getTestEnvironment","summary":"Retrieve a test environment response"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved Test Environment response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentResponse"}},"schemaId":"components/schemas/TestEnvironmentResponse"},{"code":"404","description":"The resource you were trying to reach is not found"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestEnvironmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentResponse"}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environments/gettestenvironment"}],"panels":[]}]},"httpPath":"/test-environments/{id}"}],"content":{"contentType":"group","meta":{"name":"Test Environments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test Environments","showPageActions":true},{"nodeType":"markdoc","content":"A Test Environment is a dedicated sandbox tenant designed for development, integration, and user acceptance testing of your system configurations and business processes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/test-environments","summary":"List all test environments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/test-environments/getalltestenvironments","deprecated":false},{"title":"/test-environments/{id}","summary":"Retrieve a test environment response","prefix":{"name":"get","color":"get"},"badges":[],"link":"/test-environments/gettestenvironment","deprecated":false}]}]}]}]}},{"type":"group","label":"Test Environment Jobs","link":"/v1-api-reference/api/test-environment-jobs","routeSlug":"/v1-api-reference/api/test-environment-jobs","items":[{"label":"Create a test environment job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-jobs/createtestenvironmentjob","routeSlug":"/v1-api-reference/api/test-environment-jobs/createtestenvironmentjob","metadata":{"seo":{"title":"Create a test environment job","description":"Use this operation to create a new job for a specific Test Environment.It handles HTTP POST requests to the /test-environments/{id}/jobs endpoint,accepting a JobRequest object in the request body. Upon successful creation,it returns a JobResponse object and sets the Location header to the pollingURL for the created job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTestEnvironmentJob","name":"Create a test environment job","isWebhook":false,"pointer":"/paths/~1test-environments~1{id}~1jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a test environment job","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":"Use this operation to create a new job for a specific Test Environment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It handles HTTP POST requests to the /test-environments/{id}/jobs endpoint,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepting a JobRequest object in the request body. Upon successful creation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it returns a JobResponse object and sets the Location header to the polling"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for the created job."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environment-jobs/createtestenvironmentjob/request/user-access-permission","deepLinkHash":"/test-environment-jobs/createtestenvironmentjob#test-environment-jobs/createtestenvironmentjob/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Test Environment ID","required":true}],"pointer":"/paths/~1test-environments~1{id}~1jobs/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments~1{id}~1jobs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobRequest"}},"schemaId":"components/schemas/JobRequest","pointer":"/paths/~1test-environments~1{id}~1jobs/post/requestBody","description":"jobRequest"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/test-environments/{id}/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JobRequest"}},"responseCodes":["200","201","400","403","500"],"pointer":"/test-environments/{id}/jobs","href":"test-environment-jobs/createtestenvironmentjob","openApiOperationId":"createTestEnvironmentJob","summary":"Create a test environment job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/JobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"201","description":"Successfully created a new Test Environment job","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"403","description":"Only one refresh can be performed during a set period"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments~1{id}~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"201","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"400","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environment-jobs/createtestenvironmentjob"}],"panels":[]}]},"httpPath":"/test-environments/{id}/jobs"},{"label":"List all jobs of a test environment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-jobs/getalljobsoftestenvironment","routeSlug":"/v1-api-reference/api/test-environment-jobs/getalljobsoftestenvironment","metadata":{"seo":{"title":"List all jobs of a test environment","description":"Use this operation to retrieve a list of job responses associatedwith a specific Test Environment. It handles HTTP GET requests tothe /test-environments/{id}/jobs endpoint and returns an ArrayResponsecontaining JobResponse objects. This method is documented in Swagger,including possible responses for successful retrieval and bad requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllJobsOfTestEnvironment","name":"List all jobs of a test environment","isWebhook":false,"pointer":"/paths/~1test-environments~1{id}~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all jobs of a test environment","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":"Use this operation to retrieve a list of job responses associated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a specific Test Environment. It handles HTTP GET requests to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the /test-environments/{id}/jobs endpoint and returns an ArrayResponse"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"containing JobResponse objects. This method is documented in Swagger,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"including possible responses for successful retrieval and bad requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environment-jobs/getalljobsoftestenvironment/request/user-access-permission","deepLinkHash":"/test-environment-jobs/getalljobsoftestenvironment#test-environment-jobs/getalljobsoftestenvironment/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Test Environment ID","required":true}],"pointer":"/paths/~1test-environments~1{id}~1jobs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments~1{id}~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/test-environments/{id}/jobs","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/test-environments/{id}/jobs","href":"test-environment-jobs/getalljobsoftestenvironment","openApiOperationId":"getAllJobsOfTestEnvironment","summary":"List all jobs of a test environment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved a list of Test Environment job responses","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobArrayResponse"}},"schemaId":"components/schemas/JobArrayResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments~1{id}~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobArrayResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobArrayResponse"}}},{"code":"400","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environment-jobs/getalljobsoftestenvironment"}],"panels":[]}]},"httpPath":"/test-environments/{id}/jobs"},{"label":"Retrieve a job of a test environment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-jobs/getjoboftestenvironment","routeSlug":"/v1-api-reference/api/test-environment-jobs/getjoboftestenvironment","metadata":{"seo":{"title":"Retrieve a job of a test environment","description":"Use this operation to retrieve a specific job associatedwith a Test Environment by its unique job ID. It handlesHTTP GET requests to the /test-environments/{id}/jobs/{jobId}endpoint and returns a JobResponse object if the job is found.If the specified job does not exist, it returns a 404 error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJobOfTestEnvironment","name":"Retrieve a job of a test environment","isWebhook":false,"pointer":"/paths/~1test-environments~1{id}~1jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a job of a test environment","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":"Use this operation to retrieve a specific job associated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a Test Environment by its unique job ID. It handles"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP GET requests to the /test-environments/{id}/jobs/{jobId}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint and returns a JobResponse object if the job is found."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the specified job does not exist, it returns a 404 error."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environment-jobs/getjoboftestenvironment/request/user-access-permission","deepLinkHash":"/test-environment-jobs/getjoboftestenvironment#test-environment-jobs/getjoboftestenvironment/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Test Environment ID","required":true},{"name":"jobId","in":"path","schemaId":"schema_5","description":"Test Environment Job ID","required":true}],"pointer":"/paths/~1test-environments~1{id}~1jobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments~1{id}~1jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/test-environments/{id}/jobs/{jobId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"},{"name":"jobId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/test-environments/{id}/jobs/{jobId}","href":"test-environment-jobs/getjoboftestenvironment","openApiOperationId":"getJobOfTestEnvironment","summary":"Retrieve a job of a test environment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved a Test Environment job response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"404","description":"The resource you were trying to reach was not found"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments~1{id}~1jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environment-jobs/getjoboftestenvironment"}],"panels":[]}]},"httpPath":"/test-environments/{id}/jobs/{jobId}"},{"label":"Perform an action on a test environment job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-jobs/performactionofjob","routeSlug":"/v1-api-reference/api/test-environment-jobs/performactionofjob","metadata":{"seo":{"title":"Perform an action on a test environment job","description":"Use this operation to perform a specified actionon a Test Environment job. It handles HTTP POSTrequests to the /test-environments/{id}/jobs/{jobId}/actionsendpoint, accepting a JobActionRequest object in therequest body. Upon successful execution, it returns aJobResponse object reflecting the updated job state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"performActionOfJob","name":"Perform an action on a test environment job","isWebhook":false,"pointer":"/paths/~1test-environments~1{id}~1jobs~1{jobId}~1actions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Perform an action on a test environment job","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":"Use this operation to perform a specified action"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on a Test Environment job. It handles HTTP POST"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests to the /test-environments/{id}/jobs/{jobId}/actions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint, accepting a JobActionRequest object in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request body. Upon successful execution, it returns a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JobResponse object reflecting the updated job state."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environment-jobs/performactionofjob/request/user-access-permission","deepLinkHash":"/test-environment-jobs/performactionofjob#test-environment-jobs/performactionofjob/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Test Environment ID","required":true},{"name":"jobId","in":"path","schemaId":"schema_5","description":"Test Environment Job ID","required":true}],"pointer":"/paths/~1test-environments~1{id}~1jobs~1{jobId}~1actions/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments~1{id}~1jobs~1{jobId}~1actions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobActionRequest"}},"schemaId":"components/schemas/JobActionRequest","pointer":"/paths/~1test-environments~1{id}~1jobs~1{jobId}~1actions/post/requestBody","description":"jobActionRequest"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/test-environments/{id}/jobs/{jobId}/actions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"},{"name":"jobId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JobActionRequest"}},"responseCodes":["200","400","404","500"],"pointer":"/test-environments/{id}/jobs/{jobId}/actions","href":"test-environment-jobs/performactionofjob","openApiOperationId":"performActionOfJob","summary":"Perform an action on a test environment job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/JobActionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobActionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully submitted Test Environment job action","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}},"schemaId":"components/schemas/JobResponse"},{"code":"400","description":"Bad request"},{"code":"404","description":"The resource you were trying to reach is not found"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments~1{id}~1jobs~1{jobId}~1actions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobResponse"}}},{"code":"400"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environment-jobs/performactionofjob"}],"panels":[]}]},"httpPath":"/test-environments/{id}/jobs/{jobId}/actions"}],"content":{"contentType":"group","meta":{"name":"Test Environment Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test Environment Jobs","showPageActions":true},{"nodeType":"markdoc","content":"A Test Environment Job represents an asynchronous operation initiated to refresh a Test Environment. These jobs track the status and progress of environment provisioning and refresh."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/test-environments/{id}/jobs","summary":"Create a test environment job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/test-environment-jobs/createtestenvironmentjob","deprecated":false},{"title":"/test-environments/{id}/jobs","summary":"List all jobs of a test environment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/test-environment-jobs/getalljobsoftestenvironment","deprecated":false},{"title":"/test-environments/{id}/jobs/{jobId}","summary":"Retrieve a job of a test environment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/test-environment-jobs/getjoboftestenvironment","deprecated":false},{"title":"/test-environments/{id}/jobs/{jobId}/actions","summary":"Perform an action on a test environment job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/test-environment-jobs/performactionofjob","deprecated":false}]}]}]}]}},{"type":"group","label":"Test Environment Notifications","link":"/v1-api-reference/api/test-environment-notifications","routeSlug":"/v1-api-reference/api/test-environment-notifications","items":[{"label":"Create a test environment notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-notifications/createtestenvironmentnotification","routeSlug":"/v1-api-reference/api/test-environment-notifications/createtestenvironmentnotification","metadata":{"seo":{"title":"Create a test environment notification","description":"Use this operation to create a new notificationfor a specific Test Environment. It handles HTTPPOST requests to the /test-environments/{id}/notificationsendpoint, accepting a TestEnvironmentNotificationRequestobject in the request body. Upon successful creation,it returns a TestEnvironmentNotificationResponse objectand sets the Location header to the URL of the creatednotification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTestEnvironmentNotification","name":"Create a test environment notification","isWebhook":false,"pointer":"/paths/~1test-environments~1{id}~1notifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a test environment notification","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":"Use this operation to create a new notification"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for a specific Test Environment. It handles HTTP"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST requests to the /test-environments/{id}/notifications"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint, accepting a TestEnvironmentNotificationRequest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object in the request body. Upon successful creation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it returns a TestEnvironmentNotificationResponse object"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and sets the Location header to the URL of the created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notification."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environment-notifications/createtestenvironmentnotification/request/user-access-permission","deepLinkHash":"/test-environment-notifications/createtestenvironmentnotification#test-environment-notifications/createtestenvironmentnotification/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Test Environment ID","required":true}],"pointer":"/paths/~1test-environments~1{id}~1notifications/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments~1{id}~1notifications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationRequest"}},"schemaId":"components/schemas/TestEnvironmentNotificationRequest","pointer":"/paths/~1test-environments~1{id}~1notifications/post/requestBody","description":"notificationRequest"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/test-environments/{id}/notifications","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationRequest"}},"responseCodes":["200","201","400","500"],"pointer":"/test-environments/{id}/notifications","href":"test-environment-notifications/createtestenvironmentnotification","openApiOperationId":"createTestEnvironmentNotification","summary":"Create a test environment notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/TestEnvironmentNotificationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationResponse"}},"schemaId":"components/schemas/TestEnvironmentNotificationResponse"},{"code":"201","description":"Successfully created a new Test Environment notification","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationResponse"}},"schemaId":"components/schemas/TestEnvironmentNotificationResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments~1{id}~1notifications/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestEnvironmentNotificationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationResponse"}}},{"code":"201","schemaId":"components/schemas/TestEnvironmentNotificationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationResponse"}}},{"code":"400","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environment-notifications/createtestenvironmentnotification"}],"panels":[]}]},"httpPath":"/test-environments/{id}/notifications"},{"label":"List all email notifications of a test environment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-notifications/getallemailnotificationoftestenv","routeSlug":"/v1-api-reference/api/test-environment-notifications/getallemailnotificationoftestenv","metadata":{"seo":{"title":"List all email notifications of a test environment","description":"Use this operation to retrieve all notifications associatedwith a specific Test Environment. It handles HTTP GETrequests to the /test-environments/{id}/notificationsendpoint and returns an ArrayResponse containingTestEnvironmentNotificationResponse objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllEmailNotificationOfTestEnv","name":"List all email notifications of a test environment","isWebhook":false,"pointer":"/paths/~1test-environments~1{id}~1notifications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all email notifications of a test environment","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":"Use this operation to retrieve all notifications associated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a specific Test Environment. It handles HTTP GET"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests to the /test-environments/{id}/notifications"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint and returns an ArrayResponse containing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TestEnvironmentNotificationResponse objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environment-notifications/getallemailnotificationoftestenv/request/user-access-permission","deepLinkHash":"/test-environment-notifications/getallemailnotificationoftestenv#test-environment-notifications/getallemailnotificationoftestenv/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Test Environment ID","required":true}],"pointer":"/paths/~1test-environments~1{id}~1notifications/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments~1{id}~1notifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/test-environments/{id}/notifications","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/test-environments/{id}/notifications","href":"test-environment-notifications/getallemailnotificationoftestenv","openApiOperationId":"getAllEmailNotificationOfTestEnv","summary":"List all email notifications of a test environment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched all notifications","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationArrayResponse"}},"schemaId":"components/schemas/TestEnvironmentNotificationArrayResponse"},{"code":"404","description":"The resource you were trying to reach was not found"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments~1{id}~1notifications/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestEnvironmentNotificationArrayResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationArrayResponse"}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environment-notifications/getallemailnotificationoftestenv"}],"panels":[]}]},"httpPath":"/test-environments/{id}/notifications"},{"label":"Retrieve a notification response of a test environment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-notifications/gettestenvironmentnotification","routeSlug":"/v1-api-reference/api/test-environment-notifications/gettestenvironmentnotification","metadata":{"seo":{"title":"Retrieve a notification response of a test environment","description":"Use this operation to retrieve a specific notification associatedwith a Test Environment by its unique notification ID. It handlesHTTP GET requests to the /test-environments/{id}/notifications/{notificationId}endpoint and returns a TestEnvironmentNotificationResponse objectif the notification is found. If the specified notification doesnot exist, it returns a 404 error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTestEnvironmentNotification","name":"Retrieve a notification response of a test environment","isWebhook":false,"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a notification response of a test environment","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":"Use this operation to retrieve a specific notification associated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a Test Environment by its unique notification ID. It handles"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP GET requests to the /test-environments/{id}/notifications/{notificationId}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint and returns a TestEnvironmentNotificationResponse object"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if the notification is found. If the specified notification does"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not exist, it returns a 404 error."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environment-notifications/gettestenvironmentnotification/request/user-access-permission","deepLinkHash":"/test-environment-notifications/gettestenvironmentnotification#test-environment-notifications/gettestenvironmentnotification/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Test Environment ID","required":true},{"name":"notificationId","in":"path","schemaId":"schema_5","description":"Test Environment Notification ID","required":true}],"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/test-environments/{id}/notifications/{notificationId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"},{"name":"notificationId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/test-environments/{id}/notifications/{notificationId}","href":"test-environment-notifications/gettestenvironmentnotification","openApiOperationId":"getTestEnvironmentNotification","summary":"Retrieve a notification response of a test environment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved a Test Environment notification response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationResponse"}},"schemaId":"components/schemas/TestEnvironmentNotificationResponse"},{"code":"404","description":"The resource you were trying to reach was not found"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestEnvironmentNotificationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationResponse"}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environment-notifications/gettestenvironmentnotification"}],"panels":[]}]},"httpPath":"/test-environments/{id}/notifications/{notificationId}"},{"label":"Update a test environment notification","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-notifications/updatetestenvironmentnotification","routeSlug":"/v1-api-reference/api/test-environment-notifications/updatetestenvironmentnotification","metadata":{"seo":{"title":"Update a test environment notification","description":"Use this operation to update an existing notificationfor a specific Test Environment. It handles HTTP PATCHrequests to the /test-environments/{id}/notifications/{notificationId}endpoint, accepting a TestEnvironmentNotificationRequestobject in the request body. Upon successful update, itreturns a TestEnvironmentNotificationResponse object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTestEnvironmentNotification","name":"Update a test environment notification","isWebhook":false,"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a test environment notification","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":"Use this operation to update an existing notification"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for a specific Test Environment. It handles HTTP PATCH"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests to the /test-environments/{id}/notifications/{notificationId}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint, accepting a TestEnvironmentNotificationRequest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object in the request body. Upon successful update, it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns a TestEnvironmentNotificationResponse object."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environment-notifications/updatetestenvironmentnotification/request/user-access-permission","deepLinkHash":"/test-environment-notifications/updatetestenvironmentnotification#test-environment-notifications/updatetestenvironmentnotification/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Test Environment ID","required":true},{"name":"notificationId","in":"path","schemaId":"schema_5","description":"Test Environment Notification ID","required":true}],"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationRequest"}},"schemaId":"components/schemas/TestEnvironmentNotificationRequest","pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/patch/requestBody","description":"notificationRequest"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/test-environments/{id}/notifications/{notificationId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"},{"name":"notificationId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationRequest"}},"responseCodes":["200","400","500"],"pointer":"/test-environments/{id}/notifications/{notificationId}","href":"test-environment-notifications/updatetestenvironmentnotification","openApiOperationId":"updateTestEnvironmentNotification","summary":"Update a test environment notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/TestEnvironmentNotificationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated a Test Environment notification","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationResponse"}},"schemaId":"components/schemas/TestEnvironmentNotificationResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestEnvironmentNotificationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationResponse"}}},{"code":"400","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environment-notifications/updatetestenvironmentnotification"}],"panels":[]}]},"httpPath":"/test-environments/{id}/notifications/{notificationId}"},{"label":"Delete a notification of a test environment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/test-environment-notifications/deletetestenvironmentnotification","routeSlug":"/v1-api-reference/api/test-environment-notifications/deletetestenvironmentnotification","metadata":{"seo":{"title":"Delete a notification of a test environment","description":"Use this operation to delete a specific notification associatedwith a Test Environment. It handles HTTP DELETE requests to the/test-environments/{id}/notifications/{notificationId} endpointand returns a TestEnvironmentNotificationResponse object for thedeleted notification. If the specified notification does not exist,it returns a 404 error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTestEnvironmentNotification","name":"Delete a notification of a test environment","isWebhook":false,"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a notification of a test environment","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":"Use this operation to delete a specific notification associated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a Test Environment. It handles HTTP DELETE requests to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/test-environments/{id}/notifications/{notificationId} endpoint"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and returns a TestEnvironmentNotificationResponse object for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted notification. If the specified notification does not exist,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it returns a 404 error."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"test-environment-notifications/deletetestenvironmentnotification/request/user-access-permission","deepLinkHash":"/test-environment-notifications/deletetestenvironmentnotification#test-environment-notifications/deletetestenvironmentnotification/request/user-access-permission"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must be assigned the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh Central Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to run this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Test Environment ID","required":true},{"name":"notificationId","in":"path","schemaId":"schema_5","description":"Test Environment Notification ID","required":true}],"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]}],"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/test-environments/{id}/notifications/{notificationId}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"},{"name":"notificationId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/test-environments/{id}/notifications/{notificationId}","href":"test-environment-notifications/deletetestenvironmentnotification","openApiOperationId":"deleteTestEnvironmentNotification","summary":"Delete a notification of a test environment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted a notification","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationResponse"}},"schemaId":"components/schemas/TestEnvironmentNotificationResponse"},{"code":"404","description":"The resource you were trying to reach is not found"},{"code":"500","description":"Internal Error"}],"pointer":"/paths/~1test-environments~1{id}~1notifications~1{notificationId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestEnvironmentNotificationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestEnvironmentNotificationResponse"}}},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/test-environment-notifications/deletetestenvironmentnotification"}],"panels":[]}]},"httpPath":"/test-environments/{id}/notifications/{notificationId}"}],"content":{"contentType":"group","meta":{"name":"Test Environment Notifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test Environment Notifications","showPageActions":true},{"nodeType":"markdoc","content":"A Test Environment Notification is an automated email dispatched to inform stakeholders when a Test Environment Job is completed or cancelled."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/test-environments/{id}/notifications","summary":"Create a test environment notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/test-environment-notifications/createtestenvironmentnotification","deprecated":false},{"title":"/test-environments/{id}/notifications","summary":"List all email notifications of a test environment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/test-environment-notifications/getallemailnotificationoftestenv","deprecated":false},{"title":"/test-environments/{id}/notifications/{notificationId}","summary":"Retrieve a notification response of a test environment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/test-environment-notifications/gettestenvironmentnotification","deprecated":false},{"title":"/test-environments/{id}/notifications/{notificationId}","summary":"Update a test environment notification","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/test-environment-notifications/updatetestenvironmentnotification","deprecated":false},{"title":"/test-environments/{id}/notifications/{notificationId}","summary":"Delete a notification of a test environment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/test-environment-notifications/deletetestenvironmentnotification","deprecated":false}]}]}]}]}},{"type":"separator","label":"General-Purpose Operations","content":null},{"type":"group","label":"Actions","link":"/v1-api-reference/api/actions","routeSlug":"/v1-api-reference/api/actions","items":[{"label":"Create","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/actions/action_postcreate","routeSlug":"/v1-api-reference/api/actions/action_postcreate","metadata":{"seo":{"title":"Create","description":"Use the create call to create one or more objects of a specific type. You can specify different types in different create calls, but each create call must apply to only one type of object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Action_POSTcreate","name":"Create","isWebhook":false,"pointer":"/paths/~1v1~1action~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create","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":"Use the create call to create one or more objects of a specific type. You can specify different types in different create calls, but each create call must apply to only one type of object."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"actions/action_postcreate/request/limitations","deepLinkHash":"/actions/action_postcreate#actions/action_postcreate/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call has the following limitations:"},"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":"A maximum of 50 objects are supported in a single call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Orders feature is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default WSDL version for Actions is 79. To create objects according to a different WSDL version, set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. To find out in which WSDL version a particular object or field was introduced, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-soap-api-version-history"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora SOAP API Version History"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"actions/action_postcreate/request/how-to-use-this-call","deepLinkHash":"/actions/action_postcreate#actions/action_postcreate/request/how-to-use-this-call"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to use this call"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create on an array of one or more zObjects. The fields you should specify can be found in the corresponding \"CRUD: Create an "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zObject"},"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 example, to create one or multiple accounts, use the request fields in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/older-api/operation/Object_POSTAccount/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRUD: Create an account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns an array of SaveResults sorted in the same order, indicating the success or failure of creating each object. The following information applies to this call:"},"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":"You cannot pass in null zObjects."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can pass in a maximum of 50 zObjects at a time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All objects must be of the same type."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"actions/action_postcreate/request/using-create-and-subscribe-calls","deepLinkHash":"/actions/action_postcreate#actions/action_postcreate/request/using-create-and-subscribe-calls"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using Create and Subscribe Calls"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both the Create and Subscribe calls will create a new account. However, there are differences between the calls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the create call to create an account independent of a subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the subscribe call to create the account with the subscription and the initial payment information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1action~1create/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1action~1create/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyActioncreateRequest"}},"schemaId":"components/schemas/ProxyActioncreateRequest","pointer":"/paths/~1v1~1action~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/action/create","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyActioncreateRequest"}},"responseCodes":["200","401"],"pointer":"/v1/action/create","href":"actions/action_postcreate","openApiOperationId":"Action_POSTcreate","summary":"Create"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyActioncreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyActioncreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378","exampleIds":["paths/~1v1~1action~1create/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_378","exampleIds":["paths/~1v1~1action~1create/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1create/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1create/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1action~1create/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_378","exampleIds":["paths/~1v1~1action~1create/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378","exampleIds":["paths/~1v1~1action~1create/post/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1create/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1create/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/action_postcreate"}],"panels":[]}]},"httpPath":"/v1/action/create"},{"label":"Delete","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/actions/action_postdelete","routeSlug":"/v1-api-reference/api/actions/action_postdelete","metadata":{"seo":{"title":"Delete","description":"Deletes one or more objects of the same type. You can specify different types in different delete calls, but each delete call must apply only to one type of object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Action_POSTdelete","name":"Delete","isWebhook":false,"pointer":"/paths/~1v1~1action~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete","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 one or more objects of the same type. You can specify different types in different delete calls, but each delete call must apply only to one type of object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following information applies to this call:"},"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":"You will need to first determine the IDs for the objects you wish to delete."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot pass in any null IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All objects in a specific delete call must be of the same type."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"actions/action_postdelete/request/objects-per-call","deepLinkHash":"/actions/action_postdelete#actions/action_postdelete/request/objects-per-call"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Objects per Call"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"50 objects are supported in a single call."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1action~1delete/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1action~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyActiondeleteRequest"}},"schemaId":"components/schemas/ProxyActiondeleteRequest","pointer":"/paths/~1v1~1action~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/action/delete","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyActiondeleteRequest"}},"responseCodes":["200","401"],"pointer":"/v1/action/delete","href":"actions/action_postdelete","openApiOperationId":"Action_POSTdelete","summary":"Delete"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyActiondeleteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyActiondeleteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379","exampleIds":["paths/~1v1~1action~1delete/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_379","exampleIds":["paths/~1v1~1action~1delete/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1delete/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1delete/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1action~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_379","exampleIds":["paths/~1v1~1action~1delete/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379","exampleIds":["paths/~1v1~1action~1delete/post/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1delete/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1delete/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/action_postdelete"}],"panels":[]}]},"httpPath":"/v1/action/delete"},{"label":"Query","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/actions/action_postquery","routeSlug":"/v1-api-reference/api/actions/action_postquery","metadata":{"seo":{"title":"Query","description":"The query call sends a query expression by specifying the object to query, the fields to retrieve from that object, and any filters to determine whether a given object should be queried."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Action_POSTquery","name":"Query","isWebhook":false,"pointer":"/paths/~1v1~1action~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query","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":"The query call sends a query expression by specifying the object to query, the fields to retrieve from that object, and any filters to determine whether a given object should be queried."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-zoql"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Object Query Language"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(ZOQL) to construct those queries, passing them through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryString"},"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":"Once the call is made, the API executes the query against the specified object and returns a query response object to your application. Your application can then iterate through rows in the query response to retrieve information."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"actions/action_postquery/request/limitations","deepLinkHash":"/actions/action_postquery#actions/action_postquery/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call has the following limitations:"},"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":"All "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-zoql"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZOQL limitations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All ZOQL keywords must be in lower case."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of records returned is limited to 2000 records."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Orders feature is not supported, which means that the objects listed in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-object-model"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Object Model"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Active Rating feature is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default WSDL version for Actions is 79. To query objects or fields according to a different WSDL version, set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. To find out in which WSDL version a particular object or field was introduced, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-soap-api-version-history"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora SOAP API Version History"},"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":"Fields with NULL values are not returned in the response."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1action~1query/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1action~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyActionqueryRequest"}},"schemaId":"components/schemas/ProxyActionqueryRequest","pointer":"/paths/~1v1~1action~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/action/query","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyActionqueryRequest"}},"responseCodes":["200","401"],"pointer":"/v1/action/query","href":"actions/action_postquery","openApiOperationId":"Action_POSTquery","summary":"Query"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyActionqueryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyActionqueryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyActionqueryResponse","exampleIds":["paths/~1v1~1action~1query/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyActionqueryResponse","exampleIds":["paths/~1v1~1action~1query/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1query/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1query/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1action~1query/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyActionqueryResponse","exampleIds":["paths/~1v1~1action~1query/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyActionqueryResponse","exampleIds":["paths/~1v1~1action~1query/post/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1query/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1query/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/action_postquery"}],"panels":[]}]},"httpPath":"/v1/action/query"},{"label":"QueryMore","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/actions/action_postquerymore","routeSlug":"/v1-api-reference/api/actions/action_postquerymore","metadata":{"seo":{"title":"QueryMore","description":"Use queryMore to request additional results from a previous query call. If your initial query call returns more than 2000 results, you can use queryMore to query for the additional results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Action_POSTqueryMore","name":"QueryMore","isWebhook":false,"pointer":"/paths/~1v1~1action~1queryMore/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"QueryMore","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":"Use queryMore to request additional results from a previous query call. If your initial query call returns more than 2000 results, you can use queryMore to query for the additional results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryLocator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results greater than 2,000, will only be stored by Zuora for 5 days before it is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call sends a request for additional results from an initial query call. If the initial query call returns more than 2000 results, you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryLocator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned from query to request the next set of results."},"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":" Zuora expires queryMore cursors after 15 minutes of activity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use queryMore, you first construct a query call. By default, the query call will return up to 2000 results. If there are more than 2000 results, query will return a boolean "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"done"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which will be marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryLocator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is a marker you will pass to queryMore to get the next set of results."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1action~1queryMore/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1action~1queryMore/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyActionqueryMoreRequest"}},"schemaId":"components/schemas/ProxyActionqueryMoreRequest","pointer":"/paths/~1v1~1action~1queryMore/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/action/queryMore","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyActionqueryMoreRequest"}},"responseCodes":["200","401"],"pointer":"/v1/action/queryMore","href":"actions/action_postquerymore","openApiOperationId":"Action_POSTqueryMore","summary":"QueryMore"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyActionqueryMoreRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyActionqueryMoreRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyActionqueryMoreResponse","exampleIds":["paths/~1v1~1action~1queryMore/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyActionqueryMoreResponse","exampleIds":["paths/~1v1~1action~1queryMore/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1queryMore/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1queryMore/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1action~1queryMore/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyActionqueryMoreResponse","exampleIds":["paths/~1v1~1action~1queryMore/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyActionqueryMoreResponse","exampleIds":["paths/~1v1~1action~1queryMore/post/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1queryMore/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1queryMore/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/action_postquerymore"}],"panels":[]}]},"httpPath":"/v1/action/queryMore"},{"label":"Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/actions/action_postupdate","routeSlug":"/v1-api-reference/api/actions/action_postupdate","metadata":{"seo":{"title":"Update","description":"Updates the information in one or more objects of the same type. You can specify different types of objects in different update calls, but each specific update call must apply to only one type of object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Action_POSTupdate","name":"Update","isWebhook":false,"pointer":"/paths/~1v1~1action~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update","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 information in one or more objects of the same type. You can specify different types of objects in different update calls, but each specific update call must apply to only one type of object."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"actions/action_postupdate/request/limitations","deepLinkHash":"/actions/action_postupdate#actions/action_postupdate/request/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call has the following limitations:"},"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":"A maximum of 50 objects are supported in a single call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default WSDL version for Actions is 79. To update objects or fields according to a different WSDL version, set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. To find out in which WSDL version a particular object or field was introduced, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-soap-api-version-history"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora SOAP API Version History"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"actions/action_postupdate/request/how-to-use-this-call","deepLinkHash":"/actions/action_postupdate#actions/action_postupdate/request/how-to-use-this-call"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to use this call?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update an array of one or more zObjects. The fields you should specify can be found in the corresponding \"CRUD: Update an "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zObject"},"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 example, to update one or multiple accounts, use the request fields in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/older-api/operation/Object_PUTAccount/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRUD: Update an account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns an array of SaveResults sorted in the same order, indicating the success or failure of updating each object. The following information applies to this call:"},"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":"You cannot pass in null zObjects."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can pass in a maximum of 50 zObjects at a time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All objects must be of the same type."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each field in each object, you must determine that object's ID. Then populate the fields that you want update with the new information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora ignores unrecognized fields in update calls. For example, if an optional field is spelled incorrectly or a field that does not exist is specified, Zuora ignores the field and continues to process the call. No error message is returned for unrecognized fields."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1action~1update/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1action~1update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyActionupdateRequest"}},"schemaId":"components/schemas/ProxyActionupdateRequest","pointer":"/paths/~1v1~1action~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/action/update","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyActionupdateRequest"}},"responseCodes":["200","401"],"pointer":"/v1/action/update","href":"actions/action_postupdate","openApiOperationId":"Action_POSTupdate","summary":"Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyActionupdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyActionupdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378","exampleIds":["paths/~1v1~1action~1update/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_378","exampleIds":["paths/~1v1~1action~1update/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1update/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1update/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1action~1update/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_378","exampleIds":["paths/~1v1~1action~1update/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378","exampleIds":["paths/~1v1~1action~1update/post/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1update/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1action~1update/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/action_postupdate"}],"panels":[]}]},"httpPath":"/v1/action/update"}],"content":{"contentType":"group","meta":{"name":"Actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Actions","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":"Actions are operations that are batch in nature. For example, the \"create\", \"update\", \"delete\", and other operations allow changes to up-to 50 objects at a time. The \"query\" operation will return up-to 2000 result records back at a time, before requiring additional pages of data to be returned via a subsequent \"queryMore\" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default WSDL version for Actions is 79. If you want to change the WSDL version, set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. To find out in which WSDL version a particular object or field was introduced, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-soap-api-version-history"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora SOAP API Version History"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Actions do not support the Invoice Settlement feature. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. Actions also do not support the Orders feature."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/action/create","summary":"Create","prefix":{"name":"post","color":"post"},"badges":[],"link":"/actions/action_postcreate","deprecated":false},{"title":"/v1/action/delete","summary":"Delete","prefix":{"name":"post","color":"post"},"badges":[],"link":"/actions/action_postdelete","deprecated":false},{"title":"/v1/action/query","summary":"Query","prefix":{"name":"post","color":"post"},"badges":[],"link":"/actions/action_postquery","deprecated":false},{"title":"/v1/action/queryMore","summary":"QueryMore","prefix":{"name":"post","color":"post"},"badges":[],"link":"/actions/action_postquerymore","deprecated":false},{"title":"/v1/action/update","summary":"Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/actions/action_postupdate","deprecated":false}]}]}]}]}},{"type":"group","label":"Settings","link":"/v1-api-reference/api/settings","routeSlug":"/v1-api-reference/api/settings","items":[{"label":"Submit settings requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/settings/post_processsettingsbatchrequest","routeSlug":"/v1-api-reference/api/settings/post_processsettingsbatchrequest","metadata":{"seo":{"title":"Submit settings requests","description":"Submit a batch of settings requests by this single API operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_ProcessSettingsBatchRequest","name":"Submit settings requests","isWebhook":false,"pointer":"/paths/~1settings~1batch-requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit settings requests","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":"Submit a batch of settings requests by this single API operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.csv"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200 response sample in CSV format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that lists all available settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.json"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200 response sample in JSON format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that lists all available parameters of each setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, one batch settings request can contain a maximum of 100 single operation requests, including:"},"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":"All the single requests in the process batch settings request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the children requests of the single requests."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This maximum value is configurable."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1settings~1batch-requests/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettingsBatchRequest"}},"schemaId":"components/schemas/SettingsBatchRequest","pointer":"/paths/~1settings~1batch-requests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/batch-requests","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SettingsBatchRequest"}},"responseCodes":["200"],"pointer":"/settings/batch-requests","href":"settings/post_processsettingsbatchrequest","openApiOperationId":"POST_ProcessSettingsBatchRequest","summary":"Submit settings requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/SettingsBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettingsBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettingsBatchResponse","exampleIds":["paths/~1settings~1batch-requests/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SettingsBatchResponse","exampleIds":["paths/~1settings~1batch-requests/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1settings~1batch-requests/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SettingsBatchResponse","exampleIds":["paths/~1settings~1batch-requests/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettingsBatchResponse","exampleIds":["paths/~1settings~1batch-requests/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/post_processsettingsbatchrequest"}],"panels":[]}]},"httpPath":"/settings/batch-requests"},{"label":"List all settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/settings/get_listallsettings","routeSlug":"/v1-api-reference/api/settings/get_listallsettings","metadata":{"seo":{"title":"List all settings","description":"Get a list of all available settings in your tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ListAllSettings","name":"List all settings","isWebhook":false,"pointer":"/paths/~1settings~1listing/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all settings","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":"Get a list of all available settings in your tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response message is by default in JSON format. If you want to receive all the available settings in csv format, include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the header parameters and set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/csv"},"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":"See a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.csv"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200 response sample in CSV format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that lists all available settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.json"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200 response sample in JSON format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that lists all available parameters of each setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find a specific operation of an available setting item in your tenant from the 200 response body of this call. See the following common use cases of Settings API for how to operate on a specifc setting item."},"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":"Billing Rules:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/billing-rule-settings/get-a-specific-setting---billing-rules","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific setting - Billing Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/billing-rule-settings/update-a-specific-setting---billing-rules","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a specific setting - Billing Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/billing-rule-settings/get-accounting-rules---billing-rules","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get accounting rules - Billing Rules"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Age Buckets:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/age-bucket-settings/get-age-buckets","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Age Buckets"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/age-bucket-settings/update-age-buckets","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Age Buckets"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Templates:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-template-settings/get-a-specific-invoice-template","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific Invoice Template"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-template-settings/get-all-invoice-templates","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all Invoice Templates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-template-settings/create-a-new-invoice-template","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new Invoice Template"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-template-settings/update-a-specific-invoice-template","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a specific Invoice Template"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-template-settings/delete-a-specific-invoice-templates","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a specific Invoice Template"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Group:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-group-settings/create-an-invoice-group","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an invoice group"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-group-settings/retrieve-all-invoice-groups","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all invoice groups"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-group-settings/get-a-specific-invoice-group","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific invoice group"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-group-settings/update-an-invoice-group","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an invoice group"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-group-settings/delete-an-invoice-group","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete an invoice group"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Communications Profiles:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/communication-profile-settings/create-a-new-communication-profile","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new Communication Profile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/communication-profile-settings/get-a-communication-profile","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a Communication Profile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/communication-profile-settings/get-all-communication-profiles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all Communication Profiles"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/communication-profile-settings/modify-a-communication-profile","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modify a Communication Profile"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification Definitions:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/notification-definition-settings/get-all-notifications-under-a-particular-communication-profile","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all notification definitions under a particular Communication Profile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/notification-definition-settings/create-a-notification-definition-under-a-particular-communication-profile","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a notification definition under a particular Communication Profile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/notification-definition-settings/get-a-notification-definition","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a notification definition"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/notification-definition-settings/update-a-notification-definition","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a notification definition"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/notification-definition-settings/delete-a-notification-definition","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a notification definition"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reusable Blocks:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/reusable-block-settings/create-or-update-reusable-blocks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create or update reusable blocks"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/reusable-block-settings/get-all-reusable-blocks","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all reusable blocks"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/reusable-block-settings/get-a-reusable-block","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a reusable block"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/reusable-block-settings/update-a-reusable-block","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a reusable block"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/reusable-block-settings/delete-a-reusable-block","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a reusable block"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chart of Accounts:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/chart-of-account-settings/get-chart-of-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Chart of Accounts"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/chart-of-account-settings/add-a-new-chart-of-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a new Chart of Account"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote Templates:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/quote-template-settings/get-all-quote-templates","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all Quote Templates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/quote-template-settings/get-a-specific-quote-template","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific Quote Template"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/quote-template-settings/create-a-new-quote-template","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new Quote Template"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Integration Tax Engine:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/avalara-tax-engine-settings#create-an-avalara-tax-engine-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Tax Engine"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/avalara-tax-engine-settings#get-an-avalara-tax-engine-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a Tax Engine"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/avalara-tax-engine-settings#update-an-avalara-tax-engine-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Tax Engine"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect Tax Engines:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/connect-tax-engines-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Connect Tax Engine"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/connect-tax-engines-settings#get-a-connect-tax-engine-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a Connect Tax Engine"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/connect-tax-engines-settings#update-a-connect-tax-engine-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Connect Tax Engine"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/connect-tax-engines-settings#delete-a-connect-tax-engine-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a Connect Tax Engine"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Tax Engine:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-engine-settings#get-tax-engines-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Tax Engines"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-engine-settings#create-tax-code-using-zuora-tax-engine-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Tax Code using Zuora Tax Engine"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-engine-settings#get-tax-code-using-zuora-tax-engine-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Tax Code using Zuora Tax Engine"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-engine-settings#update-tax-code-using-zuora-tax-engine-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Tax Code using Zuora Tax Engine"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-engine-settings#delete-tax-code-using-zuora-tax-engine-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete Tax Code using Zuora Tax Engine"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Tax Rate Period:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rate-period-settings#create-tax-rate-periods-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Tax Rate Periods"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rate-period-settings#get-tax-rate-periods-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Tax Rate Periods"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rate-period-settings#update-tax-rate-periods-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Tax Rate Periods"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rate-period-settings#delete-tax-rate-periods-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete Tax Rate Periods"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Tax Code:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-code-api-settings#get-specific-tax-code-id-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Specific Tax Code ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-code-api-settings#create-tax-codes-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Tax Codes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-code-api-settings#update-tax-codes-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Tax Codes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-code-api-settings#delete-tax-codes-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete Tax Codes"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Tax Rates:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rates-api-settings#retrieve-a-list-of-tax-rates-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get List of Tax Rates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rates-api-settings#create-tax-rates-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Tax Rates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rates-api-settings#update-tax-rates-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Tax Rates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rates-api-settings#delete-tax-rates-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete Tax Rates"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Units of Measure:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/unit-of-measure-settings/create-a-unit-of-measure","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Unit of Measure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/unit-of-measure-settings/get-a-unit-of-measure","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a Unit of Measure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/unit-of-measure-settings/get-all-units-of-measure","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all Units of Measure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/unit-of-measure-settings/update-a-unit-of-measure","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Unit of Measure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/unit-of-measure-settings/delete-a-unit-of-measure","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a Unit of Measure"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Summary Statement:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/summary-statement-settings#get-a-specific-summary-statement-template-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific summary statement template"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/summary-statement-settings#get-all-templates-for-summary-statement-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all templates for summary statement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/summary-statement-settings#create-a-new-summary-statement-template-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new summary statement template"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/summary-statement-settings#update-a-specific-summary-statement-template-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a specific summary statement template"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/summary-statement-settings#deletea-specific-summary-statement-template-0","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a specific summary statement template"},"children":[]}]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Accept","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies response media type. If you omit the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header parameter, the response body is by default in JSON format. If you include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header parameter and set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response body is in csv format."},"children":[]}]}]}]}],"pointer":"/paths/~1settings~1listing/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/listing","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Accept","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/settings/listing","href":"settings/get_listallsettings","openApiOperationId":"GET_ListAllSettings","summary":"List all settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/csv","mediaTypes":["application/csv","application/json"],"mediaTypeContent":{"application/csv":{"schemaId":"components/schemas/ListAllSettingsResponse"},"application/json":{"schemaId":"components/schemas/ListAllSettingsResponse","exampleIds":["paths/~1settings~1listing/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListAllSettingsResponse","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_40"}],"pointer":"/paths/~1settings~1listing/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAllSettingsResponse","mediaTypes":["application/csv","application/json"],"mediaTypeContent":{"application/csv":{"schemaId":"components/schemas/ListAllSettingsResponse"},"application/json":{"schemaId":"components/schemas/ListAllSettingsResponse","exampleIds":["paths/~1settings~1listing/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/get_listallsettings"}],"panels":[]}]},"httpPath":"/settings/listing"}],"content":{"contentType":"group","meta":{"name":"Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settings","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":"The Setting API provides a central API for managing settings in your Zuora tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use Postman, you can import the Settings API endpoints as a collection into your Postman app and try out different requests to learn how the API works."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can sign up for a free account on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://identity.getpostman.com/signup"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman website"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and download the app in case you do not use Postman yet."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/batch-requests","summary":"Submit settings requests","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settings/post_processsettingsbatchrequest","deprecated":false},{"title":"/settings/listing","summary":"List all settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settings/get_listallsettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Files","link":"/v1-api-reference/api/files","routeSlug":"/v1-api-reference/api/files","items":[{"label":"Retrieve a file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/files/get_files","routeSlug":"/v1-api-reference/api/files/get_files","metadata":{"seo":{"title":"Retrieve a file","description":"Retrieve files such as export results, invoices, and accounting period reports."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Files","name":"Retrieve a file","isWebhook":false,"pointer":"/paths/~1v1~1files~1{file-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve 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":"Retrieve files such as export results, invoices, and accounting period reports."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response content type depends on the type of file that you retrieve."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you retrieve an invoice PDF, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header in the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf;charset=UTF-8"},"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":"Other content types include:"},"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":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for CSV files"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/msword"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Microsoft Word files"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.ms-excel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for Microsoft Excel files ("},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".xls"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".xlsx"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" respectively)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/x-gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ZIP and Gzip files respectively"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for HTML files"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for text files"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response always contains character encoding information in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"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":"Content-Type: application/zip;charset=UTF-8"},"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":"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 maximum file size is 2,047 MB. If you have a data request that exceeds this limit, Zuora returns the following 403 response: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<security:max-object-size>2047MB</security:max-object-size>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine if large file optimization is an option for you."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file-id","in":"path","schemaId":"schema_5","description":"The Zuora ID of the file to retrieve.\n","required":true}],"pointer":"/paths/~1v1~1files~1{file-id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1files~1{file-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/files/{file-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"file-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/files/{file-id}","href":"files/get_files","openApiOperationId":"GET_Files","summary":"Retrieve a file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1files~1{file-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/get_files"}],"panels":[]}]},"httpPath":"/v1/files/{file-id}"},{"label":"Restore a file","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/files/put_files","routeSlug":"/v1-api-reference/api/files/put_files","metadata":{"seo":{"title":"Restore a file","description":"Restores a previously archived file to its RESTORED status. Once a file is archived, it cannot be used directly until the file is restored using this API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_Files","name":"Restore a file","isWebhook":false,"pointer":"/paths/~1v1~1files~1{file-id}~1restore/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restore 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":"Restores a previously archived file to its RESTORED status. Once a file is archived, it cannot be used directly until the file is restored using this API."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"files/put_files/request/notes","deepLinkHash":"/files/put_files#files/put_files/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"This API operation will fail if the count of restored files exceeds the quota limit (1000 by default) in the past 24 hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual restoration process may take between 12 to 48 hours to complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can monitor the status of the file restoration process using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_FileStatus"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve file status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API operation until the status transitions to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESTORED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file-id","in":"path","schemaId":"schema_5","description":"The Zuora ID of the file to restore.\n","required":true}],"pointer":"/paths/~1v1~1files~1{file-id}~1restore/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1files~1{file-id}~1restore/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/files/{file-id}/restore","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"file-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/files/{file-id}/restore","href":"files/put_files","openApiOperationId":"PUT_Files","summary":"Restore a file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestoreFile","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RestoreFile","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1files~1{file-id}~1restore/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestoreFile","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestoreFile","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1restore/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/put_files"}],"panels":[]}]},"httpPath":"/v1/files/{file-id}/restore"},{"label":"Retrieve file status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/files/get_filestatus","routeSlug":"/v1-api-reference/api/files/get_filestatus","metadata":{"seo":{"title":"Retrieve file status","description":"Retrieves the status of the file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_FileStatus","name":"Retrieve file status","isWebhook":false,"pointer":"/paths/~1v1~1files~1{file-id}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve file status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the status of the file.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file-id","in":"path","schemaId":"schema_5","description":"The Zuora ID of the file to for which the status should be retrieved.\n","required":true}],"pointer":"/paths/~1v1~1files~1{file-id}~1status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1files~1{file-id}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/files/{file-id}/status","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"file-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/files/{file-id}/status","href":"files/get_filestatus","openApiOperationId":"GET_FileStatus","summary":"Retrieve file status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveFileStatus","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RetrieveFileStatus","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1files~1{file-id}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveFileStatus","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveFileStatus","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1files~1{file-id}~1status/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/get_filestatus"}],"panels":[]}]},"httpPath":"/v1/files/{file-id}/status"}],"content":{"contentType":"group","meta":{"name":"Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files","showPageActions":true},{"nodeType":"markdoc","content":"You can use the operations contained in this section to retrieve files such as export results, invoices, accounting period reports, and so on."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/files/{file-id}","summary":"Retrieve a file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/get_files","deprecated":false},{"title":"/v1/files/{file-id}/restore","summary":"Restore a file","prefix":{"name":"put","color":"put"},"badges":[],"link":"/files/put_files","deprecated":false},{"title":"/v1/files/{file-id}/status","summary":"Retrieve file status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/get_filestatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Imports","link":"/v1-api-reference/api/imports","routeSlug":"/v1-api-reference/api/imports","items":[{"label":"CRUD: Create an import","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/imports/object_postimport","routeSlug":"/v1-api-reference/api/imports/object_postimport","metadata":{"seo":{"title":"CRUD: Create an import","description":"Creates a data import."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_POSTImport","name":"CRUD: Create an import","isWebhook":false,"pointer":"/paths/~1v1~1object~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Create an import","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a data import.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1import/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1v1~1object~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/object/import","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_380"}},"responseCodes":["200","401"],"pointer":"/v1/object/import","href":"imports/object_postimport","openApiOperationId":"Object_POSTImport","summary":"CRUD: Create an import"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_380","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyPostImport","exampleIds":["paths/~1v1~1object~1import/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyPostImport","exampleIds":["paths/~1v1~1object~1import/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1import/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1import/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1import/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyPostImport","exampleIds":["paths/~1v1~1object~1import/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyPostImport","exampleIds":["paths/~1v1~1object~1import/post/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1import/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1import/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/imports/object_postimport"}],"panels":[]}]},"httpPath":"/v1/object/import"},{"label":"CRUD: Retrieve an import","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/imports/object_getimport","routeSlug":"/v1-api-reference/api/imports/object_getimport","metadata":{"seo":{"title":"CRUD: Retrieve an import","description":"Retrieve an data import job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_GETImport","name":"CRUD: Retrieve an import","isWebhook":false,"pointer":"/paths/~1v1~1object~1import~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Retrieve an import","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an data import job."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1import~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_5","description":"Object fields to return"}],"pointer":"/paths/~1v1~1object~1import~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1import~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/object/import/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v1/object/import/{id}","href":"imports/object_getimport","openApiOperationId":"Object_GETImport","summary":"CRUD: Retrieve an import"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetImport"}},"schemaId":"components/schemas/ProxyGetImport","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1import~1{id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1import~1{id}/get/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1import~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1import~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1object~1import~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyGetImport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetImport"}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1import~1{id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1import~1{id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1import~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1import~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/imports/object_getimport"}],"panels":[]}]},"httpPath":"/v1/object/import/{id}"}],"content":{"contentType":"group","meta":{"name":"Imports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Imports","showPageActions":true},{"nodeType":"markdoc","content":"An import uploads content, especially when you have a large amount of content. The Import object contains all of the information you need to upload content, such as a large number of usage records."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/object/import","summary":"CRUD: Create an import","prefix":{"name":"post","color":"post"},"badges":[],"link":"/imports/object_postimport","deprecated":false},{"title":"/v1/object/import/{id}","summary":"CRUD: Retrieve an import","prefix":{"name":"get","color":"get"},"badges":[],"link":"/imports/object_getimport","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Exchange Rates","link":"/v1-api-reference/api/custom-exchange-rates","routeSlug":"/v1-api-reference/api/custom-exchange-rates","items":[{"label":"List custom exchange rates by currency","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/custom-exchange-rates/get_customexchangerates","routeSlug":"/v1-api-reference/api/custom-exchange-rates/get_customexchangerates","metadata":{"seo":{"title":"List custom exchange rates by currency","description":"This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CustomExchangeRates","name":"List custom exchange rates by currency","isWebhook":false,"pointer":"/paths/~1v1~1custom-exchange-rates~1{currency}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom exchange rates by currency","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":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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 reference describes how to query custom foreign exchange rates from Zuora. You can use this API method to query exchange rates only if you use a custom exchange rate provider and upload rates with the Import Foreign Exchange Rates mass action."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"currency","in":"path","schemaId":"schema_5","description":"The target base currency of the tenant. The exchange rates in the response are calculated in relation to the target currency.\n\nThe value must be a three-letter currency code, for example, USD. \n","required":true}],"pointer":"/paths/~1v1~1custom-exchange-rates~1{currency}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_5","description":"Start date of the date range for which you want to get exchange rates.\n\nThe date must be in yyyy-mm-dd format, for example, 2016-01-15. The start date cannot be later than the end date.\n","required":true},{"name":"endDate","in":"query","schemaId":"schema_5","description":"End date of the date range for which you want to get exchange rates.\n\nThe date must be in yyyy-mm-dd format, for example, 2016-01-16. The end date can be a maximum of 90 days after the start date.\n","required":true}],"pointer":"/paths/~1v1~1custom-exchange-rates~1{currency}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1custom-exchange-rates~1{currency}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/custom-exchange-rates/{currency}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"currency","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"startDate","in":"query","required":true,"schemaId":"schema_5"},{"name":"endDate","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/custom-exchange-rates/{currency}","href":"custom-exchange-rates/get_customexchangerates","openApiOperationId":"GET_CustomExchangeRates","summary":"List custom exchange rates by currency"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCustomExchangeRatesType","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCustomExchangeRatesType","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1custom-exchange-rates~1{currency}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCustomExchangeRatesType","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCustomExchangeRatesType","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-exchange-rates/get_customexchangerates"}],"panels":[]}]},"httpPath":"/v1/custom-exchange-rates/{currency}"}],"content":{"contentType":"group","meta":{"name":"Custom Exchange Rates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Exchange Rates","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":"If you use a custom exchange rate provider and upload rates with the Import Foreign Exchange Rates mass action, you can query custom foreign exchange rates from Zuora through API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/custom-exchange-rates/{currency}","summary":"List custom exchange rates by currency","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-exchange-rates/get_customexchangerates","deprecated":false}]}]}]}]}},{"type":"group","label":"Attachments","link":"/v1-api-reference/api/attachments","routeSlug":"/v1-api-reference/api/attachments","items":[{"label":"Create an attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/attachments/post_attachments","routeSlug":"/v1-api-reference/api/attachments/post_attachments","metadata":{"seo":{"title":"Create an attachment","description":"Use the Add Attachment REST request with a multipart/form-data to attach a document file to an Account, a Subscription, an Invoice, a Credit Memo, or a Debit Memo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Attachments","name":"Create an attachment","isWebhook":false,"pointer":"/paths/~1v1~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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Add Attachment REST request with a multipart/form-data to attach a document file to an Account, a Subscription, an Invoice, a Credit Memo, or a Debit Memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only use this operation if you have a Billing role that includes the Manage Attachments permission."},"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://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing roles"},"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":"To change your Billing role, contact your Zuora platform administrator."},"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 Credit and Debit Memos feature is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"description","in":"query","schemaId":"schema_5","description":"Description of the attachment document.\n"},{"name":"associatedObjectType","in":"query","schemaId":"schema_381","description":"The type of the object to add attachements for. \n","required":true},{"name":"associatedObjectKey","in":"query","schemaId":"schema_5","description":"For the Subscription type, specify the Subscription Number. An attachment is tied to the Subscription Number and thus viewable with every subscription version.\n\nFor Account, Credit Memo, and Debit Memo, specify the corresponding ID or number. For Invoice, specify the corresponding ID.\n","required":true}],"pointer":"/paths/~1v1~1attachments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1attachments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_382"}},"schemaId":"schema_382","pointer":"/paths/~1v1~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/attachments","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"description","in":"query","required":false,"schemaId":"schema_5"},{"name":"associatedObjectType","in":"query","required":true,"schemaId":"schema_381"},{"name":"associatedObjectKey","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_382"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/attachments","href":"attachments/post_attachments","openApiOperationId":"POST_Attachments","summary":"Create an attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"schema_382","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_382"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTAttachmentResponseType","exampleIds":["paths/~1v1~1attachments/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTAttachmentResponseType","exampleIds":["paths/~1v1~1attachments/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTAttachmentResponseType","exampleIds":["paths/~1v1~1attachments/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTAttachmentResponseType","exampleIds":["paths/~1v1~1attachments/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/post_attachments"}],"panels":[]}]},"httpPath":"/v1/attachments"},{"label":"Delete an attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/attachments/delete_attachments","routeSlug":"/v1-api-reference/api/attachments/delete_attachments","metadata":{"seo":{"title":"Delete an attachment","description":"Use the Delete Attachment REST request to delete an attachment from a Zuora object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_Attachments","name":"Delete an attachment","isWebhook":false,"pointer":"/paths/~1v1~1attachments~1{attachment-id}/delete","hasSamples":false},"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Delete Attachment REST request to delete an attachment from a Zuora object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only use this operation if you have a Billing role that includes the Manage Attachments permission and the Delete Attachments permission."},"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://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing roles"},"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":"To change your Billing role, contact your Zuora platform administrator."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"attachment-id","in":"path","schemaId":"schema_5","description":"Id of the attachment to be deleted.","required":true}],"pointer":"/paths/~1v1~1attachments~1{attachment-id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1attachments~1{attachment-id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/attachments/{attachment-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"attachment-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/attachments/{attachment-id}","href":"attachments/delete_attachments","openApiOperationId":"DELETE_Attachments","summary":"Delete an attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1attachments~1{attachment-id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/delete_attachments"}],"panels":[]}]},"httpPath":"/v1/attachments/{attachment-id}"},{"label":"Retrieve an attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/attachments/get_attachments","routeSlug":"/v1-api-reference/api/attachments/get_attachments","metadata":{"seo":{"title":"Retrieve an attachment","description":"Use the View Attachment REST request to retrieve information about an attachment document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Attachments","name":"Retrieve an attachment","isWebhook":false,"pointer":"/paths/~1v1~1attachments~1{attachment-id}/get","hasSamples":false},"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the View Attachment REST request to retrieve information about an attachment document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only use this operation if you have a Billing role that includes the Manage Attachments permission."},"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://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing roles"},"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":"To change your Billing role, contact your Zuora platform administrator."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"attachment-id","in":"path","schemaId":"schema_5","description":"Id of the attachment you want to view.","required":true}],"pointer":"/paths/~1v1~1attachments~1{attachment-id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1attachments~1{attachment-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/attachments/{attachment-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"attachment-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/attachments/{attachment-id}","href":"attachments/get_attachments","openApiOperationId":"GET_Attachments","summary":"Retrieve an attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAttachmentResponseType","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAttachmentResponseType","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1attachments~1{attachment-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAttachmentResponseType","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAttachmentResponseType","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/get_attachments"}],"panels":[]}]},"httpPath":"/v1/attachments/{attachment-id}"},{"label":"Update an attachment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/attachments/put_attachments","routeSlug":"/v1-api-reference/api/attachments/put_attachments","metadata":{"seo":{"title":"Update an attachment","description":"Use the Edit Attachment REST request to make changes to the descriptive fields of an attachment, such as the description and the file name. You cannot change the actual content of the attached file in Zuora. If you need to change the actual content, you need to delete the attachment and add the updated file as a new attachment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_Attachments","name":"Update an attachment","isWebhook":false,"pointer":"/paths/~1v1~1attachments~1{attachment-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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Edit Attachment REST request to make changes to the descriptive fields of an attachment, such as the description and the file name. You cannot change the actual content of the attached file in Zuora. If you need to change the actual content, you need to delete the attachment and add the updated file as a new attachment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only use this operation if you have a Billing role that includes the Manage Attachments permission."},"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://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing roles"},"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":"To change your Billing role, contact your Zuora platform administrator."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"attachment-id","in":"path","schemaId":"schema_5","description":"Id of the attachment to be updated.","required":true}],"pointer":"/paths/~1v1~1attachments~1{attachment-id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1attachments~1{attachment-id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTAttachmentType"}},"schemaId":"components/schemas/PUTAttachmentType","pointer":"/paths/~1v1~1attachments~1{attachment-id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/attachments/{attachment-id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"attachment-id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTAttachmentType"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/attachments/{attachment-id}","href":"attachments/put_attachments","openApiOperationId":"PUT_Attachments","summary":"Update an attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTAttachmentType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTAttachmentType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1attachments~1{attachment-id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{attachment-id}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/put_attachments"}],"panels":[]}]},"httpPath":"/v1/attachments/{attachment-id}"},{"label":"List attachments by object type and key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/attachments/get_attachmentslist","routeSlug":"/v1-api-reference/api/attachments/get_attachmentslist","metadata":{"seo":{"title":"List attachments by object type and key","description":"Use the View Attachment REST request to get a list of attachments on an account, an invoice, a subscription, a credit memo, or a debit memo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_AttachmentsList","name":"List attachments by object type and key","isWebhook":false,"pointer":"/paths/~1v1~1attachments~1{object-type}~1{object-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attachments by object type and key","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":"Use the View Attachment REST request to get a list of attachments on an account, an invoice, a subscription, a credit memo, or a debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only use this operation if you have a Billing role that includes the Manage Attachments permission."},"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://docs.zuora.com?resourceId=platform-billing-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing roles"},"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":"To change your Billing role, contact your Zuora platform administrator."},"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 Credit and Debit Memos feature is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object-type","in":"path","schemaId":"schema_383","description":"The type of the object to list attachements for.\n","required":true},{"name":"object-key","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the object to list attachements for."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object-type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", specify an account ID or number."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"object-type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", specify an invoice ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"object-type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", specify a subscription number."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"object-type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditmemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", specify a credit memo ID or number."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"object-type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debitmemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", specify a debit memo ID or number."},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1v1~1attachments~1{object-type}~1{object-key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1attachments~1{object-type}~1{object-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1attachments~1{object-type}~1{object-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/attachments/{object-type}/{object-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object-type","in":"path","required":true,"schemaId":"schema_383"},{"name":"object-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/attachments/{object-type}/{object-key}","href":"attachments/get_attachmentslist","openApiOperationId":"GET_AttachmentsList","summary":"List attachments by object type and key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAttachmentsResponseType","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETAttachmentsResponseType","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETAttachmentsResponseType","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETAttachmentsResponseType","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/get_attachmentslist"}],"panels":[]}]},"httpPath":"/v1/attachments/{object-type}/{object-key}"}],"content":{"contentType":"group","meta":{"name":"Attachments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attachments","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 attachments in Zuora to upload documents of various formats to associate additional information with accounts, subscriptions, invoices, credit memos, or debit memos."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example attachments could be purchase orders (PO's), tax exemption document, or ownership transfer forms."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about attachments, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/common-subscription-information/attachments-management-on-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/attachments","summary":"Create an attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/attachments/post_attachments","deprecated":false},{"title":"/v1/attachments/{attachment-id}","summary":"Delete an attachment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/attachments/delete_attachments","deprecated":false},{"title":"/v1/attachments/{attachment-id}","summary":"Retrieve an attachment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/get_attachments","deprecated":false},{"title":"/v1/attachments/{attachment-id}","summary":"Update an attachment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/attachments/put_attachments","deprecated":false},{"title":"/v1/attachments/{object-type}/{object-key}","summary":"List attachments by object type and key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/get_attachmentslist","deprecated":false}]}]}]}]}},{"type":"group","label":"Metadata","link":"/v1-api-reference/api/metadata","routeSlug":"/v1-api-reference/api/metadata","items":[{"label":"List available metadata objects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata/listmetadataobjects","routeSlug":"/v1-api-reference/api/metadata/listmetadataobjects","metadata":{"seo":{"title":"List available metadata objects","description":"Returns all available objects for the specified metadata context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMetadataObjects","name":"List available metadata objects","isWebhook":false,"pointer":"/paths/~1object-metadata/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available metadata objects","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":"Returns all available objects for the specified metadata context."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each object includes basic metadata such as object name, label, category,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom field support indicator, and a link to retrieve the full object schema."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This list operation is supported only for Data Query(DQ) and Object Query(OQ) contexts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Data Source Export and Aggregate Query API contexts, this operation is not supported. To retrieve metadata for Data Source Export(DSE) or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aggregate Query API(AQuA), use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/metadata/retrievemetadataobjectschema"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve metadata object schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the required context."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"context","in":"query","schemaId":"schema_384","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data context for which to retrieve metadata."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"text","inline":true,"attributes":{"content":"DQ: Data Query context"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OQ: Object Query context"},"children":[]}]}]}]}],"required":true,"example":"DQ"}],"pointer":"/paths/~1object-metadata/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1object-metadata/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-metadata","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"context","in":"query","required":true,"example":"DQ","schemaId":"schema_384"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-metadata","href":"metadata/listmetadataobjects","openApiOperationId":"listMetadataObjects","summary":"List available metadata objects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"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 available metadata objects.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385","exampleIds":["paths/~1object-metadata/get/responses/200/content/application~1json/examples/dq-context","paths/~1object-metadata/get/responses/200/content/application~1json/examples/oq-context"]}},"schemaId":"schema_385","exampleIds":["paths/~1object-metadata/get/responses/200/content/application~1json/examples/dq-context","paths/~1object-metadata/get/responses/200/content/application~1json/examples/oq-context"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"},{"code":"4XX","description":"Authentication failed or credentials are invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"}],"pointer":"/paths/~1object-metadata/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_385","exampleIds":["paths/~1object-metadata/get/responses/200/content/application~1json/examples/dq-context","paths/~1object-metadata/get/responses/200/content/application~1json/examples/oq-context"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385","exampleIds":["paths/~1object-metadata/get/responses/200/content/application~1json/examples/dq-context","paths/~1object-metadata/get/responses/200/content/application~1json/examples/oq-context"]}}},{"code":"500","schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata/listmetadataobjects"}],"panels":[]}]},"httpPath":"/object-metadata"},{"label":"Retrieve metadata object schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/metadata/retrievemetadataobjectschema","routeSlug":"/v1-api-reference/api/metadata/retrievemetadataobjectschema","metadata":{"seo":{"title":"Retrieve metadata object schema","description":"Returns the complete JSON Schema for the specified object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveMetadataObjectSchema","name":"Retrieve metadata object schema","isWebhook":false,"pointer":"/paths/~1object-metadata~1{objectName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve metadata object schema","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":"Returns the complete JSON Schema for the specified object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes standard JSON Schema properties and Zuora-specific"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"metadata extensions, including field types, constraints, relationships,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom field indicators, and context-specific capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Data Query(DQ) and Object Query(OQ) contexts, object name matching is case-insensitive. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response uses the canonical object name returned by the upstream source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Data Source Export(DSE) or Aggregate Query API(AQuA) contexts, the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use the canonical object name returned by Billing."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_386","description":"Name of the object to retrieve schema for.\n\nFor Data Query(DQ) and Object Query(OQ), matching is case-insensitive.\n\nFor Data Source Export(DSE) and Aggregate Query API(AQuA), use the object name casing expected by Billing Describe.\n","required":true,"example":"Account"}],"pointer":"/paths/~1object-metadata~1{objectName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"context","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data context for which to retrieve metadata."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"text","inline":true,"attributes":{"content":"DQ: Data Query context"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OQ: Object Query context"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DSE: Data Source Export context"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AQUA: Analytics Query context"},"children":[]}]}]}]}],"required":true,"example":"DQ"}],"pointer":"/paths/~1object-metadata~1{objectName}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]}],"pointer":"/paths/~1object-metadata~1{objectName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/object-metadata/{objectName}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"example":"Account","schemaId":"schema_386"}],"query":[{"name":"context","in":"query","required":true,"example":"DQ","schemaId":"schema_387"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/object-metadata/{objectName}","href":"metadata/retrievemetadataobjectschema","openApiOperationId":"retrieveMetadataObjectSchema","summary":"Retrieve metadata object schema"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"JSON Schema for the specified object.","mediaType":"application/schema+json","mediaTypes":["application/schema+json"],"mediaTypeContent":{"application/schema+json":{"schemaId":"components/schemas/GetJsonSchema","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/account-dq","paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/invoice-dse"]}},"schemaId":"components/schemas/GetJsonSchema","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/account-dq","paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/invoice-dse"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/500/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"},{"code":"4XX","description":"Object not found in the specified context.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/4XX/content/application~1json/example"]}},"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/4XX/content/application~1json/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header. ","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ","schema":{"maxLength":64,"type":"string"}}},"headerSchemaId":"schema_37"}],"pointer":"/paths/~1object-metadata~1{objectName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetJsonSchema","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/account-dq","paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/invoice-dse"],"mediaTypes":["application/schema+json"],"mediaTypeContent":{"application/schema+json":{"schemaId":"components/schemas/GetJsonSchema","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/account-dq","paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/invoice-dse"]}}},{"code":"500","schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/500/content/application~1json/example"]}}},{"code":"4XX","schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/4XX/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataApiError","exampleIds":["paths/~1object-metadata~1{objectName}/get/responses/4XX/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata/retrievemetadataobjectschema"}],"panels":[]}]},"httpPath":"/object-metadata/{objectName}"}],"content":{"contentType":"group","meta":{"name":"Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Metadata","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":"The Metadata API provides a programmatic way to discover Zuora object metadata and schemas, so that you can retrieve, compare, and validate metadata across Zuora tenants.  It is intended for schema discovery of Zuora data domains and supports use cases such as listing available objects and retrieving the schema for a specific object. The Metadata object is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you are interested, please reach out to your CSM."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/object-metadata","summary":"List available metadata objects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/metadata/listmetadataobjects","deprecated":false},{"title":"/object-metadata/{objectName}","summary":"Retrieve metadata object schema","prefix":{"name":"get","color":"get"},"badges":[],"link":"/metadata/retrievemetadataobjectschema","deprecated":false}]}]}]}]}},{"type":"group","label":"Describe","link":"/v1-api-reference/api/describe","routeSlug":"/v1-api-reference/api/describe","items":[{"label":"Describe an object","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/describe/get_describe","routeSlug":"/v1-api-reference/api/describe/get_describe","metadata":{"seo":{"title":"Describe an object","description":"Provides a reference listing of each object that is available in your Zuora tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Describe","name":"Describe an object","isWebhook":false,"pointer":"/paths/~1v1~1describe~1{object}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Describe an object","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":"Provides a reference listing of each object that is available in your Zuora tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The information returned by this call is useful if you are using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/Object_POSTExport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRUD: Create Export"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-aqua-api-introduction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AQuA API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a data source export. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-export-zoql"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export ZOQL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"describe/get_describe/request/response","deepLinkHash":"/describe/get_describe#describe/get_describe/request/response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response contains an XML document that lists the fields of the specified object. Each of the object's fields is represented by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<field>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" element in the XML document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response sample:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<object>\n  <name>ProductRatePlanCharge</name>\n  <label>Product Rate Plan Charge</label>\n  <fields>\n    ...\n    <field>\n      <name>TaxMode</name>\n      <label>Tax Mode</label>\n      <type>picklist</type>\n      <options>\n        <option>TaxExclusive</option>\n        <option>TaxInclusive</option>\n      </options>\n      <contexts>\n        <context>export</context>\n      </contexts>\n      ...\n    </field>\n    ...\n  </fields>\n</object>\n","language":"xml"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<object>\n  <name>ProductRatePlanCharge</name>\n  <label>Product Rate Plan Charge</label>\n  <fields>\n    ...\n    <field>\n      <name>TaxMode</name>\n      <label>Tax Mode</label>\n      <type>picklist</type>\n      <options>\n        <option>TaxExclusive</option>\n        <option>TaxInclusive</option>\n      </options>\n      <contexts>\n        <context>export</context>\n      </contexts>\n      ...\n    </field>\n    ...\n  </fields>\n</object>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is strongly recommended that your integration checks "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<contexts>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" elements in the response. If your integration does not check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<contexts>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" elements, your integration may process fields that are not available for use in data source exports. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-export-zoql-changes-to-describe-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes to the Describe API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"object","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API name of an object in your Zuora tenant. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-object-names/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API object names for Describe"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the list of valid object names."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the features enabled in your Zuora tenant, you may not be able to list the fields of some objects."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1describe~1{object}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"showCurrencyConversionInformation","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get additional currency conversion information in the result."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically include additional Currency Conversion information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in currency conversion settings is checked, you can pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get additional fields in the result. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=ar-configure-foreign-currency-conversion"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Foreign Currency Conversion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically include additional Currency Conversion information"},"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":"By default if you need additional Currency Conversion information, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/hc/en-us","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Set this parameter value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to not include the additional currency conversion information in the result."},"children":[]}]}]}]}]},{"name":"showRelationships","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to return joined objects information in the response. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", meaning no related object information is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", an additional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<related-objects />"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section is returned. For example, if you are describing the Account object with this parameter set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response will include information similar to the following snippet:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<related-objects>\n  <object href=\"https://apisandbox-api.zuora.com/rest/api/describe/Contact\">\n    <name>BillToContact</name>\n    <label>Bill To</label>\n    <cardinality>TO_ONE</cardinality>\n    <direct-relationship>true</direct-relationship>\n    <path>Account.BillToContact</path>\n  </object>\n  ...\n<related-objects>\n","language":"xml"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<related-objects>\n  <object href=\"https://apisandbox-api.zuora.com/rest/api/describe/Contact\">\n    <name>BillToContact</name>\n    <label>Bill To</label>\n    <cardinality>TO_ONE</cardinality>\n    <direct-relationship>true</direct-relationship>\n    <path>Account.BillToContact</path>\n  </object>\n  ...\n<related-objects>\n"},"children":[]}]}]}],"pointer":"/paths/~1v1~1describe~1{object}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1describe~1{object}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/describe/{object}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"object","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"showCurrencyConversionInformation","in":"query","schemaId":"schema_5"},{"name":"showRelationships","in":"query","schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v1/describe/{object}","href":"describe/get_describe","openApiOperationId":"GET_Describe","summary":"Describe an object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns an XML document that lists the fields of the specified object.\n","mediaType":"text/xml","mediaTypes":["text/xml"],"mediaTypeContent":{"text/xml":{"schemaId":"schema_388","exampleIds":["paths/~1v1~1describe~1{object}/get/responses/200/content/text~1xml/example"]}},"schemaId":"schema_388","exampleIds":["paths/~1v1~1describe~1{object}/get/responses/200/content/text~1xml/example"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"404","description":"Returns an XML document that indicates the error\n","mediaType":"text/xml; charset=utf-8","mediaTypes":["text/xml; charset=utf-8"],"mediaTypeContent":{"text/xml; charset=utf-8":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1describe~1{object}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1describe~1{object}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1describe~1{object}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_388","exampleIds":["paths/~1v1~1describe~1{object}/get/responses/200/content/text~1xml/example"],"mediaTypes":["text/xml"],"mediaTypeContent":{"text/xml":{"schemaId":"schema_388","exampleIds":["paths/~1v1~1describe~1{object}/get/responses/200/content/text~1xml/example"]}}},{"code":"404","schemaId":"schema_5","mediaTypes":["text/xml; charset=utf-8"],"mediaTypeContent":{"text/xml; charset=utf-8":{"schemaId":"schema_5"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1describe~1{object}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1describe~1{object}/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/describe/get_describe"}],"panels":[]}]},"httpPath":"/v1/describe/{object}"}],"content":{"contentType":"group","meta":{"name":"Describe"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Describe","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":"You can use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/GET_Describe/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describe an object"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to get a reference listing of each object that is available in your Zuora tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the information returned by the \"Describe an object\" operation corresponds to the latest version of the Zuora WSDL."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/describe/{object}","summary":"Describe an object","prefix":{"name":"get","color":"get"},"badges":[],"link":"/describe/get_describe","deprecated":false}]}]}]}]}},{"type":"separator","label":"Legacy v1 Products","content":null},{"type":"group","label":"Products","link":"/v1-api-reference/api/products","routeSlug":"/v1-api-reference/api/products","items":[{"label":"CRUD: Create a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/products/object_postproduct","routeSlug":"/v1-api-reference/api/products/object_postproduct","metadata":{"seo":{"title":"CRUD: Create a product","description":"CRUD: Create a product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_POSTProduct","name":"CRUD: Create a product","isWebhook":false,"pointer":"/paths/~1v1~1object~1product/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Create a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyCreateProduct"}},"schemaId":"components/schemas/ProxyCreateProduct","pointer":"/paths/~1v1~1object~1product/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/object/product","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyCreateProduct"}},"responseCodes":["200","400","401"],"pointer":"/v1/object/product","href":"products/object_postproduct","openApiOperationId":"Object_POSTProduct","summary":"CRUD: Create a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyCreateProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyCreateProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1product/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/object_postproduct"}],"panels":[]}]},"httpPath":"/v1/object/product"},{"label":"CRUD: Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/products/object_getproduct","routeSlug":"/v1-api-reference/api/products/object_getproduct","metadata":{"seo":{"title":"CRUD: Retrieve a product","description":"Retrieve a specific product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_GETProduct","name":"CRUD: Retrieve a product","isWebhook":false,"pointer":"/paths/~1v1~1object~1product~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Retrieve a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1product~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_5","description":"Object fields to return"}],"pointer":"/paths/~1v1~1object~1product~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/object/product/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v1/object/product/{id}","href":"products/object_getproduct","openApiOperationId":"Object_GETProduct","summary":"CRUD: Retrieve a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetProduct","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyGetProduct","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1object~1product~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyGetProduct","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetProduct","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/object_getproduct"}],"panels":[]}]},"httpPath":"/v1/object/product/{id}"},{"label":"CRUD: Update a product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/products/object_putproduct","routeSlug":"/v1-api-reference/api/products/object_putproduct","metadata":{"seo":{"title":"CRUD: Update a product","description":"Updates a Product object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_PUTProduct","name":"CRUD: Update a product","isWebhook":false,"pointer":"/paths/~1v1~1object~1product~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Update a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a Product object."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1product~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product~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/ProxyModifyProduct"}},"schemaId":"components/schemas/ProxyModifyProduct","pointer":"/paths/~1v1~1object~1product~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/object/product/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyModifyProduct"}},"responseCodes":["200","401"],"pointer":"/v1/object/product/{id}","href":"products/object_putproduct","openApiOperationId":"Object_PUTProduct","summary":"CRUD: Update a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyModifyProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyModifyProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/put/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/put/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1product~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/put/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/put/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/object_putproduct"}],"panels":[]}]},"httpPath":"/v1/object/product/{id}"},{"label":"CRUD: Delete a product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/products/object_deleteproduct","routeSlug":"/v1-api-reference/api/products/object_deleteproduct","metadata":{"seo":{"title":"CRUD: Delete a product","description":"Deletes a specific product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_DELETEProduct","name":"CRUD: Delete a product","isWebhook":false,"pointer":"/paths/~1v1~1object~1product~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: 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 specific product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1product~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/object/product/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v1/object/product/{id}","href":"products/object_deleteproduct","openApiOperationId":"Object_DELETEProduct","summary":"CRUD: Delete a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/delete/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/delete/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1product~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/delete/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product~1{id}/delete/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/object_deleteproduct"}],"panels":[]}]},"httpPath":"/v1/object/product/{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":"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 APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see our latest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/tag/Commerce/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce API"},"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 product is an item or service that your company sells. In the subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"economy, a product is generally a service that your customers subscribe to rather"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"than a physical item that they purchase one time. For example, customers subscribe"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to a service that provides them a car when and where they need a car rather than"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"buying a car outright."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Product object contains all of the items in a specific product, especially product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate plans and product rate plan charges. Each Product object can have multiple"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate plans, which in turn can each have multiple rate plan charges. Each rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan charge can have multiple tiers. Taken together, all of these items create"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a single product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers subscribe to products that are in your product catalog. Product objects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collectively compose your product catalog. You create your product catalog by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating products. As soon as you create your first product, you create your product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"catalog."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/object/product","summary":"CRUD: Create a product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/object_postproduct","deprecated":false},{"title":"/v1/object/product/{id}","summary":"CRUD: Retrieve a product","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/object_getproduct","deprecated":false},{"title":"/v1/object/product/{id}","summary":"CRUD: Update a product","prefix":{"name":"put","color":"put"},"badges":[],"link":"/products/object_putproduct","deprecated":false},{"title":"/v1/object/product/{id}","summary":"CRUD: Delete a product","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/object_deleteproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Catalog","link":"/v1-api-reference/api/catalog","routeSlug":"/v1-api-reference/api/catalog","items":[{"label":"List all products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog/get_catalog","routeSlug":"/v1-api-reference/api/catalog/get_catalog","metadata":{"seo":{"title":"List all products","description":"Retrieves the entire product catalog, including all products, features, and their corresponding product rate plans, charges. Products are returned in reverse chronological order on the UpdatedDate field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Catalog","name":"List all products","isWebhook":false,"pointer":"/paths/~1v1~1catalog~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all products","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 the entire product catalog, including all products, features, and their corresponding product rate plans, charges. Products are returned in reverse chronological order on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedDate"},"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":"For each product, this operation returns a maximum of 300 product rate plans in the response. Across the returned product rate plans, up to 300 product rate plan charges can be returned for each product."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_389","description":"The number of records returned per page in the response.\n"}],"pointer":"/paths/~1v1~1catalog~1products/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1catalog~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/catalog/products","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_389"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/catalog/products","href":"catalog/get_catalog","openApiOperationId":"GET_Catalog","summary":"List all products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCatalogType","exampleIds":["paths/~1v1~1catalog~1products/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETCatalogType","exampleIds":["paths/~1v1~1catalog~1products/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog~1products/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog~1products/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog~1products/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog~1products/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1catalog~1products/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETCatalogType","exampleIds":["paths/~1v1~1catalog~1products/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETCatalogType","exampleIds":["paths/~1v1~1catalog~1products/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog~1products/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog~1products/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog~1products/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog~1products/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/get_catalog"}],"panels":[]}]},"httpPath":"/v1/catalog/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog/get_product","routeSlug":"/v1-api-reference/api/catalog/get_product","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieves detailed information about a specific product, including information about its product rate plans and charges."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_Product","name":"Retrieve a product","isWebhook":false,"pointer":"/paths/~1v1~1catalog~1products~1{product-key}/get","hasSamples":false},"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 detailed information about a specific product, including information about its product rate plans and charges. \n\nThis operation returns a maximum of 300 product rate plans and 300 product rate plan charges across all product rate plans in the response.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product-key","in":"path","schemaId":"schema_5","description":"The unique ID, SKU, or product number of the product that you want to retrieve. For example, 8a808255575bdae4015774e9602e16fe, SKU-00000987, or PC-00000006.\n","required":true}],"pointer":"/paths/~1v1~1catalog~1products~1{product-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1catalog~1products~1{product-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/catalog/products/{product-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"product-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/catalog/products/{product-key}","href":"catalog/get_product","openApiOperationId":"GET_Product","summary":"Retrieve a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductType","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductType","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1catalog~1products~1{product-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductType","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductType","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog~1products~1{product-key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog/get_product"}],"panels":[]}]},"httpPath":"/v1/catalog/products/{product-key}"}],"content":{"contentType":"group","meta":{"name":"Catalog"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Catalog","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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 APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see our latest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/tag/Commerce/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce API"},"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 Zuora Billing product catalog is where you define your products"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and pricing. The product catalog's ability to handle sophisticated pricing models"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gives you the power to easily adapt your pricing to customer and market needs,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to grow your business and drive more revenue."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/catalog/products","summary":"List all products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/get_catalog","deprecated":false},{"title":"/v1/catalog/products/{product-key}","summary":"Retrieve a product","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog/get_product","deprecated":false}]}]}]}]}},{"type":"group","label":"Catalog Groups","link":"/v1-api-reference/api/catalog-groups","routeSlug":"/v1-api-reference/api/catalog-groups","items":[{"label":"Create a catalog group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog-groups/post_createcataloggroup","routeSlug":"/v1-api-reference/api/catalog-groups/post_createcataloggroup","metadata":{"seo":{"title":"Create a catalog group","description":"Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateCatalogGroup","name":"Create a catalog group","isWebhook":false,"pointer":"/paths/~1v1~1catalog-groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a catalog group","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":"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 is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"Creates a catalog group which groups a list of product rate plans."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1catalog-groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCatalogGroupRequest"}},"schemaId":"components/schemas/POSTCatalogGroupRequest","pointer":"/paths/~1v1~1catalog-groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/catalog-groups","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTCatalogGroupRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/catalog-groups","href":"catalog-groups/post_createcataloggroup","openApiOperationId":"POST_CreateCatalogGroup","summary":"Create a catalog group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTCatalogGroupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTCatalogGroupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1catalog-groups/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog-groups/post_createcataloggroup"}],"panels":[]}]},"httpPath":"/v1/catalog-groups"},{"label":"List all catalog groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog-groups/get_listallcataloggroups","routeSlug":"/v1-api-reference/api/catalog-groups/get_listallcataloggroups","metadata":{"seo":{"title":"List all catalog groups","description":"Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ListAllCatalogGroups","name":"List all catalog groups","isWebhook":false,"pointer":"/paths/~1v1~1catalog-groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all catalog groups","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":"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 is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"Retrieves basic information about all catalog groups."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1catalog-groups/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1catalog-groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/catalog-groups","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"page","in":"query","required":false,"schemaId":"schema_28"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/catalog-groups","href":"catalog-groups/get_listallcataloggroups","openApiOperationId":"GET_ListAllCatalogGroups","summary":"List all catalog groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAllCatalogGroupsResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ListAllCatalogGroupsResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1catalog-groups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAllCatalogGroupsResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAllCatalogGroupsResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog-groups/get_listallcataloggroups"}],"panels":[]}]},"httpPath":"/v1/catalog-groups"},{"label":"Retrieve a catalog group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog-groups/get_retrievecataloggroup","routeSlug":"/v1-api-reference/api/catalog-groups/get_retrievecataloggroup","metadata":{"seo":{"title":"Retrieve a catalog group","description":"Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RetrieveCatalogGroup","name":"Retrieve a catalog group","isWebhook":false,"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a catalog group","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":"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 is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"Retrieves basic information about a catalog group."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"catalog-group-key","in":"path","schemaId":"schema_5","description":"The unique number or ID of the catalog group to be retrieved.\n","required":true}],"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/catalog-groups/{catalog-group-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"catalog-group-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/catalog-groups/{catalog-group-key}","href":"catalog-groups/get_retrievecataloggroup","openApiOperationId":"GET_RetrieveCatalogGroup","summary":"Retrieve a catalog group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog-groups/get_retrievecataloggroup"}],"panels":[]}]},"httpPath":"/v1/catalog-groups/{catalog-group-key}"},{"label":"Update a catalog group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog-groups/put_updatecataloggroup","routeSlug":"/v1-api-reference/api/catalog-groups/put_updatecataloggroup","metadata":{"seo":{"title":"Update a catalog group","description":"Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateCatalogGroup","name":"Update a catalog group","isWebhook":false,"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a catalog group","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":"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 is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"Updates a catalog group by its unique number or ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"catalog-groups/put_updatecataloggroup/request/notes","deepLinkHash":"/catalog-groups/put_updatecataloggroup#catalog-groups/put_updatecataloggroup/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"It is best practice to only specify the fields that you want to change in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify an empty value for a field in the request body, the corresponding field in the catalog group is emptied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The catalog group type cannot be changed."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"catalog-group-key","in":"path","schemaId":"schema_5","description":"The unique number or ID of the catalog group to be updated. \n","required":true}],"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTCatalogGroup"}},"schemaId":"components/schemas/PUTCatalogGroup","pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/catalog-groups/{catalog-group-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"catalog-group-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTCatalogGroup"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/catalog-groups/{catalog-group-key}","href":"catalog-groups/put_updatecataloggroup","openApiOperationId":"PUT_UpdateCatalogGroup","summary":"Update a catalog group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTCatalogGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTCatalogGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogGroupResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog-groups/put_updatecataloggroup"}],"panels":[]}]},"httpPath":"/v1/catalog-groups/{catalog-group-key}"},{"label":"Delete a catalog group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/catalog-groups/delete_cataloggroup","routeSlug":"/v1-api-reference/api/catalog-groups/delete_cataloggroup","metadata":{"seo":{"title":"Delete a catalog group","description":"Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_CatalogGroup","name":"Delete a catalog group","isWebhook":false,"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a catalog group","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":"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 is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"Deletes a catalog group."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"catalog-group-key","in":"path","schemaId":"schema_5","description":"The unique number or ID of the catalog group to be deleted.\n","required":true}],"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/catalog-groups/{catalog-group-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"catalog-group-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/catalog-groups/{catalog-group-key}","href":"catalog-groups/delete_cataloggroup","openApiOperationId":"DELETE_CatalogGroup","summary":"Delete a catalog group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalog-groups/delete_cataloggroup"}],"panels":[]}]},"httpPath":"/v1/catalog-groups/{catalog-group-key}"}],"content":{"contentType":"group","meta":{"name":"Catalog Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Catalog Groups","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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 APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see our latest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/tag/Commerce/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce API"},"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 catalog group is used to group a list of product rate plans with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a specific grade."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/catalog-groups","summary":"Create a catalog group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/catalog-groups/post_createcataloggroup","deprecated":false},{"title":"/v1/catalog-groups","summary":"List all catalog groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog-groups/get_listallcataloggroups","deprecated":false},{"title":"/v1/catalog-groups/{catalog-group-key}","summary":"Retrieve a catalog group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalog-groups/get_retrievecataloggroup","deprecated":false},{"title":"/v1/catalog-groups/{catalog-group-key}","summary":"Update a catalog group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/catalog-groups/put_updatecataloggroup","deprecated":false},{"title":"/v1/catalog-groups/{catalog-group-key}","summary":"Delete a catalog group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/catalog-groups/delete_cataloggroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Rate Plans","link":"/v1-api-reference/api/product-rate-plans","routeSlug":"/v1-api-reference/api/product-rate-plans","items":[{"label":"List all product rate plans of a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/get_productrateplans","routeSlug":"/v1-api-reference/api/product-rate-plans/get_productrateplans","metadata":{"seo":{"title":"List all product rate plans of a product","description":"Retrieves information about all product rate plans of a specific product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ProductRatePlans","name":"List all product rate plans of a product","isWebhook":false,"pointer":"/paths/~1v1~1products~1{product-key}~1product-rate-plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all product rate plans of a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves information about all product rate plans of a specific product.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product-key","in":"path","schemaId":"schema_5","description":"The unique ID or SKU of a product. For example, 2c92c0f96487e16a016487f663c71a61 or SKU-00000987.\n","required":true}],"pointer":"/paths/~1v1~1products~1{product-key}~1product-rate-plans/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index number of the page that you want to retrieve. This parameter is dependent on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before specifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 21st to 40th records are returned in the response."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_29","description":"The number of records returned per page in the response.\n"},{"name":"show-charge-definitions","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include the product charge definitions of this rate plan in the response."},"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 parameter is applicable only if the Attribute Based Pricing feature is enabled. To access this feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1products~1{product-key}~1product-rate-plans/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1products~1{product-key}~1product-rate-plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/products/{product-key}/product-rate-plans","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"product-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_28"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_29"},{"name":"show-charge-definitions","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/products/{product-key}/product-rate-plans","href":"product-rate-plans/get_productrateplans","openApiOperationId":"GET_ProductRatePlans","summary":"List all product rate plans of a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlansResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductRatePlansResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductRatePlansResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlansResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plans/get_productrateplans"}],"panels":[]}]},"httpPath":"/v1/products/{product-key}/product-rate-plans"},{"label":"Retrieve a product rate plan by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/get_productrateplan","routeSlug":"/v1-api-reference/api/product-rate-plans/get_productrateplan","metadata":{"seo":{"title":"Retrieve a product rate plan by ID","description":"Retrieves a product rate plan by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ProductRatePlan","name":"Retrieve a product rate plan by ID","isWebhook":false,"pointer":"/paths/~1v1~1product-rate-plans~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product rate plan by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a product rate plan by its ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID, external ID, or the natural key of the product rate plan to be retrieved. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402888e67f8b3a68017f8bbb2a06062d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Apple0001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRP-00000008"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1product-rate-plans~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-rate-plans~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/product-rate-plans/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/product-rate-plans/{id}","href":"product-rate-plans/get_productrateplan","openApiOperationId":"GET_ProductRatePlan","summary":"Retrieve a product rate plan by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlanWithExternalIdResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductRatePlanWithExternalIdResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-rate-plans~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductRatePlanWithExternalIdResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlanWithExternalIdResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rate-plans~1{id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plans/get_productrateplan"}],"panels":[]}]},"httpPath":"/v1/product-rate-plans/{id}"},{"label":"List product rate plans by external ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/get_productrateplansbyexternalid","routeSlug":"/v1-api-reference/api/product-rate-plans/get_productrateplansbyexternalid","metadata":{"seo":{"title":"List product rate plans by external ID","description":"Retrieves information about one or multiple product rate plans by external ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ProductRatePlansByExternalID","name":"List product rate plans by external ID","isWebhook":false,"pointer":"/paths/~1v1~1product-rate-plans~1external-id~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product rate plans by external ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves information about one or multiple product rate plans by external ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external ID of the product rate plan to be retrieved. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Apple0001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1product-rate-plans~1external-id~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-rate-plans~1external-id~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/product-rate-plans/external-id/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/product-rate-plans/external-id/{id}","href":"product-rate-plans/get_productrateplansbyexternalid","openApiOperationId":"GET_ProductRatePlansByExternalID","summary":"List product rate plans by external ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlanWithExternalIdMultiResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductRatePlanWithExternalIdMultiResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductRatePlanWithExternalIdMultiResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlanWithExternalIdMultiResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plans/get_productrateplansbyexternalid"}],"panels":[]}]},"httpPath":"/v1/product-rate-plans/external-id/{id}"},{"label":"CRUD: Create a product rate plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/object_postproductrateplan","routeSlug":"/v1-api-reference/api/product-rate-plans/object_postproductrateplan","metadata":{"seo":{"title":"CRUD: Create a product rate plan","description":"Retrieves a product rate plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_POSTProductRatePlan","name":"CRUD: Create a product rate plan","isWebhook":false,"pointer":"/paths/~1v1~1object~1product-rate-plan/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Create a product rate plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a product rate plan.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyCreateProductRatePlan"}},"schemaId":"components/schemas/ProxyCreateProductRatePlan","pointer":"/paths/~1v1~1object~1product-rate-plan/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/object/product-rate-plan","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyCreateProductRatePlan"}},"responseCodes":["200","400","401"],"pointer":"/v1/object/product-rate-plan","href":"product-rate-plans/object_postproductrateplan","openApiOperationId":"Object_POSTProductRatePlan","summary":"CRUD: Create a product rate plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyCreateProductRatePlan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyCreateProductRatePlan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/400/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1product-rate-plan/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyBadRequestResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plans/object_postproductrateplan"}],"panels":[]}]},"httpPath":"/v1/object/product-rate-plan"},{"label":"CRUD: Retrieve a product rate plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/object_getproductrateplan","routeSlug":"/v1-api-reference/api/product-rate-plans/object_getproductrateplan","metadata":{"seo":{"title":"CRUD: Retrieve a product rate plan","description":"Retrieves a product rate plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_GETProductRatePlan","name":"CRUD: Retrieve a product rate plan","isWebhook":false,"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Retrieve a product rate plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a product rate plan.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_5","description":"Object fields to return"}],"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/object/product-rate-plan/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v1/object/product-rate-plan/{id}","href":"product-rate-plans/object_getproductrateplan","openApiOperationId":"Object_GETProductRatePlan","summary":"CRUD: Retrieve a product rate plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetProductRatePlan","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyGetProductRatePlan","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyGetProductRatePlan","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetProductRatePlan","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plans/object_getproductrateplan"}],"panels":[]}]},"httpPath":"/v1/object/product-rate-plan/{id}"},{"label":"CRUD: Update a product rate plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/object_putproductrateplan","routeSlug":"/v1-api-reference/api/product-rate-plans/object_putproductrateplan","metadata":{"seo":{"title":"CRUD: Update a product rate plan","description":"Updates a product rate plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_PUTProductRatePlan","name":"CRUD: Update a product rate plan","isWebhook":false,"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Update a product rate plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a product rate plan.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan~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/ProxyModifyProductRatePlan"}},"schemaId":"components/schemas/ProxyModifyProductRatePlan","pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/object/product-rate-plan/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyModifyProductRatePlan"}},"responseCodes":["200","401"],"pointer":"/v1/object/product-rate-plan/{id}","href":"product-rate-plans/object_putproductrateplan","openApiOperationId":"Object_PUTProductRatePlan","summary":"CRUD: Update a product rate plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyModifyProductRatePlan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyModifyProductRatePlan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plans/object_putproductrateplan"}],"panels":[]}]},"httpPath":"/v1/object/product-rate-plan/{id}"},{"label":"CRUD: Delete a product rate plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plans/object_deleteproductrateplan","routeSlug":"/v1-api-reference/api/product-rate-plans/object_deleteproductrateplan","metadata":{"seo":{"title":"CRUD: Delete a product rate plan","description":"Deletes a product rate plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_DELETEProductRatePlan","name":"CRUD: Delete a product rate plan","isWebhook":false,"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Delete a product rate plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a product rate plan.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/object/product-rate-plan/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v1/object/product-rate-plan/{id}","href":"product-rate-plans/object_deleteproductrateplan","openApiOperationId":"Object_DELETEProductRatePlan","summary":"CRUD: Delete a product rate plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plans/object_deleteproductrateplan"}],"panels":[]}]},"httpPath":"/v1/object/product-rate-plan/{id}"}],"content":{"contentType":"group","meta":{"name":"Product Rate Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Rate Plans","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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 APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see our latest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/tag/Commerce/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce API"},"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 product rate plan is the part of a product that your customers subscribe"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to. Each product can have multiple product rate plans, and each product rate plan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can have multiple product rate plan charges, which are fees for products and their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product rate plans."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/products/{product-key}/product-rate-plans","summary":"List all product rate plans of a product","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-rate-plans/get_productrateplans","deprecated":false},{"title":"/v1/product-rate-plans/{id}","summary":"Retrieve a product rate plan by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-rate-plans/get_productrateplan","deprecated":false},{"title":"/v1/product-rate-plans/external-id/{id}","summary":"List product rate plans by external ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-rate-plans/get_productrateplansbyexternalid","deprecated":false},{"title":"/v1/object/product-rate-plan","summary":"CRUD: Create a product rate plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-rate-plans/object_postproductrateplan","deprecated":false},{"title":"/v1/object/product-rate-plan/{id}","summary":"CRUD: Retrieve a product rate plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-rate-plans/object_getproductrateplan","deprecated":false},{"title":"/v1/object/product-rate-plan/{id}","summary":"CRUD: Update a product rate plan","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-rate-plans/object_putproductrateplan","deprecated":false},{"title":"/v1/object/product-rate-plan/{id}","summary":"CRUD: Delete a product rate plan","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-rate-plans/object_deleteproductrateplan","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Rate Plan Definitions","link":"/v1-api-reference/api/product-rate-plan-definitions","routeSlug":"/v1-api-reference/api/product-rate-plan-definitions","items":[{"label":"Create a product rate plan definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-definitions/post_createproductrateplandefinition","routeSlug":"/v1-api-reference/api/product-rate-plan-definitions/post_createproductrateplandefinition","metadata":{"seo":{"title":"Create a product rate plan definition","description":"Creates a product rate plan definition to use a charge in a product rate plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateProductRatePlanDefinition","name":"Create a product rate plan definition","isWebhook":false,"pointer":"/paths/~1v1~1product-rateplan-definitions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a product rate plan definition","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 product rate plan definition to use a charge in a product rate plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the request, you must specify either the unique ID or number of both the charge and the product rate plan to add the specified charge to a specific rate plan."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-rateplan-definitions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTRatePlanDefinitionRequest"}},"schemaId":"components/schemas/POSTRatePlanDefinitionRequest","pointer":"/paths/~1v1~1product-rateplan-definitions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/product-rateplan-definitions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTRatePlanDefinitionRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/product-rateplan-definitions","href":"product-rate-plan-definitions/post_createproductrateplandefinition","openApiOperationId":"POST_CreateProductRatePlanDefinition","summary":"Create a product rate plan definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTRatePlanDefinitionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTRatePlanDefinitionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTRatePlanDefinitionResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTRatePlanDefinitionResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-rateplan-definitions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTRatePlanDefinitionResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTRatePlanDefinitionResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-definitions/post_createproductrateplandefinition"}],"panels":[]}]},"httpPath":"/v1/product-rateplan-definitions"},{"label":"List product rate plan definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-definitions/get_retrieveproductrateplandefinitions","routeSlug":"/v1-api-reference/api/product-rate-plan-definitions/get_retrieveproductrateplandefinitions","metadata":{"seo":{"title":"List product rate plan definitions","description":"Retrieves basic information about the product rate plan definitions for a product rate plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RetrieveProductRatePlanDefinitions","name":"List product rate plan definitions","isWebhook":false,"pointer":"/paths/~1v1~1product-rateplan-definitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product rate plan definitions","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 basic information about the product rate plan definitions for a product rate plan."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"charge","in":"query","schemaId":"schema_5","description":"The unique number or ID of the charge for which the product rate plan definitions are to be retrieved.\n"},{"name":"rateplan","in":"query","schemaId":"schema_5","description":"The unique number or ID of the product rate plan for which the product rate plan definitions are to be retrieved.\n"}],"pointer":"/paths/~1v1~1product-rateplan-definitions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-rateplan-definitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/product-rateplan-definitions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"charge","in":"query","required":false,"schemaId":"schema_5"},{"name":"rateplan","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/product-rateplan-definitions","href":"product-rate-plan-definitions/get_retrieveproductrateplandefinitions","openApiOperationId":"GET_RetrieveProductRatePlanDefinitions","summary":"List product rate plan definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlanDefinitionsResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductRatePlanDefinitionsResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-rateplan-definitions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductRatePlanDefinitionsResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlanDefinitionsResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-definitions/get_retrieveproductrateplandefinitions"}],"panels":[]}]},"httpPath":"/v1/product-rateplan-definitions"},{"label":"Retrieve a product rate plan definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-definitions/get_retrieveproductrateplandefinition","routeSlug":"/v1-api-reference/api/product-rate-plan-definitions/get_retrieveproductrateplandefinition","metadata":{"seo":{"title":"Retrieve a product rate plan definition","description":"Retrieves basic information about a product rate plan definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RetrieveProductRatePlanDefinition","name":"Retrieve a product rate plan definition","isWebhook":false,"pointer":"/paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product rate plan definition","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 basic information about a product rate plan definition."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product-rateplan-definition-key","in":"path","schemaId":"schema_5","description":"The unique ID of the product rate plan definition to be retrieved.\n","required":true}],"pointer":"/paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/product-rateplan-definitions/{product-rateplan-definition-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"product-rateplan-definition-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/product-rateplan-definitions/{product-rateplan-definition-key}","href":"product-rate-plan-definitions/get_retrieveproductrateplandefinition","openApiOperationId":"GET_RetrieveProductRatePlanDefinition","summary":"Retrieve a product rate plan definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlanDefinitionResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductRatePlanDefinitionResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductRatePlanDefinitionResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlanDefinitionResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-definitions/get_retrieveproductrateplandefinition"}],"panels":[]}]},"httpPath":"/v1/product-rateplan-definitions/{product-rateplan-definition-key}"},{"label":"Delete a product rate plan definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-definitions/delete_productrateplandefnition","routeSlug":"/v1-api-reference/api/product-rate-plan-definitions/delete_productrateplandefnition","metadata":{"seo":{"title":"Delete a product rate plan definition","description":"Deletes a product rate plan definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_ProductRatePlanDefnition","name":"Delete a product rate plan definition","isWebhook":false,"pointer":"/paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a product rate plan definition","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 product rate plan definition."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product-rateplan-definition-key","in":"path","schemaId":"schema_5","description":"The unique ID of the product rate plan definition to be deleted.\n","required":true}],"pointer":"/paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/product-rateplan-definitions/{product-rateplan-definition-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"product-rateplan-definition-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/product-rateplan-definitions/{product-rateplan-definition-key}","href":"product-rate-plan-definitions/delete_productrateplandefnition","openApiOperationId":"DELETE_ProductRatePlanDefnition","summary":"Delete a product rate plan definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-definitions/delete_productrateplandefnition"}],"panels":[]}]},"httpPath":"/v1/product-rateplan-definitions/{product-rateplan-definition-key}"}],"content":{"contentType":"group","meta":{"name":"Product Rate Plan Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Rate Plan Definitions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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 APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see our latest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/tag/Commerce/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce API"},"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 product rate plan definitions to reuse charges in different product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate plans. The Product Rate Plan Definition object is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phase. We are actively soliciting feedback from a small set of early adopters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before releasing it as generally available. If you are interested, please reach"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out to your CSM."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/product-rateplan-definitions","summary":"Create a product rate plan definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-rate-plan-definitions/post_createproductrateplandefinition","deprecated":false},{"title":"/v1/product-rateplan-definitions","summary":"List product rate plan definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-rate-plan-definitions/get_retrieveproductrateplandefinitions","deprecated":false},{"title":"/v1/product-rateplan-definitions/{product-rateplan-definition-key}","summary":"Retrieve a product rate plan definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-rate-plan-definitions/get_retrieveproductrateplandefinition","deprecated":false},{"title":"/v1/product-rateplan-definitions/{product-rateplan-definition-key}","summary":"Delete a product rate plan definition","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-rate-plan-definitions/delete_productrateplandefnition","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Rate Plan Charges","link":"/v1-api-reference/api/product-rate-plan-charges","routeSlug":"/v1-api-reference/api/product-rate-plan-charges","items":[{"label":"Retrieve a product rate plan charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charges/get_retrieveproductrateplancharge","routeSlug":"/v1-api-reference/api/product-rate-plan-charges/get_retrieveproductrateplancharge","metadata":{"seo":{"title":"Retrieve a product rate plan charge","description":"Retrieves basic information about a product rate plan charge."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RetrieveProductRatePlanCharge","name":"Retrieve a product rate plan charge","isWebhook":false,"pointer":"/paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product rate plan charge","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 basic information about a product rate plan charge."},"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":": A request header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product-rate-plan-charge-key","in":"path","schemaId":"schema_5","description":"The unique number or ID of the product rate plan charge to be retrieved.\n","required":true}],"pointer":"/paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"show-charge-definitions","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include the product charge definitions of this charge in the response."},"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 parameter is applicable only if the Attribute-based Pricing feature is enabled. The Attribute-based Pricing feature in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We are actively soliciting feedback from a small set of early adopters. If you are interested, please reach out to your CSM."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/product-rate-plan-charges/{product-rate-plan-charge-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"product-rate-plan-charge-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"show-charge-definitions","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/product-rate-plan-charges/{product-rate-plan-charge-key}","href":"product-rate-plan-charges/get_retrieveproductrateplancharge","openApiOperationId":"GET_RetrieveProductRatePlanCharge","summary":"Retrieve a product rate plan charge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlanChargeResponse","exampleIds":["paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductRatePlanChargeResponse","exampleIds":["paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion."},"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://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot\ncontrol the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_390"}],"pointer":"/paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductRatePlanChargeResponse","exampleIds":["paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductRatePlanChargeResponse","exampleIds":["paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-charges/get_retrieveproductrateplancharge"}],"panels":[]}]},"httpPath":"/v1/product-rate-plan-charges/{product-rate-plan-charge-key}"},{"label":"CRUD: Create a product rate plan charge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charges/object_postproductrateplancharge","routeSlug":"/v1-api-reference/api/product-rate-plan-charges/object_postproductrateplancharge","metadata":{"seo":{"title":"CRUD: Create a product rate plan charge","description":"Creates a product rate plan charge for a specified rate plan charge.Product rate plan charges can be of three types, one-time fees, recurring fees, and usage fees."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_POSTProductRatePlanCharge","name":"CRUD: Create a product rate plan charge","isWebhook":false,"pointer":"/paths/~1v1~1object~1product-rate-plan-charge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Create a product rate plan charge","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 product rate plan charge for a specified rate plan charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product rate plan charges can be of three types, one-time fees, recurring fees, and usage fees."},"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":": To use the enhanced unit-based Prepaid with Drawdown fields, set the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to a value greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyCreateProductRatePlanCharge","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/valid_per_specific_months","paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/prepaid_charge"]}},"schemaId":"components/schemas/ProxyCreateProductRatePlanCharge","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/valid_per_specific_months","paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/prepaid_charge"],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/object/product-rate-plan-charge","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyCreateProductRatePlanCharge","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/valid_per_specific_months","paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/prepaid_charge"]}},"responseCodes":["200","401"],"pointer":"/v1/object/product-rate-plan-charge","href":"product-rate-plan-charges/object_postproductrateplancharge","openApiOperationId":"Object_POSTProductRatePlanCharge","summary":"CRUD: Create a product rate plan charge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyCreateProductRatePlanCharge","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/valid_per_specific_months","paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/prepaid_charge"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyCreateProductRatePlanCharge","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/valid_per_specific_months","paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/prepaid_charge"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge/post/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-charges/object_postproductrateplancharge"}],"panels":[]}]},"httpPath":"/v1/object/product-rate-plan-charge"},{"label":"CRUD: Retrieve a product rate plan charge","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charges/object_getproductrateplancharge","routeSlug":"/v1-api-reference/api/product-rate-plan-charges/object_getproductrateplancharge","metadata":{"seo":{"title":"CRUD: Retrieve a product rate plan charge","description":"Retrieves a specific product rate plan charge.Note: To use the enhanced unit-based Prepaid with Drawdown fields, set theX-Zuora-WSDL-Version request header to a value greater than 155.0."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_GETProductRatePlanCharge","name":"CRUD: Retrieve a product rate plan charge","isWebhook":false,"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Retrieve a product rate plan charge","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 specific product rate plan charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":": To use the enhanced unit-based Prepaid with Drawdown fields, set the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to a value greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19.\n","required":true}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_5","description":"Object fields to return"}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/object/product-rate-plan-charge/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v1/object/product-rate-plan-charge/{id}","href":"product-rate-plan-charges/object_getproductrateplancharge","openApiOperationId":"Object_GETProductRatePlanCharge","summary":"CRUD: Retrieve a product rate plan charge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetProductRatePlanCharge","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyGetProductRatePlanCharge","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyGetProductRatePlanCharge","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetProductRatePlanCharge","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-charges/object_getproductrateplancharge"}],"panels":[]}]},"httpPath":"/v1/object/product-rate-plan-charge/{id}"},{"label":"CRUD: Update a product rate plan charge","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charges/object_putproductrateplancharge","routeSlug":"/v1-api-reference/api/product-rate-plan-charges/object_putproductrateplancharge","metadata":{"seo":{"title":"CRUD: Update a product rate plan charge","description":"Updates the information about a product rate plan charge."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_PUTProductRatePlanCharge","name":"CRUD: Update a product rate plan charge","isWebhook":false,"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Update a product rate plan charge","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 information about a product rate plan charge."},"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":": To use the enhanced unit-based Prepaid with Drawdown fields, set the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to a value greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The unique ID of the product rate plan charge to be updated. For example, 2c93808457d787030157e031fcd34e19.\n","required":true}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"X-Zuora-WSDL-Version","in":"header","schemaId":"schema_46","description":"Zuora WSDL version number.\n"},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~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/ProxyModifyProductRatePlanCharge"}},"schemaId":"components/schemas/ProxyModifyProductRatePlanCharge","pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/object/product-rate-plan-charge/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"X-Zuora-WSDL-Version","in":"header","required":false,"schemaId":"schema_46"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyModifyProductRatePlanCharge"}},"responseCodes":["200","401","404"],"pointer":"/v1/object/product-rate-plan-charge/{id}","href":"product-rate-plan-charges/object_putproductrateplancharge","openApiOperationId":"Object_PUTProductRatePlanCharge","summary":"CRUD: Update a product rate plan charge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyModifyProductRatePlanCharge","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyModifyProductRatePlanCharge"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-charges/object_putproductrateplancharge"}],"panels":[]}]},"httpPath":"/v1/object/product-rate-plan-charge/{id}"},{"label":"CRUD: Delete a product rate plan charge","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charges/object_deleteproductrateplancharge","routeSlug":"/v1-api-reference/api/product-rate-plan-charges/object_deleteproductrateplancharge","metadata":{"seo":{"title":"CRUD: Delete a product rate plan charge","description":"Deletes a product rate plan charge."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_DELETEProductRatePlanCharge","name":"CRUD: Delete a product rate plan charge","isWebhook":false,"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Delete a product rate plan charge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a product rate plan charge.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The unique ID of the product rate plan charge to be deleted. For example, 2c93808457d787030157e031fcd34e19.\n","required":true}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/object/product-rate-plan-charge/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v1/object/product-rate-plan-charge/{id}","href":"product-rate-plan-charges/object_deleteproductrateplancharge","openApiOperationId":"Object_DELETEProductRatePlanCharge","summary":"CRUD: Delete a product rate plan charge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyDeleteResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-charges/object_deleteproductrateplancharge"}],"panels":[]}]},"httpPath":"/v1/object/product-rate-plan-charge/{id}"}],"content":{"contentType":"group","meta":{"name":"Product Rate Plan Charges"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Rate Plan Charges","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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 APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see our latest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/tag/Commerce/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce API"},"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 product rate plan charge represents a charge model or a set of fees"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated with a product rate plan, which is the part of a product that your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customers subscribe to. Each product rate plan can have multiple product rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product rate plan charges can be of three types: one-time fees, recurring fees,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and usage fees. For example, the $50 activation fee for the Topaz product rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan is a one-time product rate plan charge."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/product-rate-plan-charges/{product-rate-plan-charge-key}","summary":"Retrieve a product rate plan charge","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-rate-plan-charges/get_retrieveproductrateplancharge","deprecated":false},{"title":"/v1/object/product-rate-plan-charge","summary":"CRUD: Create a product rate plan charge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-rate-plan-charges/object_postproductrateplancharge","deprecated":false},{"title":"/v1/object/product-rate-plan-charge/{id}","summary":"CRUD: Retrieve a product rate plan charge","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-rate-plan-charges/object_getproductrateplancharge","deprecated":false},{"title":"/v1/object/product-rate-plan-charge/{id}","summary":"CRUD: Update a product rate plan charge","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-rate-plan-charges/object_putproductrateplancharge","deprecated":false},{"title":"/v1/object/product-rate-plan-charge/{id}","summary":"CRUD: Delete a product rate plan charge","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-rate-plan-charges/object_deleteproductrateplancharge","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Charge Definitions","link":"/v1-api-reference/api/product-charge-definitions","routeSlug":"/v1-api-reference/api/product-charge-definitions","items":[{"label":"Create a product charge definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/post_createproductchargedefinition","routeSlug":"/v1-api-reference/api/product-charge-definitions/post_createproductchargedefinition","metadata":{"seo":{"title":"Create a product charge definition","description":"Creates a product charge definition for a charge. You can create as many product charge definitions as needed for one charge."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateProductChargeDefinition","name":"Create a product charge definition","isWebhook":false,"pointer":"/paths/~1v1~1product-charge-definitions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a product charge definition","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 product charge definition for a charge. You can create as many product charge definitions as needed for one charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the request, you must specify the unique ID or number of the charge for which this charge definition is to be created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID or number of a product rate plan is optional."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-charge-definitions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTChargeDefinitionRequest"}},"schemaId":"components/schemas/POSTChargeDefinitionRequest","pointer":"/paths/~1v1~1product-charge-definitions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/product-charge-definitions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTChargeDefinitionRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/product-charge-definitions","href":"product-charge-definitions/post_createproductchargedefinition","openApiOperationId":"POST_CreateProductChargeDefinition","summary":"Create a product charge definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTChargeDefinitionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTChargeDefinitionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-charge-definitions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-charge-definitions/post_createproductchargedefinition"}],"panels":[]}]},"httpPath":"/v1/product-charge-definitions"},{"label":"List product charge definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/get_retrieveproductchargedefinitions","routeSlug":"/v1-api-reference/api/product-charge-definitions/get_retrieveproductchargedefinitions","metadata":{"seo":{"title":"List product charge definitions","description":"Retrieves basic information about the product charge definitions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RetrieveProductChargeDefinitions","name":"List product charge definitions","isWebhook":false,"pointer":"/paths/~1v1~1product-charge-definitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product charge definitions","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 basic information about the product charge definitions."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"charge","in":"query","schemaId":"schema_5","description":"The unique number or ID of the charge for which the product charge definitions are to be retrieved.\n"},{"name":"rateplan","in":"query","schemaId":"schema_5","description":"The unique number or ID of the product rate plan for which the product charge definitions are to be retrieved.\n"},{"name":"hide-inherited-values","in":"query","schemaId":"schema_27","description":"The flag that controls whether the response will merge the default charge definition fields for those fields that are not overridden.\n"}],"pointer":"/paths/~1v1~1product-charge-definitions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-charge-definitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/product-charge-definitions","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[{"name":"charge","in":"query","required":false,"schemaId":"schema_5"},{"name":"rateplan","in":"query","required":false,"schemaId":"schema_5"},{"name":"hide-inherited-values","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/product-charge-definitions","href":"product-charge-definitions/get_retrieveproductchargedefinitions","openApiOperationId":"GET_RetrieveProductChargeDefinitions","summary":"List product charge definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductChargeDefinitionsResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductChargeDefinitionsResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-charge-definitions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductChargeDefinitionsResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductChargeDefinitionsResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-charge-definitions/get_retrieveproductchargedefinitions"}],"panels":[]}]},"httpPath":"/v1/product-charge-definitions"},{"label":"Create product charge definitions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/post_createproductchargedefinitionbulk","routeSlug":"/v1-api-reference/api/product-charge-definitions/post_createproductchargedefinitionbulk","metadata":{"seo":{"title":"Create product charge definitions","description":"Bulk creates product charge definitions for a charge. You can create up to 1000 product charge definitions at a given time for a specific charge."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_CreateProductChargeDefinitionBulk","name":"Create product charge definitions","isWebhook":false,"pointer":"/paths/~1v1~1product-charge-definitions~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create product charge definitions","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":"Bulk creates product charge definitions for a charge. You can create up to 1000 product charge definitions at a given time for a specific charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the request, you must specify the unique ID or number of the charge for which this charge definition is to be created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID or number of a product rate plan is optional."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_4","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-charge-definitions~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTChargeDefinitionRequestBulk"}},"schemaId":"components/schemas/POSTChargeDefinitionRequestBulk","pointer":"/paths/~1v1~1product-charge-definitions~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/product-charge-definitions/bulk","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_4"},{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/POSTChargeDefinitionRequestBulk"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/product-charge-definitions/bulk","href":"product-charge-definitions/post_createproductchargedefinitionbulk","openApiOperationId":"POST_CreateProductChargeDefinitionBulk","summary":"Create product charge definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/POSTChargeDefinitionRequestBulk","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/POSTChargeDefinitionRequestBulk"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTChargeDefinitionBulkResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/POSTChargeDefinitionBulkResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-charge-definitions~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/POSTChargeDefinitionBulkResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/POSTChargeDefinitionBulkResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/post/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-charge-definitions/post_createproductchargedefinitionbulk"}],"panels":[]}]},"httpPath":"/v1/product-charge-definitions/bulk"},{"label":"Update product charge definitions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/put_updateproductchargedefinitionbulk","routeSlug":"/v1-api-reference/api/product-charge-definitions/put_updateproductchargedefinitionbulk","metadata":{"seo":{"title":"Update product charge definitions","description":"Bulk updates multiple product charge definitions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateProductChargeDefinitionBulk","name":"Update product charge definitions","isWebhook":false,"pointer":"/paths/~1v1~1product-charge-definitions~1bulk/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update product charge definitions","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":"Bulk updates multiple product charge definitions."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-charge-definitions~1bulk/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTProductChargeDefinitionBulkRequest"}},"schemaId":"components/schemas/PUTProductChargeDefinitionBulkRequest","pointer":"/paths/~1v1~1product-charge-definitions~1bulk/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/product-charge-definitions/bulk","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTProductChargeDefinitionBulkRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/product-charge-definitions/bulk","href":"product-charge-definitions/put_updateproductchargedefinitionbulk","openApiOperationId":"PUT_UpdateProductChargeDefinitionBulk","summary":"Update product charge definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTProductChargeDefinitionBulkRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTProductChargeDefinitionBulkRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductChargeDefinitionsResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductChargeDefinitionsResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-charge-definitions~1bulk/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductChargeDefinitionsResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductChargeDefinitionsResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1bulk/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-charge-definitions/put_updateproductchargedefinitionbulk"}],"panels":[]}]},"httpPath":"/v1/product-charge-definitions/bulk"},{"label":"Retrieve a product charge definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/get_retrieveproductchargedefinition","routeSlug":"/v1-api-reference/api/product-charge-definitions/get_retrieveproductchargedefinition","metadata":{"seo":{"title":"Retrieve a product charge definition","description":"Retrieves basic information about a product charge definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RetrieveProductChargeDefinition","name":"Retrieve a product charge definition","isWebhook":false,"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product charge definition","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 basic information about a product charge definition."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product-charge-definition-key","in":"path","schemaId":"schema_5","description":"The unique number or ID of the product charge definition to be retrieved.\n","required":true}],"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"hide-inherited-values","in":"query","schemaId":"schema_27","description":"The flag that controls whether the response will merge the default charge definition fields for those fields that are not overridden.\n"}],"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/product-charge-definitions/{product-charge-definition-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"product-charge-definition-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"hide-inherited-values","in":"query","required":false,"schemaId":"schema_27"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/product-charge-definitions/{product-charge-definition-key}","href":"product-charge-definitions/get_retrieveproductchargedefinition","openApiOperationId":"GET_RetrieveProductChargeDefinition","summary":"Retrieve a product charge definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-charge-definitions/get_retrieveproductchargedefinition"}],"panels":[]}]},"httpPath":"/v1/product-charge-definitions/{product-charge-definition-key}"},{"label":"Update a product charge definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/put_updateproductchargedefinition","routeSlug":"/v1-api-reference/api/product-charge-definitions/put_updateproductchargedefinition","metadata":{"seo":{"title":"Update a product charge definition","description":"Update a product charge definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_UpdateProductChargeDefinition","name":"Update a product charge definition","isWebhook":false,"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a product charge definition","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":"Update a product charge definition."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product-charge-definition-key","in":"path","schemaId":"schema_5","description":"The unique number or ID of the product charge definition to be updated.\n","required":true}],"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTProductChargeDefinitionRequest"}},"schemaId":"components/schemas/PUTProductChargeDefinitionRequest","pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/product-charge-definitions/{product-charge-definition-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"product-charge-definition-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PUTProductChargeDefinitionRequest"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/product-charge-definitions/{product-charge-definition-key}","href":"product-charge-definitions/put_updateproductchargedefinition","openApiOperationId":"PUT_UpdateProductChargeDefinition","summary":"Update a product charge definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/PUTProductChargeDefinitionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PUTProductChargeDefinitionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/GETProductChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GETProductChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GETProductChargeDefinitionResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-charge-definitions/put_updateproductchargedefinition"}],"panels":[]}]},"httpPath":"/v1/product-charge-definitions/{product-charge-definition-key}"},{"label":"Delete a product charge definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-charge-definitions/delete_productchargedefnition","routeSlug":"/v1-api-reference/api/product-charge-definitions/delete_productchargedefnition","metadata":{"seo":{"title":"Delete a product charge definition","description":"Deletes a product charge definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_ProductChargeDefnition","name":"Delete a product charge definition","isWebhook":false,"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a product charge definition","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 product charge definition."},"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled, which is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product-charge-definition-key","in":"path","schemaId":"schema_5","description":"The unique number or ID of the product charge definition to be deleted.\n","required":true}],"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/product-charge-definitions/{product-charge-definition-key}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"product-charge-definition-key","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","500","4XX"],"pointer":"/v1/product-charge-definitions/{product-charge-definition-key}","href":"product-charge-definitions/delete_productchargedefnition","openApiOperationId":"DELETE_ProductChargeDefnition","summary":"Delete a product charge definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-charge-definitions/delete_productchargedefnition"}],"panels":[]}]},"httpPath":"/v1/product-charge-definitions/{product-charge-definition-key}"}],"content":{"contentType":"group","meta":{"name":"Product Charge Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Charge Definitions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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 APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see our latest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/tag/Commerce/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce API"},"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 product charge definitions to define the attributes that can determine"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the charge behavior, such as billing attributes, pricing attributes, taxation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attributes, or accounting attributes.\\n\\nThe Product Charge Definition object"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a small set of early adopters before releasing it as generally available. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you are interested, please reach out to your CSM."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/product-charge-definitions","summary":"Create a product charge definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-charge-definitions/post_createproductchargedefinition","deprecated":false},{"title":"/v1/product-charge-definitions","summary":"List product charge definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-charge-definitions/get_retrieveproductchargedefinitions","deprecated":false},{"title":"/v1/product-charge-definitions/bulk","summary":"Create product charge definitions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-charge-definitions/post_createproductchargedefinitionbulk","deprecated":false},{"title":"/v1/product-charge-definitions/bulk","summary":"Update product charge definitions","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-charge-definitions/put_updateproductchargedefinitionbulk","deprecated":false},{"title":"/v1/product-charge-definitions/{product-charge-definition-key}","summary":"Retrieve a product charge definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-charge-definitions/get_retrieveproductchargedefinition","deprecated":false},{"title":"/v1/product-charge-definitions/{product-charge-definition-key}","summary":"Update a product charge definition","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-charge-definitions/put_updateproductchargedefinition","deprecated":false},{"title":"/v1/product-charge-definitions/{product-charge-definition-key}","summary":"Delete a product charge definition","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-charge-definitions/delete_productchargedefnition","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Rate Plan Charge Tiers","link":"/v1-api-reference/api/product-rate-plan-charge-tiers","routeSlug":"/v1-api-reference/api/product-rate-plan-charge-tiers","items":[{"label":"CRUD: Retrieve a product rate plan charge tier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charge-tiers/object_getproductrateplanchargetier","routeSlug":"/v1-api-reference/api/product-rate-plan-charge-tiers/object_getproductrateplanchargetier","metadata":{"seo":{"title":"CRUD: Retrieve a product rate plan charge tier","description":"Retrieves a specific product rate plan charge tier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_GETProductRatePlanChargeTier","name":"CRUD: Retrieve a product rate plan charge tier","isWebhook":false,"pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Retrieve a product rate plan charge tier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific product rate plan charge tier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"Object id","required":true}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_5","description":"Object fields to return"}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/object/product-rate-plan-charge-tier/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v1/object/product-rate-plan-charge-tier/{id}","href":"product-rate-plan-charge-tiers/object_getproductrateplanchargetier","openApiOperationId":"Object_GETProductRatePlanChargeTier","summary":"CRUD: Retrieve a product rate plan charge tier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetProductRatePlanChargeTier","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyGetProductRatePlanChargeTier","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/404/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/404/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyGetProductRatePlanChargeTier","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyGetProductRatePlanChargeTier","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/401/content/application~1json/examples/response"]}}},{"code":"404","schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/404/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyNoDataResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/404/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-charge-tiers/object_getproductrateplanchargetier"}],"panels":[]}]},"httpPath":"/v1/object/product-rate-plan-charge-tier/{id}"},{"label":"CRUD: Update a product rate plan charge tier","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/product-rate-plan-charge-tiers/object_putproductrateplanchargetier","routeSlug":"/v1-api-reference/api/product-rate-plan-charge-tiers/object_putproductrateplanchargetier","metadata":{"seo":{"title":"CRUD: Update a product rate plan charge tier","description":"Updates the price of a product rate plan charge tier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Object_PUTProductRatePlanChargeTier","name":"CRUD: Update a product rate plan charge tier","isWebhook":false,"pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CRUD: Update a product rate plan charge tier","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 price of a product rate plan charge tier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To make other updates to product rate plan charge tiers, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/Object_PUTProductRatePlanCharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRUD: Update a product rate plan charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanChargeTierData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The unique ID of the product rate plan charge tier to be updated. For example, 2c92c0f86c85891e016c88d55a6e543b.\n","required":true}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rejectUnknownFields","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the call fails if the request body contains unknown fields."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejectUnknownFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns a 400 response if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request body contains unknown fields. The body of the 400 response is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"Error - unrecognised fields\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora ignores unknown fields in the request body."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~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/ProxyModifyProductRatePlanChargeTier"}},"schemaId":"components/schemas/ProxyModifyProductRatePlanChargeTier","pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/object/product-rate-plan-charge-tier/{id}","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"rejectUnknownFields","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProxyModifyProductRatePlanChargeTier"}},"responseCodes":["200","401"],"pointer":"/v1/object/product-rate-plan-charge-tier/{id}","href":"product-rate-plan-charge-tiers/object_putproductrateplanchargetier","openApiOperationId":"Object_PUTProductRatePlanChargeTier","summary":"CRUD: Update a product rate plan charge tier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/ProxyModifyProductRatePlanChargeTier","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProxyModifyProductRatePlanChargeTier"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/401/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"WWW-Authenticate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}],"schema":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_12"}],"pointer":"/paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyCreateOrModifyResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProxyUnauthorizedResponse","exampleIds":["paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-rate-plan-charge-tiers/object_putproductrateplanchargetier"}],"panels":[]}]},"httpPath":"/v1/object/product-rate-plan-charge-tier/{id}"}],"content":{"contentType":"group","meta":{"name":"Product Rate Plan Charge Tiers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Rate Plan Charge Tiers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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 APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see our latest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/tag/Commerce/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce API"},"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 manage product rate plan charge tiers, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/tag/Product-Rate-Plan-Charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Rate Plan"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charges"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operations instead to update the corresponding product rate plan charge with all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the tiers."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/object/product-rate-plan-charge-tier/{id}","summary":"CRUD: Retrieve a product rate plan charge tier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-rate-plan-charge-tiers/object_getproductrateplanchargetier","deprecated":false},{"title":"/v1/object/product-rate-plan-charge-tier/{id}","summary":"CRUD: Update a product rate plan charge tier","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-rate-plan-charge-tiers/object_putproductrateplanchargetier","deprecated":false}]}]}]}]}},{"type":"group","label":"Zuora Revenue Integration","link":"/v1-api-reference/api/zuora-revenue-integration","routeSlug":"/v1-api-reference/api/zuora-revenue-integration","items":[{"label":"Update a Zuora Revenue accounting code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1-api-reference/api/zuora-revenue-integration/put_revproaccountingcodes","routeSlug":"/v1-api-reference/api/zuora-revenue-integration/put_revproaccountingcodes","metadata":{"seo":{"title":"Update a Zuora Revenue accounting code","description":"Update the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_RevProAccountingCodes","name":"Update a Zuora Revenue accounting code","isWebhook":false,"pointer":"/paths/~1v1~1revpro-accounting-codes/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Zuora Revenue accounting code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},{"name":"Content-Encoding","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload."},"children":[]}]}]}]},{"name":"Zuora-Entity-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entity ID. If you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-multi-entity-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header."},"children":[]}]}]}]},{"name":"Zuora-Org-Ids","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated IDs. If you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs."},"children":[]}]}]}]},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"Zuora-Version","in":"header","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minor API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a list of available minor versions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-upgrades/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API upgrades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1revpro-accounting-codes/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RevproAccountingCodes"}},"schemaId":"components/schemas/RevproAccountingCodes","pointer":"/paths/~1v1~1revpro-accounting-codes/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/revpro-accounting-codes","servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Content-Encoding","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Entity-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Org-Ids","in":"header","required":false,"schemaId":"schema_5"},{"name":"Zuora-Track-Id","in":"header","required":false,"schemaId":"schema_0"},{"name":"Zuora-Version","in":"header","required":false,"schemaId":"schema_5"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RevproAccountingCodes"}},"responseCodes":["200","500","4XX"],"pointer":"/v1/revpro-accounting-codes","href":"zuora-revenue-integration/put_revproaccountingcodes","openApiOperationId":"PUT_RevProAccountingCodes","summary":"Update a Zuora Revenue accounting code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"schemaId":"components/schemas/RevproAccountingCodes","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RevproAccountingCodes"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTRevproAccCodeResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/PUTRevproAccCodeResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/200/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n","schema":{"maxLength":36,"minLength":36,"type":"string"}},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"},"Concurrency-Limit-Type":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"},"Concurrency-Limit-Limit":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"},"Concurrency-Limit-Remaining":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"}},"headerSchemaId":"schema_11"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/500/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"},{"code":"4XX","description":"Request Errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/4XX/content/application~1json/examples/response"]}},"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/4XX/content/application~1json/examples/response"],"headers":{"Content-Encoding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}],"schema":{"type":"string"}},"RateLimit-Limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"string"}},"RateLimit-Remaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"RateLimit-Reset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"schema":{"type":"number"}},"Zuora-Request-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"},"Zuora-Track-Id":{"$ref":"#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1v1~1revpro-accounting-codes/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PUTRevproAccCodeResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PUTRevproAccCodeResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/200/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/500/content/application~1json/examples/response"]}}},{"code":"4XX","schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/4XX/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse","exampleIds":["paths/~1v1~1revpro-accounting-codes/put/responses/4XX/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/zuora-revenue-integration/put_revproaccountingcodes"}],"panels":[]}]},"httpPath":"/v1/revpro-accounting-codes"}],"content":{"contentType":"group","meta":{"name":"Zuora Revenue Integration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Zuora Revenue Integration","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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":" You can only use the operations in this section if you have the Billing - Revenue Integration feature enabled. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"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":"The APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead. For more information, see our latest "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/tag/Commerce/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commerce API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/revpro-accounting-codes","summary":"Update a Zuora Revenue accounting code","prefix":{"name":"put","color":"put"},"badges":[],"link":"/zuora-revenue-integration/put_revproaccountingcodes","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/TestEnvironmentResponse":{"id":"components/schemas/TestEnvironmentResponse","kind":"json-schema","title":"TestEnvironmentResponse","data":{"title":"TestEnvironmentResponse","type":"object","properties":{"createTime":{"type":"string","description":"The date and time when the Test Environment was first synced to self-service","format":"date-time"},"createdById":{"type":"string","description":"The automatically generated ID of the Zuora user who created the Test Environment object","example":"58f182ab203c447b8b9cd90382da030a"},"dataCopyType":{"type":"string","description":"The data copy approach for the Test Environment","enum":["FULL","CONFIGURATION"]},"deactivationTime":{"type":"string","description":"The date and time when the Test Environment will be deactivated","format":"date-time"},"environmentType":{"type":"string","description":"The type of tenant for the Test Environment","example":"ENTERPRISE","enum":["TEST","ENTERPRISE","TRIAL","DEMO","DEVELOPER"]},"id":{"type":"string","description":"The unique ID (UUID) of the Test Environment","example":"11111111-1111-1111-1111-111111111111"},"lastRefreshTime":{"type":"string","description":"The date and time when the Test Environment was last refreshed","format":"date-time"},"nextRefreshTime":{"type":"string","description":"The date and time when the Test Environment can be refreshed again","format":"date-time"},"provisionTime":{"type":"string","description":"The date and time when the Test Environment was provisioned","format":"date-time"},"revenueTenantId":{"type":"string","description":"The revenue tenant ID if a revenue sandbox is attached"},"revenueTenantName":{"type":"string","description":"The revenue tenant name if a revenue sandbox is attached"},"sourceTenantId":{"type":"string","description":"The source tenant ID from which the Test Environment was created","example":23223},"status":{"type":"string","description":"The current status of the Test Environment","example":"ACTIVE","enum":["ACTIVE","PROCESSING","INACTIVE","DEACTIVATED","DELETED"]},"tenantId":{"type":"string","description":"The tenant ID of the Test Environment","example":23223},"tenantName":{"type":"string","description":"The tenant name of the Test Environment"},"updateTime":{"type":"string","description":"The date and time when the Test Environment was last synced to self-service","format":"date-time"},"updatedById":{"type":"string","description":"The automatically generated ID of the Zuora user who updated the Test Environment object","example":"58f182ab203c447b8b9cd90382da030a"}},"description":"The response containing details about the Test Environment"}},"components/schemas/TestEnvironmentArrayResponse":{"id":"components/schemas/TestEnvironmentArrayResponse","kind":"json-schema","title":"ArrayResponse«TestEnvironmentResponse»","data":{"title":"ArrayResponse«TestEnvironmentResponse»","type":"object","properties":{"result":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/TestEnvironmentResponse"}},"size":{"type":"integer","format":"int32"}},"description":"Container for array of objects"}},"components/schemas/JobResponse":{"id":"components/schemas/JobResponse","kind":"json-schema","title":"JobResponse","data":{"title":"JobResponse","type":"object","properties":{"createTime":{"type":"string","description":"The date and time when the job was first synced to self service","format":"date-time"},"createdById":{"type":"string","description":"The automatically generated ID of the Zuora user who created the job object","example":"58f182ab203c447b8b9cd90382da030a"},"estimatedCompletionTime":{"type":"string","description":"The date and time when the job is estimated to be completed","format":"date-time"},"id":{"type":"string","description":"The unique ID (UUID) of the Test Environment job","example":"11111111-1111-1111-1111-111111111111"},"jobEndTime":{"type":"string","description":"The date and time when the job completed","format":"date-time"},"jobStartTime":{"type":"string","description":"The date and time when the job was started","format":"date-time"},"jobType":{"type":"string","description":"The type of Test Environment job being performed","example":"REFRESH","enum":["REFRESH","CREATE","DELETE"]},"progressPercentage":{"type":"integer","description":"The progress percentage of the job","format":"int32"},"scheduledRefreshTime":{"type":"string","description":"The optional date and time for scheduling a job","format":"date-time"},"status":{"type":"string","description":"The status of the Test Environment job","example":"QUEUED","enum":["NEW","SCHEDULED","QUEUED","INITIATED","PROVISIONING","DEPROVISIONING","EXPORTING","SCRUBBING","RESETTING","IMPORTING","FINALIZING","CANCELLING","COMPLETED","FAILED","CANCELLED"]},"testEnvironmentId":{"type":"string","description":"The Test Environment to which this job belongs","example":"11111111-1111-1111-1111-111111111111"},"updateTime":{"type":"string","description":"The date and time when the job was last synced to self-service","format":"date-time"},"updatedById":{"type":"string","description":"The automatically generated ID of the Zuora user who updated the job object","example":"58f182ab203c447b8b9cd90382da030a"}},"description":"The job response"}},"components/schemas/JobArrayResponse":{"id":"components/schemas/JobArrayResponse","kind":"json-schema","title":"ArrayResponse«JobResponse»","data":{"title":"ArrayResponse«JobResponse»","type":"object","properties":{"result":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/JobResponse"}},"size":{"type":"integer","format":"int32"}},"description":"Container for array of objects"}},"components/schemas/JobRequest":{"id":"components/schemas/JobRequest","kind":"json-schema","title":"JobRequest","data":{"title":"JobRequest","required":["jobType"],"type":"object","properties":{"jobType":{"type":"string","description":"The type of workflow job to be performed on the Test Environment","example":"REFRESH","enum":["REFRESH"]},"scheduledRefreshTime":{"type":"string","description":"Optional date for scheduling a job","format":"date-time"}},"description":"Request for creating test environment job"}},"components/schemas/JobActionRequest":{"id":"components/schemas/JobActionRequest","kind":"json-schema","title":"JobActionRequest","data":{"title":"JobActionRequest","required":["jobAction"],"type":"object","properties":{"jobAction":{"type":"string","description":"The action to perform against the workflow job","example":"CANCEL","enum":["CANCEL"]}},"description":"Request for invoking a certain action on a workflow job"}},"components/schemas/TestEnvironmentNotificationResponse":{"id":"components/schemas/TestEnvironmentNotificationResponse","kind":"json-schema","title":"TestEnvironmentNotificationResponse","data":{"title":"TestEnvironmentNotificationResponse","type":"object","properties":{"address":{"type":"string","description":"The email address to receive notifications for the Test Environment when a refresh job has been completed or cancelled","example":"john.smith@zuora.com"},"id":{"type":"string","description":"The unique id (UUID) of the Test Environment notification","example":"11111111-1111-1111-1111-111111111111"},"name":{"type":"string","description":"The name of the recipient who will receive notifications for the Test Environment","example":"John Smith"},"testEnvironmentId":{"type":"string","description":"The unique id (UUID) of the Test Environment","example":"11111111-1111-1111-1111-111111111111"}},"description":"The notification response for a Test Environment"}},"components/schemas/TestEnvironmentNotificationArrayResponse":{"id":"components/schemas/TestEnvironmentNotificationArrayResponse","kind":"json-schema","title":"ArrayResponse«TestEnvironmentNotificationResponse»","data":{"title":"ArrayResponse«TestEnvironmentNotificationResponse»","type":"object","properties":{"result":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/TestEnvironmentNotificationResponse"}},"size":{"type":"integer","format":"int32"}},"description":"Container for array of objects"}},"components/schemas/TestEnvironmentNotificationRequest":{"id":"components/schemas/TestEnvironmentNotificationRequest","kind":"json-schema","title":"TestEnvironmentNotificationRequest","data":{"title":"TestEnvironmentNotificationRequest","type":"object","properties":{"address":{"type":"string","description":"The email address to receive notifications for the Test Environment when a refresh job has been completed or cancelled","example":"john.smith@zuora.com"},"name":{"type":"string","description":"The name of the recipient who will receive notifications for the Test Environment","example":"John Smith"}},"description":"Request to create a notification record for the test environment"}},"components/schemas/tokenResponse":{"id":"components/schemas/tokenResponse","kind":"json-schema","title":"tokenResponse","data":{"properties":{"access_token":{"description":"The generated token.","type":"string"},"expires_in":{"description":"The number of seconds until the token expires.","type":"number"},"jti":{"description":"A globally unique identifier for the token.","type":"string"},"scope":{"description":"A space-delimited list of scopes that the token can be used to access.","type":"string"},"token_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of token that was generated, i.e., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/ProductObjectNSFields":{"id":"components/schemas/ProductObjectNSFields","kind":"json-schema","title":"productFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Product fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the product's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"ItemType__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of item that is created in NetSuite for the product. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Inventory","Non Inventory","Service"],"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the product was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"productFieldsNS","type":"object"}},"components/schemas/ProductObjectCustomFields":{"id":"components/schemas/ProductObjectCustomFields","kind":"json-schema","title":"productFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Product object.\n","title":"productFieldsCustom","type":"object"}},"components/schemas/ProxyCreateProduct":{"id":"components/schemas/ProxyCreateProduct","kind":"json-schema","title":"ProxyCreateProduct","data":{"allOf":[{"properties":{"AllowFeatureChanges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls whether to allow your users to add or remove features while creating or amending a subscription."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": true, false (default)"},"children":[]}]}]}],"type":"boolean"},"Category":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the product. Used by Zuora Quotes Guided Product Selector."},"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":"Values"},"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":"Base Products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add On Services"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Miscellaneous Products"},"children":[]}]}]}]}],"maxLength":100,"type":"string"},"Description":{"description":"A description of the product. \n","maxLength":500,"type":"string"},"EffectiveEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product expires and can't be subscribed to anymore, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"EffectiveStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product becomes available and can be subscribed to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"Name":{"description":"The name of the product. This information is displayed in the product catalog pages in the web-based UI.\n","maxLength":100,"type":"string"},"ProductNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The natural key of the product."},"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":"Values"},"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":"leave null for automatically generated string"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an alphanumeric string of 100 characters or fewer"},"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 only available if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]}],"maxLength":100,"type":"string"},"SKU":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique SKU for the product."},"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":"Values"},"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":"leave null for automatically generated string"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an alphanumeric string of 50 characters or fewer"},"children":[]}]}]}]}],"maxLength":50,"type":"string"}},"required":["EffectiveEndDate","EffectiveStartDate","Name"],"type":"object"},{"$ref":"#/components/schemas/ProductObjectNSFields"},{"$ref":"#/components/schemas/ProductObjectCustomFields"}],"example":{"Name":"SmartLearn Tablet","EffectiveStartDate":"2024-01-01","EffectiveEndDate":"2034-01-01"}}},"components/schemas/ProxyCreateOrModifyResponse":{"id":"components/schemas/ProxyCreateOrModifyResponse","kind":"json-schema","title":"ProxyCreateOrModifyResponse","data":{"properties":{"Id":{"description":"","type":"string"},"Success":{"description":"","type":"boolean"}},"type":"object"}},"components/schemas/ProxyBadRequestResponse":{"id":"components/schemas/ProxyBadRequestResponse","kind":"json-schema","title":"ProxyBadRequestResponse","data":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Machine-readable error code identifying the failure type.","type":"string"},"message":{"description":"Human-readable description of the error that provides more context about what went wrong.","type":"string"}},"type":"object"},"type":"array"},"success":{"description":"","type":"boolean"}},"type":"object"}},"components/schemas/ProxyUnauthorizedResponse":{"id":"components/schemas/ProxyUnauthorizedResponse","kind":"json-schema","title":"ProxyUnauthorizedResponse","data":{"properties":{"message":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error message."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the error message is \"Authentication error\", ensure that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header contains valid authentication credentials, then retry the request. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the error message is \"Failed to get user info\", retry the request."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/ProxyGetProduct":{"id":"components/schemas/ProxyGetProduct","kind":"json-schema","title":"ProxyGetProduct","data":{"allOf":[{"properties":{"AllowFeatureChanges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls whether to allow your users to add or remove features while creating or amending a subscription."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": true, false (default)"},"children":[]}]}]}],"type":"boolean"},"Category":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the product. Used by Zuora Quotes Guided Product Selector."},"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":"Values"},"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":"Base Products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add On Services"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Miscellaneous Products"},"children":[]}]}]}]}],"maxLength":100,"type":"string"},"CreatedById":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The automatically generated ID of the Zuora user who created the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"maxLength":32,"type":"string"},"CreatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object was created."},"children":[]}]}]}],"format":"date-time","type":"string"},"Description":{"description":"A description of the product. \n","maxLength":500,"type":"string"},"EffectiveEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product expires and can't be subscribed to anymore, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"EffectiveStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product becomes available and can be subscribed to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"Id":{"description":"Object identifier.","type":"string"},"Name":{"description":"The name of the product. This information is displayed in the product catalog pages in the web-based UI.\n","maxLength":100,"type":"string"},"SKU":{"description":"The unique SKU for the product.\n","maxLength":50,"type":"string"},"UpdatedById":{"description":"The ID of the last user to update the object.\n","maxLength":32,"type":"string"},"UpdatedDate":{"description":"The date when the object was last updated.\n","format":"date-time","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductObjectNSFields"},{"$ref":"#/components/schemas/ProductObjectCustomFields"}]}},"components/schemas/ProxyNoDataResponse":{"id":"components/schemas/ProxyNoDataResponse","kind":"json-schema","title":"ProxyNoDataResponse","data":{"properties":{"done":{"description":"","type":"boolean"},"records":{"description":"","items":{"type":"object"},"type":"array"},"size":{"description":"","type":"integer"}},"type":"object"}},"components/schemas/ProxyModifyProduct":{"id":"components/schemas/ProxyModifyProduct","kind":"json-schema","title":"ProxyModifyProduct","data":{"allOf":[{"properties":{"AllowFeatureChanges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls whether to allow your users to add or remove features while creating or amending a subscription."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": true, false (default)"},"children":[]}]}]}],"type":"boolean"},"Category":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the product. Used by Zuora Quotes Guided Product Selector."},"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":"Values"},"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":"Base Products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add On Services"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Miscellaneous Products"},"children":[]}]}]}]}],"maxLength":100,"type":"string"},"Description":{"description":"A description of the product. \n","maxLength":500,"type":"string"},"EffectiveEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product expires and can't be subscribed to anymore, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"EffectiveStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product becomes available and can be subscribed to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"Name":{"description":"The name of the product. This information is displayed in the product catalog pages in the web-based UI.\n","maxLength":100,"type":"string"},"ProductNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The natural key of the product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For existing Product objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"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 only available if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]}],"maxLength":100,"type":"string"},"SKU":{"description":"The unique SKU for the product.\n","maxLength":50,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductObjectNSFields"},{"$ref":"#/components/schemas/ProductObjectCustomFields"}],"example":{"Description":"Portable tablet designed for kids' learning with pre-installed educational apps and games."}}},"components/schemas/ProxyDeleteResponse":{"id":"components/schemas/ProxyDeleteResponse","kind":"json-schema","title":"ProxyDeleteResponse","data":{"properties":{"id":{"description":"","type":"string"},"success":{"description":"","type":"boolean"}},"type":"object"}},"components/schemas/ProductFeatureObjectCustomFields":{"id":"components/schemas/ProductFeatureObjectCustomFields","kind":"json-schema","title":"productFeatureFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product Feature object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Product Feature object.\n","title":"productFeatureFieldsCustom","type":"object"}},"components/schemas/GetProductFeatureType":{"id":"components/schemas/GetProductFeatureType","kind":"json-schema","title":"productFeatures","data":{"allOf":[{"properties":{"code":{"description":"Feature code, up to 255 characters long.\n","type":"string"},"description":{"description":"Feature description.\n","type":"string"},"id":{"description":"Feature ID.\n","type":"string"},"name":{"description":"Feature name, up to 255 characters long.\n","type":"string"},"status":{"description":"","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductFeatureObjectCustomFields"}],"title":"productFeatures"}},"components/schemas/GETProductType":{"id":"components/schemas/GETProductType","kind":"json-schema","title":"products","data":{"allOf":[{"properties":{"category":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the product. Used by Zuora Quotes Guided Product Selector."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"text","inline":true,"attributes":{"content":"Base Products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add On Services"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Miscellaneous Products"},"children":[]}]}]}]}],"type":"string"},"description":{"description":"Optional product description.\n","type":"string"},"effectiveEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product expires and cannot be subscribed to anymore, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"effectiveStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product becomes available and can be subscribed to, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"id":{"description":"Product ID.\n","type":"string"},"name":{"description":"Product name, up to 100 characters.\n","type":"string"},"organizationLabels":{"description":"The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.            \n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"productFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for one or more product features. Only available when the following settings are enabled:"},"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 Entitlements feature in your tenant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Enable Feature Specification in Product and Subscriptions setting in Settings > Billing"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/GetProductFeatureType"},"type":"array"},"productNumber":{"description":"The natural key of the product.\n","type":"string"},"productRatePlans":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to retrieve information about all product rate plans of a specific product. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan"},"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":"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 value of this field is a URL only if you are on the latest API version of the Zuora API or set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"230.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"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":"Zuora recommends that you use the latest behavior to retrieve product information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"229.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or earlier, the value of this field is an array of product rate plan details."},"children":[]}]}]}],"format":"URL","type":"string"},"sku":{"description":"Unique product SKU, up to 50 characters.\n","type":"string"},"tags":{"description":"","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductObjectNSFields"},{"$ref":"#/components/schemas/ProductObjectCustomFields"}],"title":"products"}},"components/schemas/GETCatalogType":{"id":"components/schemas/GETCatalogType","kind":"json-schema","title":"GETCatalogType","data":{"properties":{"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"products":{"description":"Container for one or more products:\n","items":{"$ref":"#/components/schemas/GETProductType"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"example":{"reasons":[{"code":"ObjectNotFound","message":"Notification definition with id 6e569e1e05f040eda51a927b140c0ac1 does not exist"}]},"properties":{"reasons":{"items":{"properties":{"code":{"description":"The error code of response.\n","type":"string"},"message":{"description":"The detail information of the error response","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/CommonResponse":{"id":"components/schemas/CommonResponse","kind":"json-schema","title":"CommonResponse","data":{"properties":{"processId":{"description":"The ID of the process that handles the operation.\n","type":"string"},"reasons":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container of the error code and message. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"properties":{"code":{"description":"The error code of response.\n","type":"string"},"message":{"description":"The detail information of the error response\n","type":"string"}},"type":"object"},"type":"array"},"requestId":{"description":"Unique identifier of the request.\n","format":"uuid","maxLength":36,"minLength":36,"type":"string"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/GETCatalogGroupProductRatePlanResponse":{"id":"components/schemas/GETCatalogGroupProductRatePlanResponse","kind":"json-schema","title":"productRatePlans","data":{"properties":{"description":{"description":"The description of the product rate plan.\n","type":"string","nullable":true},"effectiveEndDate":{"description":"The effective end Date of the product rate plan.\n","type":"string"},"effectiveStartDate":{"description":"The effective start date of the product rate plan.\n","type":"string"},"grade":{"description":"The grade of the product rate plan.\n","type":"number"},"id":{"description":"The ID of the product rate plan.\n","type":"string"},"name":{"description":"The name of the product rate plan.\n","type":"string"},"organizationLabels":{"description":"The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.            \n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of the product rate plan.\n","enum":["Active","Expired","NotStarted"],"type":"string"}},"title":"productRatePlans","type":"object"}},"components/schemas/CatalogGroupResponse":{"id":"components/schemas/CatalogGroupResponse","kind":"json-schema","title":"catalogGroups","data":{"properties":{"catalogGroupNumber":{"description":"The automatically generated number of the catalog group with the CG- perfix. For example, CG-00000001.\n","type":"string"},"description":{"description":"The description of the catalog group.\n","type":"string"},"id":{"description":"The ID of the catalog group.\n","type":"string"},"name":{"description":"The name of the catalog group.\n","type":"string"},"productRatePlans":{"description":"The list of product rate plans in the catalog group.\n","items":{"$ref":"#/components/schemas/GETCatalogGroupProductRatePlanResponse"},"type":"array"},"type":{"description":"The type of the catalog group.\n","enum":["Grading","Display"],"type":"string"}},"title":"catalogGroups","type":"object"}},"components/schemas/ListAllCatalogGroupsResponse":{"id":"components/schemas/ListAllCatalogGroupsResponse","kind":"json-schema","title":"ListAllCatalogGroupsResponse","data":{"properties":{"catalogGroups":{"description":"The list of catalog groups that are retrieved..\n","items":{"$ref":"#/components/schemas/CatalogGroupResponse"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"}},"type":"object"}},"components/schemas/POSTorPUTCatalogGroupAddProductRatePlan":{"id":"components/schemas/POSTorPUTCatalogGroupAddProductRatePlan","kind":"json-schema","title":"productRatePlans","data":{"allOf":[{"properties":{"grade":{"description":"The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade.\n\nA product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually. \n","type":"number"},"id":{"description":"The unique ID of the product rate plan.\n","type":"string"}},"type":"object"}],"example":{"grade":3,"id":"4028e5ab7f1b600c017f1b787d5d01cf"},"title":"productRatePlans"}},"components/schemas/POSTCatalogGroupRequest":{"id":"components/schemas/POSTCatalogGroupRequest","kind":"json-schema","title":"POSTCatalogGroupRequest","data":{"allOf":[{"properties":{"description":{"description":"The description of the catalog group.\n","type":"string"},"name":{"description":"The unique name of the catalog group.\n","type":"string"},"productRatePlans":{"description":"The list of product rate plans to be added to the catalog group.\n","items":{"$ref":"#/components/schemas/POSTorPUTCatalogGroupAddProductRatePlan"},"type":"array"},"type":{"default":"Grading","description":"The type of the catalog group. \n","enum":["Grading","Display"],"type":"string"}},"type":"object"}],"example":{"description":"description","name":"Example","productRatePlans":[{"grade":3,"id":"4028e5ab7f1b600c017f1b787d5d01cf"},{"grade":2,"id":"4028e5ab7f1b600c017f1b787d5d01ac"}],"type":"Grading"}}},"components/schemas/PUTCatalogGroupRemoveProductRatePlan":{"id":"components/schemas/PUTCatalogGroupRemoveProductRatePlan","kind":"json-schema","title":"remove","data":{"allOf":[{"properties":{"id":{"description":"The unique ID of the product rate plan to be removed from the catalog group.\n","type":"string"}},"type":"object"}],"example":{"id":"4028e5ab7f1b600c017f1b787d5d01cf"},"title":"remove"}},"components/schemas/PUTCatalogGroup":{"id":"components/schemas/PUTCatalogGroup","kind":"json-schema","title":"PUTCatalogGroup","data":{"allOf":[{"properties":{"add":{"description":"The list of product rate plans to be added to the catalog group.\n","items":{"$ref":"#/components/schemas/POSTorPUTCatalogGroupAddProductRatePlan"},"title":"add","type":"array"},"description":{"description":"The description of the catalog group.\n","type":"string"},"name":{"description":"The unique name of the catalog group.\n","type":"string"},"remove":{"description":"The list of product rate plans to be removed from the catalog group.\n","items":{"$ref":"#/components/schemas/PUTCatalogGroupRemoveProductRatePlan"},"type":"array"}},"type":"object"}],"example":{"add":[{"grade":3,"id":"4028e5ab7f1b600c017f1b787d5d01cf"},{"grade":2,"id":"4028e5ab7f1b600c017f1b787d5d01ac"}],"description":"description","name":"name","remove":[{"id":"4028e5ab7f1b600c017f1b787d5d01cf"},{"id":"4028e5ab7f1b600c017f1b787d5d01ac"}]}}},"components/schemas/GETProductRatePlanChargeDeliverySchedule":{"id":"components/schemas/GETProductRatePlanChargeDeliverySchedule","kind":"json-schema","title":"deliverySchedule","data":{"description":"The delivery schedule information of this charge. Only when this charge is using Delivery Pricing charge model\n","properties":{"frequency":{"description":"The frequency of the delivery. Only supports weekly now\n","enum":["Weekly"],"type":"string"},"friday":{"description":"The flag to indicate should the delivery happen on Friday\n","type":"boolean"},"monday":{"description":"The flag to indicate should the delivery happen on Monday\n","type":"boolean"},"saturday":{"description":"The flag to indicate should the delivery happen on Saturday\n","type":"boolean"},"sunday":{"description":"The flag to indicate should the delivery happen on Sunday\n","type":"boolean"},"thursday":{"description":"The flag to indicate should the delivery happen on Thursday\n","type":"boolean"},"tuesday":{"description":"The flag to indicate should the delivery happen on Tuesday\n","type":"boolean"},"wendesday":{"description":"The flag to indicate should the delivery happen on Wendesday\n","type":"boolean"}},"title":"deliverySchedule","type":"object"}},"components/schemas/GETProductRatePlanChargePricingTierType":{"id":"components/schemas/GETProductRatePlanChargePricingTierType","kind":"json-schema","title":"tiers","data":{"properties":{"endingUnit":{"description":"Decimal defining end of tier range.\n","format":"decimal","type":"string"},"price":{"description":"The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the price field directly under the productRatePlanCharges applies.\n","format":"decimal","type":"string"},"priceFormat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tier price format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed 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":"text","inline":true,"attributes":{"content":"flat fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per unit"},"children":[]}]}]}]}],"type":"string"},"startingUnit":{"description":"Decimal defining start of tier range.\n","format":"decimal","type":"string"},"tier":{"description":"Unique number of the tier.\n","format":"int64","type":"integer"}},"title":"tiers","type":"object"}},"components/schemas/GETProductRatePlanChargePricingType":{"id":"components/schemas/GETProductRatePlanChargePricingType","kind":"json-schema","title":"pricing","data":{"properties":{"currency":{"description":"Currency used by the charge model. For example: USD or EUR\n","type":"string"},"discountAmount":{"description":"Value subtracted from price in currency specified. Used only when the charge model is DiscountFixedAmount.\n","format":"decimal","type":"string","nullable":true},"discountPercentage":{"description":"Percent discount applied to the price. Used only when the charge model is DiscountPercentage.\n","format":"decimal","type":"string","nullable":true},"includedUnits":{"description":"Specifies the number of units in the base set of units when the charge model is Overage.\n","format":"decimal","type":"string","nullable":true},"overagePrice":{"description":"Price per unit when base set of units is exceeded. Used only when charge model is Overage or Tiered with Overage.\n","format":"decimal","type":"string","nullable":true},"price":{"description":"The decimal value that applies when the charge model is not tiered\n","format":"decimal","type":"string"},"tiers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for one or many defined tier ranges with distinct pricing.  Applies when model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TieredWithOverage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/GETProductRatePlanChargePricingTierType"},"type":"array","nullable":true}},"title":"pricing","type":"object"}},"components/schemas/GETProductDiscountApplyDetailsType":{"id":"components/schemas/GETProductDiscountApplyDetailsType","kind":"json-schema","title":"productDiscountApplyDetails","data":{"properties":{"appliedProductRatePlanChargeId":{"description":"The ID of the product rate plan charge that the discount product rate plan charge applies to.\n","type":"string"},"appliedProductRatePlanId":{"description":"The ID of the product rate plan that the discount product rate plan charge applies to.\n","type":"string"}},"title":"productDiscountApplyDetails","type":"object"}},"components/schemas/ProductRatePlanChargeObjectNSFields":{"id":"components/schemas/ProductRatePlanChargeObjectNSFields","kind":"json-schema","title":"productRatePlanChargeFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Product Rate Plan Charge fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"Class__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Class associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"DeferredRevAccount__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deferrred revenue account associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Department__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Department associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IncludeChildren__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the corresponding item in NetSuite is visible under child subsidiaries. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Yes","No"],"type":"string"},"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the product rate plan charge's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"ItemType__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of item that is created in NetSuite for the product rate plan charge. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Inventory","Non Inventory","Service"],"type":"string"},"Location__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"RecognizedRevAccount__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recognized revenue account associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"RevRecEnd__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date condition of the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Charge Period Start","Rev Rec Trigger Date","Use NetSuite Rev Rec Template"],"type":"string"},"RevRecStart__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date condition of the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Charge Period Start","Rev Rec Trigger Date","Use NetSuite Rev Rec Template"],"type":"string"},"RevRecTemplateType__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Subsidiary__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the product rate plan charge was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"productRatePlanChargeFieldsNS","type":"object"}},"components/schemas/ProductRatePlanChargeObjectCustomFields":{"id":"components/schemas/ProductRatePlanChargeObjectCustomFields","kind":"json-schema","title":"productRatePlanChargeFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product Rate Plan Charge object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Product Rate Plan Charge object.\n","title":"productRatePlanChargeFieldsCustom","type":"object"}},"components/schemas/GETProductRatePlanChargeType":{"id":"components/schemas/GETProductRatePlanChargeType","kind":"json-schema","title":"productRatePlanCharges","data":{"allOf":[{"properties":{"applyDiscountTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies where (to what charge type) the discount will be applied. These field values are case-sensitive."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permissible 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":"text","inline":true,"attributes":{"content":"RECURRING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ONETIMERECURRING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ONETIMEUSAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECURRINGUSAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ONETIMERECURRINGUSAGE"},"children":[]}]}]}]}],"type":"string","nullable":true},"billingDay":{"description":"The bill cycle day (BCD) for the charge. The BCD determines which day of the month or week the customer is billed. The BCD value in the account can override the BCD in this object.\n","type":"string"},"billingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"text","inline":true,"attributes":{"content":"Month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quarter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Semi_Annual"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific Months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Week"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]}]}]}]}],"type":"string"},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aligns charges within the same subscription if multiple charges begin on different dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"text","inline":true,"attributes":{"content":"AlignToCharge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]}]}]}]}],"type":"string"},"billingTiming":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing timing for the charge. You can choose to bill for charges in advance or in arrears."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"text","inline":true,"attributes":{"content":"In Advance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Arrears"},"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"chargeFunction":{"description":[{"$$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 only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"141"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"Standard: Normal charge with no Prepayment or Commitment or Drawdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepayment: For recurring charges. Unit or currency based prepaid charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown: For usage charges. Drawdown from prepaid funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"],"type":"string"},"commitmentType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the type of commitment. A prepaid charge can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A minimum commitment(in-arrears) charge can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. For topup(recurring or one-time) charges, this field indicates what type of funds are created."},"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 UNIT, it will create a fund with given prepaidUom."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If CURRENCY, it will create a fund with the currency amount calculated in list price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"],"type":"string"},"chargeModelConfigurations":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is for Zuora Internal Use only. See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for the same information as this field."},"children":[]}]}]}],"type":"object"},"creditOption":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"defaultQuantity":{"description":"The default quantity of units.  This field is required if you use a per-unit charge model.\n","format":"decimal","type":"string","nullable":true},"deliverySchedule":{"$ref":"#/components/schemas/GETProductRatePlanChargeDeliverySchedule"},"description":{"description":"Usually a brief line item summary of the Rate Plan Charge.\n","type":"string"},"discountClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The class that the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied."},"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://docs.zuora.com?resourceId=billing-manage-discount-classes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Discount Classes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The level of the discount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"text","inline":true,"attributes":{"content":"RatePlan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account"},"children":[]}]}]}]}],"type":"string","nullable":true},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"drawdownUom":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"endDateCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"text","inline":true,"attributes":{"content":"Subscription_End"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]}]}]}]}],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the related rate plan charges and order line items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"financeInformation":{"description":"Container for finance information of a rate plan charge.\n","properties":{"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment liability."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment liability accounting code."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment revenue accounting code."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract asset."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract asset accounting code."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract liability accounting code."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract recognized revenue accounting code."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCode":{"description":"The accounting code for deferred revenue, such as Monthly Recurring Liability. \n","type":"string"},"deferredRevenueAccountingCodeType":{"description":"The type associated with the deferred revenue accounting code, such as Deferred Revenue. \n","type":"string","nullable":true},"recognizedRevenueAccountingCode":{"description":"The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges. \n","type":"string"},"recognizedRevenueAccountingCodeType":{"description":"The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount. \n","type":"string","nullable":true},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"},"unbilledReceivablesAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the unbilled receivables accounting code."},"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 only available if you have the RevPro Integration feature enabled."},"children":[]}]}]}],"type":"string"}},"title":"financeInformation","type":"object"},"formula":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pricing formula to calculate the actual rating amount for each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"type":"string"},"id":{"description":"Unique product rate-plan charge ID.\n","type":"string"},"includedUnits":{"description":"Specifies the number of units in the base set of units when the charge model is Overage.\n","format":"decimal","type":"string"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isPrepaid":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: "},"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":"."},"children":[]}]}]}],"type":"boolean"},"isRollover":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"true\" or \"false\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"isStackedDiscount":{"description":[{"$$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 only applicable to the Discount - Percentage charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 130 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:"},"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":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is a stacked discount, which should be calculated by stacking with other discounts."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is not a stacked discount, which should be calculated in sequence with other discounts."},"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://docs.zuora.com?resourceId=billing-discount-charge-models"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stacked discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"listPriceBase":{"description":"The list price base for the product rate plan charge.\n\nThis field is only applicable for recurring charges.\n","enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months"],"type":"string"},"maxQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the maximum number of units for this charge. Use this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a range of units allowed in a product rate plan charge."},"children":[]}]}]}],"format":"decimal","type":"string"},"minQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the minimum number of units for this charge. Use this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a range of units allowed in a product rate plan charge."},"children":[]}]}]}],"format":"decimal","type":"string"},"model":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge model which determines how charges are calculated. Charge models must be individually activated in Zuora Billing administration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"FlatFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Overage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TieredWithOverage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountFixedAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (available only if you have the Delivery Pricing charge model enabled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MultiAttributePricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (available only if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PreratedPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (available only if you have the Pre-rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PreratedPricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (available only if you have the Pre-rated Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HighWatermarkVolumePricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (available only if you have the High Water Mark Volume Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HighWatermarkTieredPricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (available only if you have the High Water Mark Tiered Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains details about these charge models and the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingSummary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains their associated pricing summary values."},"children":[]}]}]}],"type":"string"},"name":{"description":"Name of the product rate-plan charge. (Not required to be unique.)\n","type":"string"},"numberOfPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model. This field is ued when overage smoothing model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RollingWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rollover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer","nullable":true},"overageCalculationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value specifies when to calculate overage charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"text","inline":true,"attributes":{"content":"EndOfSmoothingPeriod"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PerBillingPeriod"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]}],"type":"string","nullable":true},"overageUnusedUnitsCreditOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to credit the customer with unused units of usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"text","inline":true,"attributes":{"content":"NoCredit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditBySpecificRate"},"children":[]}]}]}]}],"type":"string","nullable":true},"prepaidOperationType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this charge. It is either a prepayment (topup) charge or a drawdown charge."},"children":[]}]}]}],"enum":["topup","drawdown",null],"type":"string","nullable":true},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number","nullable":true},"prepaidTotalQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of units that end customers can use during a validity period when they subscribe to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","nullable":true},"prepaidUom":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"prepayPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of periods to which prepayment is set."},"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 only available if you already have the prepayment feature enabled. The prepayment feature is deprecated and available only for backward compatibility. Zuora does not support enabling this feature anymore."},"children":[]}]}]}],"format":"int64","type":"integer","nullable":true},"priceChangeOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies an automatic price change when a termed subscription is renewed and the following applies:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AutomatedPriceChange setting is on"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge type is not one-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge model is not discount fixed amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"text","inline":true,"attributes":{"content":"NoChange (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UseLatestProductCatalogPricing"},"children":[]}]}]}]}],"type":"string","nullable":true},"priceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PriceChangeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AutomatedPriceChange setting is on"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge type is not one-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge model is not discount fixed amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: a decimal between -100 and 100"},"children":[]}]}]}],"format":"decimal","type":"string","nullable":true},"pricing":{"description":"One or more price charge models with attributes that further describe the model. \nSome attributes show as null values when not applicable.\n","items":{"$ref":"#/components/schemas/GETProductRatePlanChargePricingType"},"type":"array"},"pricingSummary":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A concise description of the charge model and pricing that is suitable to show to your customers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the rate plan charge model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and multi-currency is enabled, this field includes an array of string of each currency, and each string of currency includes tier price description separated by comma."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the rate plan charge model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field does not include currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the rate plan charge model is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field includes the currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the following charge models, the value of this field is an empty string:"},"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":"Multi-Attribute Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High Water Mark Tiered Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High Water Mark Volume Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Rated Per Unit Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Rated Pricing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"productChargeDefinitions":{"description":"A link to retrieve product charge definitions of this charge.\n","type":"string"},"productDiscountApplyDetails":{"description":"Container for the application details about a discount product rate plan charge. \n\nOnly discount product rate plan charges have values in this field.\n","items":{"$ref":"#/components/schemas/GETProductDiscountApplyDetailsType"},"type":"array"},"productRatePlanChargeNumber":{"description":"The natural key of the product rate plan charge.\n","type":"string"},"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for per unit, volume pricing, and tiered pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-Time Charges and Recurring Charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string","nullable":true},"revRecCode":{"description":"Associates this product rate plan charge with a specific revenue recognition code. The value is a valid revenue recognition code.\n","maxLength":70,"type":"string","nullable":true},"revRecTriggerCondition":{"description":"Specifies when revenue recognition begins.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate",null],"maxLength":22,"type":"string","nullable":true},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","type":"string"},"rolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year."},"children":[]}]}]}],"type":"integer"},"rolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"smoothingModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the smoothing model for an overage smoothing charge model or an tiered with overage model, which is an advanced type of a usage model that avoids spikes in usage charges. If a customer's usage spikes in a single period, then an overage smoothing model eases overage charges by considering usage and multiple periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the following values shows which smoothing model will be applied to the charge when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Overage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered with Overage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"code","inline":true,"attributes":{"content":"RollingWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" considers a number of periods to smooth usage. The rolling window starts and increments forward based on billing frequency. When allowed usage is met, then period resets and a new window begins."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rollover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" considers a fixed number of periods before calculating usage. The net balance at the end of a period is unused usage, which is carried over to the next period's balance."},"children":[]}]}]}]}],"type":"string","nullable":true},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the billing period is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Months then this positive integer reflects the number of months for billing period charges."},"children":[]}]}]}],"format":"int64","type":"integer","nullable":true},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. 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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer","nullable":true},"taxCode":{"description":"Specifies the tax code for taxation rules; used by Zuora Tax.\n","type":"string"},"taxMode":{"description":"Specifies how to define taxation for the charge; used by Zuora Tax.\n","enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the charge is taxable; used by Zuora Tax. Possible values are:"},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: 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":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date specified."},"children":[]}]}]}]}],"type":"string"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of charge. Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the Units of Measure (uom) configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the productRatePlanCharges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Each"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"License"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Seat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"type":"string","nullable":true},"upToPeriods":{"description":"Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.\nIf the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.\n","format":"int64","type":"integer","nullable":true},"upToPeriodsType":{"description":"The period type used to define when the charge ends.\n","enum":["Billing_Periods","Days","Weeks","Months","Years",null],"type":"string","nullable":true},"usageRecordRatingOption":{"description":"Determines how Zuora processes usage records for per-unit usage charges. \n","type":"string","nullable":true},"useDiscountSpecificAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to define a new accounting code for the new discount charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"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":"false"},"children":[]}]}]}],"type":"boolean","nullable":true},"useTenantDefaultForPriceChange":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shows the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. You set the tenant uplift value in the web-based UI: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing > Define Default Subscription Settings"},"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":"Values: "},"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":"false"},"children":[]}]}]}],"type":"boolean","nullable":true},"validityPeriodType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period in which the prepayment units are valid to use as defined in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductRatePlanChargeObjectNSFields"},{"$ref":"#/components/schemas/ProductRatePlanChargeObjectCustomFields"}],"title":"productRatePlanCharges"}},"components/schemas/ProductRatePlanObjectNSFields":{"id":"components/schemas/ProductRatePlanObjectNSFields","kind":"json-schema","title":"productRatePlanFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Product Rate Plan fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"BillingPeriod__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Monthly","Quarterly","Annual","Semi-Annual"],"type":"string"},"Class__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Class associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Department__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Department associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IncludeChildren__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the corresponding item in NetSuite is visible under child subsidiaries. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Yes","No"],"type":"string"},"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the product rate plan's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"ItemType__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of item that is created in NetSuite for the product rate plan. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Inventory","Non Inventory","Service"],"type":"string"},"Location__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"MultiCurrencyPrice__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-currency price associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Price__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Subsidiary__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the product rate plan was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"productRatePlanFieldsNS","type":"object"}},"components/schemas/ProductRatePlanObjectCustomFields":{"id":"components/schemas/ProductRatePlanObjectCustomFields","kind":"json-schema","title":"ProductRatePlanCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product Rate Plan object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Product Rate Plan object.\n","title":"ProductRatePlanCustomFields","type":"object"}},"components/schemas/GETProductRatePlanType":{"id":"components/schemas/GETProductRatePlanType","kind":"json-schema","title":"productRatePlans","data":{"allOf":[{"properties":{"description":{"description":"Rate plan description.\n","type":"string"},"effectiveEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final date the rate plan is active, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". After this date, the rate plan status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"effectiveStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First date the rate plan is active (i.e., available to be subscribed to), as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Before this date, the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotStarted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"grade":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grade of the product rate plan."},"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 in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"id":{"description":"Unique product rate-plan ID.\n","type":"string"},"name":{"description":"Name of the product rate-plan charge. (Not required to be unique.)\n","type":"string"},"productRatePlanCharges":{"description":"Field attributes describing the product rate plan charges:\n","items":{"$ref":"#/components/schemas/GETProductRatePlanChargeType"},"type":"array"},"productRatePlanNumber":{"description":"The natural key of the product rate plan.  \n","type":"string"},"status":{"description":"The status of the product rate plan.\n","enum":["Active","Expired","NotStarted"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductRatePlanObjectNSFields"},{"$ref":"#/components/schemas/ProductRatePlanObjectCustomFields"}],"title":"productRatePlans"}},"components/schemas/GETProductRatePlansResponse":{"id":"components/schemas/GETProductRatePlansResponse","kind":"json-schema","title":"GETProductRatePlansResponse","data":{"properties":{"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"productRatePlans":{"description":"Container for one or more products.\n","items":{"$ref":"#/components/schemas/GETProductRatePlanType"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETProductRatePlanWithExternalIdResponse":{"id":"components/schemas/GETProductRatePlanWithExternalIdResponse","kind":"json-schema","title":"GETProductRatePlanWithExternalIdResponse","data":{"properties":{"ExternalIdSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The combination of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalIdSourceSystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores."},"children":[]}]}]}],"type":"string"},"description":{"description":"The short description of the product rate plan.\n","type":"string"},"effectiveEndDate":{"description":"The end date of the product rate plan.\n","format":"date","type":"string"},"effectiveStartDate":{"description":"The start date of the product rate plan.\n","format":"date","type":"string"},"externallyManagedPlanIds":{"description":"The unique identifier for the product rate plan in a third-party store. This field is used to represent a rate plan created through third-party stores.\n","items":{"type":"string"},"type":"array"},"grade":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grade of the product rate plan."},"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 in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"id":{"description":"The unique product rate plan ID.\n","type":"string"},"name":{"description":"The name of the product rate plan.\n","type":"string"},"organizationLabels":{"description":"The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.            \n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"productRatePlanNumber":{"description":"The natural key of the product rate plan.\n","type":"string"},"status":{"description":"The status of the product rate plan. \n","enum":["Active","Expired","NotStarted"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETProductRatePlanWithExternalIdMultiResponse":{"id":"components/schemas/GETProductRatePlanWithExternalIdMultiResponse","kind":"json-schema","title":"GETProductRatePlanWithExternalIdMultiResponse","data":{"type":"object","properties":{"productRatePlans":{"description":"A list of product rate plans associated with the product. \nEach rate plan defines a set of charges and billing conditions that determine how a product is priced and billed.\n","type":"array","items":{"type":"object","properties":{"id":{"description":"The unique product rate plan ID.\n","type":"string"},"status":{"description":"The status of the product rate plan. \n","enum":["Active","Expired","NotStarted"],"type":"string"},"name":{"description":"The name of the product rate plan.\n","type":"string"},"description":{"description":"The short description of the product rate plan.\n","type":"string"},"effectiveStartDate":{"description":"The start date of the product rate plan.\n","format":"date","type":"string"},"effectiveEndDate":{"description":"The end date of the product rate plan.\n","format":"date","type":"string"},"externalIdSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The combination of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalIdSourceSystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores."},"children":[]}]}]}],"type":"string"},"externallyManagedPlanIds":{"description":"The unique identifier for the product rate plan in a third-party store. This field is used to represent a rate plan created through third-party stores.\n","type":"array","items":{"type":"string"}},"productRatePlanNumber":{"description":"A unique, human-readable identifier for the product rate plan. This value is typically auto-generated by Zuora but can also be set explicitly by the customer.\nThis field is required and should never be null.\n","type":"string"},"grade":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grade of the product rate plan."},"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 in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"organizationLabels":{"description":"The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.            \n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"}}}},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}}}},"components/schemas/ProxyCreateProductRatePlan":{"id":"components/schemas/ProxyCreateProductRatePlan","kind":"json-schema","title":"ProxyCreateProductRatePlan","data":{"allOf":[{"properties":{"ActiveCurrencies":{"description":"A list of 3-letter currency codes representing active currencies for the product rate plan. Use a comma to separate each currency code.\n\nWhen creating a product rate plan, you can use this field to specify default currency and at most four other active currencies.\n","type":"string","example":"USD,EUR"},"Description":{"description":"A description of the product rate plan.\n","maxLength":500,"type":"string"},"EffectiveEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product rate plan expires and can't be subscribed to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","maxLength":29,"type":"string"},"EffectiveStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product rate plan becomes available and can be subscribed to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","maxLength":29,"type":"string"},"ExternalIdSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the external source system."},"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":" To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"130"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]}],"type":"string"},"ExternalRatePlanIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to update to multiple values, use a comma separated string."},"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":" To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"130"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]}],"type":"string"},"Grade":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually."},"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":"Notes"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"116"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"number"},"Name":{"description":"The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.\n","maxLength":255,"type":"string"},"ProductId":{"description":"The ID of the product that contains the product rate plan.\n","maxLength":32,"type":"string"},"ProductRatePlanNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The natural key of the product rate plan."},"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":"Possible values"},"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":"leave null for automatically generated string"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an alphanumeric string of 100 characters or fewer"},"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 only available if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]}],"maxLength":100,"type":"string"}},"required":["Name","ProductId"],"type":"object"},{"$ref":"#/components/schemas/ProductRatePlanObjectNSFields"},{"$ref":"#/components/schemas/ProductRatePlanObjectCustomFields"}],"example":{"Name":"Basic Plan","Description":"monthly plan","ProductId":"8ad081dd90c4bdwafe0190desada8f9b15","ActiveCurrencies":"USD,EUR","EffectiveStartDate":"2020-10-20","EffectiveEndDate":"2030-10-20","ExternalIdSourceSystem":"extsys","ExternalRatePlanIds":"ext01,ext02"}}},"components/schemas/ProxyGetProductRatePlan":{"id":"components/schemas/ProxyGetProductRatePlan","kind":"json-schema","title":"ProxyGetProductRatePlan","data":{"allOf":[{"properties":{"ActiveCurrencies":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of 3-letter currency codes representing active currencies for the product rate plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be queried in conjunction with any other fields except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the same time."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"CreatedById":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The automatically generated ID of the Zuora user who created the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"maxLength":32,"type":"string"},"CreatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object was created."},"children":[]}]}]}],"format":"date-time","maxLength":29,"type":"string"},"Description":{"description":"A description of the product rate plan.\n","maxLength":500,"type":"string"},"EffectiveEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product rate plan expires and can't be subscribed to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","maxLength":29,"type":"string"},"EffectiveStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product rate plan becomes available and can be subscribed to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","maxLength":29,"type":"string"},"Grade":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grade that is assigned for the product rate plan."},"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":"Notes"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"116"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"number"},"Id":{"description":"Object identifier.","type":"string"},"Name":{"description":"The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.\n","maxLength":255,"type":"string"},"ProductId":{"description":"The ID of the product that contains the product rate plan.\n","maxLength":32,"type":"string"},"UpdatedById":{"description":"The automatically generated ID of the last user to update the object.\n","maxLength":32,"type":"string"},"UpdatedDate":{"description":"The date when the object was last updated.\n","format":"date-time","maxLength":29,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductRatePlanObjectNSFields"},{"$ref":"#/components/schemas/ProductRatePlanObjectCustomFields"}]}},"components/schemas/ProxyModifyProductRatePlan":{"id":"components/schemas/ProxyModifyProductRatePlan","kind":"json-schema","title":"ProxyModifyProductRatePlan","data":{"allOf":[{"properties":{"ActiveCurrencies":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of 3-letter currency codes representing active currencies for the product rate plan. Use a comma to separate each currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the request body contains this field, the value of this field must contain the desired list of active currencies. The new list can never have more than four differences from the existing list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be used to modify the status of more than four currencies in a single request. For example, in a single request, you can only activate four currencies, or deactivate four currencies, or activate two and deactivate two. Making more than four changes to currencies always requires more than one call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When specifying this field in the update request, you must provide the full list of active currencies you want, not just incremental changes. For each active currency update, provide the following currencies in the list:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current active currencies + at most four changes (additions or deletions)"},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"Description":{"description":"A description of the product rate plan.\n","maxLength":500,"type":"string"},"EffectiveEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product rate plan expires and can't be subscribed to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","maxLength":29,"type":"string"},"EffectiveStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product rate plan becomes available and can be subscribed to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","maxLength":29,"type":"string"},"ExternalIdSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the external source system."},"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":" To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"130"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]}],"type":"string"},"ExternalRatePlanIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to update to multiple values, use a comma separated string."},"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":" To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"130"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]}],"type":"string"},"Grade":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually."},"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":"Notes"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"116"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"number"},"Name":{"description":"The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.\n","maxLength":255,"type":"string"},"ProductId":{"description":"The ID of the product that contains the product rate plan.\n","maxLength":32,"type":"string"},"ProductRatePlanNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The natural key of the product rate plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For existing Product Rate Plan objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"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 only available if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]}],"maxLength":100,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductRatePlanObjectNSFields"},{"$ref":"#/components/schemas/ProductRatePlanObjectCustomFields"}],"example":{"Name":"Monthly Plan2","Description":"monthly plan","ProductId":"8ad081dd90c4bafe0190desada8f9b154b","ActiveCurrencies":"USD","ExternalIdSourceSystem":"extsys9","ExternalRatePlanIds":"ext01"}}},"components/schemas/GETProductRatePlanDefinitionsResponse":{"id":"components/schemas/GETProductRatePlanDefinitionsResponse","kind":"json-schema","title":"GETProductRatePlanDefinitionsResponse","data":{"properties":{"productRatePlanDefinitions":{"description":"The list of the product rate plan definitions that are retrieved.\n","items":{"properties":{"id":{"description":"The unique ID of the product rate plan definition.\n","type":"string"},"productRatePlanChargeId":{"description":"The unique ID of the product charge in this rate plan definition.\n","type":"string"},"productRatePlanChargeName":{"description":"Th name of the product charge in this rate plan definition.\n","type":"string"},"productRatePlanChargeNumber":{"description":"The unique number (natural key) of the product charge in this rate plan definition.\n","type":"string"},"productRatePlanId":{"description":"The unique ID of the product rate plan that uses this rate plan definition.\n","type":"string"},"productRatePlanName":{"description":"Th name of the product rate plan that uses this rate plan definition.\n","type":"string"},"productRatePlanNumber":{"description":"The unique number (natural key) of the product rate plan that uses this rate plan definition.\n","type":"string"}},"title":"productRatePlanDefinitions","type":"object"},"type":"array"},"success":{"description":"Indicates whether the request succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/POSTRatePlanDefinitionRequest":{"id":"components/schemas/POSTRatePlanDefinitionRequest","kind":"json-schema","title":"POSTRatePlanDefinitionRequest","data":{"example":{"productRatePlanChargeId":"2c9890e489f227bd0189f22f3482001f","productRatePlanChargeNumber":"PRPC-00000001","productRatePlanId":"2c9890678b1ca909018b1caea5c30000","productRatePlanNumber":"PRP-00000008"},"properties":{"productRatePlanChargeId":{"description":"The unique ID of the product rate plan charge to be used in the product rate plan.\n","type":"string"},"productRatePlanChargeNumber":{"description":"The unique number (natural key) of the product rate plan charge to be used in the product rate plan.\n","type":"string"},"productRatePlanId":{"description":"The unique ID of the product rate plan that uses this rate plan definition.\n","type":"string"},"productRatePlanNumber":{"description":"The unique number (natural key) of the product rate plan that uses this rate plan definition.\n","type":"string"}},"type":"object"}},"components/schemas/POSTRatePlanDefinitionResponse":{"id":"components/schemas/POSTRatePlanDefinitionResponse","kind":"json-schema","title":"POSTRatePlanDefinitionResponse","data":{"properties":{"id":{"description":"The unique ID of the product charge definition.\n","type":"string"},"success":{"description":"Indicates whether the request succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/GETProductRatePlanDefinitionResponse":{"id":"components/schemas/GETProductRatePlanDefinitionResponse","kind":"json-schema","title":"GETProductRatePlanDefinitionResponse","data":{"properties":{"id":{"description":"The unique ID of the product rate plan definition.\n","type":"string"},"productRatePlanChargeId":{"description":"The unique ID of the product charge in this rate plan definition.\n","type":"string"},"productRatePlanChargeName":{"description":"Th name of the product charge in this rate plan definition.\n","type":"string"},"productRatePlanChargeNumber":{"description":"The unique number (natural key) of the product charge in this rate plan definition.\n","type":"string","nullable":true},"productRatePlanId":{"description":"The unique ID of the product rate plan that uses this rate plan definition.\n","type":"string"},"productRatePlanName":{"description":"Th name of the product rate plan that uses this rate plan definition.\n","type":"string"},"productRatePlanNumber":{"description":"The unique number (natural key) of the product rate plan that uses this rate plan definition.\n","type":"string"},"success":{"description":"Indicates whether the request succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/GETDeliverySchedule":{"id":"components/schemas/GETDeliverySchedule","kind":"json-schema","title":"deliverySchedule","data":{"properties":{"frequency":{"description":"The frequency of the delivery. Only weekly delivery is supported now.\n","enum":["Weekly"],"type":"string"},"friday":{"description":"The flag to indicate whether the delivery happens on Friday.\n","type":"boolean"},"monday":{"description":"The flag to indicate whether the delivery happens on Monday.\n","type":"boolean"},"saturday":{"description":"The flag to indicate whether the delivery happens on Saturday.\n","type":"boolean"},"sunday":{"description":"The flag to indicate whether the delivery happens on Sunday.\n","type":"boolean"},"thursday":{"description":"The flag to indicate whether the delivery happens on Thursday.\n","type":"boolean"},"tuesday":{"description":"The flag to indicate whether the delivery happens on Tuesday.\n","type":"boolean"},"wednesday":{"description":"The flag to indicate whether the delivery happens on Wendesday.\n","type":"boolean"}},"title":"deliverySchedule","type":"object","nullable":true}},"components/schemas/GETRatePlanChargePricingTier":{"id":"components/schemas/GETRatePlanChargePricingTier","kind":"json-schema","title":"GETRatePlanChargePricingTier","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of product rate plan charge tiers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should specify all relevant fields of all tiers, including pricing information for each currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each currency, ensure that the tiers appear in ascending order of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StartingUnit"},"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 example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n  {\n    \"StartingUnit\": \"1\",\n    \"EndingUnit\": \"150\",\n    \"Currency\": \"USD\",\n    \"Price\": 1.95,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"151\",\n    \"EndingUnit\": \"300\",\n    \"Currency\": \"USD\",\n    \"Price\": 1.45,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"1\",\n    \"EndingUnit\": \"150\",\n    \"Currency\": \"EUR\",\n    \"Price\": 1.75,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"151\",\n    \"EndingUnit\": \"300\",\n    \"Currency\": \"EUR\",\n    \"Price\": 1.30,\n    \"PriceFormat\": \"Per Unit\"\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n  {\n    \"StartingUnit\": \"1\",\n    \"EndingUnit\": \"150\",\n    \"Currency\": \"USD\",\n    \"Price\": 1.95,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"151\",\n    \"EndingUnit\": \"300\",\n    \"Currency\": \"USD\",\n    \"Price\": 1.45,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"1\",\n    \"EndingUnit\": \"150\",\n    \"Currency\": \"EUR\",\n    \"Price\": 1.75,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"151\",\n    \"EndingUnit\": \"300\",\n    \"Currency\": \"EUR\",\n    \"Price\": 1.30,\n    \"PriceFormat\": \"Per Unit\"\n  }\n]\n"},"children":[]}]}],"items":{"properties":{"currency":{"description":"The code corresponding to the currency for the price tier.\n","type":"string"},"discountAmount":{"description":"The specific amount for a fixed discount. This field is applicable for charges based on the Discount-Fixed Amount charge model.\n","format":"double","type":"number"},"discountPercentage":{"description":"The percentage of discount for a percentage discount. This field is applicable for charges based on the Discount-Percentage charge model.\n","format":"double","type":"number"},"endingUnit":{"description":"The end number of a range of units for the tier. This field is applicable for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n","format":"double","type":"number"},"overagePrice":{"description":"Indicates whether the price is an overage price, which is the price when usage surpasses the last defined tier.\n","format":"double","type":"number"},"price":{"description":"The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n","format":"double","type":"number"},"startingUnit":{"description":"The starting number of a range of units for the tier. This field is applicable for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n","format":"double","type":"number"}},"type":"object"},"type":"array"}},"components/schemas/GETRatePlanChargePricing":{"id":"components/schemas/GETRatePlanChargePricing","kind":"json-schema","title":"GETRatePlanChargePricing","data":{"properties":{"currency":{"description":"The currency for the price.\n","type":"string"},"discountAmount":{"description":"The specific amount for a fixed discount. This field is applicable for charges based on the Discount-Fixed Amount charge model.\n","format":"double","type":"number","nullable":true},"discountPercentage":{"description":"The percentage of discount for a percentage discount. This field is applicable for charges based on the Discount-Percentage charge model.\n","format":"double","type":"number","nullable":true},"includedUnits":{"description":"The number of units included in this price item. \n\nThis field is only applicable for charges based on the Overage Pricing charge model.\n","type":"number","nullable":true},"overagePrice":{"description":"The overage price of the price item. \n\nThis field is only applicable for charges based on the Overage Pricing or Tiered with Overage Pricing charge model.\n","type":"number","nullable":true},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable for charges based on the following charge models:"},"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":"Flat Fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per Unit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Pricing"},"children":[]}]}]}]}],"type":"number"},"tiers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the tiers of the price item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable for charges based on the following charge models:"},"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":"Tiered Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered with Overage Pricing"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/GETRatePlanChargePricingTier"},"type":"array","nullable":true}},"type":"object"}},"components/schemas/GETProductRatePlanChargeResponse":{"id":"components/schemas/GETProductRatePlanChargeResponse","kind":"json-schema","title":"GETProductRatePlanChargeResponse","data":{"properties":{"applyDiscountTo":{"description":"Indicates which type of charge the discount charge applies to.\n","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE",null],"type":"string","nullable":true},"billingDay":{"description":"The bill cycle type for this charge.\n","type":"string"},"billingPeriod":{"description":"The billing period for this charge.\n","type":"string"},"billingPeriodAlignment":{"description":"The billing period alignment setting for this charge.\n","enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart","AlignToTermEnd"],"type":"string"},"billingTiming":{"description":"The billing timing for this charge.\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"chargeFunction":{"description":[{"$$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 only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"141"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"Standard: Normal charge with no Prepayment or Commitment or Drawdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepayment: For recurring charges. Unit or currency based prepaid charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown: For usage charges. Drawdown from prepaid funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"],"type":"string"},"commitmentType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the type of commitment. A prepaid charge can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A minimum commitment(in-arrears) charge can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. For topup(recurring or one-time) charges, this field indicates what type of funds are created."},"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 UNIT, it will create a fund with given prepaidUom."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If CURRENCY, it will create a fund with the currency amount calculated in list price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"],"type":"string"},"customFields":{"$ref":"#/components/schemas/ProductRatePlanChargeObjectCustomFields"},"defaultQuantity":{"description":"The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n","type":"number","nullable":true},"deliverySchedule":{"$ref":"#/components/schemas/GETDeliverySchedule"},"description":{"description":"The description for this charge.\n","type":"string"},"discountClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The class that the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied."},"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://docs.zuora.com?resourceId=billing-manage-discount-classes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Discount Classes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account",null],"type":"string","nullable":true},"endDateCondition":{"description":"The end date condition for this charge.\n","enum":["Subscription_End","One_Time","Fixed_Period","Specific_End_Date"],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related rate plan charges and order line items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"isAllocationEligible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"isUnbilled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to perform the accounting during revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"productCategory":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product category for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"productClass":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product class for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"productFamily":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product family for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"productLine":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product line for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"prorationOption":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-usage-charge-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage charge proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"135"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field to specify the charge-level proration option for a usage charge or recurring charge. The tenant-level proration option will be overridden."},"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":"NoProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeBasedProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeFullPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period."},"children":[]}]}]}]}],"enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod"],"type":"string"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set both the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"numberOfPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is ued when overage smoothing model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RollingWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rollover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer","nullable":true},"financeInformation":{"description":"Container for the finance information of a product rate plan charge.\n","properties":{"accountsReceivableAccountingCode":{"description":"The accounting code for accounts receivable.\n","type":"string","nullable":true},"accountsReceivableAccountingCodeType":{"description":"The type of the accounting code for accounts receivable.\n","type":"string","nullable":true},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment liability."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"adjustmentLiabilityAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment liability accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"adjustmentRevenueAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment revenue accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract asset."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"contractAssetAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract asset accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"contractLiabilityAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract liability accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"contractRecognizedRevenueAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract recognized revenue accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"deferredRevenueAccountingCode":{"description":"The accounting code for deferred revenue, such as Monthly Recurring Liability.\n","type":"string","nullable":true},"deferredRevenueAccountingCodeType":{"description":"The type associated with the deferred revenue accounting code, such as Deferred Revenue. \n","type":"string","nullable":true},"recognizedRevenueAccountingCode":{"description":"The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges. \n","type":"string","nullable":true},"recognizedRevenueAccountingCodeType":{"description":"The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n","type":"string","nullable":true},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"unbilledReceivablesAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the unbilled receivables accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true}},"title":"financeInformation","type":"object"},"id":{"description":"The unique ID of the product rate plan charge.\n","type":"string"},"isStackedDiscount":{"description":[{"$$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 only applicable to the Discount - Percentage charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 130 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates whether the discount is to be calculated as stacked discount. Possible values are 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":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is a stacked discount, which should be calculated by stacking with other discounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is not a stacked discount, which should be calculated in sequence with other discounts."},"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://docs.zuora.com?resourceId=billing-discount-charge-models"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stacked discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base of list price."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only for recurring charges."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum value is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year"],"type":"string"},"model":{"description":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n","enum":["DiscountFixedAmount","DiscountPercentage","FlatFee","PerUnit","Overage","Tiered","TieredwithOverage","Volume","Delivery","MultiAttributePricing","PreratedPerUnit","PreratedPricing","HighWatermarkVolumePricing","HighWatermarkTieredPricing"],"type":"string"},"name":{"description":"The name of the product rate plan charge.\n","type":"string"},"numberOfPeriod":{"description":"Indicates the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.\n","format":"int64","type":"integer"},"overageCalculationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when to calculate overage charges. If the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smoothingMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified, the value of this field is ignored."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"EndOfSmoothingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This option is used by default. The overage is charged at the end of the smoothing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The overage is charged on-demand rather than waiting until the end of the smoothing period."},"children":[]}]}]}]}],"enum":["EndOfSmoothingPeriod","PerBillingPeriod",null],"type":"string","nullable":true},"overageUnusedUnitsCreditOption":{"description":"Determines whether to credit the customer with unused units of usage.\n","enum":["NoCredit","CreditBySpecificRate",null],"type":"string","nullable":true},"priceChangeOption":{"default":"NoChange","description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing",null],"type":"string","nullable":true},"priceIncreaseOption":{"description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["FromTenantPercentageValue","SpecificPercentageValue"],"type":"string"},"priceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceIncreaseOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a decimal value between -100 and 100"},"children":[]}]}]}],"format":"double","type":"number","nullable":true},"pricing":{"description":"Container for the prices of the product rate plan charge.\n","items":{"$ref":"#/components/schemas/GETRatePlanChargePricing"},"type":"array"},"pricingSummary":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A concise description of the charge model and pricing that is suitable to show to your customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the rate plan charge model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and multi-currency is enabled, this field includes an array of string of each currency, and each string of currency includes tier price description separated by comma."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the rate plan charge model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field does not include currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the rate plan charge model is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field includes the currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the following charge models, the value of this field is an empty string:"},"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":"Multi-Attribute Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High Water Mark Tiered Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High Water Mark Volume Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Rated Per Unit Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Rated Pricing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"productChargeDefinitions":{"description":"A link to retrieve product charge definitions of this charge.\n","type":"string"},"productDiscountApplyDetails":{"description":"Container for the application details about a discount product rate plan charge. \n\nOnly discount product rate plan charges have values in this field.\n","items":{"$ref":"#/components/schemas/GETProductDiscountApplyDetailsType"},"type":"array"},"productRatePlanChargeNumber":{"description":"The number of this product rate plan charge.\n","type":"string","nullable":true},"ratingGroup":{"default":"ByBillingPeriod","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"Notes:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for per unit, volume pricing, and tiered pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-Time Charges and Recurring Charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload","ByGroupId",null],"type":"string","nullable":true},"recognizedRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the recognized revenue account for this charge."},"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":"Required when the Allow Blank Accounting Code setting is No."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional when the Allow Blank Accounting Code setting is Yes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"revRecCode":{"description":"Associates this product rate plan charge with a specific revenue recognition code.\n","maxLength":70,"type":"string","nullable":true},"revRecTriggerCondition":{"description":"Specifies when revenue recognition begins.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate",null],"type":"string","nullable":true},"revenueRecognitionRuleName":{"description":"Determines when to recognize the revenue for this charge.\n","enum":["Recognize upon invoicing","Recognize daily over time"],"type":"string"},"smoothingModel":{"description":"Specifies the smoothing model for an overage smoothing charge model.\n","enum":["RollingWindow","Rollover",null],"type":"string","nullable":true},"specificBillingPeriod":{"description":"The specific number of billing periods for this charge.\n","type":"number","nullable":true},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. 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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer","nullable":true},"success":{"description":"Indicates whether the request succeeded.\n","type":"boolean"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tax code for taxation rules. This field is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 value affects the tax calculation of the rate plan charge."},"children":[]}]}]}],"maxLength":64,"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to define taxation for the charge. This field is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 value affects the tax calculation of the rate plan charge."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the charge is taxable. When set to "},"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":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are required when creating or updating th Product Rate Plan Charge object."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"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 value affects the tax calculation of rate plan charges that come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance"],"type":"string"},"type":{"description":"Specifies the type of charge.\n","enum":["OneTime","Recurring","Usage"],"type":"string"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the units of measure (UOM) that is configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the product rate plan charge."},"children":[]}]}]}],"type":"string","nullable":true},"upToPeriods":{"description":"The number of up-to-periods value for this charge.\n","type":"number","nullable":true},"upToPeriodsType":{"description":"The up-to-periods type setting for this charge.\n","enum":["Billing_Periods","Days","Weeks","Months","Years",null],"type":"string","nullable":true},"usageRecordRatingOption":{"default":"EndOfBillingPeriod","description":"Determines how Zuora processes usage records for per-unit usage charges.\n","enum":["EndOfBillingPeriod","OnDemand",null],"type":"string","nullable":true},"useDiscountSpecificAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to define a new accounting code for the new discount charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"children":[]}]}]}],"type":"boolean","nullable":true},"useTenantDefaultForPriceChange":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"children":[]}]}]}],"type":"boolean"},"applyToBillingPeriodPartially":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow the discount duration to be aligned with the billing period partially."},"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":": You must enable the Enhanced Discount feature to access this field."},"children":[]}]}]}],"type":"boolean"},"isPrepaid":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this charge is a prepayment (topup) charge or a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge."},"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 only available if you have the Prepaid with Drawdown feature enabled."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"."},"children":[]}]}]}],"type":"boolean"},"prepaidOperationType":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this charge. It is either a prepayment (topup) charge or a drawdown charge."},"children":[]}]}]}],"enum":["topup","drawdown",null],"type":"string","nullable":true},"prepaidQuantity":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a prepayment charge. Must be a positive number (>0)."},"children":[]}]}]}],"type":"number","nullable":true},"prepaidTotalQuantity":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of units that end customers can use during a validity period when they subscribe to a prepayment charge."},"children":[]}]}]}],"type":"number","nullable":true},"prepaidUom":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a prepayment charge."},"children":[]}]}]}],"type":"string","nullable":true},"validityPeriodType":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period in which the prepayment units are valid to use as defined in a prepayment charge."},"children":[]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"type":"string"},"validityPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to align the validity period of a prepayment charge."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["ChargeStart","TermStart","TermEnd"],"type":"string","nullable":true},"validityPeriodProrationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to prorate the prepaid units for the validity period."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["ProrateUnits","NoProrate"],"type":"string","nullable":true},"specificValidityPeriodLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the length of a specific validity period."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"format":"int32","type":"integer","nullable":true},"drawdownRate":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conversion rate between Usage UOM and Drawdown UOM for a drawdown charge. Must be a positive number (>0)."},"children":[]}]}]}],"type":"number","nullable":true},"drawdownUom":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a drawdown charge."},"children":[]}]}]}],"type":"string","nullable":true},"drawdownPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the priority in which this drawdown charge consumes funds."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"type":"integer","nullable":true},"fundSupportAccountHierarchy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the fund supports account hierarchy."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"type":"boolean","nullable":true},"creditOption":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepayment-charge/create-a-prepayment-charge---zuora-ui"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"isRollover":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"true\" or \"false\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"rolloverApply":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year."},"children":[]}]}]}],"type":"integer"},"rolloverPeriods":{"description":[{"$$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 only available if you have the Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"rolloverPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the unit of time for a rollover period."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["Day","Month","Quarter","Annual"],"type":"string","nullable":true},"rolloverFundPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the priority of the rollover fund."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"type":"integer","nullable":true},"rolloverEndDateType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to determine the end date of a rollover fund."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["ChargeEndDate","SubscriptionTerm"],"type":"string","nullable":true},"formula":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price lookup formula defined for the product rate plan charge, which is used to identify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the correct and relevant charge definition based on the context."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/attribute-based-pricing/price-lookup-in-attribute-based-pricing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price lookup in Attribute-based Pricing"},"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":"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 available only if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/attribute-based-pricing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfigurationItem":{"id":"components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfigurationItem","kind":"json-schema","title":"ConfigurationItem","data":{"properties":{"Key":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the field that is specified for a specific charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration keys supported are 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":"code","inline":true,"attributes":{"content":"formula"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only available if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFieldPerUnitRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only available if you have the Pre-Rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFieldTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only available if you have the Pre-Rated Pricing model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information.)"},"children":[]}]}]}]}],"type":"string"},"Value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the field that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Key"},"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":"Possible values are 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":"A valid pricing formula to calculate actual rating amount for each usage record. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageQuantity()*10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use it with Key "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"formula"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the Multi-Attribute Pricing charge model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A name of a usage custom field that carries the per-unit rate for a usage record. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"perUnitRate__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use it with Key "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFieldPerUnitRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the Pre-Rated Per Unit Pricing charge model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A name of a usage custom field that carries the total amount for a usage record. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use it with Key "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFieldTotalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the Pre-Rated Pricing model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}]}],"type":"string"}},"required":["Key","Value"],"title":"ConfigurationItem","type":"object"}},"components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration":{"id":"components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration","kind":"json-schema","title":"ChargeModelConfiguration","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for charge model configuration data."},"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":"Notes"},"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":"This field is only available if you have the Pre-Rated Pricing or Multi-Attribute Pricing charge models enabled. These charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"102"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs with \"Code: INVALID_VALUE\"."},"children":[]}]}]}]}],"properties":{"ConfigurationItem":{"description":"An array of Charge Model Configuration Key-Value pairs.\n","items":{"$ref":"#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfigurationItem"},"type":"array"}},"title":"ChargeModelConfiguration","type":"object"}},"components/schemas/ProxyCreateOrModifyDeliverySchedule":{"id":"components/schemas/ProxyCreateOrModifyDeliverySchedule","kind":"json-schema","title":"DeliverySchedule","data":{"properties":{"frequency":{"description":"The frequency of the delivery. Only supports weekly now\n","enum":["Weekly"],"type":"string"},"friday":{"description":"The flag to indicate should the delivery happen on Friday\n","type":"boolean"},"monday":{"description":"The flag to indicate should the delivery happen on Monday\n","type":"boolean"},"saturday":{"description":"The flag to indicate should the delivery happen on Saturday\n","type":"boolean"},"sunday":{"description":"The flag to indicate should the delivery happen on Sunday\n","type":"boolean"},"thursday":{"description":"The flag to indicate should the delivery happen on Thursday\n","type":"boolean"},"tuesday":{"description":"The flag to indicate should the delivery happen on Tuesday\n","type":"boolean"},"wendesday":{"description":"The flag to indicate should the delivery happen on Wendesday\n","type":"boolean"}},"title":"DeliverySchedule","type":"object"}},"components/schemas/ProxyCreateOrModifyProductRatePlanChargeTierData":{"id":"components/schemas/ProxyCreateOrModifyProductRatePlanChargeTierData","kind":"json-schema","title":"productRatePlanChargeTierData","data":{"description":"Container for pricing information associated with the product rate plan charge.\n","properties":{"ProductRatePlanChargeTier":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of product rate plan charge tiers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should specify all relevant fields of all tiers, including pricing information for each currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each currency, ensure that the tiers appear in ascending order of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StartingUnit"},"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 example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n  {\n    \"StartingUnit\": \"1\",\n    \"EndingUnit\": \"150\",\n    \"Currency\": \"USD\",\n    \"Price\": 1.95,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"151\",\n    \"EndingUnit\": \"300\",\n    \"Currency\": \"USD\",\n    \"Price\": 1.45,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"1\",\n    \"EndingUnit\": \"150\",\n    \"Currency\": \"EUR\",\n    \"Price\": 1.75,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"151\",\n    \"EndingUnit\": \"300\",\n    \"Currency\": \"EUR\",\n    \"Price\": 1.30,\n    \"PriceFormat\": \"Per Unit\"\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n  {\n    \"StartingUnit\": \"1\",\n    \"EndingUnit\": \"150\",\n    \"Currency\": \"USD\",\n    \"Price\": 1.95,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"151\",\n    \"EndingUnit\": \"300\",\n    \"Currency\": \"USD\",\n    \"Price\": 1.45,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"1\",\n    \"EndingUnit\": \"150\",\n    \"Currency\": \"EUR\",\n    \"Price\": 1.75,\n    \"PriceFormat\": \"Per Unit\"\n  },\n  {\n    \"StartingUnit\": \"151\",\n    \"EndingUnit\": \"300\",\n    \"Currency\": \"EUR\",\n    \"Price\": 1.30,\n    \"PriceFormat\": \"Per Unit\"\n  }\n]\n"},"children":[]}]}],"items":{"properties":{"Currency":{"description":"The code corresponding to the currency for the tier's price.\n","type":"string"},"DiscountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific amount for a fixed discount. Required if the charge model of the product rate plan charge is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discount-Fixed Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"double","type":"number"},"DiscountPercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of discount for a percentage discount. Required if the charge model of the product rate plan charge is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discount-Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"double","type":"number"},"EndingUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end number of a range of units for the tier. Required if the charge model of the product rate plan charge is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered with Overage Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"double","type":"number"},"IsOveragePrice":{"description":"Indicates if the price is an overage price, which is the price when usage surpasses the last defined tier.\n","type":"boolean"},"Price":{"description":"The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n","format":"double","type":"number"},"PriceFormat":{"description":"Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only.\n","enum":["Flat Fee","Per Unit"],"type":"string"},"StartingUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The starting number of a range of units for the tier. Required if the charge model of the product rate plan charge is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered with Overage Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"double","type":"number"}},"type":"object"},"type":"array"}},"title":"productRatePlanChargeTierData","type":"object"}},"components/schemas/ProxyCreateProductRatePlanCharge":{"id":"components/schemas/ProxyCreateProductRatePlanCharge","kind":"json-schema","title":"ProxyCreateProductRatePlanCharge","data":{"allOf":[{"properties":{"AccountingCode":{"description":"The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.\n","maxLength":100,"type":"string"},"ApplyDiscountTo":{"description":"Specifies the type of charges that you want a specific discount to apply to. All field values are case sensitive and in all-caps.\n","enum":["ONETIME (1)","RECURRING (2)","USAGE (4)","ONETIMERECURRING (3)","ONETIMEUSAGE (5)","RECURRINGUSAGE (6)","ONETIMERECURRINGUSAGE (7)"],"type":"string"},"BillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 2"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid BCD integer, 1 - 31"},"children":[]}]}]}],"format":"int32","type":"integer"},"BillCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to determine the billing day for the charge."},"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":"Notes"},"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 you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify which day of the month as the billing day for the charge in the BillCycleDay field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify which day of the week as the billing day for the charge in the WeeklyBillCycleDay field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermStartDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEndDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are only available for prepayment charges. But you can reach out to Zuora Global Support to request enabling it for non-prepaid recurring charges. Meanwhile, note the following rules applies to these options:"},"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 Term End Day option of the Billing Day field must be coupled with the Align to Term End option of the Billing Period Alignment field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For prepaid charges, the Term Start Day option of the Billing Day field must be coupled with the existing Align to Term Start option of the Billing Period Alignment field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-prepaid recurring charges: If Billing Day is set to Term Start Day, Billing Period Alignment must be Align to Term Start; If Billing Day is set to Term End Day, Billing Period Alignment can be set to other values."},"children":[]}]}]}]}]}]}],"enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek","TermStartDay","TermEndDay"],"type":"string"},"BillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD)."},"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":"Notes"},"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":"Specify the number of months or weeks in the SpecificBillingPeriod field if you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Weeks"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Month","Quarter","Annual","Semi-Annual","Specific Months","Subscription Term","Week","Specific Weeks","Specific Days"],"type":"string"},"BillingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aligns charges within the same subscription if multiple charges begin on different dates."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available for prepayment charges by default. Reach out to Zuora Global Support to enable it for non-prepaid recurring charges."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart","AlignToTermEnd"],"type":"string"},"BillingTiming":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["In Advance","In Arrears"],"type":"string"},"ChargeFunction":{"description":[{"$$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 only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"141"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"Standard: Normal charge with no Prepayment or Commitment or Drawdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepayment: For recurring charges. Unit or currency based prepaid charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown: For usage charges. Drawdown from prepaid funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"],"type":"string"},"PrepaymentUnitType":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the commitment is measured in units or currency. A prepaid charge can be of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A minimum commitment charge, which is billed in arrears, can only be of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"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 top-up charges, whether recurring or one-time, this field specifies the type of funds created:"},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge creates a fund using the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepaidUom"},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge creates a fund based on the currency amount calculated using the list price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown (usage) charges, this field specifies the type of funds drawn down from the funds created by top-up charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"],"type":"string"},"DrawdownScope":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether prepaid funds are tracked and consumed at the subscription or account level."},"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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]}],"enum":["SUBSCRIPTION","ACCOUNT"],"type":"string"},"ValidityPeriodAlignment":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VP alignment mode."},"children":[]}]}]}],"enum":["ChargeStart","TermStart","TermEnd"],"type":"string"},"ValidityPeriodProrationOption":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VP proration option."},"children":[]}]}]}],"enum":["ProrateUnits","NoProrate"],"type":"string"},"SpecificValidityPeriodLength":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validity period length."},"children":[]}]}]}],"type":"integer","format":"int32"},"RolloverPeriodType":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover period type."},"children":[]}]}]}],"enum":["Day","Month","Quarter","Annual"],"type":"string"},"RolloverFundPriority":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for rolled-over funds; lower value consumed first."},"children":[]}]}]}],"type":"integer","format":"int32"},"RolloverEndDateType":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover end date type."},"children":[]}]}]}],"enum":["ChargeEndDate","SubscriptionTerm"],"type":"string"},"FundSupportAccountHierarchy":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable sub-account drawdown from parent's funds."},"children":[]}]}]}],"type":"boolean"},"DrawdownPriority":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for drawdown consumption; lower value consumed first."},"children":[]}]}]}],"type":"integer","format":"int32"},"ChargeModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration."},"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":"Notes:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivery Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is available only if you have the Delivery Pricing charge model enabled. The minimal required WSDL version is 128."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"MultiAttributePricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is available only if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information. The minimal required WSDL version is 102."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PreratedPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and  value is available only if you have the Pre-rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information. The minimal required WSDL version is 102."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PreratedPricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is available only if you have the Pre-rated Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information. The minimal required WSDL version is 102."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"HighWatermarkVolumePricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value is available only if you have the High Water Mark Volume Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information. The minimal required WSDL version is 102."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"HighWatermarkTieredPricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is available only if you have the High Water Mark Tiered Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information. The minimal required WSDL version is 102."},"children":[]}]}]}]}],"enum":["Discount-Fixed Amount","Discount-Percentage","Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Tiered Pricing","Tiered with Overage Pricing","Volume Pricing","Delivery Pricing","MultiAttributePricing","PreratedPerUnit","PreratedPricing","HighWatermarkVolumePricing","HighWatermarkTieredPricing"],"type":"string"},"ChargeModelConfiguration":{"$ref":"#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration"},"ChargeType":{"description":"Specifies the type of charge.\n","enum":["OneTime","Recurring","Usage"],"type":"string"},"CreditOption":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"DefaultQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid quantity value."},"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":" When the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeModel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if this field is not specified, the value will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"double","type":"number"},"DeferredRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the deferred revenue account for this charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"DeliverySchedule":{"$ref":"#/components/schemas/ProxyCreateOrModifyDeliverySchedule"},"Description":{"description":"A description of the charge.\n","maxLength":500,"type":"string"},"DiscountLevel":{"description":"Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account.\n","enum":["rateplan","subscription","account"],"type":"string"},"DrawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-soap-api-productrateplancharge-fields-related-to-prepaid-with-drawdown"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields related to Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"number"},"DrawdownUom":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"EndDateCondition":{"default":"SubscriptionEnd","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends after the charge trigger date."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"SubscriptionEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge ends on the subscription end date after a specified period based on the trigger date of the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge ends after a specified period based on the trigger date of the charge. If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the length of the period and a period type by defining the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":": If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date."},"children":[]}]}]}],"enum":["SubscriptionEnd","FixedPeriod"],"type":"string"},"ExcludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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":"Notes"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"115"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"ExcludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the related rate plan charges and order line items from revenue accounting."},"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":"Notes"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"115"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"IncludedUnits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of units in the base set of units."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"IsAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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":"Notes"},"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":"The field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"boolean"},"IsPrepaid":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this charge is a prepayment (topup) charge or a drawdown charge."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"."},"children":[]}]}]}],"type":"boolean"},"IsRollover":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"True\" or \"False\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"IsStackedDiscount":{"description":[{"$$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 only applicable to the Discount - Percentage charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 130 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates whether the discount is to be calculated as stacked discount. Possible values are 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":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is a stacked discount, which should be calculated by stacking with other discounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is not a stacked discount, which should be calculated in sequence with other discounts."},"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://docs.zuora.com?resourceId=billing-discount-charge-models"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stacked discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"IsUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to perform the accounting during revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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":"Notes"},"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":"The field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"boolean"},"LegacyRevenueReporting":{"description":"","type":"boolean"},"ListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price base for the product rate plan charge."},"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":": If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListBasePrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set in the request, the system will use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value as the default value."},"children":[]}]}]}],"enum":["Per Billing Period","Per Month","Per Week","Per Year","Per Specific Months"],"type":"string"},"MaxQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the maximum number of units for this charge. Use this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MinQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a range of units allowed in a product rate plan charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"MinQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the minimum number of units for this charge. Use this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MaxQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a range of units allowed in a product rate plan charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"Name":{"description":"The name of the product rate plan charge.\n","maxLength":100,"type":"string"},"NumberOfPeriod":{"description":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.\n","format":"int64","type":"integer"},"OverageCalculationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when to calculate overage charges. If the value of the SmoothingMode field is not specified, the value of this field is ignored."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"EndOfSmoothingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This option is used by default. The overage is charged at the end of the smoothing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The overage is charged on-demand rather than waiting until the end of the smoothing period."},"children":[]}]}]}]}],"enum":["EndOfSmoothingPeriod","PerBillingPeriod"],"type":"string"},"OverageUnusedUnitsCreditOption":{"description":"Determines whether to credit the customer with unused units of usage.\n","enum":["NoCredit","CreditBySpecificRate",null],"type":"string","nullable":true},"PrepaidOperationType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this charge. It is either a prepayment (topup) charge or a drawdown charge."},"children":[]}]}]}],"enum":["topup","drawdown"],"type":"string"},"PrepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number."},"children":[]}]}]}],"type":"number"},"PrepaidTotalQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of units that end customers can use during a validity period when they subscribe to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"PrepaidUom":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"PriceChangeOption":{"default":"NoChange","description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"type":"string"},"PriceIncreaseOption":{"description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["FromTenantPercentageValue","SpecificPercentageValue"],"type":"string"},"PriceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a decimal value between -100 and 100"},"children":[]}]}]}],"format":"double","type":"number","nullable":true},"ProductCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product category for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ProductClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product class for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ProductFamily":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product family for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ProductLine":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product line for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ReflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set both the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExcludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExcludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"RevenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"RevenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"ProductRatePlanChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The natural key of the product rate plan charge."},"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":"Values"},"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":"leave null for automatically generated string"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an alphanumeric string of 100 characters or fewer"},"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 only available if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]}],"maxLength":100,"type":"string"},"ProductRatePlanChargeTierData":{"$ref":"#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeTierData"},"ProductRatePlanId":{"description":"The ID of the product rate plan associated with this product rate plan charge.\n","maxLength":32,"type":"string"},"ProrationOption":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-usage-charge-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage charge proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"135"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field to specify the charge-level proration option for a usage charge or recurring charge. The tenant-level proration option will be overridden."},"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":"NoProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeBasedProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeFullPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period."},"children":[]}]}]}]}],"enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod"],"type":"string"},"RatingGroup":{"default":"ByBillingPeriod","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"Notes:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for per unit, volume pricing, and tiered pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-Time Charges and Recurring Charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload","ByGroupId",null],"type":"string","nullable":true},"RecognizedRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the recognized revenue account for this charge."},"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":"Required when the Allow Blank Accounting Code setting is No."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional when the Allow Blank Accounting Code setting is Yes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"RevRecCode":{"description":"Associates this product rate plan charge with a specific revenue recognition code.\n","maxLength":70,"type":"string","nullable":true},"RevRecTriggerCondition":{"description":"Specifies when revenue recognition begins.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate",null],"type":"string","nullable":true},"RevenueRecognitionRuleName":{"description":"Determines when to recognize the revenue for this charge.\n","enum":["Recognize upon invoicing","Recognize daily over time"],"type":"string"},"RolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"RolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"SmoothingModel":{"description":"Specifies the smoothing model for an overage smoothing charge model.\n","enum":["RollingWindow","Rollover",null],"type":"string","nullable":true},"SpecificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Weeks"},"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 valid value is a positive integer."},"children":[]}]}]}],"format":"int64","type":"integer","nullable":true},"SpecificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value must be a positive integer between "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"120"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inclusive."},"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":"Notes"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"129"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"int32","maximum":120,"minimum":1,"example":12,"type":"integer","nullable":true},"TaxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tax code for taxation rules. Required when the Taxable field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of rate plan charges that come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":64,"type":"string"},"TaxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to define taxation for the charge. Required when the Taxable field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of rate plan charges that come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"Taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the charge is taxable. When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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 value affects the tax calculation of rate plan charges that come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"TriggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance"],"type":"string"},"UOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a configured unit to measure usage."},"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":": You must specify this field when creating the following charge models:"},"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":"Per Unit Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overage Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered with Overage Pricing"},"children":[]}]}]}]}],"maxLength":25,"type":"string","nullable":true},"UpToPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a whole number between 0 and 65535, exclusive"},"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":"Notes"},"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":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period. This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"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 subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end."},"children":[]}]}]}]}],"format":"int64","type":"integer","nullable":true},"UpToPeriodsType":{"default":"Billing Periods","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the charge ends."},"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":"Notes"},"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":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Billing Periods","Days","Weeks","Months","Years",null],"type":"string","nullable":true},"UsageRecordRatingOption":{"default":"EndOfBillingPeriod","description":"Determines how Zuora processes usage records for per-unit usage charges. \n","enum":["EndOfBillingPeriod","OnDemand",null],"type":"string","nullable":true},"UseDiscountSpecificAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to define a new accounting code for the new discount charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"children":[]}]}]}],"type":"boolean","nullable":true},"UseTenantDefaultForPriceChange":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"children":[]}]}]}],"type":"boolean"},"ValidityPeriodType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period in which the prepayment units are valid to use as defined in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH","SPECIFIC_DAYS","SPECIFIC_WEEKS","SPECIFIC_MONTHS"],"type":"string"},"WeeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which day of the week as the bill cycle day (BCD) for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"ApplyToBillingPeriodPartially":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow the discount duration to be aligned with the billing period partially."},"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":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}],"type":"boolean"},"RolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header to 137 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year."},"children":[]}]}]}],"type":"integer"},"Formula":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price lookup formula defined for the product rate plan charge, which is used to identify the correct and relevant charge definition based on the context."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-price-lookup-in-attribute-based-pricing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price lookup in Attribute-based Pricing"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 138 or higher."},"children":[]}]}]}]}],"type":"string"}},"required":["BillCycleType","BillingPeriod","ChargeModel","ChargeType","Name","ProductRatePlanChargeTierData","ProductRatePlanId","TriggerEvent","UseDiscountSpecificAccountingCode"],"type":"object"},{"$ref":"#/components/schemas/ProductRatePlanChargeObjectNSFields"},{"$ref":"#/components/schemas/ProductRatePlanChargeObjectCustomFields"}],"example":{"Name":"One-Time charge","ProductRatePlanId":"8ad08ae290c4bb470190dedf752745af","ChargeType":"OneTime","ChargeModel":"Flat Fee Pricing","ProductRatePlanChargeTierData":{"ProductRatePlanChargeTier":[{"Price":10}]},"TriggerEvent":"ContractEffective"}}},"components/schemas/ProxyGetProductRatePlanCharge":{"id":"components/schemas/ProxyGetProductRatePlanCharge","kind":"json-schema","title":"ProxyGetProductRatePlanCharge","data":{"allOf":[{"properties":{"AccountingCode":{"description":"The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.\n","maxLength":100,"type":"string"},"ApplyDiscountTo":{"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 charges a specific discount applies to.  This field is only used when applied to a discount charge model. If you are not using a discount charge model, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All field values are case sensitive and in all-caps."},"children":[]}]}]}],"enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"],"type":"string"},"BillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 2"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid BCD integer, 1 - 31"},"children":[]}]}]}],"format":"int32","type":"integer"},"BillCycleType":{"description":"Specifies how to determine the billing day for the charge.               \n","enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek","TermStartDay","TermEndDay"],"type":"string"},"BillingPeriod":{"description":"The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD).\n","enum":["Month","Quarter","Annual","Semi-Annual","Specific Months","Subscription Term","Week","Specific Weeks","Specific Days"],"type":"string"},"BillingPeriodAlignment":{"description":"Aligns charges within the same subscription if multiple charges begin on different dates.\n","enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart","AlignToTermEnd"],"type":"string"},"BillingTiming":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["In Advance","In Arrears"],"type":"string"},"ChargeFunction":{"description":[{"$$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 only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"141"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"Standard: Normal charge with no Prepayment or Commitment or Drawdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepayment: For recurring charges. Unit or currency based prepaid charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown: For usage charges. Drawdown from prepaid funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"],"type":"string"},"PrepaymentUnitType":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the commitment is measured in units or currency. A prepaid charge can be of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A minimum commitment charge, which is billed in arrears, can only be of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"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 top-up charges, whether recurring or one-time, this field specifies the type of funds created:"},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge creates a fund using the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepaidUom"},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge creates a fund based on the currency amount calculated using the list price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown (usage) charges, this field specifies the type of funds drawn down from the funds created by top-up charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"],"type":"string"},"DrawdownScope":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether prepaid funds are tracked and consumed at the subscription or account level."},"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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]}],"enum":["SUBSCRIPTION","ACCOUNT"],"type":"string"},"ValidityPeriodAlignment":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the alignment point used to determine the start of the validity period."},"children":[]}]}]}],"enum":["ChargeStart","TermStart","TermEnd"],"type":"string","nullable":true},"ValidityPeriodProrationOption":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to prorate the prepaid units for the validity period."},"children":[]}]}]}],"enum":["ProrateUnits","NoProrate"],"type":"string","nullable":true},"SpecificValidityPeriodLength":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the validity period length when a specific validity period is used."},"children":[]}]}]}],"format":"int32","type":"integer","nullable":true},"RolloverPeriodType":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the unit of time used for the rollover period."},"children":[]}]}]}],"enum":["Day","Month","Quarter","Annual"],"type":"string","nullable":true},"RolloverFundPriority":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the priority for rolled-over funds. Lower values are consumed first."},"children":[]}]}]}],"format":"int32","type":"integer","nullable":true},"RolloverEndDateType":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when rolled-over funds expire."},"children":[]}]}]}],"enum":["ChargeEndDate","SubscriptionTerm"],"type":"string","nullable":true},"FundSupportAccountHierarchy":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether child accounts can consume drawdown funds from the parent account."},"children":[]}]}]}],"type":"boolean","nullable":true},"DrawdownPriority":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the priority for drawdown consumption. Lower values are consumed first."},"children":[]}]}]}],"format":"int32","type":"integer","nullable":true},"ChargeModel":{"description":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n","enum":["Discount-Fixed Amount","Discount-Percentage","Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Tiered Pricing","Tiered with Overage Pricing","Volume Pricing","Delivery Pricing","MultiAttributePricing","PreratedPerUnit","PreratedPricing","HighWatermarkVolumePricing","HighWatermarkTieredPricing"],"type":"string"},"ChargeType":{"description":"Specifies the type of charge.\n","enum":["OneTime","Recurring","Usage"],"type":"string"},"CreatedById":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The automatically generated ID of the Zuora user who created the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"maxLength":32,"type":"string"},"CreatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object was created."},"children":[]}]}]}],"format":"date-time","maxLength":29,"type":"string"},"DefaultQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid quantity value."},"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":": When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeModel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if this field is not specified, the value will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"double","type":"number"},"DeferredRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the deferred revenue account for this charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"Description":{"description":"A description of the charge.\n","maxLength":500,"type":"string"},"DiscountLevel":{"description":"Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account.\n","enum":["rateplan","subscription","account"],"type":"string"},"EndDateCondition":{"default":"SubscriptionEnd","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends after the charge trigger date."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"SubscriptionEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge ends on the subscription end date after a specified period based on the trigger date of the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge ends after a specified period based on the trigger date of the charge. If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the length of the period and a period type by defining the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":": If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date."},"children":[]}]}]}],"enum":["SubscriptionEnd","FixedPeriod"],"type":"string"},"ExcludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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":"Notes"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"115"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"ExcludeItemBookingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the related rate plan charges and order line items from revenue accounting."},"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":"Notes"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"115"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"Id":{"description":"Object identifier.","type":"string"},"IncludedUnits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of units in the base set of units."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"LegacyRevenueReporting":{"description":"","type":"boolean"},"ListPriceBase":{"description":"The list price base for the product rate plan charge.\n","enum":["Per Billing Period","Per Month","Per Week","Per Year","Per Specific Months"],"type":"string"},"MaxQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the maximum number of units for this charge. Use this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MinQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a range of units allowed in a product rate plan charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"MinQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the minimum number of units for this charge. Use this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MaxQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a range of units allowed in a product rate plan charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"Name":{"description":"The name of the product rate plan charge.\n","maxLength":100,"type":"string"},"NumberOfPeriod":{"description":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.\n","format":"int64","type":"integer"},"OverageCalculationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when to calculate overage charges. If the value of the SmoothingMode field is not specified, the value of this field is ignored."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"EndOfSmoothingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This option is used by default. The overage is charged at the end of the smoothing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The overage is charged on-demand rather than waiting until the end of the smoothing period."},"children":[]}]}]}]}],"enum":["EndOfSmoothingPeriod","PerBillingPeriod",null],"type":"string","nullable":true},"OverageUnusedUnitsCreditOption":{"description":"Determines whether to credit the customer with unused units of usage.\n","enum":["NoCredit","CreditBySpecificRate",null],"type":"string","nullable":true},"PriceChangeOption":{"default":"NoChange","description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing",null],"type":"string","nullable":true},"PriceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a decimal value between -100 and 100"},"children":[]}]}]}],"format":"double","type":"number","nullable":true},"ProductRatePlanId":{"description":"The ID of the product rate plan associated with this product rate plan charge.\n","maxLength":32,"type":"string"},"ProrationOption":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-usage-charge-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage charge proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"135"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field to specify the charge-level proration option for a usage charge or recurring charge. The tenant-level proration option will be overridden."},"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":"NoProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeBasedProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeFullPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period."},"children":[]}]}]}]}],"enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod"],"type":"string"},"RatingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rating group based on which usage records are rated. Only applicable to Usage charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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://docs.zuora.com?resourceId=billing-usage-rating-by-group"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage rating by group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload","ByGroupId",null],"type":"string","nullable":true},"RecognizedRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the recognized revenue account for this charge."},"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":"Required when the Allow Blank Accounting Code setting is No."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional when the Allow Blank Accounting Code setting is Yes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"RevRecCode":{"description":"Associates this product rate plan charge with a specific revenue recognition code.\n","maxLength":70,"type":"string","nullable":true},"RevRecTriggerCondition":{"description":"Specifies when revenue recognition begins.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate",null],"type":"string","nullable":true},"RevenueRecognitionRuleName":{"description":"Determines when to recognize the revenue for this charge.\n","enum":["Recognize upon invoicing","Recognize daily over time"],"type":"string"},"SmoothingModel":{"description":"Specifies the smoothing model for an overage smoothing charge model.\n","enum":["RollingWindow","Rollover",null],"type":"string","nullable":true},"SpecificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Weeks"},"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 valid value is a positive integer."},"children":[]}]}]}],"format":"int64","type":"integer","nullable":true},"SpecificListPriceBase":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. 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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"129"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"TaxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tax code for taxation rules. Required when the Taxable field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of rate plan charges that come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":64,"type":"string"},"TaxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to define taxation for the charge. Required when the Taxable field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of rate plan charges that come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"Taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the charge is taxable. When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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 value affects the tax calculation of rate plan charges that come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"TriggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance"],"type":"string"},"UOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units to measure usage."},"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":": You must specify this field when creating the following charge models:"},"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":"Per Unit Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume Pricin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overage Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered with Overage Pricing"},"children":[]}]}]}]}],"maxLength":25,"type":"string","nullable":true},"UpToPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a whole number between 0 and 65535, exclusive"},"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":"Notes"},"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":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period. This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"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 subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end."},"children":[]}]}]}]}],"format":"int64","type":"integer","nullable":true},"UpToPeriodsType":{"default":"Billing Periods","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the charge ends."},"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":"Notes"},"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":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Billing Periods","Days","Weeks","Months","Years",null],"type":"string","nullable":true},"UpdatedById":{"description":"The ID of the last user to update the object.\n","maxLength":32,"type":"string"},"UpdatedDate":{"description":"The date when the object was last updated.\n","format":"date-time","maxLength":29,"type":"string"},"UseDiscountSpecificAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to define a new accounting code for the new discount charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"children":[]}]}]}],"type":"boolean","nullable":true},"UseTenantDefaultForPriceChange":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"children":[]}]}]}],"type":"boolean"},"WeeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which day of the week as the bill cycle day (BCD) for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"IsAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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":"Notes"},"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":"The field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"boolean"},"IsUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to perform the accounting during revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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":"Notes"},"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":"The field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"boolean"},"ProductCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product category for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ProductClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product class for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ProductFamily":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product family for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ProductLine":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product line for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ReflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set both the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExcludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExcludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration customers are not supported with net amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"RevenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"RevenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"ApplyToBillingPeriodPartially":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow the discount duration to be aligned with the billing period partially."},"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":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}],"type":"boolean"},"Formula":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price lookup formula defined for the product rate plan charge, which is used to identify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the correct and relevant charge definition based on the context."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-price-lookup-in-attribute-based-pricing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price lookup in Attribute-based Pricing"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attribute-based-pricing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 138 or higher."},"children":[]}]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductRatePlanChargeObjectNSFields"},{"$ref":"#/components/schemas/ProductRatePlanChargeObjectCustomFields"}]}},"components/schemas/ProxyModifyProductRatePlanCharge":{"id":"components/schemas/ProxyModifyProductRatePlanCharge","kind":"json-schema","title":"ProxyModifyProductRatePlanCharge","data":{"allOf":[{"properties":{"AccountingCode":{"description":"The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.\n","maxLength":100,"type":"string"},"ApplyDiscountTo":{"description":"Specifies the type of charges that you want a specific discount to apply to. All field values are case sensitive and in all-caps.\n","enum":["ONETIME (1)","RECURRING (2)","USAGE (4)","ONETIMERECURRING (3)","ONETIMEUSAGE (5)","RECURRINGUSAGE (6)","ONETIMERECURRINGUSAGE (7)"],"type":"string"},"BillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 2 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid BCD integer, 1 - 31"},"children":[]}]}]}],"format":"int32","type":"integer"},"BillCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to determine the billing day for the charge."},"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":"Notes"},"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 you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify which day of the month as the billing day for the charge in the BillCycleDay field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify which day of the week as the billing day for the charge in the WeeklyBillCycleDay field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermStartDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEndDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are only available for prepayment charges. But you can reach out to Zuora Global Support to request enabling it for non-prepaid recurring charges. Meanwhile, note the following rules applies to these options:"},"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 Term End Day option of the Billing Day field must be coupled with the Align to Term End option of the Billing Period Alignment field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For prepaid charges, the Term Start Day option of the Billing Day field must be coupled with the existing Align to Term Start option of the Billing Period Alignment field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-prepaid recurring charges: If Billing Day is set to Term Start Day, Billing Period Alignment must be Align to Term Start; If Billing Day is set to Term End Day, Billing Period Alignment can be set to other values."},"children":[]}]}]}]}]}]}],"enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek","TermStartDay","TermEndDay"],"type":"string"},"BillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD)."},"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":"Notes"},"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":"Specify the number of months or weeks in the SpecificBillingPeriod field if you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Weeks"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Month","Quarter","Annual","Semi-Annual","Specific Months","Subscription Term","Week","Specific Weeks","Specific Days"],"type":"string"},"BillingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aligns charges within the same subscription if multiple charges begin on different dates."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available for prepayment charges by default. Reach out to Zuora Global Support to enable it for non-prepaid recurring charges."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart","AlignToTermEnd"],"type":"string"},"BillingTiming":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["In Advance","In Arrears"],"type":"string"},"ChargeFunction":{"description":[{"$$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 only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"141"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"Standard: Normal charge with no Prepayment or Commitment or Drawdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepayment: For recurring charges. Unit or currency based prepaid charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown: For usage charges. Drawdown from prepaid funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"],"type":"string"},"PrepaymentUnitType":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the commitment is measured in units or currency. A prepaid charge can be of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A minimum commitment charge, which is billed in arrears, can only be of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"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 top-up charges, whether recurring or one-time, this field specifies the type of funds created:"},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge creates a fund using the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepaidUom"},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge creates a fund based on the currency amount calculated using the list price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown (usage) charges, this field specifies the type of funds drawn down from the funds created by top-up charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"],"type":"string"},"DrawdownScope":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether prepaid funds are tracked and consumed at the subscription or account level."},"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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]}],"enum":["SUBSCRIPTION","ACCOUNT"],"type":"string"},"ValidityPeriodAlignment":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VP alignment mode."},"children":[]}]}]}],"enum":["ChargeStart","TermStart","TermEnd"],"type":"string"},"ValidityPeriodProrationOption":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VP proration option."},"children":[]}]}]}],"enum":["ProrateUnits","NoProrate"],"type":"string"},"SpecificValidityPeriodLength":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validity period length."},"children":[]}]}]}],"type":"integer","format":"int32"},"RolloverPeriodType":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover period type."},"children":[]}]}]}],"enum":["Day","Month","Quarter","Annual"],"type":"string"},"RolloverFundPriority":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for rolled-over funds; lower value consumed first."},"children":[]}]}]}],"type":"integer","format":"int32"},"RolloverEndDateType":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover end date type."},"children":[]}]}]}],"enum":["ChargeEndDate","SubscriptionTerm"],"type":"string"},"FundSupportAccountHierarchy":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable sub-account drawdown from parent's funds."},"children":[]}]}]}],"type":"boolean"},"DrawdownPriority":{"description":[{"$$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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"155"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for drawdown consumption; lower value consumed first."},"children":[]}]}]}],"type":"integer","format":"int32"},"ChargeModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration."},"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":"Notes:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivery Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is available only if you have the Delivery Pricing charge model enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"MultiAttributePricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is available only if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PreratedPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and  value is available only if you have the Pre-rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PreratedPricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is available only if you have the Pre-rated Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"HighWatermarkVolumePricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value is available only if you have the High Water Mark Volume Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"HighWatermarkTieredPricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is available only if you have the High Water Mark Tiered Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}]}],"enum":["Discount-Fixed Amount","Discount-Percentage","Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Tiered Pricing","Tiered with Overage Pricing","Volume Pricing","Delivery Pricing","MultiAttributePricing","PreratedPerUnit","PreratedPricing`","HighWatermarkVolumePricing","HighWatermarkTieredPricing"],"type":"string"},"ChargeModelConfiguration":{"$ref":"#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration"},"CreditOption":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepayment-charge/create-a-prepayment-charge---zuora-ui"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"DefaultQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid quantity value."},"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":" When the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeModel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume Pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if this field is not specified, the value will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"double","type":"number"},"DeferredRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the deferred revenue account for this charge."},"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":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountingCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is mandatory to update this field. Specify the same accounting code name as given in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountingCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"DeliverySchedule":{"$ref":"#/components/schemas/ProxyCreateOrModifyDeliverySchedule"},"Description":{"description":"A description of the charge.\n","maxLength":500,"type":"string"},"DiscountLevel":{"description":"Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account.\n","enum":["rateplan","subscription","account"],"type":"string"},"DrawdownRate":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/drawdown-charge/create-a-drawdown-charge---zuora-ui"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a drawdown charge."},"children":[]}]}]}],"type":"number"},"DrawdownUom":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a drawdown charge."},"children":[]}]}]}],"type":"string"},"EndDateCondition":{"default":"SubscriptionEnd","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends after the charge trigger date."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"SubscriptionEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge ends on the subscription end date after a specified period based on the trigger date of the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge ends after a specified period based on the trigger date of the charge. If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the length of the period and a period type by defining the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":": If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date."},"children":[]}]}]}],"enum":["SubscriptionEnd","FixedPeriod"],"type":"string"},"ExcludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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":"Notes"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"115"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"ExcludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the related rate plan charges and order line items from revenue accounting."},"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":"Notes"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"115"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"IncludedUnits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of units in the base set of units."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"IsAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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":"Notes"},"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":"The field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"boolean"},"IsPrepaid":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this charge is a prepayment (topup) charge or a drawdown charge."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"."},"children":[]}]}]}],"type":"boolean"},"IsRollover":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"True\" or \"False\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"IsStackedDiscount":{"description":[{"$$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 only applicable to the Discount - Percentage charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 130 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates whether the discount is to be calculated as stacked discount. Possible values are 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":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is a stacked discount, which should be calculated by stacking with other discounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is not a stacked discount, which should be calculated in sequence with other discounts."},"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://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/charge-models---configure-any-pricing/discount-pricing/discount-charge-models/stacked-discounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stacked discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"IsUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to perform the accounting during revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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":"Notes"},"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":"The field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"boolean"},"LegacyRevenueReporting":{"description":"","type":"boolean"},"ListPriceBase":{"description":"The list price base for the product rate plan charge.\n","enum":["Per Billing Period","Per Month","Per Week","Per Year","Per Specific Months"],"type":"string"},"MaxQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the maximum number of units for this charge. Use this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MinQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a range of units allowed in a product rate plan charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"MinQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the minimum number of units for this charge. Use this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MaxQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a range of units allowed in a product rate plan charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"Name":{"description":"The name of the product rate plan charge.\n","maxLength":100,"type":"string"},"NumberOfPeriod":{"description":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value must be a positive whole number.\n","format":"int64","type":"integer"},"OverageCalculationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when to calculate overage charges. If the value of the SmoothingMode field is not specified, the value of this field is ignored."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"EndOfSmoothingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This option is used by default. The overage is charged at the end of the smoothing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The overage is charged on-demand rather than waiting until the end of the smoothing period."},"children":[]}]}]}]}],"enum":["EndOfSmoothingPeriod","PerBillingPeriod",null],"type":"string","nullable":true},"OverageUnusedUnitsCreditOption":{"description":"Determines whether to credit the customer with unused units of usage.\n","enum":["NoCredit","CreditBySpecificRate",null],"type":"string","nullable":true},"PrepaidQuantity":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number."},"children":[]}]}]}],"type":"number"},"PrepaidUom":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"PriceChangeOption":{"default":"NoChange","description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing",null],"type":"string","nullable":true},"PriceIncreaseOption":{"description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["FromTenantPercentageValue","SpecificPercentageValue"],"type":"string"},"PriceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a decimal value between -100 and 100"},"children":[]}]}]}],"format":"double","type":"number","nullable":true},"ProductCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product category for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ProductClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product class for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ProductFamily":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product family for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ProductLine":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product line for integration with Zuora Revenue."},"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":"Notes"},"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":"This field is available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 132 or later."},"children":[]}]}]}]}],"type":"string"},"ProrationOption":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-usage-charge-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage charge proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"135"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field to specify the charge-level proration option for a usage charge or recurring charge. The tenant-level proration option will be overridden."},"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":"NoProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeBasedProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeFullPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period."},"children":[]}]}]}]}],"enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod"],"type":"string"},"RevenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/configure-revenue-settings/revenue-recognition-policy","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 140 or higher. Otherwise, an error occurs."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"RevenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/configure-revenue-settings/revenue-recognition-policy","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 140 or higher. Otherwise, an error occurs."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"ProductRatePlanChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The natural key of the product rate plan charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For existing Product Rate Plan Charge objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"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 only available if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]}],"maxLength":100,"type":"string"},"ProductRatePlanChargeTierData":{"$ref":"#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeTierData"},"ProductRatePlanId":{"description":"The ID of the product rate plan associated with this product rate plan charge.\n","maxLength":32,"type":"string"},"RatingGroup":{"default":"ByBillingPeriod","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for per unit, volume pricing, and tiered pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-Time Charges and Recurring Charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload","ByGroupId",null],"type":"string","nullable":true},"RecognizedRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the recognized revenue account for this charge."},"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":"Required when the Allow Blank Accounting Code setting is No."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional when the Allow Blank Accounting Code setting is Yes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"RevRecCode":{"description":"Associates this product rate plan charge with a specific revenue recognition code.\n","maxLength":70,"type":"string","nullable":true},"RevRecTriggerCondition":{"description":"Specifies when revenue recognition begins.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate",null],"type":"string","nullable":true},"RevenueRecognitionRuleName":{"description":"Determines when to recognize the revenue for this charge.\n","enum":["Recognize upon invoicing","Recognize daily over time"],"type":"string"},"RolloverApply":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"RolloverPeriods":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"SmoothingModel":{"description":"Specifies the smoothing model for an overage smoothing charge model.\n","enum":["RollingWindow","Rollover",null],"type":"string","nullable":true},"SpecificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Weeks"},"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 valid value is a positive integer."},"children":[]}]}]}],"format":"int64","type":"integer","nullable":true},"SpecificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/set-up-recurring-charges-with-annual-list-price/overview-of-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"129"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer","nullable":true},"TaxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tax code for taxation rules. Required when the Taxable field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of rate plan charges that come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":64,"type":"string"},"TaxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to define taxation for the charge. Required when the Taxable field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of rate plan charges that come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"Taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the charge is taxable. When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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 value affects the tax calculation of rate plan charges that come from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"TriggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance"],"type":"string"},"UOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units to measure usage."},"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":": You must specify this field when creating the following charge models:"},"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":"Per Unit Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overage Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered with Overage Pricing"},"children":[]}]}]}]}],"maxLength":25,"type":"string","nullable":true},"UpToPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a whole number between 0 and 65535, exclusive"},"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":"Notes"},"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":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period. This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"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 subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end."},"children":[]}]}]}]}],"format":"int64","type":"integer","nullable":true},"UpToPeriodsType":{"default":"Billing Periods","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the charge ends."},"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":"Notes"},"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":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Billing Periods","Days","Weeks","Months","Years",null],"type":"string","nullable":true},"UsageRecordRatingOption":{"default":"EndOfBillingPeriod","description":"Determines how Zuora processes usage records for per-unit usage charges. \n","enum":["EndOfBillingPeriod","OnDemand",null],"type":"string","nullable":true},"UseDiscountSpecificAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to define a new accounting code for the new discount charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"children":[]}]}]}],"type":"boolean","nullable":true},"UseTenantDefaultForPriceChange":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"children":[]}]}]}],"type":"boolean"},"ValidityPeriodType":{"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period in which the prepayment units are valid to use as defined in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/create-prepayment-charge-with-rollover/create-prepayment-charge-with-rollover---zuora-ui"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"type":"string"},"WeeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which day of the week as the bill cycle day (BCD) for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"ApplyToBillingPeriodPartially":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow the discount duration to be aligned with the billing period partially."},"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":": You must enable the Enhanced Discount feature to access this field."},"children":[]}]}]}],"type":"boolean"},"RolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header to 137 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year."},"children":[]}]}]}],"type":"integer"},"Formula":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price lookup formula defined for the product rate plan charge, which is used to identify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the correct and relevant charge definition based on the context."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/attribute-based-pricing/price-lookup-in-attribute-based-pricing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price lookup in Attribute-based Pricing"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/attribute-based-pricing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute-based Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 138 or higher."},"children":[]}]}]}]}],"type":"string"}},"required":["BillCycleType","BillingPeriod","ChargeModel","ProductRatePlanChargeTierData","ProductRatePlanId","TriggerEvent","UseDiscountSpecificAccountingCode"],"type":"object"},{"$ref":"#/components/schemas/ProductRatePlanChargeObjectNSFields"},{"$ref":"#/components/schemas/ProductRatePlanChargeObjectCustomFields"}],"example":{"Name":"One-Time charge"}}},"components/schemas/ProductChargeDefinitionObjectCustomFields":{"id":"components/schemas/ProductChargeDefinitionObjectCustomFields","kind":"json-schema","title":"productChargeDefinitionFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product Charge Definition object. The name of each custom field has the form of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Product Charge Definition object.\n","title":"productChargeDefinitionFieldsCustom","type":"object"}},"components/schemas/GETChargeDefinitionPricingTier":{"id":"components/schemas/GETChargeDefinitionPricingTier","kind":"json-schema","title":"pricingTiers","data":{"description":"An array of charge pricing tiers.\n","items":{"properties":{"currency":{"description":"The code corresponding to the currency for the tier's price.\n","type":"string"},"discountAmount":{"description":"The specific amount for a fixed discount. The field is applicable only for charges based on the Discount-Fixed Amount charge model.\n","format":"double","type":"number"},"discountPercentage":{"description":"The percentage of discount for a percentage discount. The field is applicable only for charges based on the Discount-Percentage charge model.\n","format":"double","type":"number"},"endingUnit":{"description":"The end number of a range of units for the tier. The field is applicable only for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n","format":"double","type":"number"},"overagePrice":{"description":"Indicates whether the price is an overage price, which is the price when usage surpasses the last defined tier.\n","format":"double","type":"number"},"price":{"description":"The price of the tier if the price format is flat fee, or the price of each unit in the tier if the price format is per unit.\n","format":"double","type":"number"},"startingUnit":{"description":"The starting number of a range of units for the tier. The field is applicable only for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n","format":"double","type":"number"}},"type":"object"},"title":"pricingTiers","type":"array"}},"components/schemas/GETProductChargeDefinitionPricing":{"id":"components/schemas/GETProductChargeDefinitionPricing","kind":"json-schema","title":"prices","data":{"properties":{"currency":{"description":"The currency for the price.\n","type":"string"},"discountAmount":{"description":"The specific amount for a fixed discount. The field is applicable only for charges based on the Discount-Fixed Amount charge model.\n","format":"double","type":"number"},"discountPercentage":{"description":"The percentage of discount for a percentage discount. The field is applicable only for charges based on the Discount-Percentage charge model.\n","format":"double","type":"number"},"includedUnits":{"description":"The number of units included in this price item. \n\nThis field is only applicable for charges based on the Overage Pricing charge model.\n","type":"number"},"overagePrice":{"description":"The overage price of the price item. \n\nThis field is only applicable for charges based on the Overage Pricing or Tiered with Overage Pricing charge model.\n","type":"number"},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of this item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable for charges based on the following charge models:"},"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":"Flat Fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per Unit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Pricing"},"children":[]}]}]}]}],"type":"number"},"tiers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the tiers of the price item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable for charges based on the following charge models:"},"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":"Tiered Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered with Overage Pricing"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/GETChargeDefinitionPricingTier"},"type":"array"}},"title":"prices","type":"object"}},"components/schemas/GETProductChargeDefinitionsResponse":{"id":"components/schemas/GETProductChargeDefinitionsResponse","kind":"json-schema","title":"GETProductChargeDefinitionsResponse","data":{"properties":{"chargeDefinitions":{"description":"The list of the product charge definitions that are retrieved.\n","items":{"properties":{"applyDiscountTo":{"description":"Indicates which type of charge the discount charge applies to.\n","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE",null],"type":"string","nullable":true},"billingDay":{"description":"The bill cycle type for the charge.\n","type":"string"},"billingPeriod":{"description":"The billing period for the product charge definition.\n","type":"string"},"billingPeriodAlignment":{"description":"The billing period alignment setting for the charge.\n","enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart","AlignToTermEnd"],"type":"string"},"billingTiming":{"description":"The billing timing setting for the product charge definition.\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"chargeModel":{"description":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n","enum":["DiscountFixedAmount","DiscountPercentage","FlatFee","PerUnit","Overage","Tiered","TieredWithOverage","Volume","Delivery","MultiAttributePricing","PreratedPerUnit","PreratedPricing","HighWatermarkVolumePricing","HighWatermarkTieredPricing"],"type":"string"},"chargeType":{"description":"Indicates the type of charge.\n","enum":["OneTime","Recurring","Usage"],"type":"string"},"customFields":{"$ref":"#/components/schemas/ProductChargeDefinitionObjectCustomFields"},"defaultQuantity":{"description":"The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n","type":"number","nullable":true},"deliverySchedule":{"$ref":"#/components/schemas/GETDeliverySchedule"},"description":{"description":"The description for the charge.\n","type":"string"},"discountClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The class that the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied."},"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://docs.zuora.com?resourceId=billing-manage-discount-classes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Discount Classes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account",null],"type":"string","nullable":true},"effectiveEndDate":{"description":"The effective end date of the product charge definition.\n","format":"date-time","type":"string"},"effectiveStartDate":{"description":"The effective start date of the product charge definition.\n","format":"date-time","type":"string"},"endDateCondition":{"description":"The end date condition for this charge.\n","enum":["Subscription_End","One_Time","Fixed_Period","Specific_End_Date"],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related rate plan charges and order line items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"isAllocationEligible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"isUnbilled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to perform the accounting during revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"productCategory":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product category for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"productClass":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product class for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"productFamily":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product family for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"productLine":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product line for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"numberOfPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is ued when overage smoothing model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RollingWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rollover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer","nullable":true},"financeInformation":{"description":"Container for finance information of the rate plan charge.\n","properties":{"accountsReceivableAccountingCode":{"description":"The accounting code for accounts receivable.\n","type":"string","nullable":true},"accountsReceivableAccountingCodeType":{"description":"The type of the accounting code for accounts receivable.\n","type":"string","nullable":true},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment liability."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment liability accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment revenue accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract asset."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract asset accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract liability accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract recognized revenue accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCode":{"description":"The accounting code for deferred revenue, such as Monthly Recurring Liability.\n","type":"string"},"deferredRevenueAccountingCodeType":{"description":"The type associated with the deferred revenue accounting code, such as Deferred Revenue. \n","type":"string","nullable":true},"recognizedRevenueAccountingCode":{"description":"The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","type":"string"},"recognizedRevenueAccountingCodeType":{"description":"The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n","type":"string","nullable":true},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"unbilledReceivablesAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the unbilled receivables accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"}},"title":"financeInformation","type":"object"},"isDefault":{"description":"Indicates whether this charge definition is the default one for the charge.\n","type":"boolean"},"isStackedDiscount":{"description":[{"$$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 only applicable to the Discount - Percentage charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 130 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates whether the discount is to be calculated as stacked discount. Possible values are 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":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is a stacked discount, which should be calculated by stacking with other discounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is not a stacked discount, which should be calculated in sequence with other discounts."},"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://docs.zuora.com?resourceId=billing-discount-charge-models"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stacked discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price base."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only for recurring charges."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum value is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year"],"type":"string"},"numberOfPeriod":{"description":"Indicates the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.\n","format":"int64","type":"integer"},"overageCalculationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when to calculate overage charges. If the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SmoothingMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified, the value of this field is ignored."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"EndOfSmoothingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This option is used by default. The overage is charged at the end of the smoothing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The overage is charged on-demand rather than waiting until the end of the smoothing period."},"children":[]}]}]}]}],"enum":["EndOfSmoothingPeriod","PerBillingPeriod",null],"type":"string","nullable":true},"overageUnusedUnitsCreditOption":{"description":"Determines whether to credit the customer with unused units of usage.\n","enum":["NoCredit","CreditBySpecificRate",null],"type":"string","nullable":true},"priceChangeOption":{"default":"NoChange","description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing",null],"type":"string","nullable":true},"priceIncreaseOption":{"description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["FromTenantPercentageValue","SpecificPercentageValue"],"type":"string"},"priceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceIncreaseOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a decimal value between -100 and 100"},"children":[]}]}]}],"format":"double","type":"number","nullable":true},"prices":{"description":"Container for the prices of the product charge definition.\n","items":{"$ref":"#/components/schemas/GETProductChargeDefinitionPricing"},"type":"array"},"productChargeDefinitionId":{"description":"The unique ID of the product charge definition.\n","type":"string"},"productChargeDefinitionNumber":{"description":"The unique number (natural key) of the product charge definition.\n","type":"string"},"productDiscountApplyDetails":{"description":"Container for the application details about a discount product rate plan charge. \n\nOnly discount product rate plan charges have values for this field.\n","items":{"$ref":"#/components/schemas/GETProductDiscountApplyDetailsType"},"type":"array"},"productRatePlanChargeId":{"description":"The unique ID of the product charge of the charge definition.\n","type":"string"},"productRatePlanChargeNumber":{"description":"The unique number (natural key) of the product charge of the charge definition.\n","type":"string","nullable":true},"productRatePlanId":{"description":"The unique ID of the product rate plan that uses this charge definition.\n","type":"string","nullable":true},"productRatePlanName":{"description":"Th name of the product rate plan that uses this charge definition.\n","type":"string","nullable":true},"productRatePlanNumber":{"description":"The unique number (natural key) of the product rate plan that uses this charge definition.\n","type":"string","nullable":true},"ratingGroup":{"default":"ByBillingPeriod","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"Notes:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for Per Unit, Volume Pricing, and Tiered Pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-time charges and recurring charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload","ByGroupId",null],"type":"string","nullable":true},"recognizedRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the recognized revenue account for this charge."},"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":"Required when the Allow Blank Accounting Code setting is No."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional when the Allow Blank Accounting Code setting is Yes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"revRecCode":{"description":"Associates this product rate plan charge with a specific revenue recognition code.\n","maxLength":70,"type":"string","nullable":true},"revRecTriggerCondition":{"description":"Indicates when revenue recognition begins.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate",null],"type":"string","nullable":true},"revenueRecognitionRuleName":{"description":"Determines when to recognize the revenue for this charge.\n","enum":["Recognize upon invoicing","Recognize daily over time"],"type":"string"},"smoothingModel":{"description":"Indicates the smoothing model for an overage smoothing charge model.\n","enum":["RollingWindow","Rollover",null],"type":"string","nullable":true},"specificBillingPeriod":{"description":"The specific number of billing period for the product charge definition.\n","type":"number","nullable":true},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge definition."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","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 the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer","nullable":true},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tax code for taxation rules."},"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 value affects the tax calculation of the rate plan charge."},"children":[]}]}]}],"maxLength":64,"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to define taxation for the charge."},"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 value affects the tax calculation of the rate plan charge."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the charge definition is taxable."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"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 value affects the tax calculation of the rate plan charge."},"children":[]}]}]}],"type":"boolean"},"term":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"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 is to be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"number","nullable":true},"termPeriodType":{"description":"The period type for the subscription term that is eligible for this charge definition.\n","enum":["Month","Year","Day","Week",null],"type":"string","nullable":true},"termType":{"description":"The type of the subscription that is eligible for this charge definition.\n","enum":["TERMED","EVERGREEN",null],"type":"string","nullable":true},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge definition."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance"],"type":"string"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the unit of measure (UOM) that is configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the product rate plan charge."},"children":[]}]}]}],"type":"string","nullable":true},"upToPeriods":{"description":"The number of up-to periods for this charge.\n","type":"number","nullable":true},"upToPeriodsType":{"description":"The up-to-periods type for this charge.\n","enum":["Billing_Periods","Days","Weeks","Months","Years",null],"type":"string","nullable":true},"usageRecordRatingOption":{"default":"EndOfBillingPeriod","description":"Determines how Zuora processes usage records for per-unit usage charges.\n","enum":["EndOfBillingPeriod","OnDemand",null],"type":"string","nullable":true},"useDiscountSpecificAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to define a new accounting code for the new discount charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"children":[]}]}]}],"type":"boolean","nullable":true},"useTenantDefaultForPriceChange":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"children":[]}]}]}],"type":"boolean"}},"title":"chargeDefinitions","type":"object"},"type":"array"},"success":{"description":"Indicates whether the request succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/POSTChargeDefinitionPricingTier":{"id":"components/schemas/POSTChargeDefinitionPricingTier","kind":"json-schema","title":"pricingTiers","data":{"description":"An array of charge pricing tier.\n","items":{"properties":{"currency":{"description":"The code corresponding to the currency for the tier's price.\n","type":"string"},"endingUnit":{"description":"The end number of a range of units for the tier. This field is required for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n","format":"double","type":"number"},"price":{"description":"The price of the tier if the price format is flat fee, or the price of each unit in the tier if the price format is per unit.\n","format":"double","type":"number"},"priceFormat":{"description":"The price format of the tier.\n","enum":["Flat Fee","Per Unit"],"type":"string"},"startingUnit":{"description":"The starting number of a range of units for the tier. This field is required for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n","format":"double","type":"number"}},"type":"object"},"title":"pricingTiers","type":"array"}},"components/schemas/POSTProductChargeDefinitionPricing":{"id":"components/schemas/POSTProductChargeDefinitionPricing","kind":"json-schema","title":"prices","data":{"properties":{"currency":{"description":"The currency for the price.\n","type":"string"},"discountAmount":{"description":"The specific amount for a fixed discount. The field is applicable only for charges based on the Discount-Fixed Amount charge model.\n","format":"double","type":"number"},"discountPercentage":{"description":"The percentage of discount for a percentage discount. The field is applicable only for charges based on the Discount-Percentage charge model.\n","format":"double","type":"number"},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of this item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable for charges based on the following charge models:"},"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":"Flat Fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per Unit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Pricing"},"children":[]}]}]}]}],"type":"number"},"tiers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the tiers of the price item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable for charges based on the following charge models:"},"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":"Tiered Pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume Pricing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify all relevant fields of all tiers, including pricing information for each currency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each currency, ensure that the tiers appear in ascending order of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StartingUnit"},"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 example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n  {\n    \"startingUnit\": \"1\",\n    \"endingUnit\": \"150\",\n    \"currency\": \"USD\",\n    \"price\": 1.95,\n    \"priceFormat\": \"Per Unit\"\n  },\n  {\n    \"startingUnit\": \"151\",\n    \"endingUnit\": \"300\",\n    \"currency\": \"USD\",\n    \"price\": 1.45,\n    \"priceFormat\": \"Per Unit\"\n  },\n  {\n    \"startingUnit\": \"1\",\n    \"endingUnit\": \"150\",\n    \"currency\": \"EUR\",\n    \"price\": 1.75,\n    \"priceFormat\": \"Per Unit\"\n  },\n  {\n    \"startingUnit\": \"151\",\n    \"endingUnit\": \"300\",\n    \"currency\": \"EUR\",\n    \"price\": 1.30,\n    \"priceFormat\": \"Per Unit\"\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n  {\n    \"startingUnit\": \"1\",\n    \"endingUnit\": \"150\",\n    \"currency\": \"USD\",\n    \"price\": 1.95,\n    \"priceFormat\": \"Per Unit\"\n  },\n  {\n    \"startingUnit\": \"151\",\n    \"endingUnit\": \"300\",\n    \"currency\": \"USD\",\n    \"price\": 1.45,\n    \"priceFormat\": \"Per Unit\"\n  },\n  {\n    \"startingUnit\": \"1\",\n    \"endingUnit\": \"150\",\n    \"currency\": \"EUR\",\n    \"price\": 1.75,\n    \"priceFormat\": \"Per Unit\"\n  },\n  {\n    \"startingUnit\": \"151\",\n    \"endingUnit\": \"300\",\n    \"currency\": \"EUR\",\n    \"price\": 1.30,\n    \"priceFormat\": \"Per Unit\"\n  }\n]\n"},"children":[]}]}],"items":{"$ref":"#/components/schemas/POSTChargeDefinitionPricingTier"},"type":"array"}},"title":"prices","type":"object"}},"components/schemas/POSTChargeDefinitionRequest":{"id":"components/schemas/POSTChargeDefinitionRequest","kind":"json-schema","title":"productChargeDefinitions","data":{"example":{"productRatePlanChargeId":"edcab92612893256dce329d0b377000e","effectiveStartDate":"2024-01-01 00:00:00","effectiveEndDate":"2025-01-01 00:00:00","listPriceBase":"Per_Billing_Period","prices":[{"currency":"USD","price":12}]},"properties":{"billingPeriod":{"description":"The billing period for the product charge definition.\n","type":"string"},"billingTiming":{"description":"The billing timing setting for the product charge definition.\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"chargeModel":{"description":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n","enum":["DiscountFixedAmount","DiscountPercentage","FlatFee","PerUnit","Tiered","Volume","Delivery"],"type":"string"},"defaultQuantity":{"description":"The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n","type":"number","nullable":true},"effectiveEndDate":{"description":"The effective end date of the product charge definition.\n","format":"date-time","type":"string"},"effectiveStartDate":{"description":"The effective start date of the product charge definition.\n","format":"date-time","type":"string"},"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price base."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only for recurring charges."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum value is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year"],"type":"string"},"prices":{"description":"Container for the prices of the product charge definition.\n","items":{"$ref":"#/components/schemas/POSTProductChargeDefinitionPricing"},"type":"array"},"productRatePlanChargeId":{"description":"The unique ID of the charge of the charge definition.\n","type":"string"},"productRatePlanChargeNumber":{"description":"The unique number (natural key) of the charge of the charge definition.\n","type":"string"},"productRatePlanId":{"description":"The unique ID of the product rate plan that uses this charge definition.\n","type":"string"},"productRatePlanNumber":{"description":"The unique number (natural key) of the product rate plan that uses this charge definition.\n","type":"string"},"specificBillingPeriod":{"description":"The specific number of billing periods for the product charge definition.\n","type":"number","nullable":true},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge definition."},"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 the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer","nullable":true},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tax code for taxation rules. This field is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of the charge."},"children":[]}]}]}],"maxLength":64,"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to define taxation for the charge. This field is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of the charge."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the charge definition is taxable. When this field is set to "},"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":"TaxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are required."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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 value affects the tax calculation of the charge."},"children":[]}]}]}],"type":"boolean"},"term":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"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 is to be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"number","nullable":true},"termPeriodType":{"description":"Specifies the period type for the subscription term that is eligible for this charge definition.\n","enum":["Month","Year","Day","Week",null],"type":"string","nullable":true},"termType":{"description":"The type of the subscription that is eligible for this charge definition.\n","enum":["TERMED","EVERGREEN",null],"type":"string","nullable":true},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the unit of measure (UOM) configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the charge."},"children":[]}]}]}],"type":"string","nullable":true}},"title":"productChargeDefinitions","type":"object"}},"components/schemas/POSTChargeDefinitionResponse":{"id":"components/schemas/POSTChargeDefinitionResponse","kind":"json-schema","title":"POSTChargeDefinitionResponse","data":{"properties":{"chargeDefinitionId":{"description":"The unique ID of the product charge definition.\n","type":"string"},"chargeDefinitionNumber":{"description":"The unique number (natural key) of the product charge definition.\n","type":"string"},"success":{"description":"Indicates whether the request succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/PUTBulkProductChargeDefinitionRequest":{"id":"components/schemas/PUTBulkProductChargeDefinitionRequest","kind":"json-schema","title":"PUTBulkProductChargeDefinitionRequest","data":{"properties":{"billingPeriod":{"description":"The override value of the billingPeriod for the product charge definition.\n","type":"string"},"billingTiming":{"description":"The override value of the billingTiming for the product charge definition.\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"chargeModel":{"description":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n","enum":["DiscountFixedAmount","DiscountPercentage","FlatFee","PerUnit","Tiered","Volume","Delivery"],"type":"string"},"defaultQuantity":{"description":"The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n","type":"number"},"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price base."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only for recurring charges."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum value is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year"],"type":"string"},"prices":{"description":"Container for the new prices to override the existing prices of the product charge definition.\n","items":{"$ref":"#/components/schemas/POSTProductChargeDefinitionPricing"},"type":"array"},"productChargeDefinitionKey":{"description":"The unique number or ID of the product charge definition to be updated.\n","type":"string"},"specificBillingPeriod":{"description":"The override value of the specificBillingPeriod for the product charge definition.\n","type":"number","nullable":true},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge definition."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer","nullable":true},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tax code for taxation rules. This field is equired when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of the charge."},"children":[]}]}]}],"maxLength":64,"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to define taxation for the charge. This field is equired when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 value affects the tax calculation of the charge."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the charge definition is taxable. When this field is set to "},"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":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are required."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"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 value affects the tax calculation of the charge."},"children":[]}]}]}],"type":"boolean"},"term":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"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 is to be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"number","nullable":true},"termPeriodType":{"description":"Specifies the period type for the subscription term that is eligible for this charge definition.\n","enum":["Month","Year","Day","Week",null],"type":"string","nullable":true},"termType":{"description":"The type of the subscription that is eligible for this charge definition.\n","enum":["TERMED","EVERGREEN",null],"type":"string","nullable":true},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the unit of measure (UOM) configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Each"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"License"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Seat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"type":"string","nullable":true}},"type":"object"}},"components/schemas/PUTProductChargeDefinitionBulkRequest":{"id":"components/schemas/PUTProductChargeDefinitionBulkRequest","kind":"json-schema","title":"PUTProductChargeDefinitionBulkRequest","data":{"example":{"productChargeDefinitions":[{"productChargeDefinitionKey":"CD-00052014","prices":[{"currency":"USD","price":22}]}]},"properties":{"productChargeDefinitions":{"description":"The list of updated product charge definitions.\n","items":{"$ref":"#/components/schemas/PUTBulkProductChargeDefinitionRequest"},"type":"array"}},"type":"object"}},"components/schemas/POSTChargeDefinitionRequestBulk":{"id":"components/schemas/POSTChargeDefinitionRequestBulk","kind":"json-schema","title":"POSTChargeDefinitionRequestBulk","data":{"example":{"productChargeDefinitions":[{"productRatePlanChargeId":"edcab92612893256dce329d0b377000e","effectiveStartDate":"2024-01-01 00:00:00","effectiveEndDate":"2025-01-01 00:00:00","listPriceBase":"Per_Billing_Period","prices":[{"currency":"USD","price":18}]}]},"properties":{"productChargeDefinitions":{"description":"Container for the array of product charge definition.\n","items":{"$ref":"#/components/schemas/POSTChargeDefinitionRequest"},"type":"array"}},"type":"object"}},"components/schemas/POSTChargeDefinitionBulkResponse":{"id":"components/schemas/POSTChargeDefinitionBulkResponse","kind":"json-schema","title":"POSTChargeDefinitionBulkResponse","data":{"type":"object","properties":{"summary":{"description":"Summary of the results of the bulk operation.\n","type":"object","properties":{"successCount":{"description":"The number of product charge definitions successfully created.\n","type":"integer"},"failureCount":{"description":"The number of product charge definitions that are not created.\n","type":"integer"},"failures":{"description":"An array containing the index of each failed charge definition.\nEach index is zero-based, and refers to the position of the invalid product charge definition in the bulk payload.\n","type":"array","items":{"type":"integer"}}},"additionalProperties":false},"results":{"description":"The list of newly created product charge definitions or errors.\n","type":"array","items":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the charge definition is successfully created."},"chargeDefinitionId":{"description":"The unique ID of the product charge definition. \nThis value is available only if this product charge definition is successfully created.\n","type":"string"},"chargeDefinitionNumber":{"description":"The unique number (natural key) of the product charge definition. \nThis value is available only if this product charge definition is successfully created.\n","type":"string"},"processId":{"description":"The ID of the process that handles the operation. \nThis value is available only if this product charge definition is not created.\n","type":"string"},"reasons":{"description":"Array of data containing the error code and reasons for failure. \nThis value is available only if this product charge definition is not created.\n","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Message explaining the reason for the error."},"code":{"type":"string","description":"Specifies the error code associated with the error.","example":"400"}}}}},"additionalProperties":false}},"success":{"description":"Indicates whether the request succeeded.\n","type":"boolean"}},"additionalProperties":false}},"components/schemas/GETProductChargeDefinitionResponse":{"id":"components/schemas/GETProductChargeDefinitionResponse","kind":"json-schema","title":"GETProductChargeDefinitionResponse","data":{"properties":{"applyDiscountTo":{"description":"Indicates which type of charge the discount charge applies to.\n","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE",null],"type":"string","nullable":true},"billingDay":{"description":"The bill cycle type for the charge.\n","type":"string"},"billingPeriod":{"description":"The billing period for the product charge definition.\n","type":"string"},"billingPeriodAlignment":{"description":"The billing period alignment setting for the charge.\n","enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart","AlignToTermEnd"],"type":"string"},"billingTiming":{"description":"The billing timing setting for the product charge definition.\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"chargeModel":{"description":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n","enum":["DiscountFixedAmount","DiscountPercentage","FlatFee","PerUnit","Overage","Tiered","TieredWithOverage","Volume","Delivery","MultiAttributePricing","PreratedPerUnit","PreratedPricing","HighWatermarkVolumePricing","HighWatermarkTieredPricing"],"type":"string"},"chargeType":{"description":"Indicates the type of charge.\n","enum":["OneTime","Recurring","Usage"],"type":"string"},"customFields":{"$ref":"#/components/schemas/ProductChargeDefinitionObjectCustomFields"},"defaultQuantity":{"description":"The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n","type":"number","nullable":true},"deliverySchedule":{"$ref":"#/components/schemas/GETDeliverySchedule"},"description":{"description":"The description for the charge.\n","type":"string"},"discountClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The class that the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied."},"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://docs.zuora.com?resourceId=billing-manage-discount-classes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Discount Classes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account",null],"type":"string","nullable":true},"effectiveEndDate":{"description":"The effective end date of the product charge definition.\n","format":"date-time","type":"string"},"effectiveStartDate":{"description":"The effective start date of the product charge definition.\n","format":"date-time","type":"string"},"endDateCondition":{"description":"The end date condition for this charge.\n","enum":["Subscription_End","One_Time","Fixed_Period","Specific_End_Date"],"type":"string"},"financeInformation":{"description":"Container for finance information of the rate plan charge.\n","properties":{"accountsReceivableAccountingCode":{"description":"The accounting code for accounts receivable.\n","type":"string","nullable":true},"accountsReceivableAccountingCodeType":{"description":"The type of the accounting code for accounts receivable.\n","type":"string","nullable":true},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment liability."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment liability accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment revenue accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract asset."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract asset accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract liability accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract recognized revenue accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCode":{"description":"The accounting code for deferred revenue, such as Monthly Recurring Liability.\n","type":"string"},"deferredRevenueAccountingCodeType":{"description":"The type associated with the deferred revenue accounting code, such as Deferred Revenue. \n","type":"string","nullable":true},"recognizedRevenueAccountingCode":{"description":"The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","type":"string"},"recognizedRevenueAccountingCodeType":{"description":"The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n","type":"string","nullable":true},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"unbilledReceivablesAccountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the unbilled receivables accounting code."},"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 only available if you have the Zuora Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"}},"title":"financeInformation","type":"object"},"isDefault":{"description":"Indicates whether this charge definition is the default one for the charge.\n","type":"boolean"},"isStackedDiscount":{"description":[{"$$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 only applicable to the Discount - Percentage charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 130 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates whether the discount is to be calculated as stacked discount. Possible values are 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":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is a stacked discount, which should be calculated by stacking with other discounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is not a stacked discount, which should be calculated in sequence with other discounts."},"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://docs.zuora.com?resourceId=billing-discount-charge-models"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stacked discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"numberOfPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is ued when overage smoothing model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RollingWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rollover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer","nullable":true},"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price base."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only for recurring charges."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum value is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year"],"type":"string"},"numberOfPeriod":{"description":"Indicates the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.\n","format":"int64","type":"integer"},"overageCalculationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when to calculate overage charges. If the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SmoothingMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified, the value of this field is ignored."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"EndOfSmoothingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This option is used by default. The overage is charged at the end of the smoothing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The overage is charged on-demand rather than waiting until the end of the smoothing period."},"children":[]}]}]}]}],"enum":["EndOfSmoothingPeriod","PerBillingPeriod",null],"type":"string","nullable":true},"overageUnusedUnitsCreditOption":{"description":"Determines whether to credit the customer with unused units of usage.\n","enum":["NoCredit","CreditBySpecificRate",null],"type":"string","nullable":true},"priceChangeOption":{"default":"NoChange","description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing",null],"type":"string","nullable":true},"priceIncreaseOption":{"description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["FromTenantPercentageValue","SpecificPercentageValue"],"type":"string"},"priceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceIncreaseOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a decimal value between -100 and 100"},"children":[]}]}]}],"format":"double","type":"number","nullable":true},"prices":{"description":"Container for the prices of the product charge definition.\n","items":{"$ref":"#/components/schemas/GETProductChargeDefinitionPricing"},"type":"array"},"productChargeDefinitionId":{"description":"The unique ID of the product charge definition.\n","type":"string"},"productChargeDefinitionNumber":{"description":"The unique number (natural key) of the product charge definition.\n","type":"string"},"productDiscountApplyDetails":{"description":"Container for the application details about a discount product rate plan charge. \n\nOnly discount product rate plan charges have values for this field.\n","items":{"$ref":"#/components/schemas/GETProductDiscountApplyDetailsType"},"type":"array"},"productRatePlanChargeId":{"description":"The unique ID of the product charge of the charge definition.\n","type":"string"},"productRatePlanChargeNumber":{"description":"The unique number (natural key) of the product charge of the charge definition.\n","type":"string","nullable":true},"productRatePlanId":{"description":"The unique ID of the product rate plan that uses this charge definition.\n","type":"string","nullable":true},"productRatePlanName":{"description":"Th name of the product rate plan that uses this charge definition.\n","type":"string","nullable":true},"productRatePlanNumber":{"description":"The unique number (natural key) of the product rate plan that uses this charge definition.\n","type":"string","nullable":true},"ratingGroup":{"default":"ByBillingPeriod","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"Notes:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for Per Unit, Volume Pricing, and Tiered Pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-time charges and recurring charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload","ByGroupId",null],"type":"string","nullable":true},"recognizedRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the recognized revenue account for this charge."},"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":"Required when the Allow Blank Accounting Code setting is No."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional when the Allow Blank Accounting Code setting is Yes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"revRecCode":{"description":"Associates this product rate plan charge with a specific revenue recognition code.\n","maxLength":70,"type":"string","nullable":true},"revRecTriggerCondition":{"description":"Indicates when revenue recognition begins.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate",null],"type":"string","nullable":true},"revenueRecognitionRuleName":{"description":"Determines when to recognize the revenue for this charge.\n","enum":["Recognize upon invoicing","Recognize daily over time"],"type":"string"},"smoothingModel":{"description":"Indicates the smoothing model for an overage smoothing charge model.\n","enum":["RollingWindow","Rollover",null],"type":"string","nullable":true},"specificBillingPeriod":{"description":"The specific number of billing period for the product charge definition.\n","type":"number","nullable":true},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge definition."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","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 the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer","nullable":true},"success":{"description":"Indicates whether the request succeeded.\n","type":"boolean"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tax code for taxation rules."},"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 value affects the tax calculation of the rate plan charge."},"children":[]}]}]}],"maxLength":64,"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to define taxation for the charge."},"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 value affects the tax calculation of the rate plan charge."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the charge definition is taxable."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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 value affects the tax calculation of the rate plan charge."},"children":[]}]}]}],"type":"boolean"},"term":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"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 is to be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"number","nullable":true},"termPeriodType":{"description":"The period type for the subscription term that is eligible for this charge definition.\n","enum":["Month","Year","Day","Week",null],"type":"string","nullable":true},"termType":{"description":"The type of the subscription that is eligible for this charge definition.\n","enum":["TERMED","EVERGREEN",null],"type":"string","nullable":true},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge definition."},"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":"Values"},"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":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance"],"type":"string"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the unit of measure (UOM) that is configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the product rate plan charge."},"children":[]}]}]}],"type":"string","nullable":true},"upToPeriods":{"description":"The number of up-to periods for this charge.\n","type":"number","nullable":true},"upToPeriodsType":{"description":"The up-to-periods type for this charge.\n","enum":["Billing_Periods","Days","Weeks","Months","Years",null],"type":"string","nullable":true},"usageRecordRatingOption":{"default":"EndOfBillingPeriod","description":"Determines how Zuora processes usage records for per-unit usage charges.\n","enum":["EndOfBillingPeriod","OnDemand",null],"type":"string","nullable":true},"useDiscountSpecificAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to define a new accounting code for the new discount charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"children":[]}]}]}],"type":"boolean","nullable":true},"useTenantDefaultForPriceChange":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"children":[]}]}]}],"type":"boolean"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related rate plan charges and order line items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"isAllocationEligible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"isUnbilled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to perform the accounting during revenue recognition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"false"},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"productCategory":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product category for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"productClass":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product class for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"productFamily":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product family for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"productLine":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to maintain the product line for integration with Zuora Revenue."},"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 available only if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}]},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other options might also be avaliable depending on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]}},"type":"object"}},"components/schemas/PUTProductChargeDefinitionRequest":{"id":"components/schemas/PUTProductChargeDefinitionRequest","kind":"json-schema","title":"PUTProductChargeDefinitionRequest","data":{"example":{"prices":[{"currency":"USD","price":20}]},"properties":{"billingPeriod":{"description":"The override value of the billingPeriod for the product charge definition.\n","type":"string"},"billingTiming":{"description":"The override value of the billingTiming for the product charge definition.\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"chargeModel":{"description":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n","enum":["DiscountFixedAmount","DiscountPercentage","FlatFee","PerUnit","Tiered","Volume","Delivery"],"type":"string"},"defaultQuantity":{"description":"The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n","type":"number","nullable":true},"effectiveEndDate":{"description":"The effective end date of the product charge definition.\n","format":"date-time","type":"string"},"effectiveStartDate":{"description":"The effective start date of the product charge definition.\n","format":"date-time","type":"string"},"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price base."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only for recurring charges."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum value is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year"],"type":"string"},"prices":{"description":"Container for the new prices to override the existing prices of the product charge definition.\n","items":{"$ref":"#/components/schemas/POSTProductChargeDefinitionPricing"},"type":"array"},"specificBillingPeriod":{"description":"The override value of the specificBillingPeriod for the product charge definition.\n","type":"number","nullable":true},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge definition."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer","nullable":true},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tax code for taxation rules. This field is equired when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of the charge."},"children":[]}]}]}],"maxLength":64,"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to define taxation for the charge. This field is equired when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"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":"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 value affects the tax calculation of the charge."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the charge definition is taxable. When this field is set to "},"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":"TaxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are required."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"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":"False"},"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 value affects the tax calculation of the charge."},"children":[]}]}]}],"type":"boolean"},"term":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"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 is to be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"number","nullable":true},"termPeriodType":{"description":"Specifies the period type for the subscription term that is eligible for this charge definition.\n","enum":["Month","Year","Day","Week",null],"type":"string","nullable":true},"termType":{"description":"The type of the subscription that is eligible for this charge definition.\n","enum":["TERMED","EVERGREEN",null],"type":"string","nullable":true},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the unit of measure (UOM) configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Each"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"License"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Seat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"type":"string","nullable":true}},"type":"object"}},"components/schemas/ProxyGetProductRatePlanChargeTier":{"id":"components/schemas/ProxyGetProductRatePlanChargeTier","kind":"json-schema","title":"ProxyGetProductRatePlanChargeTier","data":{"properties":{"CreatedById":{"description":"The ID of the Zuora user who created the ProductRatePlanChargeTier object.\n","maxLength":32,"type":"string"},"CreatedDate":{"description":"The date when the ProductRatePlanChargeTier object was created.\n","format":"date-time","maxLength":29,"type":"string"},"Currency":{"description":"The valid code corresponding to the currency for the tier's price.\n","maxLength":3,"type":"string"},"EndingUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end number of a range of units for the tier."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": any positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"Id":{"description":"Object identifier.","type":"string"},"Price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid currency value"},"children":[]}]}]}],"format":"double","type":"number"},"PriceFormat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FlatFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerUnit"},"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 values "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Flat Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with spaces) is valid for create or update calls."},"children":[]}]}]}],"maxLength":8,"type":"string"},"StartingUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The starting number of a range of units for the tier."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": any positive decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"Tier":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique number that identifies the tier that the price applies to."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 20"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"format":"int32","type":"integer"},"UpdatedById":{"description":"The ID of the user who last updated the product rate plan charge tier.\n","maxLength":32,"type":"string"},"UpdatedDate":{"description":"The date when the product rate plan charge tier was last updated.\n","format":"date-time","maxLength":29,"type":"string"}},"type":"object"}},"components/schemas/ProxyModifyProductRatePlanChargeTier":{"id":"components/schemas/ProxyModifyProductRatePlanChargeTier","kind":"json-schema","title":"ProxyModifyProductRatePlanChargeTier","data":{"example":{"Price":1.99},"properties":{"Price":{"description":"The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n","type":"number","format":"double"},"PriceFormat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only."},"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 values "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Flat Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with spaces) is valid for create or update calls."},"children":[]}]}]}],"enum":["Flat Fee","Per Unit"],"maxLength":8,"type":"string"},"DiscountPercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of discount for a percentage discount. This field is required if the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.ChargeModel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discount-Percentage"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A decimal value between -100 and 100, exclusive"},"children":[]}]}]}],"minimum":-100,"exclusiveMinimum":true,"maximum":100,"exclusiveMaximum":true,"type":"number","format":"double"},"DiscountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific amount for a fixed discount. This field is required if the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.ChargeModel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discount-Fixed Amount"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Any positive decimal value."},"children":[]}]}]}],"type":"number","format":"double"}},"type":"object"}},"components/schemas/RevproAccountingCodes":{"id":"components/schemas/RevproAccountingCodes","kind":"json-schema","title":"RevproAccountingCodes","data":{"example":{"adjustmentLiabilityAccount":"adjustL-1","adjustmentRevenueAccount":"adjustRev-1","contractAssetAccount":"CA-2","contractLiabilityAccount":"CL-2","productRatePlanChargeId":"2c92c0f962470b8101624b869fcd45fc","recognizedRevenueAccount":"ContractRevRec-1","unbilledReceivablesAccount":"unbilledR-1"},"properties":{"adjustmentLiabilityAccount":{"description":"The name of the account where the Account Type is \"Adjustment Liability\".","maxLength":100,"type":"string"},"adjustmentRevenueAccount":{"description":"The name of the account where the Account Type is \"Adjustment Revenue\".","maxLength":100,"type":"string"},"contractAssetAccount":{"description":"The name of the account where the Account Type is \"Contract Asset\".","maxLength":100,"type":"string"},"contractLiabilityAccount":{"description":"The name of the account where the Account Type is \"Contract Liability\".","maxLength":100,"type":"string"},"productRatePlanChargeId":{"description":"The ID of your product rate plan charge.","type":"string"},"recognizedRevenueAccount":{"description":"The name of the account where the Account Type is \"Recognized Revenue\".","maxLength":100,"type":"string"},"unbilledReceivablesAccount":{"description":"The name of the account where the Account Type is \"Unbilled Receivables\".","maxLength":100,"type":"string"}},"required":["productRatePlanChargeId","contractAssetAccount","contractLiabilityAccount","unbilledReceivablesAccount","adjustmentLiabilityAccount","recognizedRevenueAccount","adjustmentRevenueAccount"],"type":"object"}},"components/schemas/PUTRevproAccCodeResponse":{"id":"components/schemas/PUTRevproAccCodeResponse","kind":"json-schema","title":"PUTRevproAccCodeResponse","data":{"properties":{"success":{"description":"","type":"boolean"}},"type":"object"}},"components/schemas/BillableMetricFilter":{"id":"components/schemas/BillableMetricFilter","kind":"json-schema","title":"BillableMetricFilter","data":{"type":"object","description":"Filter applied to incoming events before aggregation.","properties":{"property":{"type":"string","description":"Event property to evaluate.","example":"cached"},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison operator."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQUALS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"EQUALS"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison value used with operators such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQUALS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"false"},"values":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison values used with operators such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"example":["claude-opus","claude-sonnet"]},"case_sensitive":{"type":"boolean","description":"Whether the comparison is case-sensitive.","example":false}}}},"components/schemas/BillableMetricComputedProperty":{"id":"components/schemas/BillableMetricComputedProperty","kind":"json-schema","title":"BillableMetricComputedProperty","data":{"type":"object","description":"Derived event property used as an aggregation input.","required":["output_key","expression"],"properties":{"output_key":{"type":"string","description":"Name of the computed property written onto the event.","example":"ai_units"},"expression":{"type":"string","description":"Expression used to calculate the computed property from event fields.","example":"quantity"},"output_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data type of the computed property."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bool_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"number"},"uom_id":{"type":"string","description":"Unit of measure associated with the computed property.","example":"Each"}}}},"components/schemas/BillableMetricAggregation":{"id":"components/schemas/BillableMetricAggregation","kind":"json-schema","title":"BillableMetricAggregation","data":{"type":"object","description":"Aggregation configuration used to calculate the billable metric from matching events.","required":["type"],"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":"How matching events are aggregated to calculate the metric."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Counts matching events."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sums a numeric event property."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Takes the maximum value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Takes the minimum value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count_distinct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Counts distinct values of a property."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Uses the most recent value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Calculates a percentile of a numeric property."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"formula"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Calculates the metric using a formula."},"children":[]}]}]}]}],"enum":["count","sum","max","min","count_distinct","last_value","percentile","formula"],"example":"sum"},"property":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event or computed property to aggregate. Required for aggregations such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ai_units"},"percentile":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentile to calculate when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"99"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":99}}}},"components/schemas/BillableMetricGroupKey":{"id":"components/schemas/BillableMetricGroupKey","kind":"json-schema","title":"BillableMetricGroupKey","data":{"type":"object","description":"An event property used to group events before aggregation.","required":["key"],"properties":{"key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event property used to group events, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"subscription_key"},"display_name":{"type":"string","description":"Human-readable label for the group key.","example":"Subscription"},"roles":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles that describe how this group key is used when aggregating events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contract_usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"presentation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"example":["contract_usage"]},"cardinality_hint":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estimated cardinality of this group key. Common values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"low"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"high"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["low","high"],"example":"high"},"position":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display and evaluation order of this group key, starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0}}}},"components/schemas/BillableMetric":{"id":"components/schemas/BillableMetric","kind":"json-schema","title":"BillableMetric","data":{"type":"object","description":"A billable metric that numbered metered features can use to measure entitlement usage.","properties":{"id":{"type":"string","description":"Unique identifier of the billable metric.","example":"7ec58fadb6f84bc18e59c7529058d941"},"metricNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System-generated number that uniquely identifies the billable metric. Values start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BM-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"BM-00000001"},"name":{"type":"string","description":"Unique name of the billable metric.","example":"AI Units Entitlement Metric"},"description":{"type":"string","nullable":true,"description":"Optional description of what the billable metric measures.","example":"Sums AI units consumed for entitlement validation"},"kind":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metric kinds. A metric can have one or more kinds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"entitlement_kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Used to measure numbered metered feature consumption."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Used for billing aggregation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"diagnostic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Used for operational or diagnostic aggregation."},"children":[]}]}]}]}],"items":{"type":"string","enum":["entitlement_kind","billable","diagnostic"]},"example":["entitlement_kind"]},"event_types":{"type":"array","description":"Event types that this metric processes when calculating usage.","items":{"type":"string"},"example":["ai.units.consumed"]},"filters":{"type":"array","description":"Filters applied to incoming events before aggregation.","items":{"$ref":"#/components/schemas/BillableMetricFilter"}},"computed_properties":{"type":"array","description":"Derived event properties used as aggregation inputs.","items":{"$ref":"#/components/schemas/BillableMetricComputedProperty"}},"aggregation":{"$ref":"#/components/schemas/BillableMetricAggregation"},"group_keys":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event properties used to group events before aggregation. The response may return this array as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groupKeys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BillableMetricGroupKey"}},"status":{"type":"string","description":"Lifecycle status of the billable metric.","example":"draft"}}}},"components/schemas/ListBillableMetricsResponse":{"id":"components/schemas/ListBillableMetricsResponse","kind":"json-schema","title":"ListBillableMetricsResponse","data":{"type":"object","description":"Response body that contains a list of billable metrics.","properties":{"data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billable metrics returned by the list operation. Some responses wrap this payload in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"response"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BillableMetric"}}}}},"components/schemas/CreateBillableMetricRequest":{"id":"components/schemas/CreateBillableMetricRequest","kind":"json-schema","title":"CreateBillableMetricRequest","data":{"type":"object","description":"Request body for creating a billable metric.","required":["name","kind","event_types","aggregation"],"properties":{"name":{"type":"string","description":"Unique name of the billable metric. Use a descriptive name that identifies the usage being measured.","example":"AI Units Entitlement Metric"},"description":{"type":"string","description":"Optional description of what the billable metric measures.","example":"Sums AI units consumed for entitlement validation"},"kind":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metric kinds. A metric can have one or more kinds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"entitlement_kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Used to measure numbered metered feature consumption."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Used for billing aggregation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"diagnostic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Used for operational or diagnostic aggregation."},"children":[]}]}]}]}],"items":{"type":"string","enum":["entitlement_kind","billable","diagnostic"]},"minItems":1,"example":["entitlement_kind"]},"event_types":{"type":"array","description":"Event types that this metric processes when calculating usage.","items":{"type":"string"},"minItems":1,"example":["ai.units.consumed"]},"filters":{"type":"array","description":"Filters applied to incoming events before aggregation.","items":{"$ref":"#/components/schemas/BillableMetricFilter"}},"computed_properties":{"type":"array","description":"Derived event properties used as aggregation inputs.","items":{"$ref":"#/components/schemas/BillableMetricComputedProperty"}},"aggregation":{"$ref":"#/components/schemas/BillableMetricAggregation"},"group_keys":{"type":"array","description":"Event properties used to group events before aggregation, such as subscription, model, or region.","items":{"$ref":"#/components/schemas/BillableMetricGroupKey"}}}}},"components/schemas/GetBillableMetricResponse":{"id":"components/schemas/GetBillableMetricResponse","kind":"json-schema","title":"GetBillableMetricResponse","data":{"type":"object","description":"Response body that contains a billable metric.","properties":{"value":{"description":"The billable metric.","allOf":[{"$ref":"#/components/schemas/BillableMetric"}]}}}},"components/schemas/UpdateBillableMetricRequest":{"id":"components/schemas/UpdateBillableMetricRequest","kind":"json-schema","title":"UpdateBillableMetricRequest","data":{"type":"object","description":"Request body for updating a billable metric.","properties":{"metric_key":{"type":"string","description":"Unique identifier or metric number of the billable metric to update.","example":"7ec58fadb6f84bc18e59c7529058d941"},"name":{"type":"string","description":"Unique name of the billable metric.","example":"LLM Inference Count"},"description":{"type":"string","description":"Description of what the billable metric measures.","example":"Updated count of non-cached LLM inference requests"},"filters":{"type":"array","description":"Filters applied to incoming events before aggregation.","items":{"$ref":"#/components/schemas/BillableMetricFilter"}},"computed_properties":{"type":"array","description":"Derived event properties used as aggregation inputs.","items":{"$ref":"#/components/schemas/BillableMetricComputedProperty"}},"group_keys":{"type":"array","description":"Event properties used to group events before aggregation.","items":{"$ref":"#/components/schemas/BillableMetricGroupKey"}}}}},"components/schemas/DeleteBillableMetricResponse":{"id":"components/schemas/DeleteBillableMetricResponse","kind":"json-schema","title":"DeleteBillableMetricResponse","data":{"type":"object","description":"Response body returned after deleting a billable metric.","properties":{"success":{"type":"boolean","description":"Indicates whether the billable metric was deleted.","example":true},"id":{"type":"string","description":"Unique identifier of the deleted billable metric.","example":"7ec58fadb6f84bc18e59c7529058d941"}}}},"components/schemas/Feature":{"id":"components/schemas/Feature","kind":"json-schema","title":"Feature","data":{"type":"object","description":"A catalog feature that can be linked to products and used in entitlement definitions.","properties":{"id":{"type":"string","description":"Unique identifier of the feature.","example":"8ad088009840d1c2019855e15c993f2f"},"featureNumber":{"type":"string","description":"System-generated number that uniquely identifies the feature.","example":"FEAT-00000001"},"name":{"type":"string","description":"Unique name of the feature.","example":"sso_access"},"description":{"type":"string","nullable":true,"description":"Optional description of the feature.","example":"Grants single sign-on access"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"bool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grants or denies access with a true or false value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Restricts the feature to a predefined set of values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numbered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Represents a numeric quantity. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isMetered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to distinguish metered and unmetered numbered features."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unmetered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Represents a non-event-driven feature that can be tagged and granted by quantity."},"children":[]}]}]}]}],"enum":["bool","enumType","numbered","unmetered"],"example":"bool"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lifecycle status of the feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The feature can be linked to products and used in entitlements."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The feature is not available for new entitlements."},"children":[]}]}]}]}],"enum":["Active","Inactive"],"example":"Active"},"values":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted values for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. Returned only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"example":["basic","premium","enterprise"]},"tags":{"type":"array","description":"Tags used to search and challenge features as a group.","items":{"type":"string"},"example":["premium"]},"unitOfMeasure":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit used to measure a numbered feature quantity, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Each"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"API Calls"},"isMetered":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a numbered feature tracks consumption. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for numbered metered features."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for numbered unmetered features. Returned only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numbered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"isCapped":{"type":"boolean","description":"Indicates whether a numbered metered feature stops consumption when the entitlement quantity is reached.","example":true},"metricId":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the billable metric that measures usage for a numbered metered feature."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numbered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isMetered"},"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":[]}]}]}],"example":"7ec58fadb6f84bc18e59c7529058d941"}}}},"components/schemas/ListFeaturesResponse":{"id":"components/schemas/ListFeaturesResponse","kind":"json-schema","title":"ListFeaturesResponse","data":{"type":"object","description":"Response body that contains a list of features.","properties":{"features":{"type":"array","description":"Features returned by search operations.","items":{"$ref":"#/components/schemas/Feature"}}}}},"components/schemas/UpdateFeatureRequest":{"id":"components/schemas/UpdateFeatureRequest","kind":"json-schema","title":"UpdateFeatureRequest","data":{"type":"object","description":"Request body for updating a feature.","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the feature to update.","example":"8ad088009840d1c2019855e15c993f2f"},"name":{"type":"string","description":"Unique name of the feature.","example":"sso_access"},"description":{"type":"string","description":"Description of the feature.","example":"Grants single sign-on access for enterprise accounts"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature type. Changing the type of an existing feature, for example from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is not allowed."},"children":[]}]}]}],"enum":["bool","enumType","numbered","unmetered"],"example":"enumType"},"values":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted values for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. Replaces the current allowed values."},"children":[]}]}]}],"items":{"type":"string"},"example":["basic","pro","enterprise","elite"]},"tags":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement tag list. Omit this field to preserve existing tags. An empty array does not clear tags"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clear_tags"},"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":[]}]}]}],"items":{"type":"string"},"example":["premium"]},"clear_tags":{"type":"boolean","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", removes all tags from the feature."},"children":[]}]}]}],"example":false}}}},"components/schemas/UpdateFeatureResponse":{"id":"components/schemas/UpdateFeatureResponse","kind":"json-schema","title":"UpdateFeatureResponse","data":{"type":"object","description":"Response body that contains a feature.","properties":{"value":{"description":"The feature.","allOf":[{"$ref":"#/components/schemas/Feature"}]}}}},"components/schemas/CreateFeatureRequest":{"id":"components/schemas/CreateFeatureRequest","kind":"json-schema","title":"CreateFeatureRequest","data":{"type":"object","description":"Request body for creating a boolean, enum, numbered metered, numbered unmetered, or unmetered feature.","required":["name","type"],"properties":{"name":{"type":"string","description":"Unique name of the feature.","example":"sso_access"},"description":{"type":"string","description":"Optional description of the feature.","example":"Grants single sign-on access"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"bool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grants or denies access with a true or false value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Restricts the feature to a predefined set of values. Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"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":"code","inline":true,"attributes":{"content":"numbered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Represents a numeric quantity. Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitOfMeasure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isMetered"},"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 numbered metered features, also include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metricId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and optionally "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCapped"},"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":"code","inline":true,"attributes":{"content":"unmetered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Represents a non-event-driven feature. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not allowed."},"children":[]}]}]}]}],"enum":["bool","enumType","numbered","unmetered"],"example":"bool"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lifecycle status of the feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The feature can be linked to products and used in entitlements."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The feature is not available for new entitlements."},"children":[]}]}]}]}],"enum":["Active","Inactive"],"example":"Active"},"values":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted values for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Duplicate values are not allowed."},"children":[]}]}]}],"items":{"type":"string"},"example":["basic","premium","enterprise"]},"tags":{"type":"array","description":"Tags used to search and challenge features as a group.","items":{"type":"string"},"example":["premium"]},"unitOfMeasure":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit used to measure a numbered feature quantity, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Each"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numbered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"API Calls"},"unit_of_measure":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitOfMeasure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Not allowed on boolean or enum features."},"children":[]}]}]}],"example":"Each"},"default_quantity":{"type":"number","description":"Default quantity associated with the feature.","example":1000},"minimum_quantity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum quantity allowed for a numbered feature. Must be omitted or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for boolean and enum features."},"children":[]}]}]}],"example":0},"maximum_quantity":{"type":"number","description":"Maximum quantity allowed for a numbered feature.","example":100000},"isMetered":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a numbered feature tracks consumption. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for numbered metered features"},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for numbered unmetered features. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numbered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"isCapped":{"type":"boolean","description":"Indicates whether a numbered metered feature stops consumption when the entitlement quantity is reached.","example":true},"metricId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the billable metric that measures usage. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numbered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isMetered"},"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":"Omit this field for numbered unmetered features."},"children":[]}]}]}],"example":"7ec58fadb6f84bc18e59c7529058d941"}}}},"components/schemas/SearchFeatureFilter":{"id":"components/schemas/SearchFeatureFilter","kind":"json-schema","title":"SearchFeatureFilter","data":{"type":"object","description":"Filter used when searching catalog features.","required":["field","operator","value"],"properties":{"field":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature field to filter on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feature_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feature_tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"feature_tag"},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison operator. Common values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"EQ"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison value, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a feature tag."},"children":[]}]}]}],"example":"premium"}}}},"components/schemas/SearchFeaturesRequest":{"id":"components/schemas/SearchFeaturesRequest","kind":"json-schema","title":"SearchFeaturesRequest","data":{"type":"object","description":"Request body for searching catalog features.","properties":{"filters":{"type":"array","description":"Filters applied to the feature search. Soft-deleted features are excluded from results.","items":{"$ref":"#/components/schemas/SearchFeatureFilter"}},"filter":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate search filter used by some clients. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter.feature_tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to search by tag."},"children":[]}]}]}],"properties":{"feature_tag":{"type":"string","description":"Feature tag used to find matching features.","example":"groupB"}}},"pagination":{"type":"object","description":"Pagination settings for the search results.","properties":{"page":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page number to retrieve, starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"page_size":{"type":"integer","description":"Number of features returned per page.","example":20},"pageSize":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Camel-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page_size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":20}}}}}},"components/schemas/DeleteFeatureResponse":{"id":"components/schemas/DeleteFeatureResponse","kind":"json-schema","title":"DeleteFeatureResponse","data":{"type":"object","description":"Response body returned after deleting a feature.","properties":{"success":{"type":"boolean","description":"Indicates whether the feature was deleted.","example":true},"id":{"type":"string","description":"Unique identifier of the deleted feature.","example":"8ad088009840d1c2019855e15c993f2f"}}}},"components/schemas/AccountingRequest":{"id":"components/schemas/AccountingRequest","kind":"json-schema","title":"AccountingRequest","data":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting fields accepted on create/update requests. Field names use snake_case."},"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":"Conditional requirement rules"},"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow blank Accounting Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Accounting fields are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional"},"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow blank Accounting Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the tenant "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has Zuora Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all Accounting fields except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounting_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required"},"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow blank Accounting Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the tenant "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"does NOT have Zuora Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recognized_revenue_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferred_revenue_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These rules apply to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all operations that accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the payload."},"children":[]}]}]}],"properties":{"accounting_code":{"type":"string","description":"An accounting code associated with the charge for reporting/ERP mapping. Typically a short code or identifier, not the GL account name.\n","example":"PRPC-REV-001"},"accounts_receivable_account":{"type":"string","description":"Accounts Receivable (AR) account to book invoices for this charge. Must match an existing account in the tenant's chart of accounts.\n","example":"Accounts Receivable"},"accounts_receivable_account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account type associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounts_receivable_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maps to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountsReceivableAccountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the accounting object."},"children":[]}]}]}]},"deferred_revenue_account":{"type":"string","description":"Deferred revenue (liability) account to book revenue before recognition. Must match an existing account in the tenant's chart of accounts.\n","example":"Deferred Revenue"},"deferred_revenue_accounting_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting method/type applied to deferred revenue. Maps to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferredRevenueAccountingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the accounting object."},"children":[]}]}]}]},"recognized_revenue_account":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Recognized Revenue\".","example":"ContractRevRec-1"},"recognized_revenue_account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account type associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recognized_revenue_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maps to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recognizedRevenueAccountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the accounting object."},"children":[]}]}]}]},"adjustment_liability_account":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Adjustment Liability\".","example":"adjustL-1"},"adjustment_liability_account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account type associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjustment_liability_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maps to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjustmentLiabilityAccountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the accounting object."},"children":[]}]}]}]},"adjustment_revenue_account":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Adjustment Revenue\".","example":"adjustRev-1"},"adjustment_revenue_account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account type associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjustment_revenue_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maps to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjustmentRevenueAccountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the accounting object."},"children":[]}]}]}]},"contract_asset_account":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Contract Asset\".","example":"CA-2"},"contract_asset_account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account type associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contract_asset_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maps to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contractAssetAccountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the accounting object."},"children":[]}]}]}]},"contract_liability_account":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Contract Liability\".","example":"CL-2"},"contract_liability_account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account type associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contract_liability_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maps to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contractLiabilityAccountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the accounting object."},"children":[]}]}]}]},"contract_recognized_revenue_account":{"type":"string","description":"Recognized revenue account used specifically for contract-based recognition flows. Must match an existing account in the tenant's chart of accounts.\n","example":"Contract Recognized Revenue"},"contract_recognized_revenue_account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account type associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contract_recognized_revenue_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maps to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contractRecognizedRevenueAccountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the accounting object."},"children":[]}]}]}]},"unbilled_receivables_account":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Unbilled Receivables\".","example":"unbilledR-1"},"unbilled_receivables_account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account type associated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unbilled_receivables_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maps to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unbilledReceivablesAccountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the accounting object."},"children":[]}]}]}]}},"example":{"accounting_code":"PRPC-REV-001","accounts_receivable_account":"Accounts Receivable","adjustment_liability_account":"adjustL-1","adjustment_revenue_account":"adjustRev-1","contract_asset_account":"CA-2","contract_liability_account":"CL-2","contract_recognized_revenue_account":"Contract Recognized Revenue","deferred_revenue_account":"Deferred Revenue","recognized_revenue_account":"ContractRevRec-1","unbilled_receivables_account":"unbilledR-1"}}},"components/schemas/UpdateChargeRequest":{"id":"components/schemas/UpdateChargeRequest","kind":"json-schema","title":"UpdateChargeRequest","data":{"type":"object","required":["charge"],"properties":{"charge":{"type":"object","additionalProperties":false,"description":"Fields to update on the product rate plan charge (PRPC). Only the properties\nprovided will be considered for update (patch semantics). Unsupported updates\nare ignored by the service.\n","required":["id"],"properties":{"chargeFunction":{"type":"string","description":"Function of the charge.","enum":["charge_function_standard","charge_function_prepayment","charge_function_commitment_true_up","charge_function_drawdown","charge_function_credit_commitment","charge_function_drawdown_and_credit_commitment"]},"prepaymentUnitType":{"type":"string","description":"Unit type used for the prepayment charge.","enum":["unit","currency"]},"id":{"type":"string","description":"Unique identifier of the product rate plan charge (PRPC) to update.","example":"9c4867ed55db43a89731605d5654d4ed"},"name":{"type":"string","description":"Optional new display name for the charge."},"description":{"type":"string","description":"Optional new description for the charge."},"trigger_event":{"type":"string","description":"Event that triggers the charge (if update is supported).","enum":["contract_effective","service_activation","customer_acceptance"]},"unit_of_measure":{"type":"string","description":"Unit of measure label for the charge, for example, Each, Seat. May be read-only in some tenants."},"default_quantity":{"type":"number","description":"Default quantity when the charge is added to a product/offer."},"min_quantity":{"type":"number","description":"Optional minimum quantity constraint (if supported)."},"max_quantity":{"type":"number","description":"Optional maximum quantity constraint (if supported)"},"list_price_base":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List price basis (e.g., Per_Billing_Period). Typically read-only after creation."},"children":[]}]}]}]},"bill_cycle":{"type":"object","description":"Billing period configuration controlling frequency, alignment, and timing.","additionalProperties":false,"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":"Source of the default billing period, for example, default_from_customer, specific_day_of_month."},"children":[]}]}]}]},"day_of_month":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of month to bill when type = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific_day_of_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"day_of_week":{"type":"string","description":"Day of week to bill when using weekly modes."},"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period, for example, bill_cycle_period_month, bill_cycle_period_quarter."},"children":[]}]}]}]},"specific_period":{"type":"string","description":"Custom period text when applicable."},"period_alignment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alignment behavior, for example, align_to_charge, align_to_term_start."},"children":[]}]}]}]},"timing":{"type":"string","description":"Indicates whether billing occurs in advance or in arrears.","enum":["in_advance","in_arrears"]}}},"pricing":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default (charge-level) pricing used when no rate-card row matches."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structure depends on the charge model:"},"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":"flat_fee → flat_amounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per_unit → unit_amounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"volume/tiered → tiers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount_fixed_amount → discount_amounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount_percentage → discount_percentage"},"children":[]}]}]}]}],"oneOf":[{"title":"Flat Fee Pricing","type":"object","required":["flat_amounts"],"properties":{"flat_amounts":{"type":"object","description":"Map of currency to flat amount.","additionalProperties":{"type":"number"},"example":{"USD":100}}}},{"title":"Per Unit Pricing","type":"object","required":["unit_amounts"],"properties":{"unit_amounts":{"type":"object","description":"Map of currency to per-unit price.","additionalProperties":{"type":"number"},"example":{"USD":2.5}}}},{"title":"Tiered or Volume Pricing","type":"object","required":["tiers"],"properties":{"tiers":{"type":"array","description":"Tier definitions (volume or tiered) with optional min/max caps.","items":{"type":"object","required":["tier","from","price_format"],"properties":{"tier":{"type":"string","description":"Tier identifier, for example, \"1\", \"2\"."},"from":{"type":"number","description":"Lower bound (inclusive)."},"up_to":{"type":"number","nullable":true,"description":"Upper bound (inclusive). Omit/null for open-ended last tier."},"price_format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, price_format_per_unit or price_format_flat_fee."},"children":[]}]}]}]},"unit_amounts":{"type":"object","description":"Per-unit price by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":2.5}},"flat_amounts":{"type":"object","description":"Flat amount by currency for this tier (if applicable).","additionalProperties":{"type":"number"},"example":{"USD":100}},"min_amounts":{"type":"object","description":"Minimum billed amount by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":6.25}},"max_amounts":{"type":"object","description":"Maximum billed amount by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":25}}}}}}},{"title":"Fixed Amount Discount","type":"object","required":["discount_amounts"],"properties":{"discount_amounts":{"type":"object","description":"Map of currency to discount amount.","additionalProperties":{"type":"number"},"example":{"USD":10}}}},{"title":"Percentage Discount","type":"object","required":["discount_percentage"],"properties":{"discount_percentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount percentage, for example, 15 for 15%."},"children":[]}]}]}],"example":15}}}]},"rate_cards":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional pricing rows (rate cards). Each row defines match attributes and a price to apply."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple rows match, the first match wins. If none match, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}],"items":{"type":"object","required":["attributes","pricing"],"properties":{"attributes":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match conditions that must all evaluate to true for the row to apply."},"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":"between"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ranges or dates."},"children":[]}]}]}],"items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Attribute name, for example, Age, Region, EffectiveDate.","example":"Age"},"operator":{"type":"string","description":"Comparison operator.","enum":[">",">=","<","<=","==","between","between-inclusive"],"example":"<="},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison value. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"between"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", provide an array of two values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must align with the attribute’s declared type."},"children":[]}]}]}],"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"}]}}],"example":12}}}},"pricing":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price to apply when this row matches. Structure mirrors "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" above."},"children":[]}]}]}],"oneOf":[{"title":"Flat Fee Pricing","type":"object","required":["flat_amounts"],"properties":{"flat_amounts":{"type":"object","description":"Map of currency to flat amount.","additionalProperties":{"type":"number"},"example":{"USD":100}}}},{"title":"Per Unit Pricing","type":"object","required":["unit_amounts"],"properties":{"unit_amounts":{"type":"object","description":"Map of currency to per-unit price.","additionalProperties":{"type":"number"},"example":{"USD":180}}}},{"title":"Tiered or Volume Pricing","type":"object","required":["tiers"],"properties":{"tiers":{"type":"array","description":"Tier definitions (volume or tiered) with optional min/max caps.","items":{"type":"object","required":["tier","from","price_format"],"properties":{"tier":{"type":"string","description":"Tier identifier, for example, \"1\", \"2\"."},"from":{"type":"number","description":"Lower bound (inclusive)."},"up_to":{"type":"number","nullable":true,"description":"Upper bound (inclusive)."},"price_format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, price_format_per_unit."},"children":[]}]}]}]},"unit_amounts":{"type":"object","description":"Per-unit price by currency for this tier.","additionalProperties":{"type":"number"}},"flat_amounts":{"type":"object","description":"Flat amount by currency for this tier (if applicable).","additionalProperties":{"type":"number"}},"min_amounts":{"type":"object","description":"Minimum billed amount by currency for this tier.","additionalProperties":{"type":"number"}},"max_amounts":{"type":"object","description":"Maximum billed amount by currency for this tier.","additionalProperties":{"type":"number"}}}}}}},{"title":"Fixed Amount Discount","type":"object","required":["discount_amounts"],"properties":{"discount_amounts":{"type":"object","description":"Map of currency to discount amount.","additionalProperties":{"type":"number"},"example":{"USD":10}}}},{"title":"Percentage Discount","type":"object","required":["discount_percentage"],"properties":{"discount_percentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount percentage (e.g., 15 for 15%)."},"children":[]}]}]}],"example":15}}}]}}}},"tax_code":{"type":"string","description":"Optional tax code to associate with the charge."},"tax_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax mode, for example, tax_exclusive, non_taxable, if supported."},"children":[]}]}]}]},"price_change_option":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How price changes apply on updates, for example, no_change."},"children":[]}]}]}]},"use_tenant_default_for_price_change":{"type":"boolean","description":"If true, tenant defaults govern price change behavior."},"delivery_schedule":{"type":"object","description":"Day-of-week delivery configuration (if enabled).","additionalProperties":true},"drawdown":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown configuration for the charge when using prepaid with drawdown."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this object to define the unit of measure used for drawdown consumption"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the conversion rate applied during drawdown evaluation."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"properties":{"unitOfMeasure":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure used for drawdown consumption."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"conversionRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conversion rate used when converting usage or rated amounts into the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown unit of measure."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]}}},"prepayment":{"type":"object","description":"Prepayment configuration for the charge, including credit, operation,\nquantity, validity period, rollover, and drawdown settings.\n","properties":{"creditOption":{"type":"string","description":"How prepayment credits are applied (if supported).","enum":["time_based","consumption_based","full_credit_back","credit_option_unspecified"],"default":"time_based"},"operationType":{"type":"string","description":"Type of prepayment operation.","enum":["prepaid_operation_type_topup"]},"quantity":{"type":"number","format":"double","description":"Number of units included in the prepayment charge."},"rollover":{"type":"boolean","description":"Whether unused prepayment funds roll over."},"rolloverApply":{"type":"string","description":"Specifies whether rollover funds are consumed before or after normal funds.","enum":["apply_first","apply_last"]},"rolloverPeriodLength":{"type":"integer","description":"Length of each rollover period."},"rolloverPeriods":{"type":"integer","description":"Number of rollover periods allowed."},"unitOfMeasure":{"type":"string","description":"Unit of measure for the prepayment charge."},"validityPeriod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period during which prepayment units are valid. When enhanced unit-based"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown is enabled, specific days, specific weeks, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific months are supported. When using a specific validity period,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificValidityPeriodLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["subscription_term","annual","semi_annual","quarter","month","specific_days","specific_weeks","specific_months"]},"validityPeriodAlignment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alignment point used to determine the start of the validity period."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["vp_alignment_charge_start","vp_alignment_term_start","vp_alignment_term_end"]},"validityPeriodProrationOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the validity period is prorated."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["vp_proration_option_prorate_units","vp_proration_option_no_prorate"]},"specificValidityPeriodLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length of the validity period when a specific validity period is used."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"rolloverPeriodType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time used for the rollover period."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["rollover_period_type_day","rollover_period_type_month","rollover_period_type_quarter","rollover_period_type_annual"]},"rolloverFundPriority":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority assigned to rolled-over funds. Lower values are consumed first."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"rolloverEndDateType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when rolled-over funds expire."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["rollover_end_date_type_charge_end_date","rollover_end_date_type_subscription_term"]},"fundSupportAccountHierarchy":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether child accounts can consume drawdown funds from the parent account."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"drawdownPriority":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority used to determine the order in which drawdown funds are consumed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower values are consumed first."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"drawdownScope":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope at which drawdown funds are tracked and consumed. This field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replaces the deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentLevel"},"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":"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["commitment_level_subscription","commitment_level_account"]}}},"prepaid":{"type":"boolean","description":"Indicates whether the charge is prepaid."},"overage_options":{"type":"object","description":"Overage configuration for usage charges.","additionalProperties":true},"accounting":{"$ref":"#/components/schemas/AccountingRequest"},"revenue":{"type":"object","description":"Revenue recognition settings (rule names, timing).","additionalProperties":true},"netsuite":{"type":"object","description":"NetSuite integration attributes for the charge.","additionalProperties":true},"custom_fields":{"type":"object","description":"Tenant-specific custom field values on the charge.","additionalProperties":true},"labels":{"type":"object","description":"Free-form labels/tags attached to the charge.","additionalProperties":true},"organization_labels":{"type":"array","description":"Organization-level labels associated with the charge.","items":{"type":"object"}},"ocm_json_by_currency":{"type":"object","description":"Offer/OCM metadata keyed by currency (internal use).","additionalProperties":true},"attributes":{"type":"array","description":"Attribute declarations for Dynamic Pricing (name/type/mapping).","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Attribute name, for example, Region, Age, EffectiveDate."},"type":{"type":"string","description":"Attribute data type.","enum":["string","integer","double","boolean","date","datetime"]},"mapping":{"type":"object","description":"Optional mapping to resolve values from Zuora objects.","required":["object","field"],"properties":{"object":{"type":"string","description":"Target Zuora object, for example, account, subscription."},"field":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field on the target object, for example, age__c."},"children":[]}]}]}]}}}}}}}}}}},"components/schemas/AccountingResponse":{"id":"components/schemas/AccountingResponse","kind":"json-schema","title":"AccountingResponse","data":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting fields returned by the API. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are derived from the tenant's chart of accounts and are read-only."},"children":[]}]}]}],"properties":{"accountingCode":{"type":"string","description":"An accounting code associated with the charge for reporting or ERP mapping.\nTypically a short code or identifier, not the GL account name.\n","example":"PRPC-REV-001"},"accountsReceivableAccount":{"type":"string","description":"Accounts Receivable (AR) account to book invoices for this charge.\nMust match an existing account in the tenant's chart of accounts.\n"},"accountsReceivableAccountType":{"type":"string","readOnly":true,"description":"System-derived type/category of the AR account from the chart of accounts.\nExamples include \"AccountsReceivable\".\n"},"adjustmentLiabilityAccount":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Adjustment Liability\".","example":"adjustL-1"},"adjustmentLiabilityAccountType":{"type":"string","readOnly":true,"description":"System-derived type/category of the Adjustment Liability account from the chart of accounts.\nExamples include \"AdjustmentLiability\".\n"},"adjustmentRevenueAccount":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Adjustment Revenue\".","example":"adjustRev-1"},"adjustmentRevenueAccountType":{"type":"string","readOnly":true,"description":"System-derived type/category of the Adjustment Revenue account from the chart of accounts.\nExamples include \"AdjustmentRevenue\".\n"},"contractAssetAccount":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Contract Asset\".","example":"CA-2"},"contractAssetAccountType":{"type":"string","readOnly":true,"description":"System-derived type/category of the Contract Asset account from the chart of accounts.\n","example":"ContractAsset"},"contractLiabilityAccount":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Contract Liability\".","example":"CL-2"},"contractLiabilityAccountType":{"type":"string","readOnly":true,"description":"System-derived type/category of the Contract Liability account from the chart of accounts.\nExamples include \"ContractLiability\".\n"},"contractRecognizedRevenueAccount":{"type":"string","description":"Recognized revenue account used specifically for contract-based recognition flows.\nMust match an existing account in the tenant's chart of accounts.\n"},"contractRecognizedRevenueAccountType":{"type":"string","readOnly":true,"description":"System-derived type/category of the Contract Recognized Revenue account from the chart of accounts.\n","example":"RecognizedRevenue"},"deferredRevenueAccount":{"type":"string","description":"Deferred revenue (liability) account to book revenue before recognition.\nMust match an existing account in the tenant's chart of accounts.\n"},"deferredRevenueAccountType":{"type":"string","readOnly":true,"description":"System-derived type/category of the Deferred Revenue account from the chart of accounts.\n","example":"DeferredRevenue"},"recognizedRevenueAccount":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Recognized Revenue\".","example":"ContractRevRec-1"},"recognizedRevenueAccountType":{"type":"string","readOnly":true,"description":"System-derived type/category of the Recognized Revenue account from the chart of accounts.\n","example":"RecognizedRevenue"},"unbilledReceivablesAccount":{"type":"string","maxLength":100,"description":"The name of the account where the Account Type is \"Unbilled Receivables\".","example":"unbilledR-1"},"unbilledReceivablesAccountType":{"type":"string","readOnly":true,"description":"System-derived type/category of the Unbilled Receivables account from the chart of accounts.\n","example":"UnbilledReceivables"},"productRatePlanChargeId":{"type":"string","description":"The ID of your product rate plan charge.","example":"2c92c0f962470b8101624b869fcd45fc"}}}},"components/schemas/CreateChargeResponse":{"id":"components/schemas/CreateChargeResponse","kind":"json-schema","title":"CreateChargeResponse","data":{"type":"object","additionalProperties":false,"properties":{"accounting":{"$ref":"#/components/schemas/AccountingResponse"},"attributes":{"type":"array","description":"Attribute metadata associated with Dynamic Pricing for this charge.","items":{"type":"object","description":"Declared attribute used by Dynamic Pricing.","additionalProperties":true}},"billCycle":{"type":"object","properties":{"dayOfMonth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific day of month to bill when type = specific_day_of_month."},"children":[]}]}]}]},"period":{"type":"string","description":"Billing period length.\n"},"periodAlignment":{"type":"string","description":"How the billing period start aligns.\n"},"timing":{"type":"string","description":"Whether the charge bills before or after the service period."},"type":{"type":"string","description":"Bill-cycle mode (inherit defaults or set specific day rules).\n"}}},"chargeFunction":{"type":"string","description":"Internal function/category of the charge used by rating.","enum":["charge_function_standard","charge_function_prepayment","charge_function_commitment_true_up","charge_function_drawdown","charge_function_credit_commitment","charge_function_drawdown_and_credit_commitment"]},"chargeModel":{"type":"string","description":"Pricing model that determines how the amount is calculated."},"chargeType":{"type":"string","description":"Whether the charge recurs, rates usage, or is a one-time fee."},"createdById":{"type":"string","description":"User ID that created the charge record."},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the charge record was created."},"customFields":{"type":"object","additionalProperties":true,"description":"Tenant-specific custom field values on the charge."},"deliverySchedule":{"type":"object","description":"Day-of-week delivery settings when delivery scheduling is enabled.","properties":{"frequency":{"type":"string","description":"Delivery frequency label for schedule rules.\n"},"friday":{"type":"boolean","description":"Deliver on Friday."},"monday":{"type":"boolean","description":"Deliver on Monday."},"saturday":{"type":"boolean","description":"Deliver on Saturday."},"sunday":{"type":"boolean","description":"Deliver on Sunday."},"thursday":{"type":"boolean","description":"Deliver on Thursday."},"tuesday":{"type":"boolean","description":"Deliver on Tuesday."},"wednesday":{"type":"boolean","description":"Deliver on Wednesday."}}},"discountOptions":{"type":"object","description":"How discount charges apply and interact with other discounts.","properties":{"applyDetails":{"type":"array","items":{"type":"object"},"description":"Per-target discount application details (if populated)."},"applyTo":{"type":"array","items":{"type":"string"},"description":"Which components or charges the discount applies to."},"applyToBillingPeriodPartially":{"type":"boolean","description":"Whether the discount duration can partially align to a period."},"reflectDiscountInNetAmount":{"type":"boolean","description":"Whether discounts reduce the net amount on invoices."},"rollover":{"type":"boolean","description":"Whether unused discount can roll over to future periods."},"stackedDiscount":{"type":"boolean","description":"Whether this discount stacks with other discounts."}}},"drawdown":{"type":"object","additionalProperties":true,"description":"Drawdown configuration for the charge when using prepaid with drawdown.\n","properties":{"unitOfMeasure":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure used for drawdown consumption."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"conversionRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conversion rate used when converting usage or rated amounts into the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown unit of measure."},"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 only available if you have the enhanced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]}}},"endDateCondition":{"type":"string","description":"Rule for when the charge ends.\n"},"upToPeriodsType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit used for the fixed period when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_period"},"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 example, billing periods or days."},"children":[]}]}]}]},"upToPeriods":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of periods, in units of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", that the charge remains"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"active when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"extendedPrice":{"type":"object","additionalProperties":true,"description":"Calculated extended price details (model-dependent)."},"id":{"type":"string","description":"Unique identifier of the product rate plan charge (PRPC)."},"isChargeLevelMinCommit":{"type":"boolean","description":"Whether a minimum commit is enforced at the charge level."},"isCommitted":{"type":"boolean","description":"Indicates if the charge definition is committed/finalized."},"labels":{"type":"object","additionalProperties":true,"description":"Free-form labels/tags attached to the charge."},"listPriceBase":{"type":"string","description":"List price basis, for example, Per Billing Period, Per Month, Per Year."},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"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 value must be a positive integer between "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"120"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", inclusive."},"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":"Notes"},"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":"This field is available only if you have the Annual List Price feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"129"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"integer"},"mergedRateCards":{"type":"array","items":{"type":"object"},"description":"Effective rate-card rows after merges (if any)."},"name":{"type":"string","description":"Display name of the charge in the plan."},"negotiatedRateCards":{"type":"array","items":{"type":"object"},"description":"Customer- or deal-specific rate-card rows applied by negotiation."},"netsuite":{"type":"object","description":"NetSuite integration attributes mapped for this charge.","additionalProperties":true},"ocmJsonByCurrency":{"type":"object","additionalProperties":true,"description":"Offer/OCM metadata keyed by currency (internal use)."},"organizationLabels":{"type":"array","items":{"type":"string"},"description":"Organization-level labels associated with the charge."},"overageOptions":{"type":"object","description":"Overage settings for usage charges.","properties":{"includedUnits":{"type":"number","description":"Included units before overage starts."},"unusedUnitsCreditRates":{"type":"object","additionalProperties":true,"description":"Credit rates for unused units (by currency)."}}},"prepaid":{"type":"boolean","description":"Indicates whether the charge is prepaid."},"prepaymentUnitType":{"type":"string","description":"Unit type used for the prepayment charge.","enum":["unit","currency"]},"prepayment":{"type":"object","description":"Prepayment configuration for the charge, including credit, operation,\nquantity, validity period, rollover, and drawdown settings.\n","properties":{"creditOption":{"type":"string","description":"How prepayment credits are applied (if supported).","enum":["time_based","consumption_based","full_credit_back","credit_option_unspecified"],"default":"time_based"},"operationType":{"type":"string","description":"Type of prepayment operation.","enum":["prepaid_operation_type_topup"]},"quantity":{"type":"number","format":"double","description":"Number of units included in the prepayment charge."},"rollover":{"type":"boolean","description":"Whether unused prepayment funds roll over."},"rolloverApply":{"type":"string","description":"Specifies whether rollover funds are consumed before or after normal funds.","enum":["apply_first","apply_last"]},"rolloverPeriodLength":{"type":"integer","description":"Length of each rollover period."},"rolloverPeriods":{"type":"integer","description":"Number of rollover periods allowed."},"unitOfMeasure":{"type":"string","description":"Unit of measure for the prepayment charge."},"validityPeriod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period during which prepayment units are valid. When enhanced unit-based"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown is enabled, specific days, specific weeks, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific months are supported. When using a specific validity period,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificValidityPeriodLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["subscription_term","annual","semi_annual","quarter","month","specific_days","specific_weeks","specific_months"]},"validityPeriodAlignment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alignment point used to determine the start of the validity period."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["vp_alignment_charge_start","vp_alignment_term_start","vp_alignment_term_end"]},"validityPeriodProrationOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the validity period is prorated."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["vp_proration_option_prorate_units","vp_proration_option_no_prorate"]},"specificValidityPeriodLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length of the validity period when a specific validity period is used."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"rolloverPeriodType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time used for the rollover period."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["rollover_period_type_day","rollover_period_type_month","rollover_period_type_quarter","rollover_period_type_annual"]},"rolloverFundPriority":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority assigned to rolled-over funds. Lower values are consumed first."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"rolloverEndDateType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when rolled-over funds expire."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["rollover_end_date_type_charge_end_date","rollover_end_date_type_subscription_term"]},"fundSupportAccountHierarchy":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether child accounts can consume drawdown funds from the parent account."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"drawdownPriority":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority used to determine the order in which drawdown funds are consumed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower values are consumed first."},"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"drawdownScope":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope at which drawdown funds are tracked and consumed. This field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replaces the deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentLevel"},"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":"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["commitment_level_subscription","commitment_level_account"]}}},"priceChangeOption":{"type":"string","description":"How price changes are applied across renewals/amendments.\n"},"pricing":{"type":"object","description":"Default (charge-level) price configuration by model/currency.","properties":{"adjustments":{"type":"object","additionalProperties":true,"description":"Price adjustments metadata."},"discountAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Fixed discount amounts by currency."},"discountPercentages":{"type":"object","additionalProperties":{"type":"number"},"description":"Percentage discount values by currency."},"flatAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Flat amounts by currency for flat-fee pricing."},"maxAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Maximum caps by currency."},"minAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Minimum charges by currency."},"percentages":{"type":"object","additionalProperties":{"type":"number"},"description":"Percentage price values by currency (model-dependent)."},"tiers":{"type":"array","items":{"type":"object"},"description":"Tier definitions for tiered/volume pricing."},"unitAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Per-unit amounts by currency for per-unit/usage pricing."}}},"pricingSummary":{"type":"array","items":{"type":"string"},"description":"Human-readable price summary strings, for example, USD100."},"pricingWaterfalls":{"type":"object","additionalProperties":true,"description":"Detailed pricing/waterfall breakdown (if available)."},"productChargeDefinitions":{"type":"array","items":{"type":"object"},"description":"Underlying charge definitions referenced for pricing lookup."},"productRatePlanChargeNumber":{"type":"string","description":"PRPC number."},"productRatePlanId":{"type":"string","description":"ID of the plan (PRP) that owns this charge."},"prorationOption":{"type":"string","description":"How proration is handled relative to tenant defaults."},"rateCards":{"type":"array","items":{"type":"object"},"description":"Dynamic Pricing rate-card rows configured on the charge."},"revenue":{"type":"object","description":"Revenue policy settings for this charge.","properties":{"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":"If true, item billing is excluded from revenue accounting."},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":"If true, item booking is excluded from revenue accounting."},"legacyReporting":{"type":"boolean","description":"Indicator for legacy revenue reporting behaviors."},"revenueRecognitionRuleName":{"type":"string","description":"Name of the revenue rule to apply, for example, \"Recognize upon invoicing\"."}}},"taxCode":{"type":"string","description":"Tax code applied to the charge (for example, a tax category code)."},"taxMode":{"type":"string","description":"Tax mode for the charge.\n"},"taxable":{"type":"boolean","description":"Whether the charge is taxable."},"triggerEvent":{"type":"string","description":"Event that triggers the charge.\n"},"unitOfMeasure":{"type":"string","description":"Unit of measure used for pricing (for example, Each, Seats)."},"updatedById":{"type":"string","description":"User ID that last updated the charge record."},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the charge record was last updated."},"useTenantDefaultForPriceChange":{"type":"boolean","description":"Whether tenant defaults govern price change behavior."}},"example":{"accounting":{"accountsReceivableAccount":"Accounts Receivable","accountsReceivableAccountType":"AccountsReceivable","deferredRevenueAccount":"Accounts Receivable","deferredRevenueAccountType":"AccountsReceivable","recognizedRevenueAccount":"Accounts Receivable","recognizedRevenueAccountType":"AccountsReceivable"},"attributes":[],"billCycle":{"dayOfMonth":5,"period":"bill_cycle_period_month","periodAlignment":"align_to_charge","timing":"in_advance","type":"specific_day_of_month"},"chargeModel":"flat_fee","chargeType":"recurring","createdById":"53c162482f054f3ca08e1ec82dccfec9","createdTime":"2025-10-13T07:46:02.000+00:00","customFields":{},"discountOptions":{"applyDetails":[],"applyTo":[],"applyToBillingPeriodPartially":false,"reflectDiscountInNetAmount":false,"rollover":false,"stackedDiscount":false},"endDateCondition":"subscription_end","upToPeriodsType":"billing_periods","upToPeriods":0,"extendedPrice":{},"id":"ad95b694d2b8442b84dc8ad26561c7d7","isChargeLevelMinCommit":false,"isCommitted":false,"labels":{},"listPriceBase":"Per_Billing_Period","mergedRateCards":[],"name":"Flat PRPC 1","negotiatedRateCards":[],"netsuite":{},"ocmJsonByCurrency":{},"organizationLabels":[],"overageOptions":{"includedUnits":0,"unusedUnitsCreditRates":{}},"prepaid":true,"chargeFunction":"charge_function_prepayment","prepaymentUnitType":"unit","prepayment":{"creditOption":"time_based","operationType":"prepaid_operation_type_topup","quantity":10,"rollover":true,"rolloverApply":"apply_first","rolloverPeriodLength":6,"rolloverPeriods":1,"unitOfMeasure":"Each","validityPeriod":"specific_months","validityPeriodAlignment":"vp_alignment_term_end","validityPeriodProrationOption":"vp_proration_option_prorate_units","specificValidityPeriodLength":6,"rolloverPeriodType":"rollover_period_type_month","rolloverFundPriority":2,"rolloverEndDateType":"rollover_end_date_type_charge_end_date","fundSupportAccountHierarchy":true,"drawdownPriority":5,"drawdownScope":"commitment_level_account"},"priceChangeOption":"no_change","pricing":{"adjustments":{},"discountAmounts":{},"discountPercentages":{},"flatAmounts":{"USD":100},"maxAmounts":{},"minAmounts":{},"percentages":{},"tiers":[],"unitAmounts":{}},"pricingSummary":["USD100"],"pricingWaterfalls":{},"productChargeDefinitions":[],"productRatePlanChargeNumber":"PRPC-00000279","productRatePlanId":"ee2d1ce1036c4dd6ae9d6945565ff7a0","prorationOption":"default_from_tenant_setting","rateCards":[],"revenue":{"excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"legacyReporting":false,"revenueRecognitionRuleName":"Recognize upon invoicing"},"taxCode":"TAX_EXEMPT","taxMode":"non_taxable","taxable":false,"triggerEvent":"contract_effective","unitOfMeasure":"Each","updatedById":"53c162482f054f3ca08e1ec82dccfec9","updatedTime":"2025-10-13T07:46:02.000+00:00","useTenantDefaultForPriceChange":true}}},"components/schemas/CreateChargeRequest":{"id":"components/schemas/CreateChargeRequest","kind":"json-schema","title":"CreateChargeRequest","data":{"type":"object","required":["charge"],"properties":{"charge":{"type":"object","description":"Product rate plan charge (PRPC) definition including pricing model, billing settings, trigger event,\nand attribute-based rate cards for Dynamic Pricing.\n","additionalProperties":false,"required":["charge_model","charge_type","name","unit_of_measure","bill_cycle","trigger_event","product_rate_plan_id"],"properties":{"prepaymentUnitType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit type used for the prepayment charge. Replaces the deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentUnitType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["unit","currency"]},"prepaid":{"type":"boolean","description":"Indicates whether the charge is prepaid."},"chargeFunction":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Function of the charge. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge_function_prepayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a prepayment charge."},"children":[]}]}]}],"example":"charge_function_prepayment"},"charge_model":{"type":"string","description":"Charge model that determines how the charge is calculated.\n","enum":["flat_fee","per_unit","overage","volume","tiered","tiered_overage","discount_fixed_amount","discount_percentage","custom_charge_model","delivery","minimum_commitment_true_up","calculated","high_water_mark_volume_pricing","high_water_mark_tiered_pricing","multi_attribute_pricing","prerated_pricing","prerated_per_unit"]},"charge_type":{"type":"string","description":"Charge category in the catalog.\n","enum":["one_time","recurring","usage"]},"description":{"type":"string","description":"Human-readable description of the charge."},"name":{"type":"string","description":"Name of the charge as displayed in the product catalog."},"unit_of_measure":{"type":"string","description":"Unit of measure (UOM) used to quantify or price the charge (for example, Each, Seats, Licenses).\n"},"default_quantity":{"type":"number","format":"double","description":"Default quantity applied when the charge is added, if not specified elsewhere."},"end_date_condition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition that determines when the charge becomes inactive. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the charge should remain active"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"until the subscription ends. Duration-based fields such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up_to_periods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up_to_periods_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not apply when this value is used."},"children":[]}]}]}],"enum":["end_date_one_time","subscription_end","fixed_period","specific_end_date"]},"up_to_periods_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Granularity used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition = fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to express how long the charge remains active. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition = subscription_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is ignored."},"children":[]}]}]}],"enum":["billing_periods","days","weeks","months","years"],"example":"billing_periods"},"up_to_periods":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of periods used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition = fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up_to_periods_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine the fixed duration of the charge. Ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition = subscription_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0},"bill_cycle":{"type":"object","description":"Billing period configuration that controls frequency, alignment, and timing of billing for this charge.\n","required":["period","period_alignment","type"],"properties":{"type":{"type":"string","description":"Determines how the billing day is selected for this charge.\n","enum":["default_from_customer","specific_day_of_month","subscription_start_day","charge_trigger_day","specific_day_of_week","term_start_day","term_end_day"],"example":"default_from_customer"},"period":{"type":"string","description":"Length of each billing period.\n","enum":["bill_cycle_period_month","bill_cycle_period_quarter","bill_cycle_period_semi_annual","bill_cycle_period_annual","bill_cycle_period_eighteen_months","bill_cycle_period_two_years","bill_cycle_period_three_years","bill_cycle_period_five_years","bill_cycle_period_specific_months","bill_cycle_period_subscription_term","bill_cycle_period_week","bill_cycle_period_specific_weeks","bill_cycle_period_specific_days"],"example":"bill_cycle_period_month"},"period_alignment":{"type":"string","description":"How the billing period start aligns.\n","enum":["align_to_charge","align_to_subscription_start","align_to_term_start","align_to_term_end"],"example":"align_to_charge"},"timing":{"type":"string","description":"When the charge is billed relative to the service period.\n","enum":["in_advance","in_arrears"],"example":"in_advance"},"day_of_month":{"type":"integer","minimum":1,"maximum":31,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific_day_of_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"day_of_week":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific_day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]}}},"list_price_base":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List price basis for this charge. This is used when interpreting list prices and, for some models, in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific_list_price_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months","Per_Validity_Period"],"example":"Per_Billing_Period"},"specific_list_price_base":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional specific value used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_price_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires an explicit quantity (for example, number of months for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":0},"trigger_event":{"type":"string","description":"Event that makes the charge active on a subscription.\n","enum":["contract_effective","service_activation","customer_acceptance","specific_date"]},"product_rate_plan_id":{"type":"string","description":"Identifier of the product rate plan that owns this charge."},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"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 value must be a positive integer between "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"120"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inclusive."},"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":"Notes"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"129"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"int32","maximum":120,"minimum":1,"example":12,"type":"integer","nullable":true},"prepayment":{"type":"object","description":"Prepayment configuration for the charge, including credit, operation,\nquantity, validity period, rollover, and drawdown settings.\n","properties":{"creditOption":{"type":"string","description":"Specifies how prepayment credits are applied.\n","enum":["time_based","consumption_based","full_credit_back","credit_option_unspecified"],"default":"time_based"},"operationType":{"type":"string","description":"Specifies the type of prepayment operation.\n","enum":["prepaid_operation_type_topup"]},"quantity":{"type":"number","format":"double","description":"Number of units included in the prepayment charge.\n"},"rollover":{"type":"boolean","description":"Indicates whether unused prepayment funds roll over.\n"},"rolloverApply":{"type":"string","description":"Specifies whether rollover funds are consumed before or after normal funds.\n","enum":["apply_first","apply_last"]},"rolloverPeriodLength":{"type":"integer","description":"Length of each rollover period.\n"},"rolloverPeriods":{"type":"integer","description":"Number of rollover periods allowed.\n"},"unitOfMeasure":{"type":"string","description":"Unit of measure for the prepayment charge.\n"},"validityPeriod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period during which prepayment units are valid. When enhanced unit-based"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown is enabled, specific days, specific weeks, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific months are supported. When using a specific validity period,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificValidityPeriodLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["subscription_term","annual","semi_annual","quarter","month","specific_days","specific_weeks","specific_months"]},"validityPeriodAlignment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alignment point used to determine the start of the validity period."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["vp_alignment_charge_start","vp_alignment_term_start","vp_alignment_term_end"]},"validityPeriodProrationOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the validity period is prorated."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["vp_proration_option_prorate_units","vp_proration_option_no_prorate"]},"specificValidityPeriodLength":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the length of the validity period when a specific validity period is used."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"rolloverPeriodType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time used for the rollover period."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["rollover_period_type_day","rollover_period_type_month","rollover_period_type_quarter","rollover_period_type_annual"]},"rolloverFundPriority":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority assigned to rolled-over funds. Funds with lower priority values are consumed first."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"rolloverEndDateType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when rolled-over funds expire."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["rollover_end_date_type_charge_end_date","rollover_end_date_type_subscription_term"]},"fundSupportAccountHierarchy":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether child accounts can consume drawdown funds from the parent account."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"drawdownPriority":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority used to determine the order in which drawdown funds are consumed. Lower values are consumed first."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"drawdownScope":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope at which drawdown funds are tracked and consumed. Use this field to specify whether funds are available at the subscription level or account level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field replaces the deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentLevel"},"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":"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["commitment_level_subscription","commitment_level_account"]}}},"drawdown":{"type":"object","description":"Drawdown configuration for the charge when using Prepaid with Drawdown.\nUse this object to define the unit of measure used for drawdown consumption\nand the conversion rate applied during drawdown evaluation.\n","properties":{"unitOfMeasure":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure used for drawdown consumption. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency-based drawdown or another supported unit defined for the charge."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"conversionRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conversion rate applied when converting usage or rated amounts into the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown unit of measure. For example, a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.25"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the drawdown"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculation uses a 1.25 conversion factor."},"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 only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]}}},"formula":{"type":"string","description":"Optional formula applied after rate-card lookup to adjust the computed price."},"tax_mode":{"type":"string","description":"Tax mode for this charge.\n","enum":["non_taxable","tax_exclusive","tax_inclusive"]},"tax_code":{"type":"string","description":"Tax code used for tax calculation on this charge."},"accounting":{"$ref":"#/components/schemas/AccountingRequest"},"revenue":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue recognition configuration, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenue_recognition_rule_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", triggers, allocation flags."},"children":[]}]}]}]},"custom_fields":{"type":"object","additionalProperties":true,"description":"Tenant custom fields on the charge."},"attributes":{"type":"array","description":"Declares the attribute metadata used by Dynamic Pricing for this charge.\nEach entry defines an attribute that pricing rules can reference, along with\nits data type and (optionally) a mapping to a Zuora object field used to resolve values at runtime.\nExamples: Region, Age, EffectiveDate.\n","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Attribute name, for example, Age, Region, EffectiveDate."},"type":{"type":"string","description":"Attribute data type.","enum":["String","Integer","Double","Boolean","Date","Datetime"]},"mapping":{"type":"object","description":"Optional mapping to a Zuora business object field used to automatically resolve\nthe attribute value at runtime.\n","required":["object","field"],"properties":{"object":{"type":"string","description":"Target Zuora object, for example, account, subscription."},"field":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field on the target object, for example, age__c."},"children":[]}]}]}]}}}}}},"pricing":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default (charge-level) pricing for the PRPC, used when no rate-card row matches."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The structure depends on the charge_model:"},"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":"flat_fee → flat_amounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per_unit → unit_amounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"volume/tiered → tiers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount_fixed_amount → discount_amounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount_percentage → discount_percentage"},"children":[]}]}]}]}],"oneOf":[{"title":"Flat Fee Pricing","type":"object","required":["flat_amounts"],"properties":{"flat_amounts":{"type":"object","description":"Map of currency to flat amount.","additionalProperties":{"type":"number"},"example":{"USD":100}}}},{"title":"Per Unit Pricing","type":"object","required":["unit_amounts"],"properties":{"unit_amounts":{"type":"object","description":"Map of currency to per-unit price.","additionalProperties":{"type":"number"},"example":{"USD":2.5}}}},{"title":"Tiered or Volume Pricing","type":"object","required":["tiers"],"properties":{"tiers":{"type":"array","description":"Tier definitions (volume or tiered) with optional min/max caps.","items":{"type":"object","required":["tier","from","price_format"],"properties":{"tier":{"type":"string","description":"Tier identifier (e.g., \"1\", \"2\")."},"from":{"type":"number","description":"Lower bound (inclusive)."},"up_to":{"type":"number","nullable":true,"description":"Upper bound (inclusive). Omit/null for open-ended last tier."},"price_format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, price_format_per_unit."},"children":[]}]}]}]},"unit_amounts":{"type":"object","description":"Per-unit price by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":2.5}},"flat_amounts":{"type":"object","description":"Flat amount by currency for this tier (if applicable).","additionalProperties":{"type":"number"},"example":{"USD":100}},"min_amounts":{"type":"object","description":"Minimum billed amount by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":6.25}},"max_amounts":{"type":"object","description":"Maximum billed amount by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":25}}}}}}},{"title":"Fixed Amount Discount","type":"object","required":["discount_amounts"],"properties":{"discount_amounts":{"type":"object","description":"Map of currency to discount amount.","additionalProperties":{"type":"number"},"example":{"USD":10}}}},{"title":"Percentage Discount","type":"object","required":["discount_percentage"],"properties":{"discount_percentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount percentage (e.g., 15 for 15%)."},"children":[]}]}]}],"example":15}}}]},"rate_cards":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the conditional pricing table ("},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate cards"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for the PRPC."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each rate-card entry specifies:"},"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":"attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The match conditions evaluated at runtime."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The price or rate to apply when the conditions match."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple rows match, Zuora applies the first matching rate card."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no row matches, the default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (defined above) is used."},"children":[]}]}]}],"items":{"type":"object","required":["attributes","pricing"],"properties":{"attributes":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the set of match conditions that must all evaluate to true"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for this rate-card row to apply. Each condition corresponds to a declared"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricing attribute. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"between"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for range or date-based conditions."},"children":[]}]}]}],"items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Attribute name for the condition (for example, Age, Region, EffectiveDate)."},"operator":{"type":"string","description":"Comparison operator for the condition.","enum":[">",">=","<","<=","==","between","between-inclusive"]},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison value. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"between"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", provide an array of two values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value type must align with the attribute’s declared type."},"children":[]}]}]}],"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"}]}}]}}}},"pricing":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing configuration returned when this rate-card row matches."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The structure depends on the charge_model:"},"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":"flat_fee → flat_amounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per_unit → unit_amounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"volume/tiered → tiers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount_fixed_amount → discount_amounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount_percentage → discount_percentage"},"children":[]}]}]}]}],"oneOf":[{"title":"Flat Fee Pricing","type":"object","required":["flat_amounts"],"properties":{"flat_amounts":{"type":"object","description":"Map of currency to flat amount.","additionalProperties":{"type":"number"},"example":{"USD":100}}}},{"title":"Per Unit Pricing","type":"object","required":["unit_amounts"],"properties":{"unit_amounts":{"type":"object","description":"Map of currency to per-unit price.","additionalProperties":{"type":"number"},"example":{"USD":2.5}}}},{"title":"Tiered or Volume Pricing","type":"object","required":["tiers"],"properties":{"tiers":{"type":"array","description":"Tier definitions (volume or tiered) with optional min/max caps.","items":{"type":"object","required":["tier","from","price_format"],"properties":{"tier":{"type":"string","description":"Tier identifier (e.g., \"1\", \"2\")."},"from":{"type":"number","description":"Lower bound (inclusive)."},"up_to":{"type":"number","nullable":true,"description":"Upper bound (inclusive). Omit/null for open-ended last tier."},"price_format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, price_format_per_unit."},"children":[]}]}]}]},"unit_amounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Per-unit price by currency for this tier."},"flat_amounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Flat amount by currency for this tier (if applicable)."},"min_amounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Minimum billed amount by currency for this tier."},"max_amounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Maximum billed amount by currency for this tier."}}}}}}]}}}}}}}}},"components/schemas/QueryChargeRequest":{"id":"components/schemas/QueryChargeRequest","kind":"json-schema","title":"QueryChargeRequest","data":{"type":"object","description":"Request schema for querying a specific Product Rate Plan Charge (PRPC) by key.\nUse this operation to fetch details of a single PRP, optionally expanding related charges.\n","properties":{"product_rate_plan_key":{"type":"string","description":"Unique identifier (key) of the Product Rate Plan (PRP) to query. This can be the PRP ID or the PRP number configured in your system.\n","example":"11dc762a07064ce496af73ff4cfb5614"},"expand":{"type":"object","description":"Optional flags to expand related resources in the response.\n","properties":{"product_rate_plan_charges":{"type":"boolean","description":"Whether to include Product Rate Plan Charges (PRPCs) in the response.","example":true}}},"attributes":{"type":"array","description":"Optional attribute values to use when evaluating Dynamic Pricing for the PRP or its charges.\nAll required attributes must be supplied if the PRP or PRPC is configured to require them.\n","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Attribute name, for example, Age, Region, EffectiveDate, AccountContext.","example":"Age"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute value used for price evaluation.  The value can be a string, number, or boolean, depending on the attribute type."},"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":"Enclose the value in quotation marks (\"\") if it is a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for example, \"Liquidity Provider\", \"Y\", \"External\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use quotation marks for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numeric"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values, for example, 98, 5, true, false."},"children":[]}]}]}]}],"example":"Liquidity Provider"}}}},"evaluation_level":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how pricing is evaluated for the charge. Supported values: - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIST_PRICE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": evaluate pricing at the list-price level. - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTENDED_PRICE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": evaluate pricing at the extended-price level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not specified, the default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIST_PRICE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["LIST_PRICE","EXTENDED_PRICE"],"example":"LIST_PRICE"}}}},"components/schemas/UpdateProductRequest":{"id":"components/schemas/UpdateProductRequest","kind":"json-schema","title":"UpdateProductRequest","data":{"type":"object","description":"Request body for updating a product in the Product Catalog.","properties":{"id":{"type":"string","description":"Unique identifier of the product to update.","example":"8ad088009840d1c2019855e15c993f2f"},"name":{"type":"string","description":"Product name.","example":"Software Service"},"description":{"type":"string","description":"Product description.","example":"Software service - basic edition"},"category":{"type":"string","description":"Product category label, for example, base, add-on.","example":"base"},"custom_fields":{"type":"object","description":"Custom fields to set on the product. Keys must match configured custom field API names.\nValues may be strings, numbers, booleans, or arrays depending on field definition.\n","additionalProperties":true,"example":{"HelloBay__c":"Updated value","Tags__c":["AI Powered","Internet Required"]}},"startDate":{"type":"string","format":"date","description":"Product effective start date (UTC, YYYY-MM-DD).","example":"2025-05-11"},"endDate":{"type":"string","format":"date","description":"Product effective end date (UTC, YYYY-MM-DD).","example":"2050-12-10"}},"required":["id"]}},"components/schemas/UpdateProductResponse":{"id":"components/schemas/UpdateProductResponse","kind":"json-schema","title":"UpdateProductResponse","data":{"type":"object","description":"Product record returned after a successful update.","properties":{"id":{"type":"string","description":"Unique identifier of the product.","example":"00c86e3a0595442c88ed9ef8474b10a7"},"name":{"type":"string","description":"Product name.","example":"Amadeus"},"description":{"type":"string","description":"Product description.","example":"Software service - basic edition"},"category":{"type":"string","description":"Product category label.","example":"base"},"productNumber":{"type":"string","description":"Product number in the catalog.","example":"PC-00000095"},"sku":{"type":"string","description":"Product SKU.","example":"SKU-00000122"},"startDate":{"type":"string","format":"date","description":"Product effective start date (UTC, YYYY-MM-DD).","example":"2024-01-08"},"endDate":{"type":"string","format":"date","description":"Product effective end date (UTC, YYYY-MM-DD).","example":"2050-12-31"},"state":{"type":"string","description":"Current product state.","example":"product_active"},"allowFeatureChanges":{"type":"boolean","description":"Whether features on this product can be changed.","example":false},"features":{"type":"array","description":"Product features.","items":{"type":"object","additionalProperties":true}},"legacyFeatures":{"type":"array","description":"Legacy features associated with this product.","items":{"type":"object","additionalProperties":true}},"contextFilters":{"type":"array","description":"Context filters applied to the product.","items":{"type":"object","additionalProperties":true}},"customFields":{"type":"object","description":"Custom fields on the product.","additionalProperties":true},"customObjects":{"type":"object","nullable":true,"description":"Custom objects linked to this product.","additionalProperties":true},"netsuite":{"type":"object","nullable":true,"description":"Netsuite integration attributes.","additionalProperties":true},"organizationLabels":{"type":"array","description":"Organization labels for the product.","items":{"type":"string"}},"productRatePlans":{"type":"array","description":"Rate plans (PRPs) defined under the product.","items":{"type":"object","additionalProperties":true}},"createdBy":{"type":"string","description":"ID of the user who created the product.","example":"8a90a2fd8030ea2e018032b11d3a3f06"},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the product was created.","example":"2025-08-06T18:11:35.000-07:00"},"updatedBy":{"type":"string","description":"ID of the user who last updated the product.","example":"53c162482f054f3ca08e1ec82dccfec9"},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the product was last updated.","example":"2025-10-23T04:55:54.000-07:00"}}}},"components/schemas/CreateProductRequest":{"id":"components/schemas/CreateProductRequest","kind":"json-schema","title":"CreateProductRequest","data":{"type":"object","required":["name","start_date","end_date","category","plans"],"properties":{"name":{"type":"string","description":"Product name.","example":"New prod"},"sku":{"type":"string","description":"The stock keeping unit (SKU) associated with the product or invoice item.","example":"SKU-12345"},"product_number":{"type":"string","description":"The product number that uniquely identifies the product in the product catalog.","example":"PROD-001"},"start_date":{"type":"string","format":"date","description":"Product effective start date (UTC, YYYY-MM-DD).","example":"2024-01-01"},"end_date":{"type":"string","format":"date","description":"Product effective end date (UTC, YYYY-MM-DD).","example":"2050-12-31"},"category":{"type":"string","description":"Product category.\n","enum":["base","add_on","other"],"example":"base"},"plans":{"type":"array","description":"Product rate plans to create under the product.","minItems":1,"items":{"type":"object","required":["name","start_date","end_date","active_currencies","charges"],"properties":{"name":{"type":"string","description":"Rate plan name.","example":"Consumer Bronze Monthly 2"},"start_date":{"type":"string","format":"date","description":"Rate plan effective start date (UTC, YYYY-MM-DD).","example":"2024-01-01"},"end_date":{"type":"string","format":"date","description":"Rate plan effective end date (UTC, YYYY-MM-DD).","example":"2050-12-31"},"active_currencies":{"type":"array","description":"ISO currency codes enabled for this plan.","items":{"type":"string","minLength":3,"maxLength":3},"example":["USD"]},"charges":{"type":"array","description":"Charges to create under this rate plan.","minItems":1,"items":{"type":"object","required":["name","charge_type","charge_model","bill_cycle","trigger_event","end_date_condition"],"properties":{"name":{"type":"string","description":"Charge name.","example":"Data Usage Charge"},"charge_type":{"type":"string","description":"Charge type.","enum":["one_time","recurring","usage"],"example":"usage"},"charge_model":{"type":"string","description":"Charge model.","enum":["flat_fee","per_unit","overage","volume","tiered","tiered_overage","discount_fixed_amount","discount_percentage","custom_charge_model","delivery","minimum_commitment_true_up","calculated","high_water_mark_volume_pricing","high_water_mark_tiered_pricing","multi_attribute_pricing","prerated_pricing","prerated_per_unit"],"example":"per_unit"},"unit_of_measure":{"type":"string","description":"Unit of measure for per-unit or usage charges.","example":"Each"},"list_price_base":{"type":"string","description":"List price base for the charge.\n","enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months","Per_Validity_Period"],"example":"Per_Billing_Period"},"default_quantity":{"type":"number","description":"Default quantity for this charge on subscriptions created from the plan.","example":1},"min_quantity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum quantity allowed for this charge.   Equivalent to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MinQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the legacy v1 Product Rate Plan Charge."},"children":[]}]}]}],"example":1},"max_quantity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum quantity allowed for this charge.   Equivalent to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MaxQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the legacy v1 Product Rate Plan Charge."},"children":[]}]}]}],"example":999999},"pricing":{"type":"object","description":"Default (standard) pricing defined at the charge level.\nProvide exactly one structure per the charge model.\n","oneOf":[{"title":"Flat Fee Pricing","type":"object","required":["flat_amounts"],"properties":{"flat_amounts":{"type":"object","description":"Map of currency to flat amount.","additionalProperties":{"type":"number"},"example":{"USD":100}}}},{"title":"Per Unit Pricing","type":"object","required":["unit_amounts"],"properties":{"unit_amounts":{"type":"object","description":"Map of currency to per-unit price.","additionalProperties":{"type":"number"},"example":{"USD":5}}}},{"title":"Tiered or Volume Pricing","type":"object","required":["tiers"],"properties":{"tiers":{"type":"array","description":"Tier definitions (volume or tiered) with optional min/max caps.","items":{"type":"object","required":["tier","from","price_format"],"properties":{"tier":{"type":"string","description":"Tier identifier (e.g., \"1\", \"2\")."},"from":{"type":"number","description":"Lower bound (inclusive)."},"up_to":{"type":"number","nullable":true,"description":"Upper bound (inclusive). Omit/null for open-ended last tier."},"price_format":{"type":"string","description":"Price format for the tier.","enum":["price_format_flat_fee","price_format_per_unit"],"example":"price_format_per_unit"},"unit_amounts":{"type":"object","description":"Per-unit price by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":2.5}},"flat_amounts":{"type":"object","description":"Flat amount by currency for this tier (if applicable).","additionalProperties":{"type":"number"},"example":{"USD":100}},"min_amounts":{"type":"object","description":"Minimum billed amount by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":6.25}},"max_amounts":{"type":"object","description":"Maximum billed amount by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":25}}}}}}},{"title":"Fixed Amount Discount","type":"object","required":["discount_amounts"],"properties":{"discount_amounts":{"type":"object","description":"Map of currency to discount amount.","additionalProperties":{"type":"number"},"example":{"USD":10}}}},{"title":"Percentage Discount","type":"object","required":["discount_percentage"],"properties":{"discount_percentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount percentage (e.g., 15 for 15%)."},"children":[]}]}]}],"example":15}}}]},"bill_cycle":{"type":"object","description":"Billing configuration of the charge.","required":["type","period","period_alignment"],"properties":{"type":{"type":"string","description":"Determines how the billing day is selected for this charge.\n","enum":["default_from_customer","specific_day_of_month","subscription_start_day","charge_trigger_day","specific_day_of_week","term_start_day","term_end_day"],"example":"default_from_customer"},"period":{"type":"string","description":"Length of each billing period. \n","enum":["bill_cycle_period_month","bill_cycle_period_quarter","bill_cycle_period_semi_annual","bill_cycle_period_annual","bill_cycle_period_eighteen_months","bill_cycle_period_two_years","bill_cycle_period_three_years","bill_cycle_period_five_years","bill_cycle_period_specific_months","bill_cycle_period_subscription_term","bill_cycle_period_week","bill_cycle_period_specific_weeks","bill_cycle_period_specific_days"],"example":"bill_cycle_period_month"},"period_alignment":{"type":"string","description":"How the billing period start aligns. \n","enum":["align_to_charge","align_to_subscription_start","align_to_term_start","align_to_term_end"],"example":"align_to_charge"},"timing":{"type":"string","description":"When the charge is billed relative to the service period.\n","enum":["in_advance","in_arrears"],"example":"in_arrears"},"day_of_month":{"type":"integer","minimum":1,"maximum":31,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if \"type\" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific_day_of_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":5},"day_of_week":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used when \"type\" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific_day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"specific_period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional specific period value when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bill_cycle_period_specific_months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bill_cycle_period_specific_weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bill_cycle_period_specific_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".   Equivalent to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the legacy v1 API."},"children":[]}]}]}]}}},"trigger_event":{"type":"string","description":"Event that triggers the charge. \n","enum":["contract_effective","service_activation","customer_acceptance","specific_date"],"example":"contract_effective"},"end_date_condition":{"type":"string","description":"Defines when the charge ends. \n","enum":["subscription_end","end_date_one_time","fixed_period","specific_end_date"],"example":"subscription_end"},"up_to_periods_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_period"},"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":"Maps to the duration unit (billing periods, days, weeks, months, years)."},"children":[]}]}]}],"enum":["billing_periods","days","weeks","months","years"],"example":"billing_periods"},"up_to_periods":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of periods used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0},"overage_options":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration for overage smoothing and period-based overage calculation. Equivalent to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NumberOfPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and related fields in the legacy v1 API."},"children":[]}]}]}],"properties":{"number_of_periods":{"type":"number","description":"Number of billing periods used for overage smoothing / calculation.\n"}}},"price_increase_percentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price_change_option"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to apply a specific percentage price increase. Equivalent to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PriceIncreasePercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (v1)."},"children":[]}]}]}],"example":5},"price_change_option":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how price changes are handled for future terms when this product or rate plan is amended. Equivalent to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PriceChangeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the legacy v1 API. Examples include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific_percentage_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"use_latest_product_catalog_pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["no_change","specific_percentage_value","use_latest_product_catalog_pricing"],"example":"no_change"},"use_tenant_default_for_price_change":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, uses the tenant-level default setting for price change behavior instead of the charge-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price_change_option"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".   Equivalent to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UseTenantDefaultForPriceChange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the legacy v1 API."},"children":[]}]}]}],"example":true},"discount_options":{"type":"object","description":"Discount configuration for discount charge models, including \"Apply Discount To\" and related settings.\n","properties":{"discount_class":{"type":"string","description":"Discount class to associate with this discount charge."},"stacked_discount":{"type":"boolean","description":"When true, this discount can stack with other discounts.\n"},"apply_to":{"type":"array","description":"Charge types that this discount applies to.   Mirrors the \"One-Time / Recurring / Usage\" checkboxes in the UI.\n","items":{"type":"string","enum":["one_time","recurring","usage"]}},"discount_level":{"type":"string","description":"Level at which the discount applies (for example, subscription-level or account-level discounts).\n","enum":["rate_plan","subscription","account"]},"apply_to_billing_period_partially":{"type":"boolean","description":"When true, allows the discount to apply to partial billing periods.\n"},"specific_accounting_codes":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, uses discount-specific accounting codes instead of inheriting from the discounted charges.   Equivalent to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UseDiscountSpecificAccountingCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the legacy v1 API."},"children":[]}]}]}]},"reflect_discount_in_net_amount":{"type":"boolean","description":"When true, discount is reflected directly in the net amount (Apply To Charge Net Amount option in the UI).\n"},"rollover":{"type":"boolean","description":"Indicates whether unused discount amounts roll over to the next billing period.\n"},"apply_details":{"type":"array","description":"Explicit list of product charges that this discount applies to when targeting specific charges.\n","items":{"type":"object","properties":{"applied_product_rate_plan_id":{"type":"string","description":"ID of the target product rate plan."},"applied_product_rate_plan_charge_id":{"type":"string","description":"ID of the target product rate plan charge."}}}}}},"accounting":{"$ref":"#/components/schemas/AccountingRequest"}}}}}}}}}},"components/schemas/CreateProductResponse":{"id":"components/schemas/CreateProductResponse","kind":"json-schema","title":"CreateProductResponse","data":{"type":"object","description":"Product created with optional plans and charges.","required":["id","name","category","startDate","endDate","state"],"properties":{"id":{"type":"string","description":"Unique identifier of the product.","example":"7ec58fadb6f84bc18e59c7529058d941"},"name":{"type":"string","description":"Product name.","example":"New prod"},"category":{"type":"string","description":"Product category, for example, base or add-on.","example":"base"},"description":{"type":"string","description":"Free-form product description.","example":""},"productNumber":{"type":"string","description":"The product number.","example":"PC-00000105"},"sku":{"type":"string","description":"Stock keeping unit for the product.","example":"SKU-00000135"},"startDate":{"type":"string","format":"date","description":"Product effective start date, for example, UTC, YYYY-MM-DD.","example":"2024-01-01"},"endDate":{"type":"string","format":"date","description":"Product effective end date, for example, UTC, YYYY-MM-DD.","example":"2050-12-31"},"state":{"type":"string","description":"Current lifecycle state of the product.","example":"product_active"},"allowFeatureChanges":{"type":"boolean","description":"Whether feature changes are allowed for this product.","example":false},"features":{"type":"array","description":"List of features associated with the product.","items":{"type":"object"}},"legacyFeatures":{"type":"array","description":"Legacy feature list retained for backward compatibility.","items":{"type":"object","additionalProperties":true}},"contextFilters":{"type":"array","description":"Context filter rules that may restrict product availability.","items":{"type":"object"}},"organizationLabels":{"type":"array","description":"Key/value style organizational labels applied to the product.","items":{"type":"object"}},"customFields":{"type":"object","description":"Custom field values on the product.","additionalProperties":true},"customObjects":{"type":"object","nullable":true,"description":"Custom object payloads linked to the product, if any.","additionalProperties":true,"example":null},"dacTags":{"type":"object","description":"Data access control or categorization tags for the product.","additionalProperties":true},"netsuite":{"type":"object","nullable":true,"description":"NetSuite integration metadata (if present).","additionalProperties":true,"example":null},"createdBy":{"type":"string","description":"ID of the user who created the product.","example":"53c162482f054f3ca08e1ec82dccfec9"},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the product was created.","example":"2025-10-17T04:02:54.621-07:00"},"updatedBy":{"type":"string","description":"ID of the user who last updated the product.","example":"53c162482f054f3ca08e1ec82dccfec9"},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the product was last updated.","example":"2025-10-17T04:02:54.621-07:00"},"plans":{"type":"array","description":"Rate plans (PRPs) defined under this product.","items":{"type":"object","required":["id","name","startDate","endDate","activeCurrencies"],"properties":{"id":{"type":"string","description":"Unique identifier of the product rate plan (PRP).","example":"572a2efe711b449e80cbef94419bc050"},"name":{"type":"string","description":"Rate plan display name.","example":"Consumer Bronze Monthly"},"displayName":{"type":"string","description":"Optional alternate display name for the plan.","example":""},"description":{"type":"string","description":"Free-form plan description.","example":""},"startDate":{"type":"string","format":"date","description":"Plan effective start date (UTC, YYYY-MM-DD).","example":"2024-01-01"},"endDate":{"type":"string","format":"date","description":"Plan effective end date (UTC, YYYY-MM-DD).","example":"2050-12-31"},"state":{"type":"string","description":"Current lifecycle state of the plan.","example":"active"},"status":{"type":"string","description":"Optional status when present in some responses.","example":"ACTIVE"},"activeCurrencies":{"type":"array","description":"ISO currency codes enabled for this plan.","items":{"type":"string"},"example":"USD"},"createTime":{"type":"string","format":"date-time","description":"Timestamp when the plan was created.","example":"2025-10-17T04:02:54.655-07:00"},"updateTime":{"type":"string","format":"date-time","description":"Timestamp when the plan was last updated.","example":"2025-10-17T04:02:54.655-07:00"},"createdBy":{"type":"string","description":"ID of the user who created the plan.","example":"53c162482f054f3ca08e1ec82dccfec9"},"updatedBy":{"type":"string","description":"ID of the user who last updated the plan.","example":"53c162482f054f3ca08e1ec82dccfec9"},"productId":{"type":"string","description":"ID of the parent product for this plan.","example":"7ec58fadb6f84bc18e59c7529058d941"},"productRatePlanNumber":{"type":"string","description":"The plan number.","example":"PRP-00000198"},"attributes":{"type":"array","description":"Plan-level attribute metadata.","items":{"type":"object"}},"contextFilters":{"type":"array","description":"Context filter rules scoped to the plan.","items":{"type":"object"}},"entitlements":{"type":"array","description":"Entitlements included with the plan.","items":{"type":"object"}},"externalIdSourceSystem":{"type":"string","description":"Source system identifier for the external plan ID.","example":""},"externalRateplanId":{"type":"array","description":"External plan identifier(s) from other systems.","items":{"type":"string"}},"netsuite":{"type":"object","nullable":true,"description":"NetSuite integration metadata (if present).","additionalProperties":true,"example":null},"organizationLabels":{"type":"array","description":"Key/value style organizational labels on the plan.","items":{"type":"object"}},"customFields":{"type":"object","description":"Custom field values on the plan.","additionalProperties":true},"productRatePlanCharges":{"type":"array","description":"Charges created under this plan.","items":{"type":"object","required":["id","name","chargeModel","chargeType","billCycle","pricing"],"properties":{"id":{"type":"string","description":"Unique identifier of the product rate plan charge (PRPC).","example":"42db6ead399a4521bae91b3af469c074"},"name":{"type":"string","description":"Charge display name within the plan.","example":"Flat PRPC"},"chargeModel":{"type":"string","description":"Pricing model that determines how the amount is calculated.","example":"flat_fee"},"chargeType":{"type":"string","description":"Whether the charge recurs, rates usage, or is a one-time fee.","example":"recurring"},"chargeFunction":{"type":"string","description":"Internal function identifier for the charge.","example":"charge_function_standard"},"productRatePlanChargeNumber":{"type":"string","description":"The charge number.","example":"PRPC-00000283"},"productRatePlanId":{"type":"string","description":"ID of the parent plan for this charge.","example":"572a2efe711b449e80cbef94419bc050"},"triggerEvent":{"type":"string","description":"Event that triggers the charge to become billable.","example":"contract_effective"},"endDateCondition":{"type":"string","description":"Condition that determines when the charge ends.","example":"subscription_end"},"upToPeriodsType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example, billing periods, days, weeks, months, or years."},"children":[]}]}]}],"example":"billing_periods"},"upToPeriods":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of periods used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0},"listPriceBase":{"type":"string","description":"Basis used for list pricing (if applicable).","example":"Per_Billing_Period"},"specificListPriceBase":{"type":"number","description":"Optional override for list price base when billing uses a specific period configuration.\n","example":0},"billCycle":{"type":"object","description":"Billing configuration of the charge.","properties":{"type":{"type":"string","description":"Whether the charge inherits account defaults or uses an override.","example":"specific_day_of_month"},"dayOfMonth":{"type":"integer","description":"Day of month to bill when using a specific day schedule.","example":5},"period":{"type":"string","description":"Billing period length (for example, monthly).","example":"bill_cycle_period_month"},"periodAlignment":{"type":"string","description":"How the billing period start aligns.","example":"align_to_charge"},"timing":{"type":"string","description":"When the charge is billed relative to the service period.","example":"in_advance"}}},"organizationLabels":{"type":"array","description":"Key/value style organizational labels on the charge.","items":{"type":"object"}},"accounting":{"$ref":"#/components/schemas/AccountingResponse"},"discountOptions":{"type":"object","description":"Discount behavior flags configured on the charge.","properties":{"applyDetails":{"type":"array","description":"List of granular discount application details.","items":{"type":"object"}},"applyTo":{"type":"array","description":"Line item categories the discount applies to.","items":{"type":"string"}},"applyToBillingPeriodPartially":{"type":"boolean","description":"Whether discount applies to partial billing periods.","example":false},"reflectDiscountInNetAmount":{"type":"boolean","description":"Whether to reflect discounts in the net amount fields.","example":false},"rollover":{"type":"boolean","description":"Whether unapplied discounts roll over.","example":false},"stackedDiscount":{"type":"boolean","description":"Whether multiple discounts can stack.","example":false}},"additionalProperties":true},"overageOptions":{"type":"object","description":"Options governing overage behavior for usage charges.","properties":{"includedUnits":{"type":"number","description":"Number of units included before overages apply.","example":0},"unusedUnitsCreditRates":{"type":"object","description":"Credit rates for unused units by currency.","additionalProperties":{"type":"number"}}}},"prepayment":{"type":"object","description":"Prepayment configuration for the charge (if applicable).","properties":{"rollover":{"type":"boolean","description":"Whether unused prepaid amounts roll over.","example":false},"rolloverApply":{"type":"string","description":"How rollover amounts are applied.","example":"apply_last"},"rolloverPeriodLength":{"type":"integer","description":"Length of the rollover period.","example":0},"rolloverPeriods":{"type":"integer","description":"Number of rollover periods.","example":0}}},"prorationOption":{"type":"string","description":"Proration behavior for partial periods.","example":"default_from_tenant_setting"},"priceChangeOption":{"type":"string","description":"How price changes are applied to existing subscriptions.","example":"no_change"},"taxable":{"type":"boolean","description":"Whether the charge is taxable.","example":false},"taxMode":{"type":"string","description":"Tax mode classification (present on some responses).","example":"non_taxable"},"prepaid":{"type":"boolean","description":"Whether the charge is prepaid.","example":false},"isCommitted":{"type":"boolean","description":"Whether the charge is committed.","example":false},"isChargeLevelMinCommit":{"type":"boolean","description":"Whether a minimum commitment is enforced at the charge level.","example":false},"useTenantDefaultForPriceChange":{"type":"boolean","description":"Whether tenant default settings apply to price changes.","example":true},"labels":{"type":"object","description":"Arbitrary label metadata for the charge.","additionalProperties":true},"attributes":{"type":"array","description":"Attribute metadata on the charge (if configured).","items":{"type":"object"}},"customFields":{"type":"object","description":"Custom field values on the charge.","additionalProperties":true},"createdById":{"type":"string","description":"ID of the user who created the charge.","example":"53c162482f054f3ca08e1ec82dccfec9"},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was created.","example":"2025-10-17T04:02:54.719-07:00"},"updatedById":{"type":"string","description":"ID of the user who last updated the charge.","example":"53c162482f054f3ca08e1ec82dccfec9"},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was last updated.","example":"2025-10-17T04:02:54.719-07:00"},"pricing":{"type":"object","description":"Default (charge-level) pricing returned for the charge.","properties":{"adjustments":{"type":"object","description":"Price adjustments by currency or context.","additionalProperties":true},"discountAmounts":{"type":"object","description":"Fixed discount amounts by currency.","additionalProperties":{"type":"number"}},"discountPercentages":{"type":"object","description":"Discount percentages by currency.","additionalProperties":{"type":"number"}},"flatAmounts":{"type":"object","description":"Flat fee amounts by currency.","additionalProperties":{"type":"number"},"example":{"USD":100}},"maxAmounts":{"type":"object","description":"Maximum amounts by currency (caps).","additionalProperties":{"type":"number"}},"minAmounts":{"type":"object","description":"Minimum amounts by currency (floors).","additionalProperties":{"type":"number"}},"percentages":{"type":"object","description":"Percentage values by currency for percentage models.","additionalProperties":{"type":"number"}},"tiers":{"type":"array","description":"Tier definitions for tiered/volume pricing.","items":{"type":"object"}},"unitAmounts":{"type":"object","description":"Per-unit prices by currency for usage/per-unit models.","additionalProperties":{"type":"number"}}}},"pricingSummary":{"type":"array","description":"Textual summary of pricing for display purposes.","items":{"type":"string"}},"pricingWaterfalls":{"type":"object","description":"Detailed pricing waterfall data (if available).","additionalProperties":true},"productChargeDefinitions":{"type":"array","description":"Charge definition metadata linked to this PRPC.","items":{"type":"object"}},"rateCards":{"type":"array","description":"Conditional rate card rules configured for the charge.","items":{"type":"object"}},"revenue":{"type":"object","description":"Revenue recognition metadata for the charge.","properties":{"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":"Whether item billing is excluded from revenue accounting.","example":false},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":"Whether item booking is excluded from revenue accounting.","example":false},"legacyReporting":{"type":"boolean","description":"Whether legacy reporting is enabled.","example":false},"revenueRecognitionRuleName":{"type":"string","description":"Revenue recognition rule applied to this charge.","example":"Recognize upon invoicing"}}},"ocmJsonByCurrency":{"type":"object","description":"Offer/charge metadata keyed by currency.","additionalProperties":true},"drawdown":{"type":"object","description":"Drawdown configuration data (if applicable).","additionalProperties":true},"extendedPrice":{"type":"object","description":"Extended price metadata (if present).","additionalProperties":true},"mergedRateCards":{"type":"array","description":"Merged/compiled rate card entries after evaluation.","items":{"type":"object"}},"negotiatedRateCards":{"type":"array","description":"Customer-specific negotiated rate card entries.","items":{"type":"object"}}}}}}}}},"additionalProperties":true}},"components/schemas/UpdatePlanRequest":{"id":"components/schemas/UpdatePlanRequest","kind":"json-schema","title":"UpdatePlanRequest","data":{"type":"object","description":"Request body for updating a Product Rate Plan (PRP).","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan to update.","example":"5758b1d5a589840e0e6855e1c2ce014d"},"name":{"type":"string","description":"Rate plan name.","example":"Bronze Plan"},"description":{"type":"string","description":"Rate plan description.","example":"Basic version of our software service"},"grade":{"type":"integer","description":"Plan grade or display rank used for ordering in catalogs or UIs.","example":1},"startDate":{"type":"string","format":"date","description":"Rate plan effective start date (UTC, YYYY-MM-DD).","example":"2025-09-10"},"endDate":{"type":"string","format":"date","description":"Rate plan effective end date (UTC, YYYY-MM-DD).","example":"2043-08-16"}},"required":["id"]}},"components/schemas/UpdatePlanResponse":{"id":"components/schemas/UpdatePlanResponse","kind":"json-schema","title":"UpdatePlanResponse","data":{"type":"object","description":"Product Rate Plan record returned after a successful update.","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan (PRP).","example":"38660706ef2f48cfb5222f7dde491895"},"name":{"type":"string","description":"Rate plan name.","example":"Bronze Plan"},"description":{"type":"string","description":"Rate plan description.","example":"Basic version of our software service"},"productId":{"type":"string","description":"Owning product ID.","example":"8a90aac8948deebf01949098b7790326"},"productRatePlanNumber":{"type":"string","description":"Rate plan number.","example":"PRP-00000172"},"startDate":{"type":"string","format":"date","description":"Rate plan effective start date (UTC, YYYY-MM-DD).","example":"2025-09-10"},"endDate":{"type":"string","format":"date","description":"Rate plan effective end date (UTC, YYYY-MM-DD).","example":"2027-01-01"},"state":{"type":"string","description":"Current rate plan state.","example":"active"},"status":{"type":"string","description":"Rate plan status.","example":"ACTIVE"},"activeCurrencies":{"type":"array","description":"Currencies with active pricing.","items":{"type":"string"},"example":["USD"]},"displayName":{"type":"string","description":"Product rate plan display name.","example":""},"attributes":{"type":"array","description":"Attribute definitions associated with the plan.","items":{"type":"object","additionalProperties":true}},"contextFilters":{"type":"array","description":"Context filters at the plan level.","items":{"type":"object","additionalProperties":true}},"entitlements":{"type":"array","description":"Entitlements linked to the plan.","items":{"type":"object","additionalProperties":true}},"externalIdSourceSystem":{"type":"string","description":"External ID source system.","example":""},"externalRateplanId":{"type":"array","description":"External plan identifiers.","items":{"type":"string"}},"netsuite":{"type":"object","description":"Netsuite integration attributes.","additionalProperties":true},"organizationLabels":{"type":"array","description":"Organization labels.","items":{"type":"string"}},"customFields":{"type":"object","description":"Custom fields at the plan level.","additionalProperties":true},"productRatePlanCharges":{"type":"array","description":"Charges (PRPCs) that belong to this product rate plan.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan Charge (PRPC).","example":"99e226fec45943f4b80ed7bcf6d595d7"},"name":{"type":"string","description":"Charge name.","example":"disc_currency"},"chargeType":{"type":"string","description":"Charge type.","example":"recurring"},"chargeModel":{"type":"string","description":"Charge model.","example":"discount_percentage"},"listPriceBase":{"type":"string","description":"Indicates how list price is interpreted.","example":"Per_Billing_Period"},"triggerEvent":{"type":"string","description":"Event that triggers the charge.","example":"contract_effective"},"billCycle":{"type":"object","description":"Billing cycle configuration.","additionalProperties":true,"example":{"period":"bill_cycle_period_quarter","periodAlignment":"align_to_term_start","type":"term_start_day"}},"pricing":{"type":"object","description":"Pricing configuration for the charge.","additionalProperties":true,"example":{"discountPercentages":{"USD":10},"tiers":[]}},"prepayment":{"type":"object","description":"Prepayment options for the charge (when applicable).","additionalProperties":true},"taxMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax mode for this charge, for example, non_taxable or taxable."},"children":[]}]}]}],"example":"non_taxable"},"taxable":{"type":"boolean","description":"Indicates whether the charge is taxable.","example":false},"createdById":{"type":"string","description":"ID of the user who created the charge."},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was created."},"updatedById":{"type":"string","description":"ID of the user who last updated the charge."},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was last updated."},"accounting":{"type":"object","additionalProperties":true,"description":"Accounting configuration for the charge (for example, account mappings and posting preferences)."},"attributes":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Attribute definitions bound to this charge (used for dynamic pricing or evaluation)."},"customFields":{"type":"object","additionalProperties":true,"description":"Custom fields on the charge."},"deliverySchedule":{"type":"object","additionalProperties":true,"description":"Delivery schedule settings, for example, frequency and applicable days."},"discountOptions":{"type":"object","additionalProperties":true,"description":"Discount configuration for this charge, including scope, stacking, and net-amount reflection."},"drawdown":{"type":"object","additionalProperties":true,"description":"Drawdown configuration for consuming balances or entitlements."},"endDateCondition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends, for example, subscription_end or after a term."},"children":[]}]}]}]},"extendedPrice":{"type":"object","additionalProperties":true,"description":"Calculated extended price details, if applicable."},"isChargeLevelMinCommit":{"type":"boolean","description":"Indicates whether a minimum commitment is enforced at the charge level."},"isCommitted":{"type":"boolean","description":"Indicates whether this charge is part of a committed contract."},"labels":{"type":"object","additionalProperties":true,"description":"Key-value metadata labels associated with the charge."},"mergedRateCards":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Effective rate card entries after merging default and negotiated cards."},"negotiatedRateCards":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Customer- or segment-specific negotiated rate card entries."},"ocmJsonByCurrency":{"type":"object","additionalProperties":true,"description":"Per-currency pricing/configuration metadata in JSON format."},"organizationLabels":{"type":"array","items":{"type":"string"},"description":"Organization labels attached to the charge."},"overageOptions":{"type":"object","additionalProperties":true,"description":"Overage configuration, for example, included units and unused-unit credit rates."},"prepaid":{"type":"boolean","description":"Indicates whether the charge is prepaid."},"priceChangeOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How price changes are handled on updates, for example, no_change."},"children":[]}]}]}]},"pricingSummary":{"type":"array","items":{"type":"string"},"description":"Human-readable pricing summary lines."},"pricingWaterfalls":{"type":"object","additionalProperties":true,"description":"Pricing source breakdown, for example, base price vs. segment price."},"productChargeDefinitions":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Charge definition objects that specify pricing and behavioral rules."},"productRatePlanChargeNumber":{"type":"string","description":"Charge number (PRPC number) for this charge."},"productRatePlanId":{"type":"string","description":"Owning Product Rate Plan ID."},"prorationOption":{"type":"string","description":"Proration behavior for this charge."},"rateCards":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Associated rate card definitions used for dynamic or segmented pricing."},"revenue":{"type":"object","additionalProperties":true,"description":"Revenue recognition configuration, for example, rules and codes."},"taxCode":{"type":"string","description":"Tax code applied to the charge for taxation purposes."}}}},"createTime":{"type":"string","format":"date-time","description":"Plan creation time.","example":"2025-02-24T01:20:44.000+00:00"},"updateTime":{"type":"string","format":"date-time","description":"Plan update time.","example":"2025-10-23T05:16:28.334+00:00"},"createdBy":{"type":"string","description":"ID of the user who created the plan.","example":"8a90a2fd8030ea2e018032b11d3a3f06"},"updatedBy":{"type":"string","description":"ID of the user who updated the plan.","example":"53c162482f054f3ca08e1ec82dccfec9"}}}},"components/schemas/CreatePlanRequest":{"id":"components/schemas/CreatePlanRequest","kind":"json-schema","title":"CreatePlanRequest","data":{"type":"object","required":["product_key","name","start_date","end_date","active_currencies","charges"],"properties":{"product_key":{"type":"string","description":"The unique identifier of the product under which the plan is created.","example":"6b14067136304e64b090daccae6680cb"},"name":{"type":"string","description":"The name of the rate plan.","example":"New plan"},"start_date":{"type":"string","format":"date","description":"Plan effective start date (UTC, YYYY-MM-DD).","example":"2024-01-01"},"end_date":{"type":"string","format":"date","description":"Plan effective end date (UTC, YYYY-MM-DD).","example":"2049-12-31"},"active_currencies":{"type":"array","description":"ISO currency codes enabled for this plan.","minItems":1,"items":{"type":"string","minLength":3,"maxLength":3},"example":["USD"]},"charges":{"type":"array","description":"The list of product rate plan charges to create under the plan.","minItems":1,"items":{"type":"object","required":["name","charge_model","charge_type","bill_cycle","trigger_event","end_date_condition","pricing"],"properties":{"name":{"type":"string","description":"The name of the charge.","example":"Flat PRPC 1"},"charge_model":{"type":"string","description":"Charge model that defines how pricing is calculated.","enum":["flat_fee","per_unit","overage","volume","tiered","tiered_overage","discount_fixed_amount","discount_percentage","custom_charge_model","delivery","minimum_commitment_true_up","calculated","high_water_mark_volume_pricing","high_water_mark_tiered_pricing","multi_attribute_pricing","prerated_pricing","prerated_per_unit"],"example":"flat_fee"},"charge_type":{"type":"string","description":"Charge type (recurring, usage, or one-time).","enum":["one_time","recurring","usage"],"example":"recurring"},"unit_of_measure":{"type":"string","description":"Unit of measure for per-unit or usage charges.","example":"Each"},"list_price_base":{"type":"string","description":"Optional list price base, if supported by the charge model.\n","enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months","Per_Validity_Period"],"example":"Per_Billing_Period"},"specific_list_price_base":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional specific value used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_price_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires an explicit quantity (for example, number of months for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":0},"pricing":{"type":"object","description":"Defines the pricing for the charge. Provide exactly one structure per charge model.","oneOf":[{"title":"Flat Fee Pricing","type":"object","required":["flat_amounts"],"properties":{"flat_amounts":{"type":"object","description":"Map of currency to flat amount.","additionalProperties":{"type":"number"},"example":{"USD":100}}}},{"title":"Per Unit Pricing","type":"object","required":["unit_amounts"],"properties":{"unit_amounts":{"type":"object","description":"Map of currency to per-unit price.","additionalProperties":{"type":"number"},"example":{"USD":5}}}},{"title":"Tiered or Volume Pricing","type":"object","required":["tiers"],"properties":{"tiers":{"type":"array","description":"Tier definitions with optional min/max caps.","items":{"type":"object","required":["tier","from","price_format"],"properties":{"tier":{"type":"string","description":"Tier identifier."},"from":{"type":"number","description":"Lower bound (inclusive)."},"up_to":{"type":"number","nullable":true,"description":"Upper bound (inclusive). Null for open-ended last tier."},"price_format":{"type":"string","description":"Price format identifier used for the tier.","enum":["price_format_flat_fee","price_format_per_unit"],"example":"price_format_per_unit"},"unit_amounts":{"type":"object","description":"Per-unit price by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":2.5}},"flat_amounts":{"type":"object","description":"Flat amount by currency for this tier (if applicable).","additionalProperties":{"type":"number"},"example":{"USD":100}},"min_amounts":{"type":"object","description":"Minimum billed amount by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":6.25}},"max_amounts":{"type":"object","description":"Maximum billed amount by currency for this tier.","additionalProperties":{"type":"number"},"example":{"USD":25}}}}}}},{"title":"Fixed Amount Discount","type":"object","required":["discount_amounts"],"properties":{"discount_amounts":{"type":"object","description":"Map of currency to discount amount.","additionalProperties":{"type":"number"},"example":{"USD":10}}}},{"title":"Percentage Discount","type":"object","required":["discount_percentage"],"properties":{"discount_percentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount percentage (e.g., 15 for 15%)."},"children":[]}]}]}],"example":15}}}]},"bill_cycle":{"type":"object","description":"Defines how billing occurs for this charge.","required":["type","period","period_alignment"],"properties":{"type":{"type":"string","description":"Determines how the billing day is selected for this charge.\n","enum":["default_from_customer","specific_day_of_month","subscription_start_day","charge_trigger_day","specific_day_of_week","term_start_day","term_end_day"],"example":"specific_day_of_month"},"day_of_month":{"type":"integer","minimum":1,"maximum":31,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required \"when type is specific_day_of_month\"."},"children":[]}]}]}],"example":5},"day_of_week":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used \"when type is specific_day_of_week\"."},"children":[]}]}]}],"enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"period":{"type":"string","description":"Billing period length.\n","enum":["bill_cycle_period_month","bill_cycle_period_quarter","bill_cycle_period_semi_annual","bill_cycle_period_annual","bill_cycle_period_eighteen_months","bill_cycle_period_two_years","bill_cycle_period_three_years","bill_cycle_period_five_years","bill_cycle_period_specific_months","bill_cycle_period_subscription_term","bill_cycle_period_week","bill_cycle_period_specific_weeks","bill_cycle_period_specific_days"],"example":"bill_cycle_period_month"},"period_alignment":{"type":"string","description":"How the billing period start aligns. \n","enum":["align_to_charge","align_to_subscription_start","align_to_term_start","align_to_term_end"],"example":"align_to_charge"},"timing":{"type":"string","description":"When the charge is billed relative to the service period.\n","enum":["in_advance","in_arrears"],"example":"in_advance"}}},"end_date_condition":{"type":"string","description":"Defines when the charge ends.\n","enum":["subscription_end","end_date_one_time","fixed_period","specific_end_date"],"example":"subscription_end"},"up_to_periods_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Granularity used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition = fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to express how long the charge remains active. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition = subscription_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is ignored."},"children":[]}]}]}],"enum":["billing_periods","days","weeks","months","years"],"example":"billing_periods"},"up_to_periods":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of periods used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition = fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up_to_periods_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine the fixed duration of the charge. Ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_condition = subscription_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0},"trigger_event":{"type":"string","description":"Event that triggers the charge. \n","enum":["contract_effective","service_activation","customer_acceptance","specific_date"],"example":"contract_effective"},"accounting":{"$ref":"#/components/schemas/AccountingRequest"}}}}},"example":{"product_key":"6b14067136304e64b090daccae6680cb","name":"New plan","start_date":"2024-01-01","end_date":"2049-12-31","active_currencies":["USD"],"charges":[{"name":"Flat PRPC 1","charge_model":"flat_fee","charge_type":"recurring","pricing":{"flat_amounts":{"USD":100}},"bill_cycle":{"type":"specific_day_of_month","day_of_month":5,"period_alignment":"align_to_charge","period":"bill_cycle_period_month","timing":"in_advance"},"end_date_condition":"subscription_end","trigger_event":"contract_effective","accounting":{"accounting_code":"PRPC-REV-002","accounts_receivable_account":"Accounts Receivable","deferred_revenue_account":"Deferred Revenue","recognized_revenue_account":"Recognized Revenue","adjustment_liability_account":"adjustL-2","adjustment_revenue_account":"adjustRev-2","contract_asset_account":"CA-3","contract_liability_account":"CL-3","contract_recognized_revenue_account":"Contract Recognized Revenue","unbilled_receivables_account":"unbilledR-2"}},{"name":"Flat PRPC 2","charge_model":"flat_fee","charge_type":"recurring","pricing":{"flat_amounts":{"USD":100}},"bill_cycle":{"type":"specific_day_of_month","day_of_month":5,"period_alignment":"align_to_charge","period":"bill_cycle_period_month","timing":"in_advance"},"end_date_condition":"subscription_end","trigger_event":"contract_effective","accounting":{"accounting_code":"PRPC-REV-002","accounts_receivable_account":"Accounts Receivable","deferred_revenue_account":"Deferred Revenue","recognized_revenue_account":"Recognized Revenue","adjustment_liability_account":"adjustL-2","adjustment_revenue_account":"adjustRev-2","contract_asset_account":"CA-3","contract_liability_account":"CL-3","contract_recognized_revenue_account":"Contract Recognized Revenue","unbilled_receivables_account":"unbilledR-2"}}]}}},"components/schemas/CreatePlanResponse":{"id":"components/schemas/CreatePlanResponse","kind":"json-schema","title":"CreatePlanResponse","data":{"type":"object","required":["id","name","startDate","endDate","activeCurrencies"],"properties":{"id":{"type":"string","description":"The unique identifier of the created plan (product rate plan).","example":"ee2d1ce1036c4dd6ae9d6945565ff7a0"},"name":{"type":"string","description":"Plan display name.","example":"New plan"},"displayName":{"type":"string","description":"The display name of the plan.","example":""},"description":{"type":"string","description":"Free-form plan description.","example":""},"state":{"type":"string","description":"Current lifecycle state of the plan.","example":"active"},"startDate":{"type":"string","format":"date","description":"Plan effective start date (UTC, YYYY-MM-DD).","example":"2024-01-01"},"endDate":{"type":"string","format":"date","description":"Plan effective end date (UTC, YYYY-MM-DD).","example":"2049-12-31"},"activeCurrencies":{"type":"array","description":"ISO currency codes enabled for the plan.","items":{"type":"string"},"example":["USD"]},"createTime":{"type":"string","format":"date-time","description":"Timestamp when the plan was created.","example":"2025-10-13T07:46:02.314-07:00"},"updateTime":{"type":"string","format":"date-time","description":"Timestamp when the plan was last updated.","example":"2025-10-13T07:46:02.314-07:00"},"createdBy":{"type":"string","description":"User ID that created the plan.","example":"53c162482f054f3ca08e1ec82dccfec9"},"updatedBy":{"type":"string","description":"User ID that last updated the plan.","example":"53c162482f054f3ca08e1ec82dccfec9"},"productId":{"type":"string","description":"The product ID (key) this plan belongs to.","example":"7228c9e6fd814e3a9e59bcdf0117e34f"},"productRatePlanNumber":{"type":"string","description":"Plan number","example":"PRP-00000195"},"customFields":{"type":"object","description":"Custom field values on the plan.","additionalProperties":true},"attributes":{"type":"array","description":"Attribute metadata defined at the plan level (if any).","items":{"type":"object"}},"contextFilters":{"type":"array","description":"Contextual filters used to limit plan applicability.","items":{"type":"object"}},"entitlements":{"type":"array","description":"Entitlements included with the plan.","items":{"type":"object"}},"externalIdSourceSystem":{"type":"string","description":"Source system identifier for external integrations.","example":""},"externalRateplanId":{"type":"array","description":"External rate plan identifiers, if any.","items":{"type":"string"}},"organizationLabels":{"type":"array","description":"Organization-level labels associated with the plan.","items":{"type":"object"}},"netsuite":{"type":"object","nullable":true,"description":"NetSuite integration metadata (if present).","example":null},"productRatePlanCharges":{"type":"array","description":"Charges created under this plan.","items":{"type":"object","required":["id","name","chargeModel","chargeType","pricing","billCycle"],"properties":{"id":{"type":"string","description":"Unique identifier of the product rate plan charge (PRPC).","example":"ad95b694d2b8442b84dc8ad26561c7d7"},"name":{"type":"string","description":"Charge display name within the plan.","example":"Flat PRPC 1"},"chargeModel":{"type":"string","description":"Pricing model that determines how the amount is calculated.","example":"flat_fee"},"chargeType":{"type":"string","description":"Whether the charge recurs, rates usage, or is a one-time fee.","example":"recurring"},"chargeFunction":{"type":"string","description":"Internal function identifier for the charge.","example":"charge_function_standard"},"productRatePlanChargeNumber":{"type":"string","description":"PRPC number","example":"PRPC-00000279"},"triggerEvent":{"type":"string","description":"Event that triggers the charge to start billing.","example":"contract_effective"},"endDateCondition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rule for when the charge ends, for example, subscription_end."},"children":[]}]}]}],"example":"subscription_end"},"upToPeriodsType":{"type":"string","description":"Unit applied when charge ends after a fixed duration.","example":"billing_periods"},"upToPeriods":{"type":"number","description":"Number of periods defining fixed charge duration.","example":0},"listPriceBase":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List price basis, for example, Per_Billing_Period."},"children":[]}]}]}],"example":"Per_Billing_Period"},"specificListPriceBase":{"type":"number","description":"Optional override for list price base when billing uses a specific period configuration.\n","example":0},"billCycle":{"type":"object","description":"How and when this charge bills within each billing period.","properties":{"type":{"type":"string","description":"Bill-cycle mode (inherit defaults or set specific day rules).","example":"specific_day_of_month"},"dayOfMonth":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific bill day when type = specific_day_of_month."},"children":[]}]}]}],"example":5},"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period length, for example, bill_cycle_period_month."},"children":[]}]}]}],"example":"bill_cycle_period_month"},"periodAlignment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the billing period start aligns, for example, align_to_charge."},"children":[]}]}]}],"example":"align_to_charge"},"timing":{"type":"string","description":"Whether the charge bills before or after the service period.","example":"in_advance"}}},"accounting":{"$ref":"#/components/schemas/AccountingResponse"},"pricing":{"type":"object","description":"Default (charge-level) price configuration by model/currency.","properties":{"flatAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Flat amounts by currency for flat-fee pricing.","example":{"USD":100}},"unitAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Per-unit amounts by currency for per-unit/usage pricing."},"tiers":{"type":"array","items":{"type":"object"},"description":"Tier definitions for tiered/volume pricing."},"discountAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Fixed discount amounts by currency."},"discountPercentages":{"type":"object","additionalProperties":{"type":"number"},"description":"Percentage discount values by currency."},"minAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Minimum charge amounts by currency."},"maxAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Maximum charge amounts by currency."},"percentages":{"type":"object","additionalProperties":{"type":"number"},"description":"Percentage price values by currency (model-dependent)."}}},"priceChangeOption":{"type":"string","description":"How price changes are applied across renewals/amendments.","example":"no_change"},"prorationOption":{"type":"string","description":"How proration is handled relative to tenant defaults.","example":"default_from_tenant_setting"},"taxable":{"type":"boolean","description":"Whether the charge is taxable.","example":false},"discountOptions":{"type":"object","description":"How discount charges apply and interact with other discounts.","properties":{"stackedDiscount":{"type":"boolean","description":"Whether this discount stacks with other discounts.","example":false},"applyToBillingPeriodPartially":{"type":"boolean","description":"Whether the discount can partially align to a billing period.","example":false},"reflectDiscountInNetAmount":{"type":"boolean","description":"Whether discounts reduce the net amount on invoices.","example":false},"rollover":{"type":"boolean","description":"Whether unused discount can roll over to future periods.","example":false}}},"attributes":{"type":"array","description":"Attribute metadata for this charge.","items":{"type":"object"}},"createdById":{"type":"string","description":"User ID that created the charge record.","example":"53c162482f054f3ca08e1ec82dccfec9"},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the charge record was created.","example":"2025-10-13T07:46:02.375-07:00"},"updatedById":{"type":"string","description":"User ID that last updated the charge record.","example":"53c162482f054f3ca08e1ec82dccfec9"},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the charge record was last updated.","example":"2025-10-13T07:46:02.375-07:00"},"labels":{"type":"object","additionalProperties":true,"description":"Free-form labels/tags attached to the charge."},"mergedRateCards":{"type":"array","items":{"type":"object"},"description":"Effective rate-card rows after merges (if any)."},"negotiatedRateCards":{"type":"array","items":{"type":"object"},"description":"Customer- or deal-specific rate-card rows."},"ocmJsonByCurrency":{"type":"object","additionalProperties":true,"description":"Offer/OCM metadata keyed by currency (internal use)."},"productChargeDefinitions":{"type":"array","items":{"type":"object"},"description":"Underlying charge definitions referenced for pricing."},"rateCards":{"type":"array","items":{"type":"object"},"description":"Dynamic Pricing rate-card rows configured on the charge."},"pricingSummary":{"type":"array","items":{"type":"object"},"description":"Structured price summary breakdown (if returned)."},"pricingWaterfalls":{"type":"object","additionalProperties":true,"description":"Detailed pricing/waterfall breakdown (if returned)."},"overageOptions":{"type":"object","description":"Overage settings for usage charges.","properties":{"includedUnits":{"type":"number","description":"Included units before overage starts.","example":0},"unusedUnitsCreditRates":{"type":"object","additionalProperties":{"type":"number"},"description":"Credit rates for unused units (by currency)."}}},"prepaid":{"type":"boolean","description":"Indicates whether the charge is prepaid.","example":false},"prepayment":{"type":"object","description":"Prepayment handling and rollover behavior.","properties":{"rollover":{"type":"boolean","description":"Whether unused prepayment rolls over.","example":false},"rolloverApply":{"type":"string","description":"Order in which rollover is applied.","example":"apply_last"},"rolloverPeriodLength":{"type":"integer","description":"Length of each rollover period.","example":0},"rolloverPeriods":{"type":"integer","description":"Number of rollover periods allowed.","example":0}}},"isChargeLevelMinCommit":{"type":"boolean","description":"Whether a minimum commit is enforced at the charge level.","example":false},"isCommitted":{"type":"boolean","description":"Indicates if the charge definition is committed/finalized.","example":false},"useTenantDefaultForPriceChange":{"type":"boolean","description":"Whether tenant defaults govern price change behavior.","example":true},"revenue":{"type":"object","description":"Revenue policy settings for this charge.","properties":{"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":"If true, item billing is excluded from revenue accounting.","example":false},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":"If true, item booking is excluded from revenue accounting.","example":false},"legacyReporting":{"type":"boolean","description":"Indicator for legacy revenue reporting behaviors.","example":false},"revenueRecognitionRuleName":{"type":"string","description":"Name of the revenue recognition rule applied.","example":"Recognize upon invoicing"}}}},"additionalProperties":true}}},"additionalProperties":true}},"components/schemas/ListPlansRequest":{"id":"components/schemas/ListPlansRequest","kind":"json-schema","title":"ListPlansRequest","data":{"type":"object","description":"Request body for retrieving Product Rate Plans from the Product Catalog.","properties":{"filters":{"type":"array","description":"Filter conditions for querying product rate plans.  \nEach filter defines a field, operator, and value.\n","items":{"type":"object","required":["field","operator","value"],"properties":{"field":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field name to filter by, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prp_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prp_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"prp_id"},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison operator for the filter condition. Supported 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":"EQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (equals)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (not equals)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (in a list of values)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (partial match)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (greater than)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (greater than or equal)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (less than)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (less than or equal)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (starts with)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (ends with)"},"children":[]}]}]}]}],"enum":["EQ","NE","IN","LIKE","GT","GTE","LT","LTE","SW","EW"],"example":"EQ"},"value":{"type":"string","description":"Value to match for the specified field.","example":"38660706ef2f48cfb5222f7dde491895"}}}},"expand":{"type":"object","description":"Expand related entities in the response.","properties":{"product_rate_plan_charges":{"type":"boolean","description":"Whether to include associated Product Rate Plan Charges (PRPCs).","example":true}}}},"required":["filters"]}},"components/schemas/ListPlansResponse":{"id":"components/schemas/ListPlansResponse","kind":"json-schema","title":"ListPlansResponse","data":{"type":"object","description":"Response body containing a list of Product Rate Plans.","properties":{"values":{"type":"array","description":"List of Product Rate Plans returned by the query.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan.","example":"38660706ef2f48cfb5222f7dde491895"},"name":{"type":"string","description":"Product Rate Plan name.","example":"Bronze Plan"},"description":{"type":"string","description":"Product Rate Plan description.","example":"Basic version of our software service"},"productId":{"type":"string","description":"Identifier of the product this plan belongs to.","example":"8a90aac8948deebf01949098b7790326"},"startDate":{"type":"string","format":"date","description":"Effective start date of the plan (UTC, YYYY-MM-DD).","example":"2025-09-10"},"endDate":{"type":"string","format":"date","description":"Effective end date of the plan (UTC, YYYY-MM-DD).","example":"2027-01-01"},"state":{"type":"string","description":"Current plan state.","example":"active"},"status":{"type":"string","description":"Status of the plan.","example":"ACTIVE"},"activeCurrencies":{"type":"array","items":{"type":"string"},"description":"Currencies supported by this plan.","example":["USD"]},"accounting":{"$ref":"#/components/schemas/AccountingResponse"},"productRatePlanNumber":{"type":"string","description":"Product Rate Plan number.","example":"PRP-00000172"},"productRatePlanCharges":{"type":"array","description":"List of Product Rate Plan Charges (PRPCs) belonging to the plan.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan Charge.","example":"fe9b0e764dca4178a11c0e471e5dc0d8"},"name":{"type":"string","description":"Charge name.","example":"prepay_currency"},"chargeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge type (recurring, one_time, or usage)."},"children":[]}]}]}],"example":"recurring"},"chargeModel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge model (flat_fee, per_unit, tiered, etc.)."},"children":[]}]}]}],"example":"flat_fee"},"listPriceBase":{"type":"string","description":"Indicates how list price is interpreted.","example":"Per_Billing_Period"},"specificListPriceBase":{"type":"number","description":"Optional override for list price base when billing uses a specific period configuration.\n","example":0},"triggerEvent":{"type":"string","description":"Event that triggers the charge.","example":"contract_effective"},"unitOfMeasure":{"type":"string","description":"Unit of measure used for pricing (for example, Each).","example":"Each"},"defaultQuantity":{"type":"number","description":"Default quantity applied for the charge.","example":1},"endDateCondition":{"type":"string","description":"Condition that determines when the charge ends.","example":"subscription_end"},"upToPeriodsType":{"type":"string","description":"Unit applied when charge ends after a fixed duration.","example":"billing_periods"},"upToPeriods":{"type":"number","description":"Number of periods defining fixed charge duration.","example":0},"billCycle":{"type":"object","description":"Billing cycle configuration.","additionalProperties":true,"example":{"period":"bill_cycle_period_quarter","periodAlignment":"align_to_term_start","timing":"in_advance","type":"term_start_day"}},"pricing":{"type":"object","description":"Pricing configuration for the charge.","additionalProperties":true,"example":{"flatAmounts":{"USD":30},"tiers":[]}},"pricingSummary":{"type":"array","items":{"type":"string"},"description":"Human-readable pricing summary lines.","example":["USD30"]},"taxMode":{"type":"string","description":"Tax mode for this charge.","example":"non_taxable"},"taxable":{"type":"boolean","description":"Indicates whether the charge is taxable.","example":false},"createdById":{"type":"string","description":"ID of the user who created the charge.","example":"8a90a2fd8030ea2e018032b11d3a3f06"},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was created.","example":"2025-02-24T01:21:23.000+00:00"},"updatedById":{"type":"string","description":"ID of the user who last updated the charge.","example":"8a90a2fd8030ea2e018032b11d3a3f06"},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was last updated.","example":"2025-02-24T01:21:23.000+00:00"}}}}}}}}}},"components/schemas/CreateEntitlementDefinitionRequest":{"id":"components/schemas/CreateEntitlementDefinitionRequest","kind":"json-schema","title":"CreateEntitlementDefinitionRequest","data":{"type":"object","description":"Request body for creating a catalog entitlement definition on a plan.","properties":{"featureId":{"type":"string","description":"Unique identifier of the catalog feature to include on the plan.","example":"572a2efe711b449e80cbef94419bc050"},"defaultQuantity":{"type":"number","description":"Default quantity granted by this entitlement definition for a numbered feature.","example":100},"product_rate_plan_id":{"type":"string","description":"Unique identifier of the plan that owns this entitlement definition.","example":"38660706ef2f48cfb5222f7dde491895"},"feature_number":{"type":"string","description":"Feature number of the catalog feature to include on the plan.","example":"FEAT-00000001"},"featureNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Camel-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feature_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"FEAT-00000001"},"startDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the entitlement definition becomes effective, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2025-01-01"},"endDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the entitlement definition ends, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2099-12-31"},"quantity":{"type":"number","description":"Quantity granted by this entitlement definition for a numbered feature.","example":5},"values":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted values for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. Each value must be in the feature's allowed list."},"children":[]}]}]}],"items":{"type":"string"},"example":["basic","pro"]},"chargeSource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge source for the entitlement definition."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usage_charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"non_billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"non_billable"},"scope":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope of the entitlement, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"subscription"},"enforcementMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How entitlement overage is enforced."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soft_warn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"none"},"resetPolicy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How metered usage resets, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calendar_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"calendar_month"},"alertThresholds":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage alert thresholds, typically a JSON array of percentages such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[75, 95]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"[75, 95]"},"limitSource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of the entitlement limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"static"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"static"},"limitValue":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Static limit applied when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limitSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"static"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1000}}}},"components/schemas/EntitlementDefinition":{"id":"components/schemas/EntitlementDefinition","kind":"json-schema","title":"EntitlementDefinition","data":{"type":"object","description":"A catalog entitlement definition on a plan. This object defines the feature and default\nquantity included with the plan. It is not a runtime entitlement grant created by the Z-EMS grant API.\n","properties":{"id":{"type":"string","description":"Unique identifier of the entitlement definition.","example":"ee2d1ce1036c4dd6ae9d6945565ff7a0"},"entitlementNumber":{"type":"string","description":"System-generated number that uniquely identifies the entitlement definition.","example":"ENT-00000001"},"featureId":{"type":"string","description":"Unique identifier of the catalog feature included in this entitlement definition.","example":"572a2efe711b449e80cbef94419bc050"},"featureNumber":{"type":"string","description":"Feature number of the catalog feature included in this entitlement definition.","example":"FEAT-00000001"},"feature_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"FEAT-00000001"},"defaultQuantity":{"type":"number","nullable":true,"description":"Default quantity granted by this entitlement definition for a numbered feature.","example":10000},"quantity":{"type":"number","nullable":true,"description":"Quantity granted by this entitlement definition for a numbered feature.","example":5},"planId":{"type":"string","description":"Unique identifier of the plan that owns this entitlement definition.","example":"38660706ef2f48cfb5222f7dde491895"},"productRatePlanChargeId":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge linked to this entitlement definition when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limitSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"fe9b0e764dca4178a11c0e471e5dc0d8"},"product_rate_plan_charge_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"fe9b0e764dca4178a11c0e471e5dc0d8"},"chargeSource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge source for the entitlement definition, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usage_charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"non_billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"usage_charge"},"charge_source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"usage_charge"},"scope":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope of the entitlement, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"subscription"},"enforcementMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How entitlement overage is enforced, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soft_warn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"soft_warn"},"resetPolicy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How metered usage resets, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calendar_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"calendar_month"},"reset_policy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resetPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"calendar_month"},"alertThresholds":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage alert thresholds, typically a JSON array of percentages such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[75, 95]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"[75, 95]"},"limitSource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of the entitlement limit, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"static"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"charge"},"limit_source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limitSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"charge"},"limitValue":{"type":"number","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Static limit applied when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limitSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"static"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1000},"values":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted values for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entitlement definition."},"children":[]}]}]}],"items":{"type":"string"},"example":["basic","pro"]},"entitlementBool":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean value granted by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entitlement definition."},"children":[]}]}]}],"example":true},"entitlement_bool":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlementBool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true}}}},"components/schemas/UpdateEntitlementDefinitionResponse":{"id":"components/schemas/UpdateEntitlementDefinitionResponse","kind":"json-schema","title":"UpdateEntitlementDefinitionResponse","data":{"type":"object","description":"Response body that contains a catalog entitlement definition.","properties":{"value":{"description":"The catalog entitlement definition.","allOf":[{"$ref":"#/components/schemas/EntitlementDefinition"}]}}}},"components/schemas/UpdateEntitlementDefinitionRequest":{"id":"components/schemas/UpdateEntitlementDefinitionRequest","kind":"json-schema","title":"UpdateEntitlementDefinitionRequest","data":{"type":"object","description":"Request body for updating a catalog entitlement definition.","properties":{"entitlementNumber":{"type":"string","description":"Entitlement number of the definition to update.","example":"ENT-00000001"},"entitlement_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlementNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ENT-00000001"},"productRatePlanChargeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge to link to this entitlement definition when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limitSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"fe9b0e764dca4178a11c0e471e5dc0d8"},"chargeSource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge source for the entitlement definition, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usage_charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"non_billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"usage_charge"},"scope":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope of the entitlement, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"subscription"},"enforcementMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How entitlement overage is enforced, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soft_warn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"soft_warn"},"resetPolicy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How metered usage resets, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calendar_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"calendar_month"},"alertThresholds":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage alert thresholds, typically a JSON array of percentages such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[75, 95]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"[75, 95]"},"limitSource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of the entitlement limit, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"static"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"charge"},"entitlement_bool":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean value granted by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bool"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entitlement definition."},"children":[]}]}]}],"example":true}}}},"components/schemas/GetProductByKeyResponse":{"id":"components/schemas/GetProductByKeyResponse","kind":"json-schema","title":"GetProductByKeyResponse","data":{"type":"object","description":"Response body returned when retrieving a product by product key.","properties":{"allowFeatureChanges":{"type":"boolean","example":false},"category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product category, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add_on"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"base"},"contextFilters":{"type":"array","items":{"type":"object"}},"createdBy":{"type":"string","description":"ID of the user who created the product.","example":"53c162482f054f3ca08e1ec82dccfec9"},"createdTime":{"type":"string","format":"date-time","example":"2025-10-13T07:44:55.000-07:00"},"customFields":{"type":"object","description":"Custom field values keyed by API name.","additionalProperties":true},"customObjects":{"type":"object","nullable":true,"description":"Custom object references related to this product.","example":null},"dacTag":{"type":"object","description":"Internal DAC tag associated with the product.","properties":{"id":{"type":"string","description":"DAC tag identifier.","example":"1234567890abcdef"},"name":{"type":"string","description":"DAC tag name.","example":"Example DAC Tag"}}},"endDate":{"type":"string","format":"date","description":"Product effective end date.","example":"2050-12-31"},"features":{"type":"array","items":{"type":"object"}},"id":{"type":"string","description":"Unique identifier of the product.","example":"7228c9e6fd814e3a9e59bcdf0117e34f"},"legacyFeatures":{"type":"array","description":"Legacy, customer-defined feature objects retained for compatibility.","items":{"type":"object","additionalProperties":true}},"name":{"type":"string","description":"Product name.","example":"New prod"},"netsuite":{"type":"object","nullable":true,"description":"NetSuite integration metadata if applicable.","example":null},"organizationLabels":{"type":"array","items":{"type":"object"}},"productNumber":{"type":"string","description":"System-generated product number.","example":"PC-00000103"},"productRatePlans":{"type":"array","description":"List of rate plans under this product.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan.","example":"38660706ef2f48cfb5222f7dde491895"},"createdBy":{"type":"string","description":"ID of the user who created the rate plan.","example":"53c162482f054f3ca08e1ec82dccfec9"},"createTime":{"type":"string","format":"date-time","description":"Timestamp when the rate plan was created.","example":"2025-02-24T01:21:23.000+00:00"},"updatedBy":{"type":"string","description":"ID of the user who last updated the rate plan.","example":"53c162482f054f3ca08e1ec82dccfec9"},"updateTime":{"type":"string","format":"date-time","description":"Timestamp when the rate plan was last updated.","example":"2025-02-24T01:21:23.000+00:00"},"name":{"type":"string","description":"Product Rate Plan name.","example":"Bronze Plan"},"displayName":{"type":"string","description":"Product Rate Plan display name.","example":"Bronze Plan"},"description":{"type":"string","description":"Product Rate Plan description.","example":"Basic version of our software service"},"productId":{"type":"string","description":"Identifier of the product this plan belongs to.","example":"7228c9e6fd814e3a9e59bcdf0117e34f"},"startDate":{"type":"string","format":"date","description":"Effective start date of the plan (UTC, YYYY-MM-DD).","example":"2025-09-10"},"endDate":{"type":"string","format":"date","description":"Effective end date of the plan (UTC, YYYY-MM-DD).","example":"2027-01-01"},"state":{"type":"string","description":"Current plan state.","example":"active"},"status":{"type":"string","description":"Status of the plan.","example":"ACTIVE"},"activeCurrencies":{"type":"array","items":{"type":"string"},"description":"Currencies supported by this plan.","example":["USD"]},"productRatePlanNumber":{"type":"string","description":"Product Rate Plan number.","example":"PRP-00000172"},"productRatePlanCharges":{"type":"array","description":"List of Product Rate Plan Charges (PRPCs) belonging to the plan.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan Charge.","example":"fe9b0e764dca4178a11c0e471e5dc0d8"},"productRatePlanChargeNumber":{"type":"string","description":"System-generated number of the Product Rate Plan Charge.","example":"PRPC-00000279"},"name":{"type":"string","description":"Charge name.","example":"prepay_currency"},"description":{"type":"string","description":"Charge description.","example":"Prepaid recurring software fee"},"chargeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge type (recurring, one_time, or usage)."},"children":[]}]}]}],"example":"recurring"},"chargeModel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge model (flat_fee, per_unit, tiered, etc.)."},"children":[]}]}]}],"example":"flat_fee"},"listPriceBase":{"type":"string","description":"Indicates how list price is interpreted.","example":"Per_Billing_Period"},"specificListPriceBase":{"type":"integer","description":"Specifies the number of periods for list price when listPriceBase is period-based.","example":1},"triggerEvent":{"type":"string","description":"Event that triggers the charge.","example":"contract_effective"},"endDateCondition":{"type":"string","description":"Condition that determines when the charge ends.","example":"subscription_end"},"upToPeriodsType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of period used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control charge duration."},"children":[]}]}]}],"example":"billing_periods"},"upToPeriods":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of periods after which the charge ends, based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"billCycle":{"type":"object","description":"Billing cycle configuration.","additionalProperties":true,"example":{"period":"bill_cycle_period_quarter","periodAlignment":"align_to_term_start","timing":"in_advance","type":"term_start_day"}},"pricing":{"type":"object","description":"Pricing configuration for the charge.","additionalProperties":true,"example":{"flatAmounts":{"USD":30},"tiers":[]}},"pricingSummary":{"type":"array","items":{"type":"string"},"description":"Human-readable pricing summary lines.","example":["USD30"]},"taxMode":{"type":"string","description":"Tax mode for this charge.","example":"non_taxable"},"taxable":{"type":"boolean","description":"Indicates whether the charge is taxable.","example":false},"createdById":{"type":"string","description":"ID of the user who created the charge.","example":"53c162482f054f3ca08e1ec82dccfec9"},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was created.","example":"2025-02-24T01:21:23.000+00:00"},"updatedById":{"type":"string","description":"ID of the user who last updated the charge.","example":"53c162482f054f3ca08e1ec82dccfec9"},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was last updated.","example":"2025-02-24T01:21:23.000+00:00"}}}}}}},"sku":{"type":"string","description":"Stock keeping unit for the product.","example":"SKU-00000133"},"startDate":{"type":"string","format":"date","description":"Product effective start date.","example":"2024-01-01"},"state":{"type":"string","description":"Current product state.","example":"product_active"},"updatedBy":{"type":"string","description":"ID of the user who last updated the product.","example":"53c162482f054f3ca08e1ec82dccfec9"},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp of the last update.","example":"2025-10-13T07:44:55.000-07:00"}},"example":{"allowFeatureChanges":false,"category":"base","contextFilters":[],"createdBy":"53c162482f054f3ca08e1ec82dccfec9","createdTime":"2025-10-13T07:44:55.000-07:00","customFields":{},"customObjects":null,"dacTag":{"id":"1234567890abcdef","name":"Example DAC Tag"},"endDate":"2050-12-31","features":[],"id":"7228c9e6fd814e3a9e59bcdf0117e34f","legacyFeatures":[],"name":"New prod","netsuite":null,"organizationLabels":[],"productNumber":"PC-00000103","productRatePlans":[{"id":"38660706ef2f48cfb5222f7dde491895","createdBy":"53c162482f054f3ca08e1ec82dccfec9","createTime":"2025-02-24T01:21:23.000+00:00","updatedBy":"53c162482f054f3ca08e1ec82dccfec9","updateTime":"2025-02-24T01:21:23.000+00:00","name":"Bronze Plan","displayName":"Bronze Plan","description":"Basic version of our software service","productId":"7228c9e6fd814e3a9e59bcdf0117e34f","startDate":"2025-09-10","endDate":"2027-01-01","state":"active","status":"ACTIVE","activeCurrencies":["USD"],"productRatePlanNumber":"PRP-00000172","productRatePlanCharges":[{"id":"fe9b0e764dca4178a11c0e471e5dc0d8","productRatePlanChargeNumber":"PRPC-00000279","name":"prepay_currency","description":"Prepaid recurring software fee","chargeType":"recurring","chargeModel":"flat_fee","listPriceBase":"Per_Billing_Period","specificListPriceBase":1,"triggerEvent":"contract_effective","endDateCondition":"subscription_end","upToPeriodsType":"billing_periods","upToPeriods":1,"billCycle":{"period":"bill_cycle_period_quarter","periodAlignment":"align_to_term_start","timing":"in_advance","type":"term_start_day"},"pricing":{"flatAmounts":{"USD":30},"tiers":[]},"pricingSummary":["USD30"],"taxMode":"non_taxable","taxable":false,"createdById":"53c162482f054f3ca08e1ec82dccfec9","createdTime":"2025-02-24T01:21:23.000+00:00","updatedById":"53c162482f054f3ca08e1ec82dccfec9","updatedTime":"2025-02-24T01:21:23.000+00:00"}]}],"sku":"SKU-00000133","startDate":"2024-01-01","state":"product_active","updatedBy":"53c162482f054f3ca08e1ec82dccfec9","updatedTime":"2025-10-13T07:44:55.000-07:00"}}},"components/schemas/AddProductFeatureRequest":{"id":"components/schemas/AddProductFeatureRequest","kind":"json-schema","title":"AddProductFeatureRequest","data":{"type":"object","description":"Request body for linking a catalog feature to a product.","properties":{"featureId":{"type":"string","description":"Unique identifier of the catalog feature to link to the product.","example":"572a2efe711b449e80cbef94419bc050"},"feature_number":{"type":"string","description":"Feature number of the catalog feature to link to the product.","example":"FEAT-00000001"},"featureNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Camel-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feature_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"FEAT-00000001"},"productKey":{"type":"string","description":"Product ID or product number of the product to update. Use this field when the path parameter is a product key.","example":"PC-00000103"}}}},"components/schemas/AddProductFeatureResponse":{"id":"components/schemas/AddProductFeatureResponse","kind":"json-schema","title":"AddProductFeatureResponse","data":{"type":"object","description":"Response body returned after linking a catalog feature to a product.","properties":{"value":{"description":"The updated product, including its linked features.","allOf":[{"$ref":"#/components/schemas/GetProductByKeyResponse"}]},"features":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features linked to the product. Returned at the top level when the response is not wrapped in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Feature"}},"id":{"type":"string","description":"Unique identifier of the product.","example":"7ec58fadb6f84bc18e59c7529058d941"}}}},"components/schemas/CreateProductListLegacyRequest":{"id":"components/schemas/CreateProductListLegacyRequest","kind":"json-schema","title":"CreateProductListLegacyRequest","data":{"type":"object","description":"Request body for querying legacy products in the Product Catalog.","properties":{"filters":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter conditions for querying legacy products."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each filter defines a field, an operator, and a value to match against."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common filter fields include "},"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":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","required":["field","operator","value"],"properties":{"field":{"type":"string","description":"Field name to filter by. \n","example":"id","enum":["id","name","product_number","category"]},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison operator for the filter condition."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"EQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (equals)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (not equals)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (less than)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (greater than)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (starts with)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (ends with)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (in list of values)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (partial match)"},"children":[]}]}]}]}],"example":"EQ","enum":["EQ","NE","LT","GT","SW","IN","EW","LIKE"]},"value":{"type":"string","description":"Value to match for the specified field.\nThe data type depends on the field being filtered.\n","example":"8a90850b963680cb01963ad92a7a46e0"}}}},"expand":{"type":"object","description":"Defines whether to include related entities such as Product Rate Plans (PRPs) and \nProduct Rate Plan Charges (PRPCs) in the response. Each key corresponds to an entity type that can be expanded.\n","properties":{"product_rate_plans":{"type":"boolean","description":"When true, includes Product Rate Plans (PRPs) under each product.","example":true},"product_rate_plan_charges":{"type":"boolean","description":"When true, includes Product Rate Plan Charges (PRPCs) for each rate plan.","example":true}}},"pagination":{"type":"object","description":"Pagination controls for the query.\n","properties":{"page":{"type":"integer","minimum":1,"default":1,"description":"The page number to return. This value is one-based.\n"},"pageSize":{"type":"integer","minimum":1,"maximum":40,"default":20,"description":"The number of records to return per page. \n"}}}},"example":{"filters":[{"field":"id","operator":"EQ","value":"8a90850b963680cb01963ad92a7a46e0"}],"expand":{"product_rate_plans":true,"product_rate_plan_charges":true}}}},"components/schemas/CreateProductListLegacyResponse":{"id":"components/schemas/CreateProductListLegacyResponse","kind":"json-schema","title":"CreateProductListLegacyResponse","data":{"type":"object","description":"Response body returned after querying legacy products.","properties":{"values":{"type":"array","description":"List of legacy products matching the query.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the product.","example":"1a951a549f464e93bea1bfe7b8ffce1f"},"name":{"type":"string","description":"Product name.","example":"ABP demo product"},"description":{"type":"string","description":"Product description.","example":""},"category":{"type":"string","description":"Product category label.","example":"Add On Services"},"productNumber":{"type":"string","description":"Product number in the catalog.","example":"PC-00011567"},"sku":{"type":"string","description":"Product SKU.","example":"SKU-00011727"},"effectiveStartDate":{"type":"string","format":"date","description":"Date when the product becomes effective in the catalog.","example":"2025-05-01"},"effectiveEndDate":{"type":"string","format":"date","description":"Date when the product is no longer effective in the catalog.","example":"2025-05-31"},"state":{"type":"string","description":"Current product state.","example":"active"},"allowFeatureChanges":{"type":"boolean","description":"Whether features on this product can be changed.","example":false},"contextFilters":{"type":"array","description":"Context filters applied to the product.","items":{"type":"object","additionalProperties":true}},"features":{"type":"array","description":"Product features.","items":{"type":"object","additionalProperties":true}},"legacyFeatures":{"type":"array","description":"Legacy features associated with this product.","items":{"type":"object","additionalProperties":true}},"customFields":{"type":"object","description":"Custom fields on the product.","additionalProperties":true,"example":{"DecimalNumber__c":1.12,"test5bool__c":true}},"customObjects":{"type":"object","nullable":true,"description":"Custom objects linked to this product.","additionalProperties":true},"netsuite":{"type":"object","description":"Netsuite integration attributes.","additionalProperties":true},"organizationLabels":{"type":"array","description":"Organization labels for the product.","items":{"type":"string"}},"createdBy":{"type":"string","description":"ID of the user who created the product.","example":"34aa321aa7cd46d19bebcf9c090af7a0"},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the product was created.","example":"2025-05-01T19:32:51.000+00:00"},"updatedBy":{"type":"string","description":"ID of the user who last updated the product.","example":"34aa321aa7cd46d19bebcf9c090af7a0"},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the product was last updated.","example":"2025-05-12T08:19:44.000+00:00"},"productRatePlans":{"type":"array","description":"Product rate plans (PRPs) of the product.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan.","example":"c3a52dd029704b7e89274c9e7e8fd99c"},"name":{"type":"string","description":"Rate plan name.","example":"Demo Rate Plan"},"description":{"type":"string","description":"Rate plan description.","example":""},"displayName":{"type":"string","description":"Rate plan display name.","example":""},"state":{"type":"string","description":"Current rate plan state.","example":"active"},"effectiveStartDate":{"type":"string","format":"date","description":"Effective start date of the rate plan.","example":"2025-05-01"},"effectiveEndDate":{"type":"string","format":"date","description":"Effective end date of the rate plan.","example":"2025-05-31"},"activeCurrencies":{"type":"array","description":"Currencies with active pricing.","items":{"type":"string"},"example":["USD"]},"productId":{"type":"string","description":"Owning product ID.","example":"1a951a549f464e93bea1bfe7b8ffce1f"},"productRatePlanNumber":{"type":"string","description":"Rate plan number.","example":"PRP-00012518"},"attributes":{"type":"array","description":"Attribute definitions associated with the plan.","items":{"type":"object","additionalProperties":true}},"contextFilters":{"type":"array","description":"Context filters at the plan level.","items":{"type":"object","additionalProperties":true}},"customFields":{"type":"object","description":"Custom fields at the plan level.","additionalProperties":true},"entitlements":{"type":"array","description":"Entitlements linked to the plan.","items":{"type":"object","additionalProperties":true}},"externalIdSourceSystem":{"type":"string","description":"External ID source system.","example":""},"externalManagedPlanIds":{"type":"array","items":{"type":"string"},"description":"External plan identifiers."},"netsuite":{"type":"object","additionalProperties":true,"description":"Netsuite integration attributes."},"organizationLabels":{"type":"array","items":{"type":"string"},"description":"Organization labels."},"createTime":{"type":"string","format":"date-time","description":"Plan creation time.","example":"2025-05-01T19:33:11.000+00:00"},"createdBy":{"type":"string","description":"ID of the user who created the plan."},"updateTime":{"type":"string","format":"date-time","description":"Plan update time."},"updatedBy":{"type":"string","description":"ID of the user who updated the plan."},"productRatePlanCharges":{"type":"array","description":"Charges (PRPCs) that belong to this product rate plan.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan Charge.","example":"ebcd93dc77b34d20912dbfae5881acff"},"name":{"type":"string","description":"Charge name.","example":"Charge with state 2"},"model":{"type":"string","description":"Charge model.","example":"PerUnit"},"uom":{"type":"string","description":"Unit of measure.","example":"Each"},"billingDay":{"type":"string","description":"Billing day behavior."},"billingPeriod":{"type":"string","description":"Billing period (e.g., Month).","example":"Month"},"billingPeriodAlignment":{"type":"string","description":"Alignment for billing period.","example":"AlignToCharge"},"billingTiming":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing timing (IN_ADVANCE or IN_ARREARS)."},"children":[]}]}]}],"example":"IN_ADVANCE"},"listPriceBase":{"type":"string","description":"How list price is interpreted.","example":"Per_Billing_Period"},"defaultQuantity":{"type":"number","description":"Default quantity for the charge.","example":10},"includedUnits":{"type":"number","description":"Included units for usage or dimensional pricing.","example":0},"isDimensionalPrice":{"type":"boolean","description":"Indicates if the charge uses dimensional pricing.","example":true},"triggerEvent":{"type":"string","description":"Event that triggers the charge.","example":"ContractEffective"},"productRatePlanId":{"type":"string","description":"Owning PRP ID.","example":"c3a52dd029704b7e89274c9e7e8fd99c"},"productRatePlanChargeNumber":{"type":"string","description":"Charge number.","example":"PRPC-00017066"},"attributes":{"type":"array","description":"Dynamic pricing attributes bound to the charge.","items":{"type":"object","properties":{"name":{"type":"string","description":"Attribute name","example":"State"},"type":{"type":"string","description":"Attribute type","example":"String"},"mapping":{"type":"object","description":"Source mapping for attribute values.","properties":{"object":{"type":"string","description":"Source object","example":"account"},"field":{"type":"string","description":"Source field","example":"state__c"}}}}}},"pricing":{"type":"array","description":"Currency pricing entries.","items":{"type":"object","properties":{"currency":{"type":"string","description":"ISO currency code","example":"USD"},"price":{"type":"number","format":"double","description":"Price for the currency","example":101},"tiers":{"type":"array","items":{"type":"object"},"description":"Tier definitions (if applicable)."}}}},"pricingSummary":{"type":"array","description":"Human-readable pricing summary.","items":{"type":"string"},"example":["USD101/Each"]},"pricingWaterfalls":{"type":"object","description":"Price sources such as base and segment prices.","additionalProperties":true},"revenue":{"type":"object","description":"Revenue recognition settings.","additionalProperties":true},"netsuite":{"type":"object","description":"Netsuite integration settings.","additionalProperties":true},"customFields":{"type":"object","description":"Custom fields on the charge.","additionalProperties":true},"accounting":{"type":"object","additionalProperties":true,"description":"Accounting configuration."},"applyToBillingPeriodPartially":{"type":"boolean","description":"Indicates whether the charge is applied to partial billing periods."},"creditOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how credits are handled for this charge, for example, credit_option."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"]},"deliverySchedule":{"type":"object","additionalProperties":true,"description":"Defines the delivery frequency and applicable days for the charge."},"discountRollover":{"type":"boolean","description":"Indicates whether unused discounts roll over to the next billing period."},"endDateCondition":{"type":"string","description":"Defines when the charge ends, such as at the subscription end or after a fixed term."},"extendedPrice":{"type":"object","additionalProperties":true,"description":"Contains calculated extended pricing details for the charge, if applicable."},"isCommitted":{"type":"boolean","description":"Indicates whether this charge is part of a committed contract."},"isPrepaid":{"type":"boolean","description":"Specifies whether the charge is prepaid."},"chargeFunction":{"type":"string","description":"Function of the charge.","enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"]},"commitmentType":{"type":"string","description":"Type of funds created or consumed by the charge.","enum":["UNIT","CURRENCY"]},"prepaidOperationType":{"type":"string","description":"Indicates whether the charge is a top-up or drawdown charge.","enum":["topup","drawdown"]},"prepaidQuantity":{"type":"number","description":"Number of units included in the prepayment charge."},"prepaidTotalQuantity":{"type":"number","description":"Total units available during the validity period."},"prepaidUom":{"type":"string","description":"Unit of measure for the prepayment charge."},"validityPeriodType":{"type":"string","description":"Period during which prepayment units are valid.","enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"]},"validityPeriodAlignment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VP alignment mode."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["ChargeStart","TermStart","TermEnd"]},"validityPeriodProrationOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VP proration option."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["ProrateUnits","NoProrate"]},"specificValidityPeriodLength":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validity period length."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"rolloverPeriodType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover period type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["Day","Month","Quarter","Annual"]},"rolloverFundPriority":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for rolled-over funds; lower values are consumed first."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"rolloverEndDateType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover end date type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}],"enum":["ChargeEndDate","SubscriptionTerm"]},"fundSupportAccountHierarchy":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables sub-account drawdown from the parent accounts funds."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"drawdownPriority":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for drawdown consumption; lower values are consumed first."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled."},"children":[]}]}]}]},"drawdownRate":{"type":"number","description":"Conversion rate between the usage and drawdown units."},"drawdownUom":{"type":"string","description":"Unit of measure for the drawdown charge."},"isRollover":{"type":"boolean","description":"Indicates whether unused units or balances roll over to subsequent periods."},"isStackedDiscount":{"type":"boolean","description":"Indicates whether this charge supports multiple stacked discounts."},"labels":{"type":"object","additionalProperties":true,"description":"Stores additional key-value metadata labels associated with the charge."},"ocmJsonByCurrency":{"type":"object","additionalProperties":true,"description":"Contains pricing or configuration metadata per currency in JSON format."},"priceChangeOption":{"type":"string","description":"Defines how price changes are handled when the product or rate plan changes."},"productChargeDefinitions":{"type":"array","description":"List of charge-level definition objects that specify pricing and behavior for the charge.","items":{"type":"object","additionalProperties":true}},"productDiscountApplyDetails":{"type":"array","description":"Details of how discounts are applied to this charge.","items":{"type":"object","additionalProperties":true}},"rateCards":{"type":"array","description":"Associated rate card definitions used for dynamic or segmented pricing.","items":{"type":"object","additionalProperties":true}},"reflectDiscountInNetAmount":{"type":"boolean","description":"Indicates whether discounts are reflected directly in the net amount of the charge."},"rolloverApply":{"type":"string","description":"Defines how rolled-over balances or discounts are applied.","enum":["ApplyFirst","ApplyLast"]},"rolloverPeriodLength":{"type":"integer","format":"int32","description":"Length of each rollover period, in the unit specified by the product configuration."},"rolloverPeriods":{"type":"number","description":"Total number of rollover periods allowed for this charge."},"taxCode":{"type":"string","description":"Tax code applied to the charge for taxation purposes."},"taxMode":{"type":"string","description":"Tax mode for this charge, for example, NonTaxable or Taxable."},"taxable":{"type":"boolean","description":"Indicates whether the charge is taxable."},"type":{"type":"string","description":"The charge type, for example, Recurring, OneTime, or Usage."},"updatedById":{"type":"string","description":"ID of the user who last updated the charge."},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was last updated."},"createdById":{"type":"string","description":"ID of the user who created the charge."},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was created."}}}}}}}}}}}}},"components/schemas/UpdateTierRequest":{"id":"components/schemas/UpdateTierRequest","kind":"json-schema","title":"UpdateTierRequest","data":{"type":"object","description":"Request body to update a Product Rate Plan Charge Tier.","properties":{"id":{"type":"string","description":[{"$$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":"Product Rate Plan Charge Tier ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeTierId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the unique identifier of the tier row under a Product Rate Plan Charge."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This identifier is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not surfaced by the new Commerce APIs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is typically retrieved via "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Data Query (DQ)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or by using the legacy v1 Object API equivalence:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/object/product-rate-plan-charge-tier/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/Object_PUTProductRatePlanChargeTier/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRUD: Update a product rate plan charge tier"},"children":[]}]}]}]}],"example":"8fe232784e7946f9aa79cfc8aad30bd9"},"price":{"type":"number","format":"double","description":"Tier price to apply for the specified currency/quantity range.","example":450}},"required":["id","price"]}},"components/schemas/UpdateTierResponse":{"id":"components/schemas/UpdateTierResponse","kind":"json-schema","title":"UpdateTierResponse","data":{"type":"object","description":"Product Rate Plan Charge Tier record returned after a successful update.","properties":{"id":{"type":"string","description":"Product Rate Plan Charge Tier ID.","example":"8fe232784e7946f9aa79cfc8aad30bd9"},"currency":{"type":"string","description":"ISO currency code for this tier.","example":"USD"},"price":{"type":"number","format":"double","description":"Price configured for this tier.","example":450},"startingUnit":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The inclusive starting unit for this tier’s range."},"children":[]}]}]}],"example":0},"endingUnit":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The inclusive ending unit for this tier’s range. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can represent open-ended depending on tenant configuration."},"children":[]}]}]}],"example":0},"tier":{"type":"string","description":"Display order or label of the tier within the charge.","example":"1"},"isOveragePrice":{"type":"boolean","description":"Indicates whether this tier represents an overage price row.","example":false},"priceFormat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price format applied to this tier (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price_format_flat_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"price_format_flat_fee"},"createdById":{"type":"string","description":"ID of the user who created the tier.","example":"190758cda21c41138233263a951580b3"},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the tier was created.","example":"2025-10-15T19:07:25.000+00:00"},"updatedById":{"type":"string","description":"ID of the user who last updated the tier.","example":"190758cda21c41138233263a951580b3"},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the tier was last updated.","example":"2025-10-15T20:47:58.000+00:00"}},"required":["id","currency","price","startingUnit","endingUnit"]}},"components/schemas/PurchaseOptionRequest":{"id":"components/schemas/PurchaseOptionRequest","kind":"json-schema","title":"PurchaseOptionRequest","data":{"type":"object","properties":{"filters":{"type":"array","description":"Defines the filtering criteria for querying purchase options or product rate plans.\nEach filter includes a target field, an operator, and a value.\n","items":{"type":"object","required":["field","operator","value"],"properties":{"field":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the field to filter by."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported fields include:"},"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":"prp_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Product Rate Plan ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Product ID."},"children":[]}]}]}]}],"example":"prp_id"},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison operator. Supported 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":"EQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (equals)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (not equals)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (less than)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (greater than)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (starts with)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (ends with)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  (in list)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (partial match)"},"children":[]}]}]}]}],"enum":["EQ","NE","LT","GT","SW","IN","EW","LIKE"],"example":"EQ"},"value":{"type":"object","description":"Specifies the value to compare against.\nOnly one of the following value types should be provided.\n","properties":{"string_value":{"type":"string","description":"String value for string-based comparisons.","example":"8a90f5088799c8ed01879cb4b47a3b1a"},"number_value":{"type":"number","format":"double","description":"Numeric value for numeric comparisons."},"boolean_value":{"type":"boolean","description":"Boolean value for logical comparisons."}}}}}},"expand":{"type":"object","description":"Optional flags to include related entities in the query results.\n","properties":{"product_rate_plan_charges":{"type":"boolean","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", expands the response to include Product Rate Plan Charges (PRPCs)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated with the queried Product Rate Plans. Expanded PRPCs include full"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge configuration, including pricing, billing settings, and end date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration fields such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true}}},"product_rate_plan_charge_key":{"type":"string","description":"Optional identifier for a specific Product Rate Plan Charge (PRPC) to query.\nCan be either a PRPC ID or a PRPC number/key.\n","example":"ad95b694d2b8442b84dc8ad26561c7d7"},"attributes":{"type":"array","description":"Optional attributes used for evaluating Dynamic Pricing.\nRequired when the queried PRPC is configured to depend on contextual attributes.\n","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the pricing attribute (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Region"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Age"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"Region"},"string_value":{"type":"string","description":"String-based attribute value."},"number_value":{"type":"number","format":"double","description":"Numeric attribute value."},"boolean_value":{"type":"boolean","description":"Boolean attribute value."},"date_value":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date value in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"datetime_value":{"type":"string","format":"date-time","description":"Datetime value in ISO 8601 format."}}}}}}},"components/schemas/PurchaseOptionResponse":{"id":"components/schemas/PurchaseOptionResponse","kind":"json-schema","title":"PurchaseOptionResponse","data":{"type":"object","description":"Response object containing Product Rate Plan (PRP) and Product Rate Plan Charge (PRPC) details \nthat match the request filters. Each returned PRP includes all associated charge configurations,\npricing details, and relevant metadata.\n","properties":{"error":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error information, if the request fails. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on success."},"children":[]}]}]}]},"productRatePlans":{"type":"array","description":"List of Product Rate Plans (PRPs) that match the filter criteria.\nEach PRP includes associated product, pricing, and charge configuration details.\n","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan (PRP).","example":"8a90f5088799c8ed01879cb4b47a3b1a"},"name":{"type":"string","description":"Display name of the Product Rate Plan.","example":"New Rate Plan"},"description":{"type":"string","description":"Description of the Product Rate Plan."},"startDate":{"type":"string","format":"date","description":"Effective start date of the Product Rate Plan."},"endDate":{"type":"string","format":"date","description":"Effective end date of the Product Rate Plan."},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current state of the Product Rate Plan (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"active"},"productRatePlanNumber":{"type":"string","description":"Unique reference number of the Product Rate Plan.","example":"PRP-00000001"},"productId":{"type":"string","description":"ID of the Product associated with this rate plan.","example":"8a90f5088799c8ed01879cb481d83b18"},"product":{"type":"object","description":"Metadata and configuration details for the associated Product.","properties":{"id":{"type":"string","description":"Unique Product ID."},"name":{"type":"string","description":"Product name."},"productNumber":{"type":"string","description":"Unique product reference number."},"category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product category, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"sku":{"type":"string","description":"Stock-keeping unit (SKU) identifier for the Product."},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current state of the Product (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"customFields":{"type":"object","additionalProperties":true,"description":"Custom field values defined for the Product."}}},"productRatePlanCharges":{"type":"array","description":"List of Product Rate Plan Charges (PRPCs) defined under this rate plan.\nEach charge defines pricing, billing, taxation, and accounting details.\n","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Product Rate Plan Charge (PRPC).","example":"8a90876c8799b81801879cb516f8400b"},"name":{"type":"string","description":"Display name of the charge.","example":"New Component"},"chargeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of charge (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"one_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"chargeModel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing model applied to the charge (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flat_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tiered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"pricing":{"type":"object","description":"Pricing configuration for the charge by currency.\nIncludes flat, unit, or tier-based amounts depending on the model.\n","properties":{"flatAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Flat amount per billing period by currency.","example":{"USD":100}},"minAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Minimum charge thresholds by currency."},"maxAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Maximum charge thresholds by currency."},"unitAmounts":{"type":"object","additionalProperties":{"type":"number"},"description":"Per-unit charge amounts by currency."},"tiers":{"type":"array","items":{"type":"object"},"description":"Tier-level pricing definitions for tiered or volume models."}}},"billCycle":{"type":"object","description":"Billing configuration for this charge.","properties":{"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"periodAlignment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the billing period aligns (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"align_to_charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"timing":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the charge bills "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_advance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_arrears"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"taxMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether tax is included ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_inclusive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or excluded ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_exclusive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"taxable":{"type":"boolean","description":"Indicates if the charge is taxable."},"revenue":{"type":"object","description":"Revenue recognition configuration for this charge.","properties":{"revenueRecognitionRuleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the revenue recognition rule (for example, “Recognize upon invoicing”)."},"children":[]}]}]}]}}},"accounting":{"$ref":"#/components/schemas/AccountingResponse"},"customFields":{"type":"object","additionalProperties":true,"description":"Tenant-specific custom fields for the PRPC."},"pricingSummary":{"type":"array","description":"Human-readable price summary for quick display.","items":{"type":"string","example":"USD100"}},"triggerEvent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event that triggers the charge (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contract_effective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"endDateCondition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition that determines when the charge ends, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_end"},"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":"fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific_end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"upToPeriodsType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is duration-based (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_periods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"upToPeriods":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration value used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"listPriceBase":{"type":"string","description":"Indicates how list price is interpreted.","example":"Per_Billing_Period"},"specificListPriceBase":{"type":"number","description":"Optional override for list price base when billing uses a specific period configuration.\n","example":0},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was last updated."},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the charge was created."}}}}}}}},"example":{"error":null,"productRatePlans":[{"id":"8a90f5088799c8ed01879cb4b47a3b1a","name":"New Rate Plan","state":"active","productId":"8a90f5088799c8ed01879cb481d83b18","productRatePlanCharges":[{"id":"8a90876c8799b81801879cb516f8400b","name":"New Component","chargeType":"recurring","chargeModel":"flat_fee","pricing":{"flatAmounts":{"USD":100}},"pricingSummary":["USD100"],"taxMode":"tax_exclusive","taxable":true,"triggerEvent":"contract_effective","endDateCondition":"subscription_end","upToPeriodsType":"billing_periods","upToPeriods":0,"createdTime":"2023-04-19T20:28:46.000+00:00","updatedTime":"2023-04-19T20:28:46.000+00:00"}]}]}}},"components/schemas/EntitlementAuditEvent":{"id":"components/schemas/EntitlementAuditEvent","kind":"json-schema","title":"EntitlementAuditEvent","data":{"type":"object","title":"EntitlementAuditEvent","description":"An audit event that records a change to a runtime entitlement grant.","properties":{"eventId":{"type":"string","description":"Unique identifier of the audit event.","example":"8ad088009840d1c2019855e15c993f2f"},"event_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"8ad088009840d1c2019855e15c993f2f"},"eventType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of entitlement change recorded by this event, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a quantity change."},"children":[]}]}]}],"example":"paused"},"event_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"paused"},"grantId":{"type":"string","description":"Unique identifier of the runtime entitlement grant.","example":"EG-00000001"},"grant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"EG-00000001"},"accountId":{"type":"string","description":"Account ID associated with the grant.","example":"2c92c0f86a7e7a40016a7ec3c1f01c1a"},"account_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2c92c0f86a7e7a40016a7ec3c1f01c1a"},"featureCode":{"type":"string","description":"Feature code of the catalog feature on the grant.","example":"api_calls"},"subscriptionId":{"type":"string","nullable":true,"description":"Subscription ID associated with the grant.","example":"8a8081ae547aac1e01547efb61f20140"},"occurredAt":{"type":"string","format":"date-time","description":"Date and time the event occurred.","example":"2026-03-15T10:30:00Z"},"actorKind":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kind of actor that caused the event, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"user"},"actorId":{"type":"string","description":"Identifier of the actor that caused the event.","example":"53c162482f054f3ca08e1ec82dccfec9"},"beforeState":{"type":"object","nullable":true,"additionalProperties":true,"description":"Grant state before the change."},"afterState":{"type":"object","nullable":true,"additionalProperties":true,"description":"Grant state after the change."},"metadata":{"type":"object","nullable":true,"additionalProperties":true,"description":"Additional event details, such as reason or order numbers."},"updatedOn":{"type":"string","format":"date-time","description":"Date and time the audit record was last updated.","example":"2026-03-15T10:30:00Z"},"updatedBy":{"type":"string","description":"User ID that last updated the audit record.","example":"53c162482f054f3ca08e1ec82dccfec9"},"updatedByUsername":{"type":"string","description":"Username of the user that last updated the audit record.","example":"admin@example.com"}}}},"components/schemas/ListEntitlementAuditEventsResponse":{"id":"components/schemas/ListEntitlementAuditEventsResponse","kind":"json-schema","title":"ListEntitlementAuditEventsResponse","data":{"type":"object","description":"Response body that contains a list of entitlement audit events.","properties":{"events":{"type":"array","description":"Entitlement audit events that match the request filters.","items":{"$ref":"#/components/schemas/EntitlementAuditEvent"}},"items":{"type":"array","description":"Alternate array field returned by some audit list responses.","items":{"$ref":"#/components/schemas/EntitlementAuditEvent"}},"nextPageToken":{"type":"string","nullable":true,"description":"Token used to retrieve the next page of results. Omitted when there are no more pages.","example":"8ad088009840d1c2019855e15c993f2f"}}}},"components/schemas/ApplyEntitlementConsumptionRequest":{"id":"components/schemas/ApplyEntitlementConsumptionRequest","kind":"json-schema","title":"ApplyEntitlementConsumptionRequest","data":{"type":"object","description":"Request body for authorizing consumption against a numbered metered feature.","required":["accountKey","featureKey","requestedQuantity"],"properties":{"accountKey":{"type":"string","description":"Account number or account ID that consumes the entitlement.","example":"A00000001"},"subscriptionKey":{"type":"string","description":"Subscription number or subscription ID used to scope the authorization.","example":"A-S00000001"},"featureKey":{"type":"string","description":"Unique key of the numbered metered feature to consume.","example":"api_calls"},"requestedQuantity":{"type":"number","description":"Quantity to authorize and consume.","example":25},"effectiveDate":{"format":"date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of the consumption event, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. If omitted, the current date is used."},"children":[]}]}]}],"example":"2026-03-15"}}}},"components/schemas/EntitlementGrant":{"id":"components/schemas/EntitlementGrant","kind":"json-schema","title":"EntitlementGrant","data":{"type":"object","title":"EntitlementGrant","description":"A runtime entitlement grant. This object represents a granted entitlement for an account\nand is distinct from a catalog entitlement definition on a plan.\n","properties":{"id":{"type":"string","description":"Unique identifier of the runtime entitlement grant.","example":"8ad088009840d1c2019855e15c993f2f"},"entitlementKey":{"type":"string","description":"Unique key of the runtime entitlement grant.","example":"EG-00000001"},"entitlement_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlementKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"EG-00000001"},"entitlementNumber":{"type":"string","description":"System-generated number that uniquely identifies the grant.","example":"EG-00000001"},"accountKey":{"type":"string","description":"Account number or account ID that owns the grant.","example":"A00000001"},"subscriptionKey":{"type":"string","nullable":true,"description":"Subscription number or subscription ID associated with the grant.","example":"A-S00000001"},"planKey":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product rate plan ID or product rate plan number associated with the grant, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRP-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PRP-00000001"},"plan_key":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PRP-00000001"},"featureKey":{"type":"string","description":"Unique key of the granted catalog feature.","example":"api_calls"},"featureCode":{"type":"string","description":"Feature code of the granted catalog feature.","example":"api_calls"},"quantity":{"type":"number","nullable":true,"description":"Granted quantity for a numbered feature.","example":10000},"startDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the grant became effective, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2026-01-01"},"endDate":{"type":"string","format":"date","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the grant ends, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2026-12-31"},"revokedDate":{"type":"string","format":"date","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the grant was revoked, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2026-06-01"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current state of the grant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The grant requires activation or has a future start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The grant is in effect."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The grant is temporarily paused."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The grant is deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The grant end date has passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The grant is revoked."},"children":[]}]}]}]}],"enum":["pending","active","paused","inactive","expired","revoked"],"example":"active"},"unit":{"type":"string","nullable":true,"description":"Unit of measure for a numbered feature grant.","example":"API Calls"},"isDisabled":{"type":"boolean","description":"Indicates whether the grant is disabled.","example":false}}}},"components/schemas/ValidateEntitlementAccessResponse":{"id":"components/schemas/ValidateEntitlementAccessResponse","kind":"json-schema","title":"ValidateEntitlementAccessResponse","data":{"type":"object","description":"Access decision returned when checking or authorizing entitlement consumption.","properties":{"isValid":{"type":"boolean","description":"Indicates whether the requested access is allowed.","example":true},"entitlements":{"type":"array","description":"Runtime entitlement grants that were evaluated for this decision.","items":{"$ref":"#/components/schemas/EntitlementGrant"}},"cacheTtlSeconds":{"type":"integer","description":"Number of seconds the decision can be cached.","example":60},"policy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entitlement policy applied to this decision, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hard_block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"warning"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"hard_block"},"totalBalance":{"type":"number","description":"Total granted quantity for the numbered feature.","example":10000},"remainingBalance":{"type":"number","description":"Remaining quantity available after this decision.","example":8500},"enforcementResult":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome of policy enforcement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"allow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access is allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deny"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access is denied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"warn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access is allowed with a warning."},"children":[]}]}]}]}],"enum":["allow","deny","warn"],"example":"allow"},"accessDeniedReason":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason access was denied. Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isValid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Common values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_revoked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_active_grant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit_exceeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"effectiveLimit":{"type":"number","nullable":true,"description":"Effective quantity limit applied to this decision.","example":10000},"currentUsage":{"type":"number","description":"Quantity already consumed for the numbered feature.","example":1500},"remaining":{"type":"number","description":"Remaining quantity available for the numbered feature.","example":8500},"percentageUsed":{"type":"number","description":"Percentage of the effective limit that has been consumed.","example":15},"resetAt":{"type":"string","format":"date-time","nullable":true,"description":"Date and time the metered balance resets.","example":"2026-04-01T00:00:00Z"},"overageQuantity":{"type":"number","description":"Quantity that exceeds the effective limit.","example":0},"chargeSource":{"type":"string","nullable":true,"description":"Charge source associated with the evaluated entitlement, when applicable.","example":"usage_charge"}}}},"components/schemas/ApplyEntitlementConsumptionResponse":{"id":"components/schemas/ApplyEntitlementConsumptionResponse","kind":"json-schema","title":"ApplyEntitlementConsumptionResponse","data":{"description":"Response body returned after authorizing entitlement consumption.","allOf":[{"$ref":"#/components/schemas/ValidateEntitlementAccessResponse"}]}},"components/schemas/ValidateEntitlementsByTagRequest":{"id":"components/schemas/ValidateEntitlementsByTagRequest","kind":"json-schema","title":"ValidateEntitlementsByTagRequest","data":{"type":"object","description":"Request body for checking access to multiple features by tag or by feature keys.","required":["accountKey"],"properties":{"accountKey":{"type":"string","description":"Account number or account ID to evaluate.","example":"A00000001"},"subscriptionKey":{"type":"string","description":"Subscription number or subscription ID used to scope the check, when applicable.","example":"A-S00000001"},"featureTag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature tag used to select the features to check. Do not send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureTag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureKey"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the same request."},"children":[]}]}]}],"example":"premium"},"featureKeys":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalog feature keys to check. Use this field instead of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureTag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to challenge specific features."},"children":[]}]}]}],"items":{"type":"string"},"example":["8ad088009840d1c2019855e15c993f2f","00c86e3a0595442c88ed9ef8474b10a7"]},"featureKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single feature key. Do not send this field together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureTag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"8ad088009840d1c2019855e15c993f2f"},"requestedQuantity":{"type":"number","description":"Quantity to evaluate for numbered features, when applicable.","example":1},"effectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date to evaluate access, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. If omitted, the current date is used."},"children":[]}]}]}],"example":"2026-03-15"}}}},"components/schemas/BulkChallengeEntitlementResult":{"id":"components/schemas/BulkChallengeEntitlementResult","kind":"json-schema","title":"BulkChallengeEntitlementResult","data":{"type":"object","title":"BulkChallengeEntitlementResult","description":"Access result for one feature in a bulk entitlement challenge.","properties":{"featureKey":{"type":"string","description":"Unique key of the catalog feature that was evaluated.","example":"8ad088009840d1c2019855e15c993f2f"},"feature_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"8ad088009840d1c2019855e15c993f2f"},"result":{"type":"object","description":"Access decision for this feature.","properties":{"isValid":{"type":"boolean","description":"Indicates whether access is allowed for this feature.","example":true}}},"value":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by some responses."},"children":[]}]}]}],"properties":{"isValid":{"type":"boolean","description":"Indicates whether access is allowed for this feature.","example":true}}}}}},"components/schemas/ValidateEntitlementsByTagResponse":{"id":"components/schemas/ValidateEntitlementsByTagResponse","kind":"json-schema","title":"ValidateEntitlementsByTagResponse","data":{"type":"object","description":"Response body returned after checking access to features that match a feature tag or a list of feature keys.","properties":{"results":{"type":"array","description":"Access result for each evaluated feature.","items":{"$ref":"#/components/schemas/BulkChallengeEntitlementResult"}},"entitlements":{"type":"array","description":"Alternate array field returned by some bulk-challenge responses.","items":{"$ref":"#/components/schemas/BulkChallengeEntitlementResult"}},"bulkValue":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional wrapper that contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/BulkChallengeEntitlementResult"}}}},"bulk_value":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snake-case form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulkValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/BulkChallengeEntitlementResult"}}}}}}},"components/schemas/ValidateEntitlementFeaturesRequest":{"id":"components/schemas/ValidateEntitlementFeaturesRequest","kind":"json-schema","title":"ValidateEntitlementFeaturesRequest","data":{"type":"object","description":"Request body for checking access to multiple features for an account.","required":["accountKey","featureKeys"],"properties":{"accountKey":{"type":"string","description":"Account number or account ID to evaluate.","example":"A00000001"},"featureKeys":{"type":"array","description":"Catalog feature keys to check.","minItems":1,"items":{"type":"string"},"example":["api_calls","sso_access"]},"subscriptionKey":{"type":"string","description":"Subscription number or subscription ID used to scope the check, when applicable.","example":"A-S00000001"},"requestedQuantity":{"type":"number","description":"Quantity to evaluate for numbered metered features, when applicable.","example":1}}}},"components/schemas/EntitlementAccessResult":{"id":"components/schemas/EntitlementAccessResult","kind":"json-schema","title":"EntitlementAccessResult","data":{"type":"object","title":"EntitlementAccessResult","description":"Access result for one feature in a bulk entitlement check.","properties":{"featureKey":{"type":"string","description":"Unique key of the catalog feature that was evaluated.","example":"api_calls"},"result":{"type":"boolean","description":"Indicates whether access is allowed for this feature.","example":true},"isValid":{"type":"boolean","description":"Indicates whether access is allowed for this feature.","example":true},"cacheTtlSeconds":{"type":"integer","description":"Number of seconds this feature decision can be cached.","example":60}}}},"components/schemas/ValidateEntitlementFeaturesResponse":{"id":"components/schemas/ValidateEntitlementFeaturesResponse","kind":"json-schema","title":"ValidateEntitlementFeaturesResponse","data":{"type":"object","description":"Response body returned after checking access to multiple features.","properties":{"results":{"description":"Access results. Some responses return a map keyed by feature ID. Other responses return an array.","oneOf":[{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EntitlementAccessResult"}},{"type":"array","items":{"$ref":"#/components/schemas/EntitlementAccessResult"}}]},"entitlements":{"type":"array","description":"Alternate array field returned by some bulk-check responses.","items":{"$ref":"#/components/schemas/EntitlementAccessResult"}},"cacheTtlSeconds":{"type":"integer","description":"Number of seconds the overall decision can be cached.","example":60}}}},"components/schemas/FeatureEntitlementPolicy":{"id":"components/schemas/FeatureEntitlementPolicy","kind":"json-schema","title":"FeatureEntitlementPolicy","data":{"type":"object","title":"FeatureEntitlementPolicy","description":"Feature and quantity to grant on a runtime entitlement.","required":["featureKey"],"properties":{"featureKey":{"type":"string","description":"Unique key of the catalog feature to grant.","example":"api_calls"},"quantity":{"type":"number","description":"Quantity to grant for a numbered feature. Omit this field for boolean and enum features.","example":10000}}}},"components/schemas/OveragePolicy":{"id":"components/schemas/OveragePolicy","kind":"json-schema","title":"OveragePolicy","data":{"type":"object","title":"OveragePolicy","description":"Policy that determines grant behavior when the entitlement balance is exhausted.","properties":{"onBalanceExhaust":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action taken when the remaining entitlement balance is exhausted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"hard_block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Prevents further consumption after the balance reaches zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Allows continued consumption after the balance reaches zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"warning"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Allows consumption and raises a warning when the balance reaches zero."},"children":[]}]}]}]}],"enum":["hard_block","allow","warning"],"example":"hard_block"}}}},"components/schemas/CreateEntitlementGrantItem":{"id":"components/schemas/CreateEntitlementGrantItem","kind":"json-schema","title":"CreateEntitlementGrantItem","data":{"type":"object","title":"CreateEntitlementGrantItem","description":"A manual runtime entitlement grant to create for an account.","required":["accountKey","startDate","featureEntitlementPolicy"],"properties":{"accountKey":{"type":"string","description":"Account number or account ID that receives the grant.","example":"A00000001"},"subscriptionKey":{"type":"string","description":"Subscription number or subscription ID associated with the grant.","example":"A-S00000001"},"planKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product rate plan ID or product rate plan number associated with the grant, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRP-00000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PRP-00000001"},"startDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the grant becomes effective, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2026-01-01"},"endDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the grant ends, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Omit this field for an open-ended grant."},"children":[]}]}]}],"example":"2026-12-31"},"featureEntitlementPolicy":{"type":"array","description":"Features and quantities included in this grant.","minItems":1,"items":{"$ref":"#/components/schemas/FeatureEntitlementPolicy"}},"overagePolicy":{"$ref":"#/components/schemas/OveragePolicy"},"number":{"type":"string","description":"Optional grant number. If omitted, Zuora generates a number.","example":"EG-00000001"},"orderNumber":{"type":"string","description":"Order number associated with this grant, when the grant is created from an order.","example":"O-00000001"},"orderActionNumber":{"type":"string","description":"Order action number associated with this grant, when applicable.","example":"OA-00000001"},"activationRequired":{"type":"boolean","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the grant is created in a pending state until it is activated."},"children":[]}]}]}],"example":false},"unit":{"type":"string","description":"Unit of measure for a numbered feature grant.","example":"API Calls"},"isDisabled":{"type":"boolean","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the grant is created in a disabled state."},"children":[]}]}]}],"example":false}}}},"components/schemas/BulkGrantEntitlementsRequest":{"id":"components/schemas/BulkGrantEntitlementsRequest","kind":"json-schema","title":"BulkGrantEntitlementsRequest","data":{"type":"object","title":"BulkGrantEntitlementsRequest","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for creating runtime entitlement grants in bulk. Each item uses the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shape as a single grant in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /commerce/entitlements/grant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The request is rejected"},"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":"grantEntitlementRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty or contains more than 500 items."},"children":[]}]}]}],"required":["grantEntitlementRequest"],"properties":{"grantEntitlementRequest":{"type":"array","description":"One or more manual entitlement grants to create.","minItems":1,"maxItems":500,"items":{"$ref":"#/components/schemas/CreateEntitlementGrantItem"}},"skipExisting":{"type":"boolean","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if a grant for the same account/feature (or account/subscription/feature"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for subscription-scoped grants) already exists, mark that item as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulk_item_skipped"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of returning an error. This makes batch re-submission idempotent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":true,"example":true},"continueOnError":{"type":"boolean","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", continue processing remaining items after one fails. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", items"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after the first failure are omitted from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"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 default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":true,"example":true}}}},"components/schemas/EntitlementApiError":{"id":"components/schemas/EntitlementApiError","kind":"json-schema","title":"EntitlementApiError","data":{"type":"object","title":"EntitlementApiError","description":"Error envelope returned by entitlement runtime endpoints on failure, and nested under\nfailed items in bulk grant results.\n","properties":{"type":{"type":"string","description":"Error type that maps to the HTTP status.","enum":["bad_request","unauthorized","forbidden","method_not_allowed","conflict","not_found","locked","too_many_requests","internal_server_error","idempotency_key_in_use","request_failed","request_timeout","gateway_timeout","payment_gateway_timeout","payment_gateway_unavailable","payment_gateway_error","not_implemented","duplicate_value","missing_parameter","invalid_field"],"example":"not_found"},"errors":{"type":"array","description":"One or more error details for this failure.","items":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"invalid_parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_parameter_integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_parameter_number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_parameter_boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_parameter_string"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters_exclusive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"already_exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_token_expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_not_found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete_not_allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unexpected_error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"db_error"},"children":[]}]}]}]}],"example":"resource_not_found"},"message":{"type":"string","description":"Human-readable error message.","example":"Entitlement with key 'ent_bad_key' was not found"},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locale of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"localizedMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"en-US"},"localizedMessage":{"type":"string","description":"Localized human-readable error message.","example":"Entitlement with key 'ent_bad_key' was not found"},"parameter":{"type":"string","description":"Request parameter related to the error, when applicable.","example":"entitlementKey"}}}}}}},"components/schemas/BulkGrantEntitlementResult":{"id":"components/schemas/BulkGrantEntitlementResult","kind":"json-schema","title":"BulkGrantEntitlementResult","data":{"type":"object","title":"BulkGrantEntitlementResult","description":"Per-item result for a bulk grant request.","properties":{"index":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero-based position of the corresponding item in the request's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantEntitlementRequest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array. Use this field to correlate results when multiple items share the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account, subscription, or plan keys."},"children":[]}]}]}],"example":0},"accountKey":{"type":"string","description":"Account number or account ID from the corresponding request item.","example":"A00000001"},"subscriptionKey":{"type":"string","nullable":true,"description":"Subscription number or subscription ID from the corresponding request item.","example":"A-S00000001"},"planKey":{"type":"string","nullable":true,"description":"Plan ID or plan number from the corresponding request item.","example":"38660706ef2f48cfb5222f7dde491895"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome for this request item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"bulk_item_succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - One or more grants were created for this item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulk_item_skipped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Matching grants already existed and were left unchanged"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"because "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipExisting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"code","inline":true,"attributes":{"content":"bulk_item_failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The item failed. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}],"enum":["bulk_item_succeeded","bulk_item_skipped","bulk_item_failed"],"example":"bulk_item_succeeded"},"entitlement":{"type":"array","description":"Entitlements created for this item. A single plan key can expand to more than one\nentitlement, one per entitled feature.\n","items":{"$ref":"#/components/schemas/EntitlementGrant"}},"skippedEntitlement":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing grants that were left untouched for this item when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipExisting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/EntitlementGrant"}},"error":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populated only 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":"bulk_item_failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/EntitlementApiError"}]}}}},"components/schemas/BulkGrantEntitlementsResponse":{"id":"components/schemas/BulkGrantEntitlementsResponse","kind":"json-schema","title":"BulkGrantEntitlementsResponse","data":{"type":"object","title":"BulkGrantEntitlementsResponse","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body returned after a bulk grant request. Processing is synchronous and not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactional across items. Each item's rows are written independently, so a partially"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied item is safe to resubmit when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipExisting"},"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":[]}]}]}],"properties":{"requested":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of items submitted in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantEntitlementRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"succeeded":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of items with "},"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":"bulk_item_succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"skipped":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of items with "},"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":"bulk_item_skipped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0},"failed":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of items with "},"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":"bulk_item_failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0},"entitlementsGranted":{"type":"integer","description":"Total number of entitlement grants created across all succeeded items.","example":1},"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-item outcomes, correlated to the request by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BulkGrantEntitlementResult"}}}}},"components/schemas/BulkRevokeEntitlementItem":{"id":"components/schemas/BulkRevokeEntitlementItem","kind":"json-schema","title":"BulkRevokeEntitlementItem","data":{"type":"object","title":"BulkRevokeEntitlementItem","description":"A runtime entitlement grant to revoke.","required":["entitlementKey"],"properties":{"entitlementKey":{"type":"string","description":"Unique key of the runtime entitlement grant to revoke.","example":"EG-00000001"},"revokedDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the grant is revoked, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2026-06-01"},"orderNumber":{"type":"string","description":"Order number associated with this revocation, when applicable.","example":"O-00000002"},"orderActionNumber":{"type":"string","description":"Order action number associated with this revocation, when applicable.","example":"OA-00000002"}}}},"components/schemas/BulkRevokeEntitlementsRequest":{"id":"components/schemas/BulkRevokeEntitlementsRequest","kind":"json-schema","title":"BulkRevokeEntitlementsRequest","data":{"type":"object","description":"Request body for revoking multiple runtime entitlement grants.","required":["revokeEntitlementRequest"],"properties":{"revokeEntitlementRequest":{"type":"array","description":"One or more runtime entitlement grants to revoke.","minItems":1,"items":{"$ref":"#/components/schemas/BulkRevokeEntitlementItem"}}}}},"components/schemas/BulkRevokeEntitlementResult":{"id":"components/schemas/BulkRevokeEntitlementResult","kind":"json-schema","title":"BulkRevokeEntitlementResult","data":{"type":"object","title":"BulkRevokeEntitlementResult","description":"Result of revoking one runtime entitlement grant.","properties":{"value":{"type":"object","description":"Revoke result for this grant.","properties":{"isRevoked":{"type":"boolean","description":"Indicates whether the grant was revoked.","example":true},"entitlement":{"description":"The runtime entitlement grant after the revoke action.","allOf":[{"$ref":"#/components/schemas/EntitlementGrant"}]}}},"error":{"type":"object","description":"Error details when the grant could not be revoked.","properties":{"errors":{"type":"array","description":"List of errors that occurred while attempting to revoke the entitlement.","items":{"type":"object","properties":{"code":{"type":"string","description":"The error code that identifies why the revoke operation failed.","example":"BILLABLE_REVOKE_REQUIRES_ORDER_ACTION"},"message":{"type":"string","description":"The description of the error.","example":"BILLABLE_REVOKE_REQUIRES_ORDER_ACTION"},"localizedMessage":{"type":"string","description":"Localized description of the error for the request locale.","example":"BILLABLE_REVOKE_REQUIRES_ORDER_ACTION"}}}}}},"isRevoked":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the grant was revoked. Returned at the top level when the result is not wrapped in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"entitlement":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The runtime entitlement grant after the revoke action. Returned at the top level when the result is not wrapped in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/EntitlementGrant"}]}}}},"components/schemas/BulkRevokeEntitlementsResponse":{"id":"components/schemas/BulkRevokeEntitlementsResponse","kind":"json-schema","title":"BulkRevokeEntitlementsResponse","data":{"type":"object","description":"Response body returned after revoking multiple runtime entitlement grants.","properties":{"revokeEntitlementsResponse":{"type":"array","description":"Revoke result for each requested grant.","items":{"$ref":"#/components/schemas/BulkRevokeEntitlementResult"}}}}},"components/schemas/ValidateEntitlementAccessRequest":{"id":"components/schemas/ValidateEntitlementAccessRequest","kind":"json-schema","title":"ValidateEntitlementAccessRequest","data":{"type":"object","description":"Request body for checking whether an account has access to a feature.","required":["accountKey","featureKey"],"properties":{"accountKey":{"type":"string","description":"Account number or account ID to evaluate.","example":"A00000001"},"featureKey":{"type":"string","description":"Unique key of the catalog feature to check.","example":"api_calls"},"quantity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity to evaluate for a numbered metered feature. Prefer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"requestedQuantity":{"type":"number","description":"Requested consumption quantity for a numbered metered feature.","example":100},"effectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date to evaluate access, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. If omitted, the current date is used."},"children":[]}]}]}],"example":"2026-03-15"},"subscriptionKey":{"type":"string","description":"Subscription number or subscription ID used to scope the access check.","example":"A-S00000001"},"enumValues":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum values to evaluate when the feature type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enumType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"example":["basic","pro"]},"accountKeys":{"type":"array","description":"Additional account numbers or account IDs to include in the access check.","items":{"type":"string"}},"actionType":{"type":"string","description":"Type of access decision to evaluate, for example a read check versus a consume check.","example":"check"}}}},"components/schemas/CreateEntitlementGrantsRequest":{"id":"components/schemas/CreateEntitlementGrantsRequest","kind":"json-schema","title":"CreateEntitlementGrantsRequest","data":{"type":"object","description":"Request body for creating one or more runtime entitlement grants.","required":["grantEntitlementRequest"],"properties":{"grantEntitlementRequest":{"type":"array","description":"One or more manual entitlement grants to create.","minItems":1,"items":{"$ref":"#/components/schemas/CreateEntitlementGrantItem"}}}}},"components/schemas/CreateEntitlementGrantsResponse":{"id":"components/schemas/CreateEntitlementGrantsResponse","kind":"json-schema","title":"CreateEntitlementGrantsResponse","data":{"type":"object","description":"Response body returned after creating runtime entitlement grants.","properties":{"entitlement":{"type":"array","description":"Entitlement grants created by the request.","items":{"$ref":"#/components/schemas/EntitlementGrant"}},"entitlements":{"type":"array","description":"Alternate array field returned by some create-grant responses.","items":{"$ref":"#/components/schemas/EntitlementGrant"}}}}},"components/schemas/ListEntitlementGrantsResponse":{"id":"components/schemas/ListEntitlementGrantsResponse","kind":"json-schema","title":"ListEntitlementGrantsResponse","data":{"type":"object","description":"Response body that contains a list of runtime entitlement grants.","properties":{"grants":{"type":"array","description":"Runtime entitlement grants that match the request filters.","items":{"$ref":"#/components/schemas/EntitlementGrant"}},"items":{"type":"array","description":"Alternate array field returned by some list responses.","items":{"$ref":"#/components/schemas/EntitlementGrant"}},"totalCount":{"type":"integer","description":"Total number of grants that match the request filters.","example":2},"nextPageToken":{"type":"string","nullable":true,"description":"Token used to retrieve the next page of results. Omitted when there are no more pages.","example":"8ad088009840d1c2019855e15c993f2f"}}}},"components/schemas/GetEntitlementGrantResponse":{"id":"components/schemas/GetEntitlementGrantResponse","kind":"json-schema","title":"GetEntitlementGrantResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body that contains one runtime entitlement grant. Some responses wrap the grant in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Other responses return grant fields at the top level."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/EntitlementGrant"}],"properties":{"grant":{"description":"The runtime entitlement grant.","allOf":[{"$ref":"#/components/schemas/EntitlementGrant"}]}}}},"components/schemas/UpdateEntitlementGrantRequest":{"id":"components/schemas/UpdateEntitlementGrantRequest","kind":"json-schema","title":"UpdateEntitlementGrantRequest","data":{"type":"object","description":"Request body for changing the dates or quantity of a runtime entitlement grant.","required":["action"],"properties":{"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modification to apply to the grant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"redate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Changes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"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":"code","inline":true,"attributes":{"content":"increment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Increases the granted quantity by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delta"},"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":"code","inline":true,"attributes":{"content":"decrement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Decreases the granted quantity by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["redate","increment","decrement"],"example":"increment"},"delta":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity to add or subtract. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"increment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decrement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":100},"startDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New grant start date, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-02-01"},"endDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New grant end date, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-12-31"}}}},"components/schemas/UpdateEntitlementGrantResponse":{"id":"components/schemas/UpdateEntitlementGrantResponse","kind":"json-schema","title":"UpdateEntitlementGrantResponse","data":{"type":"object","description":"Response body returned after updating a runtime entitlement grant.","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":"Result of the modification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The change is queued, typically because it requires an order intent."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The change was applied immediately."},"children":[]}]}]}]}],"enum":["queued","applied"],"example":"queued"},"entitlementKey":{"type":"string","description":"Unique key of the runtime entitlement grant.","example":"EG-00000001"},"orderIntentId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order intent created 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":"queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"8ad088009840d1c2019855e15c993f2f"}}}},"components/schemas/UpdateEntitlementGrantStateRequest":{"id":"components/schemas/UpdateEntitlementGrantStateRequest","kind":"json-schema","title":"UpdateEntitlementGrantStateRequest","data":{"type":"object","description":"Request body for changing the state of a runtime entitlement grant.","required":["action"],"properties":{"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State change to apply to the grant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported 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":"pause"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Pauses an active grant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resume"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Resumes a paused grant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Activates a pending grant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deactivate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deactivates an active grant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoke"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Revokes the grant. Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revokedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applicable."},"children":[]}]}]}]}],"enum":["pause","resume","activate","deactivate","revoke"],"example":"pause"},"reason":{"type":"string","description":"Reason for the state change.","example":"Customer requested pause"},"revokedDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the grant is revoked, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoke"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-06-01"},"orderNumber":{"type":"string","description":"Order number associated with this state change, when applicable.","example":"O-00000002"},"orderActionNumber":{"type":"string","description":"Order action number associated with this state change, when applicable.","example":"OA-00000002"}}}},"components/schemas/UpdateEntitlementGrantStateResponse":{"id":"components/schemas/UpdateEntitlementGrantStateResponse","kind":"json-schema","title":"UpdateEntitlementGrantStateResponse","data":{"type":"object","description":"Response body returned after changing the state of a runtime entitlement grant.","properties":{"entitlementKey":{"type":"string","description":"Unique key of the runtime entitlement grant.","example":"EG-00000001"},"newState":{"type":"string","description":"State of the grant after the action is applied.","enum":["pending","active","paused","inactive","expired","revoked"],"example":"paused"},"action":{"type":"string","description":"State-change action that was applied.","example":"pause"},"isRevoked":{"type":"boolean","description":"Indicates whether the grant is revoked after the action.","example":false}}}},"components/schemas/ContactObjectCustomFields":{"id":"components/schemas/ContactObjectCustomFields","kind":"json-schema","title":"contactFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Contact object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Contact object.\n","title":"contactFieldsCustom","type":"object"}},"components/schemas/POSTAccountTypeBillToContact":{"id":"components/schemas/POSTAccountTypeBillToContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"city":{"description":"City\n","type":"string","maxLength":100},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n","type":"string"},"county":{"description":"May optionally be used by Zuora Tax to calculate county tax.\n","type":"string","maxLength":100},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"homePhone":{"description":"Home phone number, 40 characters or less.\n","type":"string"},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","type":"string"},"nickname":{"description":"Nickname for this contact\n","type":"string"},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","type":"string"},"otherPhoneType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"personalEmail":{"description":"Personal email address.\n","type":"string","format":"email","maxLength":80},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If using Zuora Tax, be aware that Zuora tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided."},"children":[]}]}]}],"type":"string","maxLength":100},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n","type":"string","maxLength":100},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"required":["firstName","lastName"],"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":"Container for bill-to contact information for this account. If you do not provide a sold-to contact, the bill-to contact is copied to sold-to contact. Once the sold-to contact is created, changes to billToContact will not affect soldToContact and vice versa.\n","title":"Contact"}},"components/schemas/PaymentMethodObjectCustomFields":{"id":"components/schemas/PaymentMethodObjectCustomFields","kind":"json-schema","title":"paymentMethodFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the payment method. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a payment method object.\n","title":"paymentMethodFieldsCustom","type":"object"}},"components/schemas/POSTAccountTypeCreditCard":{"id":"components/schemas/POSTAccountTypeCreditCard","kind":"json-schema","title":"creditCard","data":{"allOf":[{"properties":{"cardHolderInfo":{"description":"Container for cardholder information.\n","properties":{"addressLine1":{"description":"First address line, 255 characters or less.\n","type":"string"},"addressLine2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"cardHolderName":{"description":"The card holder's full name as it appears on the card, e.g., \"John J Smith\", 50 characters or less.\n","type":"string"},"city":{"description":"City, 40 characters or less.\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"country":{"description":"Country; must be a valid country name or abbreviation.\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"email":{"description":"Card holder's email address, 80 characters or less.\n","type":"string"},"phone":{"description":"Phone number, 40 characters or less.\n","type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State; must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"required":["addressLine1","cardHolderName","city","country","state","zipCode"]},"cardNumber":{"description":"Card number, up to 16 characters. Once created, this field can't be updated or queried, and is only available in masked format (e.g., XXXX-XXXX-XXXX-1234).\n","type":"string"},"cardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the credit card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values  include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JCB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Diners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about credit card types supported by different payment gateways, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Payment Gateways"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"expirationMonth":{"description":"Two-digit expiration month (01-12).\n","type":"string"},"expirationYear":{"description":"Four-digit expiration year.\n","type":"string"},"securityCode":{"description":"The CVV or CVV2 security code of the card. To ensure PCI compliance, this value is not stored and cannot be queried.\n","type":"string"}},"required":["cardHolderInfo","cardNumber","cardType","expirationMonth","expirationYear"],"type":"object"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"description":[{"$$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 has been deprecated, and is currently available only for backward compatibility. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field instead to create a payment method associated with this account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for information on a credit card to associate with this account."},"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":"autoPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must provide one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hpmCreditCardPaymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, but not multiple."},"children":[]}]}]}],"title":"creditCard"}},"components/schemas/EinvoiceObjectCustomFields":{"id":"components/schemas/EinvoiceObjectCustomFields","kind":"json-schema","title":"eInvoiceProfileCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the eInvoiceProfile object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-custom-field-management-with-object-manager","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage custom fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an EinvoiceProfile object.\n","title":"eInvoiceProfileCustomFields","type":"object"}},"components/schemas/PostAccountEInvoiceProfile":{"id":"components/schemas/PostAccountEInvoiceProfile","kind":"json-schema","title":"einvoiceProfile","data":{"allOf":[{"properties":{"businessCategory":{"description":"The high-level category of the business.\n","type":"string","enum":["B2B","B2C","B2G"]},"businessName":{"description":"The full official name that the Buyer is registered with the relevant legal authority.\n","maxLength":255,"type":"string"},"businessNumber":{"description":"The unique identifier number of the legal entity or person that you do business with.\n\nFor example, you must use a GSTIN for India.\n","type":"string"},"businessNumberSchemeId":{"description":"The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person.\n","type":"string"},"enabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to enable the e-invoicing profile for the customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the following conditions are met, all billing documents for one account can be submitted to an e-invoicing service provider to be generated in electronic format:"},"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 account must be configured to generate e-invoice files for billing documents."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing document must be in Posted status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A business region must be created for the billing country contact, and be linked to an e-invoicing service provider."},"children":[]}]}]}]}],"type":"boolean"},"endpointId":{"description":"The Buyer's electronic address, to which the application-level response to the billing document might be delivered.\n","type":"string"},"endpointSchemeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification scheme identifier of the Buyer’s electronic address."},"children":[]}]}]}],"type":"string"},"taxRegisterNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Buyer's VAT identifier (also known as the Buyer's VAT identification number) or the local identification (defined by the Buyer’s address) of the Buyer for tax purposes, or a reference that enables the Buyer to state the registered tax status."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/EinvoiceObjectCustomFields"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for e-invoicing profile information for this account."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"title":"einvoiceProfile"}},"components/schemas/PostAccountEReportingProfile":{"id":"components/schemas/PostAccountEReportingProfile","kind":"json-schema","title":"eReportingProfile","data":{"allOf":[{"properties":{"businessCategory":{"description":"The high-level category of the business.\n","type":"string","enum":["B2B","B2B_CROSS_BORDER","B2C","B2G","ANY"]},"businessName":{"description":"The full official name that the Buyer is registered with the relevant legal authority.\n","maxLength":255,"type":"string"},"businessNumber":{"description":"The unique identifier number of the legal entity or person that you do business with.\n","maxLength":100,"type":"string"},"businessNumberSchemeId":{"description":"The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person.\n","maxLength":50,"type":"string"},"enabled":{"description":"Whether to enable the e-reporting profile for the customer account.\n","type":"boolean"},"endpointId":{"description":"The Buyer's electronic address, to which the application-level response to the billing document might be delivered.\n","maxLength":100,"type":"string"},"endpointSchemeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification scheme identifier of the Buyer’s electronic address."},"children":[]}]}]}],"maxLength":50,"type":"string"},"taxRegisterNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Buyer's VAT identifier (also known as the Buyer's VAT identification number) or the local identification (defined by the Buyer’s address) of the Buyer for tax purposes, or a reference that enables the Buyer to state the registered tax status."},"children":[]}]}]}],"maxLength":100,"type":"string"}},"type":"object"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for e-reporting profile information for this account."},"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 available only if you have the E-Reporting feature enabled."},"children":[]}]}]}],"title":"eReportingProfile"}},"components/schemas/CreatePaymentMethodCardholderInfo":{"id":"components/schemas/CreatePaymentMethodCardholderInfo","kind":"json-schema","title":"cardHolderInfo","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for cardholder information. The nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]}],"properties":{"addressLine1":{"description":"First address line, 255 characters or less.\n","type":"string"},"addressLine2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"cardHolderName":{"description":"The card holder's full name as it appears on the card, e.g., \"John J Smith\", 50 characters or less. The value must consist only of US-ASCII  characters and must not include special characters.","type":"string"},"city":{"description":"City, 40 characters or less.\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"country":{"description":"Country, must be a valid country name or abbreviation.\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"email":{"description":"Card holder's email address, 80 characters or less.\n","type":"string"},"phone":{"description":"Phone number, 40 characters or less.\n","type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State; must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"required":["cardHolderName"],"title":"cardHolderInfo","type":"object","example":{"cardHolderName":"Amy Lawrence","addressLine1":"101 Redwood Shores Parkway","city":"Redwood City","state":"CA","zipCode":94065,"country":"USA","phone":"(888) 976-9056"}}},"components/schemas/PaymentMethodCommonFields":{"id":"components/schemas/PaymentMethodCommonFields","kind":"json-schema","title":"PaymentMethodCommonFields","data":{"properties":{"accountKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer account ID such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2x92c0f859b0480f0159d3a4a6ee5bb6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the customer account number such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A02855638"},"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 an orphan payment method that is not associated with any customer account, you can skip this field.  As soon as the account information is available, associate the payment method with an account through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a payment method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  operation."},"children":[]}]}]}],"type":"string"},"authGateway":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not set this field, Zuora will use one of the following payment gateways instead:"},"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 default payment gateway of the customer account that owns the payment method, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default payment gateway of your Zuora tenant, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-gateway-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Gateway Routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled:"},"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 field is not specified, gateway routing rules will be invoked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Payment Gateway Routing is disabled:"},"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 field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"children":[]}]}]}]}],"type":"string"},"currencyCode":{"description":"The currency used for payment method authorization.\n","type":"string","example":"USD"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts."},"children":[]}]}]}],"properties":{"key":{"description":"The name of a gateway-specific parameter.\n","type":"string"},"value":{"description":"The value of the gateway-specific parameter.\n","type":"string"}},"type":"object","example":{"shopperInteraction":"POS","shopperEmail":"testemail@test.com"}},"ipAddress":{"description":"The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. \n\nIf the IP address length is beyond 45 characters, a validation error occurs.\n\nFor validating SEPA payment methods on Stripe v2, this field is required.\n","type":"string"},"makeDefault":{"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 the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", make sure the payment method is supported by the default payment gateway."},"children":[]}]}]}],"type":"boolean"},"skipValidation":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to skip the validation."},"children":[]}]}]}],"type":"boolean"},"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 payment method. The following types of the payment methods are supported:"},"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":"code","inline":true,"attributes":{"content":"CreditCard"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditCardReferenceTransaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Betalingsservice"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Autogiro"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bacs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Becs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Becsnz"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAD"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayPalCP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayPalEC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayPalNativeEC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayPalAdaptive"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdyenApplePay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdyenGooglePay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GooglePay"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list."},"children":[]}]}]}],"type":"string","enum":["CreditCard","CreditCardReferenceTransaction","ACH","SEPA","Betalingsservice","Autogiro","Bacs","Becs","Becsnz","PAD","PayPalCP","PayPalEC","PayPalNativeEC","PayPalAdaptive","AdyenApplePay","AdyenGooglePay","GooglePay","AmazonPay"]}},"type":"object"}},"components/schemas/CreatePaymentMethodCreditCard":{"id":"components/schemas/CreatePaymentMethodCreditCard","kind":"json-schema","title":"CreatePaymentMethodCreditCard","data":{"allOf":[{"type":"object","properties":{"type":{"type":"string"},"cardHolderInfo":{"$ref":"#/components/schemas/CreatePaymentMethodCardholderInfo"},"cardMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked card number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, this field is only supported on certain integrations. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"cardNumber":{"description":"Credit card number.\n","type":"string"},"cardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the credit card."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JCB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Diners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about credit card types supported by different payment gateways, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Payment Gateways"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following fields are used for the duplication check:"},"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":"cardHolderName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expirationMonth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expirationYear"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditCardMaskNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is the masked credit card number generated by Zuora. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"************1234"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is being deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  To achieve the same purpose, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processingOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkDuplicated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the payment method object."},"children":[]}]}]}],"type":"boolean"},"expirationMonth":{"description":"One or two digit expiration month (1-12) of the credit card.\n","type":"integer"},"expirationYear":{"description":"Four-digit expiration year of the credit card.\n","type":"integer"},"identityNumber":{"description":"The identity number of the cardholder. This field is required for Credit Card payment methods in certain countries such as Brazil.\n","type":"string"},"mitConsentAgreementRef":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":128,"type":"string"},"mitConsentAgreementSrc":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Specifies how the consent agreement has been established with the customer. The allowed value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["External"],"type":"string"},"mitNetworkTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the ID of a network transaction. Only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Persist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":128,"type":"string"},"mitProfileAction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora creates and activates the stored credential profile."},"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":"code","inline":true,"attributes":{"content":"Activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use this value if you are creating the stored credential profile after receiving the customer's consent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the CIT does not succeed, Zuora will not create a stored credential profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Agreed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Persist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"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 you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["Activate","Persist"],"type":"string"},"mitProfileAgreedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the profile is agreed. The date format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"mitProfileType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Indicates the type of the stored credential profile to process recurring or unsecheduled transactions. If you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["Recurring","Unscheduled"],"type":"string"},"screeningAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-chase-orbital-gateway-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chase Paymentech Orbital Gateway"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations, if the Safetech Fraud service is enabled, use this field to pass in the amount used for fraud screening for Credit Card validation transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-decimal amount is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"screeningAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified, the authorization amount is used for fraud screening."},"children":[]}]}]}],"format":"decimal","type":"number"},"securityCode":{"description":"CVV or CVV2 security code of the credit card.\n\nTo ensure PCI compliance, this value is not stored and cannot be queried.\n","type":"string"},"tokens":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create tokenized payment methods, pass in the existing token information through the fields in this container."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, this field is only supported on certain integrations. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"properties":{"gatewayType":{"description":"The type of the payment gateway to generate the tokens. This field is\ncase-sensitive.\n","type":"string"},"secondTokenId":{"description":"Pass in the second token of the payment method.\n","type":"string"},"thirdTokenId":{"description":"Pass in the third token of the payment method.\n","type":"string"},"tokenId":{"description":"Pass in the first token of the payment method.\n","type":"string"}},"required":["gatewayType","tokenId"],"type":"object"},"tokenize":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to tokenize the payment method with the card information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, this field is only supported on certain integrations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"mandateInfo":{"description":"The container of the mandate information for the payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}},"type":"object"},"processingOptions":{"description":"The container for payment method processing options.\n","type":"object","properties":{"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to perform a duplication check when you create a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-duplication-check","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplication check on payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}}}}},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","cardHolderInfo","cardNumber","cardType","expirationMonth","expirationYear"],"example":{"accountKey":"8ad09be48db5aba7018db604776d4854","type":"CreditCard","cardType":"Visa","cardNumber":"4111111111111111","expirationMonth":12,"expirationYear":2028,"cardHolderInfo":{"cardHolderName":"Amy Lawrence"}}}},"components/schemas/CreatePaymentMethodCCReferenceTransaction":{"id":"components/schemas/CreatePaymentMethodCCReferenceTransaction","kind":"json-schema","title":"CreatePaymentMethodCCReferenceTransaction","data":{"allOf":[{"type":"object","properties":{"type":{"type":"string"},"creditCardMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked credit card number, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*********1112"},"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 field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked."},"children":[]}]}]}],"maxLength":19,"type":"string"},"secondTokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A gateway unique identifier that replaces sensitive payment method data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondTokenId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is conditionally required only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tokenId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is being used to represent a gateway customer profile. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondTokenId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used in the CC Reference Transaction payment method."},"children":[]}]}]}],"type":"string"},"tokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile."},"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":"tokenId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to represent a customer profile, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondTokenId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is conditionally required for representing the underlying tokenized payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The values for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tokenId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondTokenId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method."},"children":[]}]}]}],"type":"string"},"mandateInfo":{"description":"The container of the mandate information for the payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}}}}},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"type":"object","required":["type","tokenId"],"example":{"accountKey":"8a90d6128d45df2b018d4b90681c05x0","tokenId":"A9xCTM0A3D7g0OOiYnwxJMjkZ6Nn8yMDusVbnhvH","secondTokenId":"B4D339HPV3KHQQ65","creditCardMaskNumber":"************1111","type":"CreditCardReferenceTransaction"}}},"components/schemas/CreatePaymentMethodACH":{"id":"components/schemas/CreatePaymentMethodACH","kind":"json-schema","title":"CreatePaymentMethodACH","data":{"allOf":[{"properties":{"type":{"type":"string"},"addressLine1":{"description":"First address line, 255 characters or less.\n","type":"string"},"addressLine2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"bankABACode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nine-digit routing number or ABA number used by banks. This field is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"bankAccountMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked account number such as ****1234."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, this field is only supported on certain integrations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"bankAccountName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the account holder, which can be either a person or a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ACH payment methods on the BlueSnap integration, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-bluesnap-payment-gateway-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BlueSnap gateway"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integration"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information about how Zuora splits the string in this field into"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two parts and passes them to BlueSnap's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"maxLength":70,"type":"string"},"bankAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bank account number associated with the ACH payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the creation of tokenized ACH payment methods, this field is optional. Currently, ACH tokenization is supported on selected payment gateway integrations."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"maxLength":30,"type":"string"},"bankAccountType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of bank account associated with the ACH payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating an ACH payment method on Adyen, this field is required by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora but it is not required by Adyen. To create the ACH payment method"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successfully, specify a real value for this field if you can. If it is not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"possible to get the real value for it, specify any of the allowed values"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as a dummy value, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" preferably."},"children":[]}]}]}],"enum":["BusinessChecking","Checking","Saving"],"type":"string"},"bankName":{"description":"The name of the bank where the ACH payment account is held.\n\n\nWhen creating an ACH payment method on Adyen, this field is required by\nZuora but it is not required by Adyen. To create the ACH payment method\nsuccessfully, specify a real value for this field if you can. If it is not\npossible to get the real value for it, specify a dummy value.\n","maxLength":70,"type":"string"},"city":{"description":"City, 40 characters or less.\n\n\nIt is recommended to provide the city and country information when\ncreating a payment method. The information will be used to process\npayments. If the information is not provided during payment method\ncreation, the city and country data will be missing during payment\nprocessing.\n    \n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country, must be a valid country name or abbreviation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the list of supported country names and abbreviations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is recommended to provide the city and country information when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating a payment method. The information will be used to process"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payments. If the information is not provided during payment method"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creation, the city and country data will be missing during payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing."},"children":[]}]}]}],"type":"string"},"phone":{"description":"Phone number, 40 characters or less.\n","type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State, must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"},"mandateInfo":{"description":"The container of the mandate information for the payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}},"type":"object"},"processingOptions":{"description":"The container for payment method processing options.\n","properties":{"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to perform a duplication check when you create a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-duplication-check","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplication check on payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},"tokens":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create tokenized payment methods, pass in the existing token information through the fields in this container."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, this field is only supported on certain integrations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"properties":{"gatewayType":{"description":"The type of the payment gateway to generate the tokens. This field is\ncase-sensitive.\n","type":"string"},"secondTokenId":{"description":"Pass in the second token of the payment method.\n","type":"string"},"thirdTokenId":{"description":"Pass in the third token of the payment method.\n","type":"string"},"tokenId":{"description":"Pass in the first token of the payment method.\n","type":"string"}},"type":"object","required":["gatewayType","tokenId"]},"tokenize":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to tokenize the payment method with the account information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, this field is only supported on certain integrations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"}},"type":"object","title":"AchPaymentMethod"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","bankABACode","bankAccountName","bankAccountNumber","bankAccountType","bankName"],"example":{"accountKey":"8a90d6128d45df2b018d4b90681c05x0","bankABACode":"999999999","bankAccountName":"TestName","bankAccountNumber":"999999999","bankAccountType":"Checking","bankName":"TestBank","addressLine1":"Test Address line1","addressLine2":"Test Address line2","phone":"1234567890","city":"testCity","country":"USA","state":"Alaska","zipCode":"123456","processingOptions":{"checkDuplicated":true},"type":"ACH"}}},"components/schemas/CreatePaymentMethodSEPA":{"id":"components/schemas/CreatePaymentMethodSEPA","kind":"json-schema","title":"CreatePaymentMethodSEPA","data":{"allOf":[{"properties":{"type":{"type":"string"},"IBAN":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The International Bank Account Number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"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":"However, for the creation of tokenized SEPA payment methods, this field is optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, SEPA tokenization is supported on selected payment gateway integrations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"accountHolderInfo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for the account holder information. The nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, for the creation of tokenized SEPA payment methods, this field is optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, SEPA tokenization is supported on selected payment gateway integrations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"properties":{"accountHolderName":{"description":"The full name of the bank account holder.\n","maxLength":60,"type":"string"},"addressLine1":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address for the account holder."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required for SEPA Direct Debit payment methods on Stripe v2 for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"certain countries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"addressLine2":{"description":"The second line of the address for the account holder. \n","type":"string"},"city":{"description":"The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country where the account holder stays."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required for SEPA payment methods on Stripe v2 for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"certain countries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"email":{"description":"The email address of the account holder.\n","type":"string"},"firstName":{"description":"The first name of the account holder.\n","type":"string"},"lastName":{"description":"The last name of the account holder.\n","type":"string"},"phone":{"description":"The phone number of the account holder.\n","type":"string"},"state":{"description":"The state where the account holder stays.\n","type":"string"},"zipCode":{"description":"The zip code for the address of the account holder.\n","type":"string"}},"type":"object","required":["accountHolderName"]},"accountMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked account number such as ****1234."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating tokenized SEPA payment methods, this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountMaskNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tokens"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, SEPA tokenization is supported on selected payment gateway integrations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"businessIdentificationCode":{"description":"The BIC code used for SEPA.\n","type":"string"},"mandateInfo":{"description":"The container of the mandate information for the payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}},"type":"object"},"tokenize":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a SEPA payment method on Adyen Integration v2.0, use this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field to specify whether to tokenize the payment method with IBAN. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tokenize"},"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":"IBAN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tokens"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is provided, this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tokenize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not required. For more information about how to create tokenized SEPA payment methods on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adyen, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-tokenize-payment-methods-on-adyen","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokenize SEPA payment methods on Adyen Integration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"v2.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"tokens":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create tokenized payment methods, pass in the existing token information through the fields in this container."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, SEPA tokenization is supported on selected payment gateway integrations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"properties":{"gatewayType":{"description":"The type of the payment gateway to generate the tokens. This field is\ncase-sensitive.\n","enum":["Adyen","Stripe"],"type":"string"},"secondTokenId":{"description":"Pass in the second token of the payment method.\n","type":"string"},"thirdTokenId":{"description":"Pass in the third token of the payment method.\n","type":"string"},"tokenId":{"description":"Pass in the first token of the payment method.\n","type":"string"}},"type":"object","required":["gatewayType","tokenId"]},"processingOptions":{"description":"The container for payment method processing options.\n","properties":{"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to perform a duplication check when you create a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-duplication-check","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplication check on payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","IBAN","accountHolderInfo"],"example":{"accountKey":"8a90d6128d45df2b018d4b90681c05x0","IBAN":"FR1420041010050500013M02606","accountHolderInfo":{"accountHolderName":"TestName"},"processingOptions":{"checkDuplicated":true},"type":"SEPA"}}},"components/schemas/CreatePaymentMethodBetalingsservice":{"id":"components/schemas/CreatePaymentMethodBetalingsservice","kind":"json-schema","title":"CreatePaymentMethodBetalingsservice","data":{"allOf":[{"properties":{"type":{"type":"string"},"accountHolderInfo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for the account holder information. The nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]}],"properties":{"accountHolderName":{"description":"Required.\n\nThe full name of the bank account holder.\n","maxLength":60,"type":"string"},"addressLine1":{"description":"The first line of the address for the account holder.\n","type":"string"},"addressLine2":{"description":"The second line of the address for the account holder. \n","type":"string"},"city":{"description":"The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"country":{"description":"The country where the account holder stays.\n","type":"string"},"email":{"description":"The email address of the account holder.\n","type":"string"},"firstName":{"description":"The first name of the account holder.\n","type":"string"},"lastName":{"description":"The last name of the account holder.\n","type":"string"},"phone":{"description":"The phone number of the account holder.\n","type":"string"},"state":{"description":"The state where the account holder stays.\n","type":"string"},"zipCode":{"description":"The zip code for the address of the account holder.\n","type":"string"}},"type":"object"},"accountNumber":{"description":"The number of the customer's bank account.\n","type":"string"},"accountMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked account number such as ****1234."},"children":[]}]}]}],"type":"string"},"bankCode":{"description":"The sort code or number that identifies the bank. This is also known as the sort code.\n","type":"string"},"identityNumber":{"description":"The identity number used for Bank Transfer.\n","type":"string"},"mandateInfo":{"description":"The container of the mandate information for the payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}},"type":"object"},"processingOptions":{"description":"The container for payment method processing options.\n","properties":{"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to perform a duplication check when you create a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-duplication-check","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplication check on payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","accountNumber","identityNumber","bankCode","accountHolderInfo"],"example":{"accountKey":"8a90d6128d45df2b018d4b90681c05x0","accountNumber":"3179681","identityNumber":"0101701234","bankCode":"345","accountHolderInfo":{"accountHolderName":"TestName"},"processingOptions":{"checkDuplicated":true},"type":"Betalingsservice"}}},"components/schemas/CreatePaymentMethodAutogiro":{"id":"components/schemas/CreatePaymentMethodAutogiro","kind":"json-schema","title":"CreatePaymentMethodAutogiro","data":{"allOf":[{"properties":{"type":{"type":"string"},"accountHolderInfo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for the account holder information. The nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]}],"properties":{"accountHolderName":{"description":"Required.\n\nThe full name of the bank account holder.\n","maxLength":60,"type":"string"},"addressLine1":{"description":"The first line of the address for the account holder.\n","type":"string"},"addressLine2":{"description":"The second line of the address for the account holder. \n","type":"string"},"city":{"description":"The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"country":{"description":"The country where the account holder stays.\n","type":"string"},"email":{"description":"The email address of the account holder.\n","type":"string"},"firstName":{"description":"The first name of the account holder.\n","type":"string"},"lastName":{"description":"The last name of the account holder.\n","type":"string"},"phone":{"description":"The phone number of the account holder.\n","type":"string"},"state":{"description":"The state where the account holder stays.\n","type":"string"},"zipCode":{"description":"The zip code for the address of the account holder.\n","type":"string"}},"type":"object"},"accountNumber":{"description":"The number of the customer's bank account.\n","type":"string"},"accountMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked account number such as ****1234."},"children":[]}]}]}],"type":"string"},"branchCode":{"description":"The branch code of the bank used for direct debit.\n","type":"string"},"identityNumber":{"description":"The identity number used for Bank Transfer.\n","type":"string"},"mandateInfo":{"description":"The container of the mandate information for the payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}},"type":"object"},"processingOptions":{"description":"The container for payment method processing options.\n","properties":{"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to perform a duplication check when you create a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-duplication-check","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplication check on payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"type":"object","title":"AutogiroPaymentMethod"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","accountNumber","identityNumber","branchCode","accountHolderInfo"],"example":{"accountKey":"8a90d6128d45df2b018d4b90681c05x0","accountNumber":"0000003","identityNumber":"198112289874","branchCode":"5491","accountHolderInfo":{"accountHolderName":"TestName"},"processingOptions":{"checkDuplicated":true},"type":"Autogiro"}}},"components/schemas/CreatePaymentMethodBacs":{"id":"components/schemas/CreatePaymentMethodBacs","kind":"json-schema","title":"CreatePaymentMethodBacs","data":{"allOf":[{"properties":{"type":{"type":"string"},"accountHolderInfo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for the account holder information. The nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]}],"properties":{"accountHolderName":{"description":"Required.\n\nThe full name of the bank account holder.\n","maxLength":60,"type":"string"},"addressLine1":{"description":"The first line of the address for the account holder.\n","type":"string"},"addressLine2":{"description":"The second line of the address for the account holder. \n","type":"string"},"city":{"description":"The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"country":{"description":"The country where the account holder stays.\n","type":"string"},"email":{"description":"The email address of the account holder.\n","type":"string"},"firstName":{"description":"The first name of the account holder.\n","type":"string"},"lastName":{"description":"The last name of the account holder.\n","type":"string"},"phone":{"description":"The phone number of the account holder.\n","type":"string"},"state":{"description":"The state where the account holder stays.\n","type":"string"},"zipCode":{"description":"The zip code for the address of the account holder.\n","type":"string"}},"type":"object"},"accountNumber":{"description":"The number of the customer's bank account.\n","type":"string"},"accountMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked account number such as ****1234."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating BACS payment methods on Stripe, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tokens"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is provided, this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountMaskNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required. For more information, see  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-stripe-gateway-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Stripe payment gateway integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"bankCode":{"description":"The sort code or number that identifies the bank. This is also known as the sort code.\n","type":"string"},"mandateInfo":{"description":"The container of the mandate information for the payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}},"type":"object"},"tokenize":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a BACS payment method on Adyen v2.0, set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to support processing BACS recurring payments. For more information about other requirements for processing BACS recurring payments, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-direct-debit-uk-bacs-for-adyen","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Adyen Integration v2.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"tokens":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create tokenized BACS payment methods on Stripe v2, pass in the existing token information through the fields in this container."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-stripe-gateway-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Stripe payment gateway integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"gatewayType":{"description":"Required. \n\nThe type of the payment gateway to generate the tokens. This field is case-sensitive.\n","enum":["Stripe"],"type":"string"},"secondTokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass in the second token of the payment method. For more information, see  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-stripe-gateway-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Stripe payment gateway integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"thirdTokenId":{"description":"Pass in the third token of the payment method.\n","type":"string"},"tokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass in the first token of the payment method. For more information, see  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-stripe-gateway-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Stripe payment gateway integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"},"processingOptions":{"description":"The container for payment method processing options.\n","properties":{"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to perform a duplication check when you create a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-duplication-check","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplication check on payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"type":"object","title":"BacsPaymentMethod"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","accountNumber","bankCode","accountHolderInfo"],"example":{"accountKey":"8a90d6128d45df2b018d4b90681c05x0","accountNumber":"55779911","bankCode":"200000","accountHolderInfo":{"accountHolderName":"TestName"},"processingOptions":{"checkDuplicated":true},"type":"Bacs"}}},"components/schemas/CreatePaymentMethodBecs":{"id":"components/schemas/CreatePaymentMethodBecs","kind":"json-schema","title":"CreatePaymentMethodBecs","data":{"allOf":[{"properties":{"type":{"type":"string"},"accountHolderInfo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for the account holder information. The nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]}],"properties":{"accountHolderName":{"description":"Required.\n\nThe full name of the bank account holder.\n","maxLength":60,"type":"string"},"addressLine1":{"description":"The first line of the address for the account holder.\n","type":"string"},"addressLine2":{"description":"The second line of the address for the account holder. \n","type":"string"},"city":{"description":"The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"country":{"description":"The country where the account holder stays.\n","type":"string"},"email":{"description":"The email address of the account holder.\n","type":"string"},"firstName":{"description":"The first name of the account holder.\n","type":"string"},"lastName":{"description":"The last name of the account holder.\n","type":"string"},"phone":{"description":"The phone number of the account holder.\n","type":"string"},"state":{"description":"The state where the account holder stays.\n","type":"string"},"zipCode":{"description":"The zip code for the address of the account holder.\n","type":"string"}},"type":"object"},"accountNumber":{"description":"The number of the customer's bank account.\n","type":"string"},"accountMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked account number such as ****1234."},"children":[]}]}]}],"type":"string"},"branchCode":{"description":"The branch code of the bank used for direct debit.\n","type":"string"},"mandateInfo":{"description":"The container of the mandate information for the payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}},"type":"object"},"processingOptions":{"description":"The container for payment method processing options.\n","properties":{"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to perform a duplication check when you create a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-duplication-check","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplication check on payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","accountNumber","branchCode"],"example":{"accountKey":"8a90d6128d45df2b018d4b90681c05x0","accountNumber":"012345678","branchCode":"082-082","accountHolderInfo":{"accountHolderName":"TestName"},"processingOptions":{"checkDuplicated":true},"type":"Becs"}}},"components/schemas/CreatePaymentMethodBecsnz":{"id":"components/schemas/CreatePaymentMethodBecsnz","kind":"json-schema","title":"CreatePaymentMethodBecsnz","data":{"allOf":[{"properties":{"type":{"type":"string"},"accountHolderInfo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for the account holder information. The nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]}],"properties":{"accountHolderName":{"description":"Required.\n\nThe full name of the bank account holder.\n","maxLength":60,"type":"string"},"addressLine1":{"description":"The first line of the address for the account holder.\n","type":"string"},"addressLine2":{"description":"The second line of the address for the account holder. \n","type":"string"},"city":{"description":"The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"country":{"description":"The country where the account holder stays.\n","type":"string"},"email":{"description":"The email address of the account holder.\n","type":"string"},"firstName":{"description":"The first name of the account holder.\n","type":"string"},"lastName":{"description":"The last name of the account holder.\n","type":"string"},"phone":{"description":"The phone number of the account holder.\n","type":"string"},"state":{"description":"The state where the account holder stays.\n","type":"string"},"zipCode":{"description":"The zip code for the address of the account holder.\n","type":"string"}},"type":"object"},"accountNumber":{"description":"The number of the customer's bank account.\n","type":"string"},"accountMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked account number such as ****1234."},"children":[]}]}]}],"type":"string"},"branchCode":{"description":"The branch code of the bank used for direct debit.\n","type":"string"},"bankCode":{"description":"The sort code or number that identifies the bank. This is also known as the sort code.\n","type":"string"},"mandateInfo":{"description":"The container of the mandate information for the payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}},"type":"object"},"processingOptions":{"description":"The container for payment method processing options.\n","properties":{"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to perform a duplication check when you create a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-duplication-check","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplication check on payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","accountNumber","bankCode","branchCode","accountHolderInfo"],"example":{"accountKey":"8a90d6128d45df2b018d4b90681c05x0","accountNumber":"0003869-00","accountHolderInfo":{"accountHolderName":"TestName"},"branchCode":"3113","bankCode":"12","processingOptions":{"checkDuplicated":true},"type":"Becsnz"}}},"components/schemas/CreatePaymentMethodPAD":{"id":"components/schemas/CreatePaymentMethodPAD","kind":"json-schema","title":"CreatePaymentMethodPAD","data":{"allOf":[{"properties":{"type":{"type":"string"},"accountHolderInfo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for the account holder information. The nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]}],"properties":{"accountHolderName":{"description":"Required.\n\nThe full name of the bank account holder.\n","maxLength":60,"type":"string"},"addressLine1":{"description":"The first line of the address for the account holder.\n","type":"string"},"addressLine2":{"description":"The second line of the address for the account holder. \n","type":"string"},"city":{"description":"The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","type":"string"},"country":{"description":"The country where the account holder stays.\n","type":"string"},"email":{"description":"The email address of the account holder.\n","type":"string"},"firstName":{"description":"The first name of the account holder.\n","type":"string"},"lastName":{"description":"The last name of the account holder.\n","type":"string"},"phone":{"description":"The phone number of the account holder.\n","type":"string"},"state":{"description":"The state where the account holder stays.\n","type":"string"},"zipCode":{"description":"The zip code for the address of the account holder.\n","type":"string"}},"type":"object"},"accountNumber":{"description":"The number of the customer's bank account.\n","type":"string"},"accountMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked account number such as ****1234."},"children":[]}]}]}],"type":"string"},"branchCode":{"description":"The branch code of the bank used for direct debit.\n","type":"string"},"bankCode":{"description":"The sort code or number that identifies the bank. This is also known as the sort code.\n","type":"string"},"mandateInfo":{"description":"The container of the mandate information for the payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}},"type":"object"},"processingOptions":{"description":"The container for payment method processing options.\n","properties":{"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to perform a duplication check when you create a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-duplication-check","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplication check on payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","accountNumber","bankCode","branchCode","accountHolderInfo"],"example":{"accountKey":"8a90d6128d45df2b018d4b90681c05x0","accountNumber":"0000000","accountHolderInfo":{"accountHolderName":"TestName"},"branchCode":"00006","bankCode":"0003","processingOptions":{"checkDuplicated":true},"type":"PAD"}}},"components/schemas/CreatePMPayPalCP":{"id":"components/schemas/CreatePMPayPalCP","kind":"json-schema","title":"CreatePMPayPalCP","data":{"allOf":[{"properties":{"type":{"type":"string"},"BAID":{"description":"ID of a PayPal billing agreement.\n","type":"string","example":"I-1TJ3GAGG82Y9"},"email":{"description":"Email address associated with the payment method.\n","type":"string"},"tokens":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create tokenized payment methods, pass in the existing token information through the fields in this container."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, this field is only supported on certain integrations. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"properties":{"gatewayType":{"description":"The type of the payment gateway to generate the tokens. This field is\ncase-sensitive.\n","type":"string"},"secondTokenId":{"description":"Pass in the second token of the payment method.\n","type":"string"},"thirdTokenId":{"description":"Pass in the third token of the payment method.\n","type":"string"},"tokenId":{"description":"Pass in the first token of the payment method.\n","type":"string"}},"required":["gatewayType","tokenId"],"type":"object"},"tokenize":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to tokenize the payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, this field is only supported on certain integrations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-create-tokenized-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","BAID","email"],"example":{"BAID":"I-1TJ3GAGG82Y9","accountKey":"8a90d6128d45df2b018d4b90681c05x0","email":"customer@example.com","type":"PayPalCP"}}},"components/schemas/CreatePMPayPalEC":{"id":"components/schemas/CreatePMPayPalEC","kind":"json-schema","title":"CreatePMPayPalEC","data":{"allOf":[{"properties":{"type":{"type":"string"},"BAID":{"description":"ID of a PayPal billing agreement.\n","type":"string","example":"I-1TJ3GAGG82Y9"},"email":{"description":"Email address associated with the payment method.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","BAID","email"],"example":{"BAID":"I-1TJ3GAGG82Y9","accountKey":"8a90d6128d45df2b018d4b90681c05x0","email":"customer@example.com","type":"PayPalEC"}}},"components/schemas/CreatePMPayPalNativeEC":{"id":"components/schemas/CreatePMPayPalNativeEC","kind":"json-schema","title":"CreatePMPayPalNativeEC","data":{"allOf":[{"properties":{"type":{"type":"string"},"BAID":{"description":"ID of a PayPal billing agreement. \nexample: I-1TJ3GAGG82Y9\n","type":"string"},"email":{"description":"Email address associated with the payment method.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","BAID"],"example":{"BAID":"I-1TJ3GAGG82Y9","accountKey":"8a90d6128d45df2b018d4b90681c05x0","email":"customer@example.com","type":"PayPalNativeEC"}}},"components/schemas/CreatePaymentMethodPayPalAdaptive":{"id":"components/schemas/CreatePaymentMethodPayPalAdaptive","kind":"json-schema","title":"CreatePaymentMethodPayPalAdaptive","data":{"allOf":[{"properties":{"type":{"type":"string"},"preapprovalKey":{"description":"The PayPal preapproval key.\n","type":"string"},"email":{"description":"Email address associated with the payment method.\n","type":"string","format":"email"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"}],"required":["type","preapprovalKey","email"],"example":{"preapprovalKey":"PA-3X000000LS390262X","accountKey":"8a90d6128d45df2b018d4b90681c05x0","email":"customer@example.com","type":"PayPalAdaptive"}}},"components/schemas/CreatePaymentMethodApplePayAdyen":{"id":"components/schemas/CreatePaymentMethodApplePayAdyen","kind":"json-schema","title":"CreatePaymentMethodApplePayAdyen","data":{"allOf":[{"properties":{"type":{"type":"string"},"applePaymentData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-create-apply-pay-using-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set up Adyen Apple Pay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"email":{"type":"string","format":"email","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address associated with the payment method. This field is specific for setting up Apple Pay on Adyen v2.0. This field will be passed to Adyen as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shopperEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"}],"required":["type","applePaymentData"],"example":{"accountKey":"2c92c0f97911f46a0179147510484b90","type":"AdyenApplePay","email":"testemail@test.com","applePaymentData":"{\"data\":\"hM8GTBX0UVhoKmJ/DkneZfwLlH/utWfEueshybbTpuzlf5i1IwO1kvW32SlFW7TmyvU98gf2Pp1FeyFCh7F2atmstxQdonkeJgpIUV7eWW1wUNaOeND28J8YQsEkDhC3sMgOJoju7FHcXNwveq5fk94StFZozRSi08oAjTnTJko5F32aY/JNWr19GiwWBHZe2jkokryt0TEWKO5hm5oTxeLs1LBOoC2ezaR+p2jQb4ISN2aCgCNiX8605w5eYWk7UCTK3Axf/EuJT4vHe75OKghEmcQLxvFzTtEw33ly6Nj2RJX3+I5TbYLXOfiAO0XnsWdhguDrKogtI44HMFqlNCdt79G71tXwCwbXz0VJywEh1d57tbU5Y5f6pw8TrjjeAMt9sa2pHuHmMGDf\",\"signature\":\"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID5DCCA4ugAwIBAgIIWdihvKr0480wCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTIxMDQyMDE5MzcwMFoXDTI2MDQxOTE5MzY1OVowYjEoMCYGA1UEAwwfZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtU0FOREJPWDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgjD9q8Oc914gLFDZm0US5jfiqQHdbLPgsc1LUmeY+M9OvegaJajCHkwz3c6OKpbC9q+hkwNFxOh6RCbOlRsSlaOCAhEwggINMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUI/JJxE+T5O8n5sT2KGw/orv9LkswRQYIKwYBBQUHAQEEOTA3MDUGCCsGAQUFBzABhilodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxlYWljYTMwMjCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZIhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRwOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNAYDVR0fBC0wKzApoCegJYYjaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGVhaWNhMy5jcmwwHQYDVR0OBBYEFAIkMAua7u1GMZekplopnkJxghxFMA4GA1UdDwEB/wQEAwIHgDAPBgkqhkiG92NkBh0EAgUAMAoGCCqGSM49BAMCA0cAMEQCIHShsyTbQklDDdMnTFB0xICNmh9IDjqFxcE2JWYyX7yjAiBpNpBTq/ULWlL59gBNxYqtbFCn1ghoN5DgpzrQHkrZgTCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI/JJxE+T5O8n5sT2KGw/orv9LkswDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn/Rd8LCFtlk/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYswggGHAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIIWdihvKr0480wDQYJYIZIAWUDBAIBBQCggZUwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMjEwNjAzMTgzNzExWjAqBgkqhkiG9w0BCTQxHTAbMA0GCWCGSAFlAwQCAQUAoQoGCCqGSM49BAMCMC8GCSqGSIb3DQEJBDEiBCCiDFBojwOJgYgEzWaGdLTMez4XiDpYJd34PswTPVdt+DAKBggqhkjOPQQDAgRGMEQCIHAWYyr/s28rtd/khGapLi1jCg3iXwgUfL2l4XadiKq3AiBHuronD982WBP3x0Tzc51rXwMEVpL+GDPme9Ydn2MF2gAAAAAAAA==\", \"header\": { \"publicKeyHash\":\"vJeh5XAkv8SGX2JHswEbnCUPn01YHcQ6imAp+gP300w=\", \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEVx9kP/eFM6MrP5sXKuzHT7f9Uhsc0Rox0FKvRpHIiqQ05EXYPsgBJZCEjOYlkviC2jDSvV6tEC8Kfq/z/GhrFA==\", \"transactionId\":\"7fd9ede5ea8c1d7a8985346c241a8933190a1acb408448c52ac27f7862f674ff\" }, \"version\":\"EC_v1\" }"}}},"components/schemas/CreatePaymentMethodGooglePayAdyen":{"id":"components/schemas/CreatePaymentMethodGooglePayAdyen","kind":"json-schema","title":"CreatePaymentMethodGooglePayAdyen","data":{"allOf":[{"properties":{"type":{"type":"string"},"googlePaymentToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is specific for setting up Google Pay for Adyen  gateway integrations to specify the stringified Google Pay token. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-setup-adyen-googlepay-using-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set up Adyen Google Pay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address associated with the payment method. This field is specific for setting up Google Pay on Adyen v2.0. This field will be passed to Adyen as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shopperEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"}],"required":["type","googlePaymentToken"],"example":{"accountKey":"2c92c0f97911f46a0179147510484b90","type":"AdyenGooglePay","email":"testemail@test.com","googlePaymentToken":"{\"signature\":\"MEUCICeJTEEW+a9ak93yk8pYg4xGlPJbrBNjD8b6vahxD5TRAiEAyMiNhzosJDl2N46Dojzc53bwbT/O0t+VToLCqr01qs4\\u003d\",\"protocolVersion\":\"ECv1\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"aXpc95j3gEFJfaHF8PEpybNuV/k/IDKMa/FkbNnj2p/uaH8ll99hAUwWkH5EnHr2NwNgLuj3j9IhDomWI9gJ4n2fQlsQ9FsNuqsJjct/QuNvlzooLhu76HlzE3mScXcTUqPI1fgC8s/CVNz06aCUd7/oNMzyCw6VploO9abxp3zcpRvAO39bScaO3fri2Kl0WGozyiS0egXcUzMOpPxDw03SjmpgU/X5FjmxayOBUNxM9r/yOQyvY9mTUHOK855XVl3Xf9dpj6GDnDMp4bvCW8zpXWr76Snwtvv41dIaLxNWsBP0lS5PpJ5K1/rSRZg/dauIKQbWGmTTL24vz4Om7hVu25L7XrSM6F2PRUE4rqMblVDvXAlVsD+149r2fjXsB4DXmvGmwaDcuFeTDuI3ov7GDetgW3Fdl+n7RtBOK/luJYs76a9nPbVLhN/aKU5Hpd0ZrIO8ZUOoUYr6WuecD24tTzwic3k921eLJez8IJnG1k05kiqPpHEqMeLyP/WovjH/U7Vu3iDrH4yAxMEuh0MMi0tTgjXlVEezVnsU\\\",\\\"ephemeralPublicKey\\\":\\\"BGNnBpAd6WypQEYJmDH/DhUZ9mX2b/wJK6as8g6hZmDCDpHSWFC1BZ42UBrX/hrF/UarrT24CMcWLZp6fYl6PNw\\\\u003d\\\",\\\"tag\\\":\\\"j9fPmiEL/zj8R+0JRrTC1NgV9VVCYQ9zYaB7uZrEz9U\\\\u003d\\\"}\"}"}}},"components/schemas/CreatePaymentMethodGooglePayChase":{"id":"components/schemas/CreatePaymentMethodGooglePayChase","kind":"json-schema","title":"CreatePaymentMethodGooglePayChase","data":{"allOf":[{"properties":{"type":{"type":"string"},"googlePaymentToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is specific for setting up Google Pay on Chase gateway integrations to specify the stringified Google Pay token. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-setup-chase-googlepay-using-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set up Google Pay on Chase"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"}],"required":["type","googlePaymentToken"],"example":{"accountKey":"2c92c0f97911f46a0179147510484b90","type":"GooglePay","googlePaymentToken":"{\"signature\":\"MEUCICeJTEEW+a9ak93yk8pYg4xGlPJbrBNjD8b6vahxD5TRAiEAyMiNhzosJDl2N46Dojzc53bwbT/O0t+VToLCqr01qs4\\u003d\",\"protocolVersion\":\"ECv1\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"aXpc95j3gEFJfaHF8PEpybNuV/k/IDKMa/FkbNnj2p/uaH8ll99hAUwWkH5EnHr2NwNgLuj3j9IhDomWI9gJ4n2fQlsQ9FsNuqsJjct/QuNvlzooLhu76HlzE3mScXcTUqPI1fgC8s/CVNz06aCUd7/oNMzyCw6VploO9abxp3zcpRvAO39bScaO3fri2Kl0WGozyiS0egXcUzMOpPxDw03SjmpgU/X5FjmxayOBUNxM9r/yOQyvY9mTUHOK855XVl3Xf9dpj6GDnDMp4bvCW8zpXWr76Snwtvv41dIaLxNWsBP0lS5PpJ5K1/rSRZg/dauIKQbWGmTTL24vz4Om7hVu25L7XrSM6F2PRUE4rqMblVDvXAlVsD+149r2fjXsB4DXmvGmwaDcuFeTDuI3ov7GDetgW3Fdl+n7RtBOK/luJYs76a9nPbVLhN/aKU5Hpd0ZrIO8ZUOoUYr6WuecD24tTzwic3k921eLJez8IJnG1k05kiqPpHEqMeLyP/WovjH/U7Vu3iDrH4yAxMEuh0MMi0tTgjXlVEezVnsU\\\",\\\"ephemeralPublicKey\\\":\\\"BGNnBpAd6WypQEYJmDH/DhUZ9mX2b/wJK6as8g6hZmDCDpHSWFC1BZ42UBrX/hrF/UarrT24CMcWLZp6fYl6PNw\\\\u003d\\\",\\\"tag\\\":\\\"j9fPmiEL/zj8R+0JRrTC1NgV9VVCYQ9zYaB7uZrEz9U\\\\u003d\\\"}\"}"}}},"components/schemas/CreatePaymentMethodAmazonPay":{"id":"components/schemas/CreatePaymentMethodAmazonPay","kind":"json-schema","title":"CreatePaymentMethodAmazonPay","data":{"allOf":[{"properties":{"type":{"type":"string"},"amazonPayToken":{"description":"This field is specific for setting up Amazon Pay gateway integrations to specify the stringified Amazon Pay token.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodCommonFields"}],"required":["type","amazonPayToken"],"example":{"amazonPayToken":"C03-0739300-4671639","amazonPayRegion":"JP","accountKey":"2c92c0f97911f46a0179147510484b90"}}},"components/schemas/POSTPaymentMethodRequest":{"id":"components/schemas/POSTPaymentMethodRequest","kind":"json-schema","title":"POSTPaymentMethodRequest","data":{"type":"object","discriminator":{"propertyName":"type","mapping":{"CreditCard":"#/components/schemas/CreatePaymentMethodCreditCard","CreditCardReferenceTransaction":"#/components/schemas/CreatePaymentMethodCCReferenceTransaction","ACH":"#/components/schemas/CreatePaymentMethodACH","SEPA":"#/components/schemas/CreatePaymentMethodSEPA","Betalingsservice":"#/components/schemas/CreatePaymentMethodBetalingsservice","Autogiro":"#/components/schemas/CreatePaymentMethodAutogiro","Bacs":"#/components/schemas/CreatePaymentMethodBacs","Becs":"#/components/schemas/CreatePaymentMethodBecs","Becsnz":"#/components/schemas/CreatePaymentMethodBecsnz","PAD":"#/components/schemas/CreatePaymentMethodPAD","PayPalCP":"#/components/schemas/CreatePMPayPalCP","PayPalEC":"#/components/schemas/CreatePMPayPalEC","PayPalNativeEC":"#/components/schemas/CreatePMPayPalNativeEC","PayPalAdaptive":"#/components/schemas/CreatePaymentMethodPayPalAdaptive","AdyenApplePay":"#/components/schemas/CreatePaymentMethodApplePayAdyen","AdyenGooglePay":"#/components/schemas/CreatePaymentMethodGooglePayAdyen","GooglePay":"#/components/schemas/CreatePaymentMethodGooglePayChase","AmazonPay":"#/components/schemas/CreatePaymentMethodAmazonPay"}},"oneOf":[{"$ref":"#/components/schemas/CreatePaymentMethodCreditCard"},{"$ref":"#/components/schemas/CreatePaymentMethodCCReferenceTransaction"},{"$ref":"#/components/schemas/CreatePaymentMethodACH"},{"$ref":"#/components/schemas/CreatePaymentMethodSEPA"},{"$ref":"#/components/schemas/CreatePaymentMethodBetalingsservice"},{"$ref":"#/components/schemas/CreatePaymentMethodAutogiro"},{"$ref":"#/components/schemas/CreatePaymentMethodBacs"},{"$ref":"#/components/schemas/CreatePaymentMethodBecs"},{"$ref":"#/components/schemas/CreatePaymentMethodBecsnz"},{"$ref":"#/components/schemas/CreatePaymentMethodPAD"},{"$ref":"#/components/schemas/CreatePMPayPalNativeEC"},{"$ref":"#/components/schemas/CreatePMPayPalCP"},{"$ref":"#/components/schemas/CreatePMPayPalEC"},{"$ref":"#/components/schemas/CreatePaymentMethodPayPalAdaptive"},{"$ref":"#/components/schemas/CreatePaymentMethodApplePayAdyen"},{"$ref":"#/components/schemas/CreatePaymentMethodGooglePayAdyen"},{"$ref":"#/components/schemas/CreatePaymentMethodGooglePayChase"},{"$ref":"#/components/schemas/CreatePaymentMethodAmazonPay"}],"required":["type"],"description":"Payment method information associated with an account."}},"components/schemas/CreateAccountShipToContact":{"id":"components/schemas/CreateAccountShipToContact","kind":"json-schema","title":"ShipToContact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"city":{"description":"City\n","type":"string","maxLength":100},"country":{"description":"Country; must be a valid country name or abbreviation.\n","type":"string"},"county":{"description":"May optionally be used by Zuora Tax to calculate county tax.\n","type":"string","maxLength":100},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"homePhone":{"description":"Home phone number, 40 characters or less.\n","type":"string"},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","type":"string"},"nickname":{"description":"Nickname for this contact\n","type":"string"},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","type":"string"},"otherPhoneType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"personalEmail":{"description":"Personal email address.\n","type":"string","format":"email","maxLength":80},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":100},"taxRegion":{"description":"100 characters or less.\nIf using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n","type":"string","maxLength":100},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"required":["firstName","lastName"],"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for optional ship-to contact; uses the same field structure as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If this field is not specified and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToSameAsBillTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the ship-to contact of the account is empty."},"children":[]}]}]}],"title":"ShipToContact"}},"components/schemas/POSTAccountTypeSoldToContact":{"id":"components/schemas/POSTAccountTypeSoldToContact","kind":"json-schema","title":"soldToContact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"city":{"description":"City\n","type":"string","maxLength":100},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n","type":"string"},"county":{"description":"May optionally be used by Zuora Tax to calculate county tax.\n","type":"string","maxLength":100},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"homePhone":{"description":"Home phone number, 40 characters or less.\n","type":"string"},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","type":"string"},"nickname":{"description":"Nickname for this contact\n","type":"string"},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","type":"string"},"otherPhoneType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"personalEmail":{"description":"Personal email address.\n","type":"string","format":"email","maxLength":80},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State; must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided."},"children":[]}]}]}],"type":"string","maxLength":100},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n","type":"string","maxLength":100},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"required":["firstName","lastName"],"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":"Container for optional sold-to contact; uses the same field structure as the bill-to contact (above). If a sold-to contact is not specified, one is created from the bill-to contact. Once created, these are two separate data entities, and future changes to one do not affect the other.\n","title":"soldToContact"}},"components/schemas/ChargeModelConfigurationType":{"id":"components/schemas/ChargeModelConfigurationType","kind":"json-schema","title":"chargeModelConfiguration","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for charge model configuration data."},"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 only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. These charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"properties":{"customFieldPerUnitRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field that carries the per-unit rate for each usage record. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"perUnitAmount__c"},"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 field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"type":"string"},"customFieldTotalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field that carries the total amount to charge for a usage record. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount__c"},"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 field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"type":"string"},"formula":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pricing formula to calculate actual rating amount for each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"type":"string"}},"title":"chargeModelConfiguration","type":"object","nullable":true}},"components/schemas/POSTTierType":{"id":"components/schemas/POSTTierType","kind":"json-schema","title":"tiers","data":{"properties":{"endingUnit":{"description":"End number of a range of units for the tier.\n","type":"number"},"price":{"description":"Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n","type":"number"},"priceFormat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if pricing is a flat fee or is per unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"FlatFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerUnit"},"children":[]}]}]}]}],"type":"string"},"startingUnit":{"description":"Starting number of a range of units for the tier.\n","type":"number"},"tier":{"description":"Unique number that identifies the tier that the price applies to.\n","format":"int64","type":"integer"}},"required":["tier","price"],"title":"tiers","type":"object"}},"components/schemas/RatePlanChargeObjectCustomFields":{"id":"components/schemas/RatePlanChargeObjectCustomFields","kind":"json-schema","title":"ratePlanChargeFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan Charge object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Rate Plan Charge object.\n","title":"ratePlanChargeFieldsCustom","type":"object"}},"components/schemas/POSTScCreateType":{"id":"components/schemas/POSTScCreateType","kind":"json-schema","title":"chargeOverrides","data":{"allOf":[{"properties":{"amendedByOrderOn":{"description":"The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n","type":"string"},"applyDiscountTo":{"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 charges that you want a specific discount to apply to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"ONETIME"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONETIMERECURRING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONETIMEUSAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRINGUSAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONETIMERECURRINGUSAGE"},"children":[]}]}]}]}],"type":"string"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month the customer is billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]}]}]}],"type":"string"},"billCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to determine the billing day for the charge. When this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. When this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeklyBillCycleDay"},"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":"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":"DefaultFromCustomer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionStartDay"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeTriggerDay"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]}]}]}]}],"type":"string"},"billingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quarter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Semi_Annual"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Annual"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Eighteen_Months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Two_Years"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Three_Years"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Five_Years"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription_Term"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]}]}]}]}],"type":"string"},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aligns charges within the same subscription if multiple charges begin on different dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"AlignToCharge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]}]}]}]}],"type":"string"},"billingTiming":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing timing for the charge for recurring charge types. Not avaliable for one time, usage, and discount charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"IN_ADVANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_ARREARS"},"children":[]}]}]}]}],"type":"string"},"chargeModelConfiguration":{"$ref":"#/components/schemas/ChargeModelConfigurationType"},"description":{"description":"Description of the charge.\n","type":"string"},"discountAmount":{"description":"Specifies the amount of fixed-amount discount.\n","type":"number"},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the discount applies to the product rate plan only, the entire subscription, or to any activity in the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"rateplan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]}]}]}]}],"type":"string"},"discountPercentage":{"description":"Percentage of discount for a percentage discount. \n","type":"number"},"endDateCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Subscription_End"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_End_Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"One_Time"},"children":[]}]}]}]}],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"includedUnits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of units in the base set of units for this charge. Must be >="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price base for the product rate plan charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Per_Billing_Period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Week"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]}]}]}]}],"type":"string"},"number":{"description":"Unique number that identifies the charge. Max 50 characters. System-generated if not provided.\n","type":"string"},"numberOfPeriods":{"description":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model.\n","format":"int64","type":"integer"},"originalOrderDate":{"description":"The date when the rate plan charge is created through an order or amendment. This field is not updatable.\n\nThis field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n","format":"date","type":"string"},"overagePrice":{"description":"Price for units over the allowed amount.\n","type":"number"},"overageUnusedUnitsCreditOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to credit the customer with unused units of usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"NoCredit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditBySpecificRate"},"children":[]}]}]}]}],"type":"string"},"price":{"description":"Price for units in the subscription rate plan.\n","type":"number"},"priceChangeOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies an automatic price change when a termed subscription is renewed. The Billing Admin setting "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable Automatic Price Change When Subscriptions are Renewed?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to Yes to use this field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"NoChange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UseLatestProductCatalogPricing"},"children":[]}]}]}]}],"type":"string"},"priceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PriceChangeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"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":"Value must be a decimal between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"productRatePlanChargeId":{"description":"ID of a product rate-plan charge for this subscription.\n","type":"string"},"productRatePlanChargeNumber":{"description":"Number of a product rate-plan charge for this subscription.\n","type":"string"},"quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of units. Must be a decimal >="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for creating subscriptions with recurring charge types, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be populated when the charge model is \"Tiered Pricing\" or \"Volume Pricing\". It is not required for \"Flat Fee Pricing\" charge model."},"children":[]}]}]}],"type":"number"},"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for per unit, volume pricing, and tiered pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-Time Charges and Recurring Charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string"},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of month or week for the charges billing period. Required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer"},"specificEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends after the charge trigger date."},"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":":"},"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":"This field is only applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_End_Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date."},"children":[]}]}]}]}]}],"format":"date","type":"string"},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer"},"tiers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Volume, Tiered, or Tiered with Overage charge models. Supports the following charge 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":"One-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/POSTTierType"},"type":"array"},"triggerDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge. Required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"UCE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UCA"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]}],"type":"string"},"unusedUnitsCreditRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the rate to credit a customer for unused units of usage. This field applies only for overage charge models when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OverageUnusedUnitsCreditOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditBySpecificRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"upToPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends."},"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":" You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period."},"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":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"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 subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end."},"children":[]}]}]}]}],"format":"int64","type":"integer"},"upToPeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the charge ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Billing_Periods"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Weeks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Years"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"weeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which day of the week is the bill cycle day (BCD) for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Sunday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tuesday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wednesday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Thursday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Friday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Saturday"},"children":[]}]}]}]}],"type":"string"}},"required":["productRatePlanChargeId"],"type":"object"},{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"}],"title":"chargeOverrides"}},"components/schemas/RatePlanObjectCustomFields":{"id":"components/schemas/RatePlanObjectCustomFields","kind":"json-schema","title":"RatePlanCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Rate Plan object.\n","title":"RatePlanCustomFields","type":"object"}},"components/schemas/POSTSrpCreateType":{"id":"components/schemas/POSTSrpCreateType","kind":"json-schema","title":"subscribeToRatePlans","data":{"allOf":[{"properties":{"chargeOverrides":{"description":"This optional container is used to override the quantity of one or more product rate plan charges for this subscription.\n","items":{"$ref":"#/components/schemas/POSTScCreateType"},"type":"array"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"externalIdSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the external source system. You can use this field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a product rate plan that is imported from an external system."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalIdSourceSystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"externallyManagedPlanId":{"description":"Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"productRatePlanId":{"description":"ID of a product rate plan for this subscription.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/RatePlanObjectCustomFields"}],"title":"subscribeToRatePlans"}},"components/schemas/SubscriptionObjectQTFields":{"id":"components/schemas/SubscriptionObjectQTFields","kind":"json-schema","title":"subscriptionFieldsQT","data":{"description":"Container for Subscription fields provided by Zuora Quotes.\n","properties":{"CpqBundleJsonId__QT":{"description":"The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.\n","maxLength":32,"type":"string"},"OpportunityCloseDate__QT":{"description":"The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n","format":"date","type":"string"},"OpportunityName__QT":{"description":"The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n","maxLength":100,"type":"string"},"QuoteBusinessType__QT":{"description":"The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n","maxLength":32,"type":"string"},"QuoteNumber__QT":{"description":"The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n","maxLength":32,"type":"string"},"QuoteType__QT":{"description":"The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n","maxLength":32,"type":"string"}},"title":"subscriptionFieldsQT","type":"object"}},"components/schemas/SubscriptionObjectNSFields":{"id":"components/schemas/SubscriptionObjectNSFields","kind":"json-schema","title":"subscriptionFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Subscription fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"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's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Project__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The NetSuite project that the subscription was created from. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SalesOrder__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The NetSuite sales order than the subscription was created from. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the subscription was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"subscriptionFieldsNS","type":"object"}},"components/schemas/SubscriptionObjectCustomFields":{"id":"components/schemas/SubscriptionObjectCustomFields","kind":"json-schema","title":"subscriptionFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Subscription object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Subscription object.\n","title":"subscriptionFieldsCustom","type":"object"}},"components/schemas/POSTAccountTypeSubscription":{"id":"components/schemas/POSTAccountTypeSubscription","kind":"json-schema","title":"subscription","data":{"allOf":[{"properties":{"autoRenew":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", auto-renew is enabled. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"contractEffectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Effective contract date for this subscription, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"customerAcceptanceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the services or products within a subscription have been accepted by the customer, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"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":"Default value is dependent on the value of other fields. See Notes section for more details."},"children":[]}]}]}],"format":"date","type":"string"},"initialTerm":{"description":"Duration of the initial subscription term in whole months.  Default is 0. \n","format":"int64","type":"integer"},"invoiceOwnerAccountKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice owner account number or ID."},"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"invoiceSeparately":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Separates a single subscription from other subscriptions and invoices the charge independently."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is billed separately from other subscriptions. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is included with other subscriptions in the account invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Prerequisite: The default subscription setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Enable Subscriptions to be Invoiced Separately"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"notes":{"description":"","type":"string"},"renewalTerm":{"description":"Duration of the renewal term in whole months. Default is 0.\n","format":"int64","type":"integer"},"serviceActivationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the services or products within a subscription have been activated and access has been provided to the customer, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"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":"Default value is dependent on the value of other fields. See Notes section for more details."},"children":[]}]}]}],"format":"date","type":"string"},"subscribeToRatePlans":{"description":"Container for one or more rate plans for this subscription.\n","items":{"$ref":"#/components/schemas/POSTSrpCreateType"},"type":"array"},"subscriptionNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Number. The value can be up to 1000 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not specify a subscription number when creating a subscription for the new account, Zuora will generate a subscription number automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the account is created successfully, the subscription number is returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response field."},"children":[]}]}]}],"type":"string"},"termStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the subscription term begins, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this is a renewal subscription, this date is different from the subscription start date."},"children":[]}]}]}],"format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"required":["contractEffectiveDate","termType"],"type":"object"},{"$ref":"#/components/schemas/SubscriptionObjectQTFields"},{"$ref":"#/components/schemas/SubscriptionObjectNSFields"},{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"}],"description":"Container for subscription information, used if creating a subscription for the new account at the time of account creation.\n","title":"subscription"}},"components/schemas/AccountObjectNSFields":{"id":"components/schemas/AccountObjectNSFields","kind":"json-schema","title":"accountFieldsNetSuite","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Account fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"Class__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"CustomerType__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the Customer Type field for the corresponding customer account in NetSuite. The Customer Type field is used when the customer account is created in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Company","Individual"],"type":"string"},"Department__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the Department field for the corresponding customer account in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Location__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Subsidiary__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the Subsidiary field for the corresponding customer account in NetSuite. The Subsidiary field is required if you use NetSuite OneWorld. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the account was sychronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SynctoNetSuite__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Yes","No"],"type":"string"}},"title":"accountFieldsNetSuite","type":"object"}},"components/schemas/AccountObjectCustomFields":{"id":"components/schemas/AccountObjectCustomFields","kind":"json-schema","title":"accountFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Account object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Account object.\n","title":"accountFieldsCustom","type":"object"}},"components/schemas/POSTAccountType":{"id":"components/schemas/POSTAccountType","kind":"json-schema","title":"POSTAccountType","data":{"allOf":[{"properties":{"accountNumber":{"description":"A unique account number, up to 70 characters that do not begin with the default account number prefix.  If no account number is specified, one is generated.\n","type":"string","maxLength":70},"associateCommitmentNumber":{"description":"The number of an existing commitment to re-associate with the account being created.\nWhen specified, the account is validated against the commitment's eligible account\ncondition and associated if eligible. Requires the CommitmentManagement permission.","type":"string","maxLength":255},"additionalEmailAddresses":{"description":"A list of additional email addresses to receive email notifications. Use commas to separate email addresses.\n","items":{"type":"string"},"type":"array"},"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the specified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply to invoices."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply credit memos or unapplied payments, or both to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"applyCreditBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies a credit balance to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit balance is applied to the invoice. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method."},"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":"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 you are using the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"This field is deprecated if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"autoPay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether future payments are to be automatically billed when they are due."},"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 field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hpmCreditCardPaymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can specify neither the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field nor the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hpmCreditCardPaymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}],"type":"boolean"},"batch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The alias name given to a batch. A string of 50 characters or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"less."},"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":": By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=performance-booster-elite","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance Booster Elite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" package."},"children":[]}]}]}],"type":"string"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account's bill cycle day (BCD), when bill runs generate invoices for the account.  Specify any day of the month (1-31, where 31 = end-of-month), or 0 for auto-set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if no subscription will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional if a subscription is created and defaults to the day-of-the-month of the subscription's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contractEffectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer"},"billToContact":{"$ref":"#/components/schemas/POSTAccountTypeBillToContact"},"collect":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the automatic payment is collected. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"196.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile that this account is linked to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can provide either or both of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both are provided, the request will fail if they do not refer to the same communication profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If none is provided, the default communication profile will be used for this account."},"children":[]}]}]}],"type":"string"},"creditCard":{"$ref":"#/components/schemas/POSTAccountTypeCreditCard"},"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"creditMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memo template ID or template number, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b."},"children":[]}]}]}],"type":"string"},"crmId":{"description":"CRM account ID for the account, up to 100 characters.\n","type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A currency as defined in Billing Settings in the Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For payment method authorization, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used. Otherwise, this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used."},"children":[]}]}]}],"type":"string"},"customerServiceRepName":{"description":"Name of the account's customer service representative, if applicable.\n","maxLength":50,"type":"string"},"debitMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The debit memo template ID or template number, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2."},"children":[]}]}]}],"type":"string"},"documentDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the billing document, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos."},"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 field is specified, the specified date is used as the billing document date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, the date specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used as the billing document date."},"children":[]}]}]}]}],"format":"date","type":"string"},"einvoiceProfile":{"$ref":"#/components/schemas/PostAccountEInvoiceProfile"},"eReportingProfile":{"$ref":"#/components/schemas/PostAccountEReportingProfile"},"gatewayId":{"description":"The ID of the payment gateway instance to use.\n","type":"string"},"gatewayRoutingEligible":{"default":false,"description":"Indicates whether to include the applicable billing accounts to gateway routing for controlled adoption. \n","type":"boolean"},"hpmCreditCardPaymentMethodId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment method associated with this account. You can use this field to set the default payment method for the account. The payment method ID specified in this field will be set as the default payment method for this account. You can pass the ID of any valid payment method, including a  system-generated payment method ID, into this field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"autoPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must provide the credit card payment method ID for either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a CC Reference Transaction payment method for an account."},"children":[]}]}]}],"type":"string"},"invoiceDeliveryPrefsEmail":{"default":false,"description":"Whether the customer wants to receive invoices through email. \n","type":"boolean"},"invoiceDeliveryPrefsPrint":{"default":false,"description":"Whether the customer wants to receive printed invoices, such as through postal mail.\n","type":"boolean"},"invoiceTemplateId":{"description":"Invoice template ID or template number, configured in Billing Settings in the Zuora UI.\n","type":"string"},"name":{"description":"Account name, up to 255 characters.\n","type":"string"},"notes":{"description":"A string of up to 65,535 characters.","type":"string"},"organizationLabel":{"description":"Name of the organization that the account belongs to.  \n\nThis field is only required when you have already turned on Multi-Org feature.    \n","type":"string"},"parentAccountNumber":{"description":"Account number of the parent account.\n","maxLength":70,"type":"string"},"parentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}],"type":"string"},"partnerAccount":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer account is a partner, distributor, or reseller."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"paymentGateway":{"description":"The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.\n","type":"string"},"paymentGatewayName":{"description":"The name of the payment gateway instance to use.\n","maxLength":40,"type":"string"},"paymentGatewayNumber":{"description":"The natural key that identifies the payment gateway instance to use.\n","maxLength":40,"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/POSTPaymentMethodRequest"},"paymentMethodId":{"description":"The unique identifier of the payment method.\n","type":"string"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment terms for this account. Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Due Upon Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 90"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you want to specify a payment term when creating a new account, you must set a value in this field. If you do not set a value in this field, Zuora will use the default value set in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Terms"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from Zuora UI."},"children":[]}]}]}],"type":"string"},"profileNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the communication profile that this account is linked to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can provide either or both of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both are provided, the request will fail if they do not refer to the same communication profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If none is provided, the default communication profile will be used for this account."},"children":[]}]}]}],"type":"string"},"purchaseOrderNumber":{"description":"The purchase order number provided by your customer for services, products, or both purchased.","type":"string"},"rollUpUsage":{"description":"Specifies whether usage is rolled up to the parent account.\n","type":"boolean"},"runBilling":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-and-credit-memo-generation-rule"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice and credit memo generation rule"},"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 billing documents generated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this operation is only for this subscription, not for the entire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"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":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No invoice is created."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"196.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"salesRep":{"description":"The name of the sales representative associated with this account, if applicable. Maximum of 50 characters.","type":"string"},"sequenceSetId":{"description":"The ID or number of the billing document sequence set to assign to the customer account. \n\nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\n\nIf a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.\n","type":"string","nullable":true},"shipToContact":{"$ref":"#/components/schemas/CreateAccountShipToContact"},"shipToSameAsBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the ship-to contact and bill-to contact are the same entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The created account has the same bill-to contact and ship-to contact entity only when all the following conditions are met in the request body:"},"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":"This field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"A bill-to contact is specified."},"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":"No ship-to contact is specified."},"children":[]}]}]}]}]}],"type":"boolean"},"soldToContact":{"$ref":"#/components/schemas/POSTAccountTypeSoldToContact"},"soldToSameAsBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the sold-to contact and bill-to contact are the same entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The created account has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:"},"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":"This field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"A bill-to contact is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No sold-to contact is specified."},"children":[]}]}]}]}],"type":"boolean"},"subscription":{"$ref":"#/components/schemas/POSTAccountTypeSubscription"},"summaryStatementTemplateId":{"description":"The summary statement template ID or number. When a user attempts to generate a summary statement from the \"Account Summary Statement\" screen, the system utilizes this template to produce the PDF.\n","type":"string","nullable":true},"tagging":{"description":"","type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"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":"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 credit memo is only available only if you have the Invoice Settlement feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"taxInfo":{"description":"Container for tax exempt information, used to establish the tax exempt status of a customer account.\n","properties":{"VATId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU Value Added Tax ID."},"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"companyCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara."},"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"exemptCertificateId":{"description":"ID of the customer tax exemption certificate. Requires Zuora Tax.\n","type":"string"},"exemptCertificateType":{"description":"Type of tax exemption certificate that the customer holds. Requires Zuora Tax.\n","type":"string"},"exemptDescription":{"description":"Description of the tax exemption certificate that the customer holds. Requires Zuora Tax.\n","type":"string"},"exemptEffectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the customer tax exemption starts. Requires Zuora Tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the current date."},"children":[]}]}]}],"format":"date","type":"string"},"exemptEntityUseCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique entity use code to apply exemptions in Avalara AvaTax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This account-level field is required only when you choose Avalara as your tax engine. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.avalara.com/avatax/handling-tax-exempt-customers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exempt Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more details."},"children":[]}]}]}],"maxLength":64,"type":"string"},"exemptExpirationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the customer tax exemption expires. Requires Zuora Tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the current date."},"children":[]}]}]}],"format":"date","type":"string"},"exemptIssuingJurisdiction":{"description":"Jurisdiction in which the customer tax exemption certificate was issued.\n","type":"string"},"exemptStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account tax exemption. Requires Zuora Tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if you use Zuora Tax. This field is unavailable if Zuora Tax is not used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(default), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pendingVerification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note that the value will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no input."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"required":["name","currency","billToContact"],"type":"object"},{"$ref":"#/components/schemas/AccountObjectNSFields"},{"$ref":"#/components/schemas/AccountObjectCustomFields"}],"example":{"name":"Amy Lawrence","billToContact":{"firstName":"Amy","lastName":"Lawrence","country":"United States","state":"CA"},"autoPay":false,"currency":"USD","billCycleDay":1}}},"components/schemas/ReAssociationResult":{"id":"components/schemas/ReAssociationResult","kind":"json-schema","title":"ReAssociationResult","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result of associating the newly created account with an existing commitment when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"associateCommitmentNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]}],"properties":{"commitmentNumber":{"description":"The commitment number that was associated with the new account.","type":"string"},"accountNumber":{"description":"The account number that was associated with the commitment.","type":"string"},"activated":{"description":"Whether the account was activated as part of the re-association.","type":"boolean"}}}},"components/schemas/POSTAccountResponseType":{"id":"components/schemas/POSTAccountResponseType","kind":"json-schema","title":"POSTAccountResponseType","data":{"properties":{"accountId":{"description":"Auto-generated account ID.\n","type":"string"},"accountNumber":{"description":"Account number.\n","type":"string"},"billToContactId":{"description":"The ID of the bill-to contact.\n","type":"string"},"contractedMrr":{"description":"Contracted monthly recurring revenue of the subscription.\n","format":"decimal","type":"string"},"creditMemoId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memo ID, if a credit memo is generated during the subscription process."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"invoiceId":{"description":"ID of the invoice generated at account creation, if applicable.\n","type":"string"},"paidAmount":{"description":"Amount collected on the invoice generated at account creation, if applicable.\n","format":"decimal","type":"string"},"paymentId":{"description":"ID of the payment collected on the invoice generated at account creation, if applicable.\n","type":"string"},"paymentMethodId":{"description":"ID of the payment method that was set up at account creation, which automatically becomes the default payment method for this account.\n","type":"string"},"reAssociationResult":{"$ref":"#/components/schemas/ReAssociationResult"},"shipToContactId":{"description":"The ID of the ship-to contact.\n","type":"string"},"soldToContactId":{"description":"The ID of the sold-to contact.\n","type":"string"},"subscriptionId":{"description":"ID of the subscription that was set up at account creation, if applicable.\n","type":"string"},"subscriptionNumber":{"description":"Number of the subscription that was set up at account creation, if applicable.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"totalContractedValue":{"description":"Total contracted value of the subscription.\n","format":"decimal","type":"string"}},"type":"object"}},"components/schemas/GETAccountTypeBasicInfo":{"id":"components/schemas/GETAccountTypeBasicInfo","kind":"json-schema","title":"basicInfo","data":{"allOf":[{"properties":{"accountNumber":{"description":"Account number.\n","type":"string"},"batch":{"description":"The alias name given to a batch. A string of 50 characters or less.\n","type":"string"},"communicationProfileId":{"description":"The ID of the communication profile that this account is linked to.","type":"string"},"creditMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the credit memo template, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b."},"children":[]}]}]}],"type":"string"},"crmId":{"description":"CRM account ID for the account, up to 100 characters.\n","type":"string"},"customerServiceRepName":{"description":"Name of the account's customer service representative, if applicable.\n","maxLength":50,"type":"string"},"debitMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the debit memo template, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2."},"children":[]}]}]}],"type":"string"},"defaultPaymentMethodId":{"description":"ID of the default payment method for the account.\n","type":"string","nullable":true},"id":{"description":"Account ID.\n","type":"string"},"invoiceTemplateId":{"description":"Invoice template ID, configured in Billing Settings in the Zuora UI.\n","type":"string","nullable":true},"lastMetricsUpdate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when account metrics are last updated, if the account is a partner account."},"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":":"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Reseller Account feature enabled, and set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an account, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastMetricsUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you ever set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an account, the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastMetricsUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is the time when the account metrics are last updated."},"children":[]}]}]}]}],"type":"string"},"name":{"description":"Account name.\n","type":"string"},"notes":{"description":"Notes associated with the account, up to 65,535 characters.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"parentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}],"type":"string"},"partnerAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer account is a partner, distributor, or reseller."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"profileNumber":{"description":"The number of the communication profile that this account is linked to.","type":"string"},"purchaseOrderNumber":{"description":"The purchase order number provided by your customer for services, products, or both purchased.","type":"string"},"salesRep":{"description":"The name of the sales representative associated with this account, if applicable. Maximum of 50 characters.","type":"string"},"sequenceSetId":{"description":"The ID of the billing document sequence set that is assigned to the customer account. \n","type":"string","nullable":true},"summaryStatementTemplateId":{"description":"The summary statement template ID. When a user attempts to generate a summary statement from the \"Account Summary Statement\" screen, the system utilizes this template to produce the PDF.","type":"string","nullable":true},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account status; possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"tags":{"description":"","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/AccountObjectNSFields"},{"$ref":"#/components/schemas/AccountObjectCustomFields"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for basic information about the account."},"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":"Notes"},"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":"In the \"Retrieve an order\" operation, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription owner account details "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and invoice owner account details "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the \"Retrieve a subscription by key\" operation, the returned result differs based on the following query parameters:"},"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":"getSubscriptionOwnerDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription owner account details "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountOwnerDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response."},"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":"getInvoiceOwnerDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the invoice owner account details "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both query parameters are set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription owner account details "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountOwnerDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and invoice owner account details "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response."},"children":[]}]}]}]}]}]}],"title":"basicInfo"}},"components/schemas/GETAccountTypeBillToContact":{"id":"components/schemas/GETAccountTypeBillToContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"asBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a bill-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asShipTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a ship-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asSoldTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a sold-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"city":{"description":"City\n","type":"string","maxLength":100},"country":{"description":"Full country name. This field does not contain the ISO-standard abbreviation of the country name.\n","type":"string","nullable":true},"county":{"description":"Zuora Tax uses this information to calculate county taxation.          ","type":"string","maxLength":100,"nullable":true},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"homePhone":{"description":"Home phone number, 40 characters or less.\n","type":"string"},"id":{"description":"ID of the person to bill for the account, 32 characters or less.","type":"string"},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","type":"string"},"nickname":{"description":"Nickname for this contact.\n","type":"string"},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","type":"string","nullable":true},"otherPhoneType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"personalEmail":{"description":"Personal email address.\n","type":"string","maxLength":80},"state":{"description":"Full state name. This field does not contain the ISO-standard abbreviation of the state name.\n","type":"string","maxLength":100},"taxRegion":{"description":"A region string, defined in your Zuora tax rules.\n","type":"string","maxLength":100,"nullable":true},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":"Container for bill-to contact information.\n","title":"Contact"}},"components/schemas/GetAccountEInvoiceProfile":{"id":"components/schemas/GetAccountEInvoiceProfile","kind":"json-schema","title":"GetAccountEInvoiceProfile","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for e-invoicing profile information for this account."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"allOf":[{"properties":{"businessCategory":{"description":"The high-level category of the business.\n","type":"string","enum":["B2B","B2C","B2G"]},"businessName":{"description":"The full official name that the Buyer is registered with the relevant legal authority.\n","maxLength":255,"type":"string"},"businessNumber":{"description":"The unique identifier number of the legal entity or person that you do business with.\n\nFor example, you must use a GSTIN for India.\n","type":"string"},"businessNumberSchemeId":{"description":"The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person.\n","type":"string"},"enabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the e-invoicing profile for the customer account is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the following conditions are met, all billing documents for one account can be submitted to an e-invoicing service provider to be generated in electronic format:"},"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 account must be configured to generate e-invoice files for billing documents."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing document must be in Posted status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A business region must be created for the billing country contact, and be linked to an e-invoicing service provider."},"children":[]}]}]}]}],"type":"boolean"},"endpointId":{"description":"The Buyer's electronic address, to which the application-level response to the billing document might be delivered.\n","type":"string"},"endpointSchemeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification scheme identifier of the Buyer’s electronic address."},"children":[]}]}]}],"type":"string"},"taxRegisterNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Buyer's VAT identifier (also known as the Buyer's VAT identification number) or the local identification (defined by the Buyer’s address) of the Buyer for tax purposes, or a reference that enables the Buyer to state the registered tax status."},"children":[]}]}]}],"type":"string"}},"title":"einvoiceProfile","type":"object"},{"$ref":"#/components/schemas/EinvoiceObjectCustomFields"}]}},"components/schemas/GetAccountEReportingProfile":{"id":"components/schemas/GetAccountEReportingProfile","kind":"json-schema","title":"GetAccountEReportingProfile","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for e-reporting profile information for this account."},"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 available only if you have the E-Reporting feature enabled."},"children":[]}]}]}],"allOf":[{"properties":{"businessCategory":{"description":"The high-level category of the business.\n","type":"string","enum":["B2B","B2B_CROSS_BORDER","B2C","B2G","ANY"]},"businessName":{"description":"The full official name that the Buyer is registered with the relevant legal authority.\n","maxLength":255,"type":"string"},"businessNumber":{"description":"The unique identifier number of the legal entity or person that you do business with.\n","maxLength":100,"type":"string"},"businessNumberSchemeId":{"description":"The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person.\n","maxLength":50,"type":"string"},"enabled":{"description":"Whether the e-reporting profile for the customer account is enabled.\n","type":"boolean"},"endpointId":{"description":"The Buyer's electronic address, to which the application-level response to the billing document might be delivered.\n","maxLength":100,"type":"string"},"endpointSchemeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification scheme identifier of the Buyer’s electronic address."},"children":[]}]}]}],"maxLength":50,"type":"string"},"taxRegisterNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Buyer's VAT identifier (also known as the Buyer's VAT identification number) or the local identification (defined by the Buyer’s address) of the Buyer for tax purposes, or a reference that enables the Buyer to state the registered tax status."},"children":[]}]}]}],"maxLength":100,"type":"string"}},"title":"eReportingProfile","type":"object"}]}},"components/schemas/GETAccountCurrencyMetricsType":{"id":"components/schemas/GETAccountCurrencyMetricsType","kind":"json-schema","title":"metricsData","data":{"allOf":[{"properties":{"balance":{"description":"The total balance in this currency.\n","type":"string"},"contractedMrr":{"description":"The future expected Monthly Recurring Revenue (MRR) in this currency, accounting for future upgrades, downgrades, upsells, and cancellations.\n","format":"decimal","type":"string"},"currency":{"description":"The currency that metrics are aggregated based on.\n","type":"string"},"reservedPaymentAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reserved payment amount of the customer account in this currency. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"decimal","type":"string"},"totalDebitMemoBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total balance of all posted debit memos in this currency."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"decimal","type":"string"},"totalInvoiceBalance":{"description":"The total balance of all posted invoices in this currency.\n","format":"decimal","type":"string"},"unappliedCreditMemoAmount":{"description":"The total unapplied amount of all posted credit memos in this currency.\n","format":"decimal","type":"string"},"unappliedPaymentAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total unapplied amount of all posted payments in this currency."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"decimal","type":"string"}},"type":"object"}],"title":"metricsData"}},"components/schemas/GetAccountTypeShipToContact":{"id":"components/schemas/GetAccountTypeShipToContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"asBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a bill-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asShipTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a ship-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asSoldTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a sold-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"city":{"description":"City, 40 characters or less.\n","type":"string"},"country":{"description":"Full country name. This field does not contain the ISO-standard abbreviation of the country name.\n","type":"string","nullable":true},"county":{"description":"County; 32 characters or less. Zuora tax uses this information to calculate county taxation.          ","type":"string"},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"homePhone":{"description":"Home phone number, 40 characters or less.\n","type":"string"},"id":{"description":"ID of the person who bought the subscription associated with the account, 32 characters or less.","type":"string"},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","type":"string"},"nickname":{"description":"Nickname for this contact.\n","type":"string"},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","type":"string"},"otherPhoneType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"personalEmail":{"description":"Personal email address.\n","type":"string","maxLength":80},"state":{"description":"Full state name. This field does not contain the ISO-standard abbreviation of the state name.\n","type":"string"},"taxRegion":{"description":"A region string, defined in your Zuora tax rules.\n","type":"string"},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":"Container for ship-to contact information. Uses the same field structure as billToContact.\n","title":"Contact"}},"components/schemas/GETAccountTypeSoldToContact":{"id":"components/schemas/GETAccountTypeSoldToContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"asBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a bill-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asShipTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a ship-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asSoldTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a sold-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"city":{"description":"City, 40 characters or less.\n","type":"string"},"country":{"description":"Full country name. This field does not contain the ISO-standard abbreviation of the country name.\n","type":"string","nullable":true},"county":{"description":"County; 32 characters or less. Zuora tax uses this information to calculate county taxation.          ","type":"string","nullable":true},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"homePhone":{"description":"Home phone number, 40 characters or less.\n","type":"string"},"id":{"description":"ID of the person who bought the subscription associated with the account, 32 characters or less.","type":"string"},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","type":"string"},"nickname":{"description":"Nickname for this contact.\n","type":"string"},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","type":"string"},"otherPhoneType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"personalEmail":{"description":"Personal email address.\n","type":"string","maxLength":80},"state":{"description":"Full state name. This field does not contain the ISO-standard abbreviation of the state name.\n","type":"string"},"taxRegion":{"description":"A region string, defined in your Zuora tax rules.\n","type":"string","nullable":true},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":"Container for sold-to contact information. Uses the same field structure as billToContact.\n","title":"Contact"}},"components/schemas/GETAccountType":{"id":"components/schemas/GETAccountType","kind":"json-schema","title":"GETAccountType","data":{"properties":{"basicInfo":{"$ref":"#/components/schemas/GETAccountTypeBasicInfo"},"billToContact":{"$ref":"#/components/schemas/GETAccountTypeBillToContact"},"billingAndPayment":{"description":"Container for billing and payment information for the account.","properties":{"additionalEmailAddresses":{"description":"A list of additional email addresses to receive email notifications.\n","items":{"type":"string"},"type":"array"},"autoPay":{"description":"Whether future payments are automatically collected when they are due during a payment run.\n\n","type":"boolean"},"billCycleDay":{"description":"Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.\n","format":"int64","type":"integer"},"bcdSettingOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill cycle day setting option. Indicates whether the account’s bill cycle day is managed manually or automatically."},"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":"ManualSet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The bill cycle day is explicitly set to a specific day of the month (1–31)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AutoSet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The bill cycle day is automatically determined by Zuora. The bill cycle day is assigned when the first subscription is created for the account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is system-derived and read-only. Its value is automatically determined based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string","enum":["ManualSet","AutoSet"]},"currency":{"description":"A currency defined in the web-based UI administrative settings.\n","type":"string"},"defaultPaymentMethodId":{"description":"ID of the default payment method for the account.\n","type":"string"},"invoiceDeliveryPrefsEmail":{"description":"Whether the customer wants to receive invoices through email. \n","type":"boolean"},"invoiceDeliveryPrefsPrint":{"description":"Whether the customer wants to receive printed invoices, such as through postal mail.\n","type":"boolean"},"paymentMethodCascadingConsent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent from your customer to use the Cascading Payment Method feature was collected."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent was not collected and the Cascading Payment Method feature is not enabled."},"children":[]}]}]}],"type":"boolean"},"paymentGateway":{"description":"The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.\n","type":"string"},"paymentTerm":{"description":"A payment-terms indicator defined in the web-based UI administrative settings, e.g., \"Net 30\".\n","type":"string"}},"type":"object"},"einvoiceProfile":{"$ref":"#/components/schemas/GetAccountEInvoiceProfile"},"eReportingProfile":{"$ref":"#/components/schemas/GetAccountEReportingProfile"},"gatewayRoutingEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the applicable billing accounts were was processed successfully for gateway routing ."},"children":[]}]}]}],"type":"boolean"},"metrics":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for account metrics of the account's default currency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metricsData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field provides account metrics of different currencies."},"children":[]}]}]}],"properties":{"balance":{"description":"The customer's total invoice balance minus credit balance.\n","format":"decimal","type":"string"},"contractedMrr":{"description":"Future expected MRR that accounts for future upgrades, downgrades, upsells and cancellations.\n","format":"decimal","type":"string"},"creditBalance":{"description":"Current credit balance.\n","format":"decimal","type":"string"},"reservedPaymentAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Reserved Payment Amount of the customer account. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"float","type":"number"},"totalDebitMemoBalance":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total balance of all posted debit memos."},"children":[]}]}]}],"format":"decimal","type":"string"},"totalInvoiceBalance":{"description":"Total balance of all posted invoices.\n","format":"decimal","type":"string"},"unappliedCreditMemoAmount":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total unapplied amount of all posted credit memos."},"children":[]}]}]}],"format":"decimal","type":"string"},"unappliedPaymentAmount":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total unapplied amount of all posted payments."},"children":[]}]}]}],"format":"decimal","type":"string"}},"type":"object"},"metricsData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for account metrics of different currencies."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/GETAccountCurrencyMetricsType"},"type":"array"},"shipToContact":{"$ref":"#/components/schemas/GetAccountTypeShipToContact"},"soldToContact":{"$ref":"#/components/schemas/GETAccountTypeSoldToContact"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"taxInfo":{"description":"Container for tax exempt information, used to establish the tax exempt status of a customer account.\n","properties":{"VATId":{"description":"EU Value Added Tax ID.\n","type":"string"},"companyCode":{"description":"Unique code that identifies a company account in Avalara.\n","type":"string"},"exemptCertificateId":{"description":"ID of the customer tax exemption certificate.\n","type":"string"},"exemptCertificateType":{"description":"Type of tax exemption certificate that the customer holds.\n","type":"string"},"exemptDescription":{"description":"Description of the tax exemption certificate that the customer holds.\n","type":"string"},"exemptEffectiveDate":{"description":"Date when the customer tax exemption starts.\n","format":"date","type":"string"},"exemptEntityUseCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique entity use code to apply exemptions in Avalara AvaTax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This account-level field is required only when you choose Avalara as your tax engine. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.avalara.com/avatax/handling-tax-exempt-customers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exempt Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more details."},"children":[]}]}]}],"maxLength":64,"type":"string"},"exemptExpirationDate":{"description":"Date when the customer tax exemption expires.\n","format":"date","type":"string"},"exemptIssuingJurisdiction":{"description":"Jurisdiction in which the customer tax exemption certificate was issued.\n","type":"string"},"exemptStatus":{"description":"Status of the account tax exemption.\n","type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/PUTAccountTypeBillToContact":{"id":"components/schemas/PUTAccountTypeBillToContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"city":{"description":"City\n","type":"string","maxLength":100},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n","type":"string"},"county":{"description":"May optionally be used by Zuora Tax to calculate county tax.\n","type":"string","maxLength":100},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"homePhone":{"description":"Home phone number, 40 characters or less.\n","type":"string"},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","type":"string"},"nickname":{"description":"Nickname for this contact\n","type":"string"},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","type":"string"},"otherPhoneType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"personalEmail":{"description":"Personal email address.\n","type":"string","format":"email","maxLength":80},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State; must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided."},"children":[]}]}]}],"type":"string","maxLength":100},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n","type":"string","maxLength":100},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":"Container for bill-to contact information for this account.\n","title":"Contact"}},"components/schemas/PUTAccountEinvoiceProfile":{"id":"components/schemas/PUTAccountEinvoiceProfile","kind":"json-schema","title":"einvoiceProfile","data":{"allOf":[{"properties":{"businessCategory":{"description":"The high-level category of the business.\n","type":"string","enum":["B2B","B2C","B2G"]},"businessName":{"description":"Legal Business Name. The full formal name by which the Buyer is registered with the relevant legal authority. ","maxLength":255,"type":"string"},"businessNumber":{"description":"Buyer legal registration identifier. An identifier issued by an official registrar that identifies the Buyer as a legal entity or person. GSTIN of buyer for India. ","type":"string"},"businessNumberSchemeId":{"description":"Business Number Schema Id. The identification scheme identifier of the Buyer legal registration identifier. ","type":"string"},"enabled":{"description":"Enable e-invoice for the account. All invoices generated from this account can be submitted to generate e-invoices when invoices meet the conditions: A business region must be created for the billing country contact, and it must be linked to a service provider. The account must be enabled to generate e-invoices. The invoice must be in the \"Posted\" status. ","type":"boolean"},"endpointId":{"description":"Buyer electronic address.Identifies the Buyer's electronic address to which the invoice is delivered.\n","type":"string"},"endpointSchemeId":{"description":"Buyer electronic address identification scheme identifier. ","type":"string"},"taxRegisterNumber":{"description":"Buyer VAT identifier. The Buyer's VAT identifier (also known as Buyer VAT identification number).\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/EinvoiceObjectCustomFields"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for profile information for this account."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"title":"einvoiceProfile"}},"components/schemas/PUTAccountEReportingProfile":{"id":"components/schemas/PUTAccountEReportingProfile","kind":"json-schema","title":"eReportingProfile","data":{"allOf":[{"properties":{"businessCategory":{"description":"The high-level category of the business.\n","type":"string","enum":["B2B","B2B_CROSS_BORDER","B2C","B2G","ANY"]},"businessName":{"description":"The full official name that the Buyer is registered with the relevant legal authority.\n","maxLength":255,"type":"string"},"businessNumber":{"description":"The unique identifier number of the legal entity or person that you do business with.\n","maxLength":100,"type":"string"},"businessNumberSchemeId":{"description":"The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person.\n","maxLength":50,"type":"string"},"enabled":{"description":"Whether to enable the e-reporting profile for the customer account.\n","type":"boolean"},"endpointId":{"description":"The Buyer's electronic address, to which the application-level response to the billing document might be delivered.\n","maxLength":100,"type":"string"},"endpointSchemeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification scheme identifier of the Buyer’s electronic address."},"children":[]}]}]}],"maxLength":50,"type":"string"},"taxRegisterNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Buyer's VAT identifier (also known as the Buyer's VAT identification number) or the local identification (defined by the Buyer’s address) of the Buyer for tax purposes, or a reference that enables the Buyer to state the registered tax status."},"children":[]}]}]}],"maxLength":100,"type":"string"}},"type":"object"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for e-reporting profile information for this account."},"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 available only if you have the E-Reporting feature enabled."},"children":[]}]}]}],"title":"eReportingProfile"}},"components/schemas/UpdateAccountShipToContact":{"id":"components/schemas/UpdateAccountShipToContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"city":{"description":"City\n","type":"string","maxLength":100},"country":{"description":"Country; must be a valid country name or abbreviation.\n","type":"string"},"county":{"description":"May optionally be used by Zuora Tax to calculate county tax.\n","type":"string","maxLength":100},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"homePhone":{"description":"Home phone number, 40 characters or less.\n","type":"string"},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","type":"string"},"nickname":{"description":"Nickname for this contact\n","type":"string"},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","type":"string"},"otherPhoneType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"personalEmail":{"description":"Personal email address.\n","type":"string","format":"email","maxLength":80},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State; must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":100},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n","type":"string","maxLength":100},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":"Container for optional ship-to contact.\n","title":"Contact"}},"components/schemas/PUTAccountTypeSoldToContact":{"id":"components/schemas/PUTAccountTypeSoldToContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"city":{"description":"City, 100 characters or less.\n","type":"string"},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n","type":"string"},"county":{"description":"County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax.\n","type":"string"},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"homePhone":{"description":"Home phone number, 40 characters or less.\n","type":"string"},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","type":"string"},"nickname":{"description":"Nickname for this contact\n","type":"string"},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","type":"string"},"otherPhoneType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"personalEmail":{"description":"Personal email address.\n","type":"string","format":"email","maxLength":80},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100 characters or less."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State; must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If using Zuora Tax, be aware that Zuora Tax  requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided."},"children":[]}]}]}],"type":"string"},"taxRegion":{"description":"100 characters or less.\nIf using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n","type":"string"},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":"Container for optional sold-to contact.\n","title":"Contact"}},"components/schemas/PUTAccountType":{"id":"components/schemas/PUTAccountType","kind":"json-schema","title":"PUTAccountType","data":{"allOf":[{"properties":{"additionalEmailAddresses":{"description":"A list of additional email addresses to receive email notifications. Use commas to separate email addresses.\n","items":{"type":"string"},"type":"array"},"autoPay":{"description":"Whether future payments are to be automatically billed when they are due. \n","type":"boolean"},"batch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The alias name given to a batch. A string of 50 characters or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"less."},"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":": By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=performance-booster-elite","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance Booster Elite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" package."},"children":[]}]}]}],"type":"string"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the bill cycle day (BCD) for the charge. The BCD determines"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which day of the month the customer is billed. Values: Any activated system-defined bill cycle day （"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"）"},"children":[]}]}]}],"maxLength":2,"type":"integer"},"billToContact":{"$ref":"#/components/schemas/PUTAccountTypeBillToContact"},"billToContactId":{"description":"The ID of a contact that will be the bill-to contact of the current account. \n","type":"string"},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile that this account is linked to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can provide either or both of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both are provided, the request will fail if they do not refer to the same communication profile."},"children":[]}]}]}],"type":"string"},"creditMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memo template ID or template number, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b."},"children":[]}]}]}],"type":"string"},"crmId":{"description":"CRM account ID for the account, up to 100 characters.\n","type":"string"},"customerServiceRepName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the account’s customer service representative, if applicable."},"children":[]}]}]}],"maxLength":50,"type":"string"},"debitMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The debit memo template ID or template number, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2."},"children":[]}]}]}],"type":"string"},"defaultPaymentMethodId":{"description":"ID of the default payment method for the account.\n\nValues: a valid ID for an existing payment method.\n","maxLength":64,"type":"string"},"einvoiceProfile":{"$ref":"#/components/schemas/PUTAccountEinvoiceProfile"},"eReportingProfile":{"$ref":"#/components/schemas/PUTAccountEReportingProfile"},"gatewayRoutingEligible":{"default":false,"description":"Indicates whether to include the applicable billing accounts to gateway routing for controlled adoption. \n","type":"boolean"},"invoiceDeliveryPrefsEmail":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer wants to receive invoices through email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"invoiceDeliveryPrefsPrint":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer wants to receive printed invoices, such as through postal mail."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"invoiceTemplateId":{"description":"Invoice template ID, configured in Billing Settings in the Zuora UI.\n","type":"string"},"name":{"description":"Account name, up to 255 characters.\n","type":"string"},"notes":{"description":"A string of up to 65,535 characters.\n","type":"string"},"parentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}],"type":"string"},"partnerAccount":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer account is a partner, distributor, or reseller."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"paymentGateway":{"description":"The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.\n","type":"string"},"paymentGatewayNumber":{"description":"The natural key that identifies the payment gateway instance to use.\n","maxLength":40,"type":"string"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment terms for this account. Possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Due Upon Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 90"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"profileNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the communication profile that this account is linked to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can provide either or both of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both are provided, the request will fail if they do not refer to the same communication profile."},"children":[]}]}]}],"type":"string"},"purchaseOrderNumber":{"description":"The purchase order number provided by your customer for services, products, or both purchased.","type":"string"},"rollUpUsage":{"description":"Specifies whether usage is rolled up to the parent account.","type":"boolean"},"salesRep":{"description":"The name of the sales representative associated with this account, if applicable. Maximum of 50 characters.","type":"string"},"sequenceSetId":{"description":"The billing document sequence set ID or number to assign to the customer account.\n\nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\n\nIf a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.\n","type":"string","nullable":true},"shipToContact":{"$ref":"#/components/schemas/UpdateAccountShipToContact"},"shipToContactId":{"description":"The ID of a contact that will be the ship-to contact of the current account.\n","type":"string"},"soldToContact":{"$ref":"#/components/schemas/PUTAccountTypeSoldToContact"},"soldToContactId":{"description":"The ID of a contact that will be the sold-to contact of the current account. \n","type":"string"},"tagging":{"description":"","type":"string"},"summaryStatementTemplateId":{"description":"The summary statement template ID or number. When a user attempts to generate a summary statement from the \"Account Summary Statement\" screen, the system utilizes this template to produce the PDF.\n","type":"string","nullable":true},"taxInfo":{"description":"Container for tax exempt information, used to establish the tax exempt status of a customer account.\n","properties":{"VATId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU Value Added Tax ID."},"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"companyCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara."},"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"exemptCertificateId":{"description":"ID of the customer tax exemption certificate. Requires Zuora Tax.\n","type":"string"},"exemptCertificateType":{"description":"Type of tax exemption certificate that the customer holds. Requires Zuora Tax.\n","type":"string"},"exemptDescription":{"description":"Description of the tax exemption certificate that the customer holds. Requires Zuora Tax.\n","type":"string"},"exemptEffectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the customer tax exemption starts. Requires Zuora Tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the current date."},"children":[]}]}]}],"format":"date","type":"string"},"exemptEntityUseCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique entity use code to apply exemptions in Avalara AvaTax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This account-level field is required only when you choose Avalara as your tax engine. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.avalara.com/avatax/handling-tax-exempt-customers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exempt Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more details."},"children":[]}]}]}],"maxLength":64,"type":"string"},"exemptExpirationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the customer tax exemption expires. Requires Zuora Tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the current date."},"children":[]}]}]}],"format":"date","type":"string"},"exemptIssuingJurisdiction":{"description":"Jurisdiction in which the customer tax exemption certificate was issued.\n","type":"string"},"exemptStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the account tax exemption. Requires Zuora Tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if you use Zuora Tax. This field is unavailable if Zuora Tax is not used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(default), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pendingVerification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note that the value will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no input."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/AccountObjectNSFields"},{"$ref":"#/components/schemas/AccountObjectCustomFields"}],"example":{"billCycleDay":1}}},"components/schemas/DeleteAccountResponseType":{"id":"components/schemas/DeleteAccountResponseType","kind":"json-schema","title":"DeleteAccountResponseType","data":{"properties":{"id":{"description":"The ID of the deleted account.\n","type":"string"},"jobId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the job that handles the account deletion operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify the value of this field as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_OperationJob/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an operation job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API operation to query job information."},"children":[]}]}]}],"type":"string"},"jobStatus":{"description":"The status of the account deletion operation. \n","enum":["Pending"],"type":"string"},"reasons":{"items":{"properties":{"code":{"description":"The error code of the response.\n","type":"string"},"message":{"description":"The detail information of the error response.\n","type":"string"}},"type":"object"},"type":"array"},"success":{"description":"Whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/GETAccountPMAccountHolderInfo":{"id":"components/schemas/GETAccountPMAccountHolderInfo","kind":"json-schema","title":"accountHolderInfo","data":{"description":"The account holder information.\n","properties":{"accountHolderName":{"description":"The full name of the account holder.\n","maxLength":60,"type":"string"},"addressLine1":{"description":"The first line of the address for the account holder.\n","type":"string"},"addressLine2":{"description":"The second line of the address for the account holder. \n","type":"string"},"city":{"description":"The city where the account holder stays. \n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country where the account holder stays."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected. Regardless of the country texts selected when creating the payment method, only the supported country name returns in this field. For a complete list of supported country names, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Internationalization is not supported for the API field value."},"children":[]}]}]}],"type":"string","nullable":true},"email":{"description":"The email address of the account holder.\n","type":"string"},"phone":{"description":"The phone number of the account holder.\n","type":"string"},"state":{"description":"The state where the account holder stays.\n","type":"string"},"zipCode":{"description":"The zip code for the address of the account holder.\n","type":"string"}},"title":"accountHolderInfo","type":"object"}},"components/schemas/POSTAccountPMMandateInfo":{"id":"components/schemas/POSTAccountPMMandateInfo","kind":"json-schema","title":"mandateInfo","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following mandate fields are common to all supported payment methods:"},"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":"mandateId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandateReason"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandateStatus"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following mandate fields are specific to the ACH and Bank Transfer payment methods:"},"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":"mandateReceivedStatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingMandateStatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandateCreationDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandateUpdateDate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following mandate fields are specific to the Credit Card, Apple Pay, and Google Pay payment methods:"},"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":"mitTransactionId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAgreedOn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitConsentAgreementRef"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitConsentAgreementSrc"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileType"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]}]}]}]}],"properties":{"existingMandateStatus":{"description":"Indicates whether the mandate is an existing mandate.\n","enum":["Yes","No"],"type":"string"},"mandateCreationDate":{"description":"The date on which the mandate was created.\n","format":"date","type":"string"},"mandateId":{"description":"The mandate ID.\n","type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","type":"string"},"mandateReceivedStatus":{"description":"Indicates whether the mandate is received from the gateway\n","enum":["Yes","No"],"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","type":"string"},"mandateUpdateDate":{"description":"The date on which the mandate was updated.\n","format":"date","type":"string"},"mitConsentAgreementRef":{"description":"Reference for the consent agreement that you have established with the customer.  \n","type":"string","nullable":true},"mitConsentAgreementSrc":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Specify how the consent agreement has been established with the customer. The allowed value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["External"],"type":"string","nullable":true},"mitProfileAction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora creates and activates the stored credential profile. Only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the CIT does not succeed, Zuora will not create a stored credential profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Agreed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Persist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"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 you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["Activate","Persist"],"type":"string","nullable":true},"mitProfileAgreedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the stored credential profile is agreed. The date format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"mitProfileType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the type of the stored credential profile. If you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"type":"string","nullable":true},"mitTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the ID of the transaction. Only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Persist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":128,"type":"string","nullable":true}},"title":"mandateInfo","type":"object"}},"components/schemas/PaymentMethodObjectCustomFieldsForAccount":{"id":"components/schemas/PaymentMethodObjectCustomFieldsForAccount","kind":"json-schema","title":"paymentMethodFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the payment method. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a payment method object.\n","title":"paymentMethodFieldsCustom","type":"object"}},"components/schemas/GETPaymentMethodResponseBankTransferForAccount":{"id":"components/schemas/GETPaymentMethodResponseBankTransferForAccount","kind":"json-schema","title":"GETPaymentMethodResponseBankTransferForAccount","data":{"properties":{"IBAN":{"description":"The International Bank Account Number used to create the SEPA payment method. The value is masked.\n","type":"string"},"accountNumber":{"description":"The number of the customer's bank account and it is masked.\n","type":"string"},"bankCode":{"description":"The sort code or number that identifies the bank. This is also known as the sort code.         \n","type":"string"},"bankTransferType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the Bank Transfer payment method. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"branchCode":{"description":"The branch code of the bank used for Direct Debit.\n","type":"string"},"businessIdentificationCode":{"description":"The BIC code used for SEPA. The value is masked.       \n","type":"string"},"identityNumber":{"description":"The identity number of the account holder or the cardholder.\n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponseACHForAccount":{"id":"components/schemas/GETPaymentMethodResponseACHForAccount","kind":"json-schema","title":"GETPaymentMethodResponseACHForAccount","data":{"properties":{"bankABACode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nine-digit routing number or ABA number used by banks. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"bankAccountName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the account holder, which can be either a person or a company. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponseCreditCardForAccount":{"id":"components/schemas/GETPaymentMethodResponseCreditCardForAccount","kind":"json-schema","title":"GETPaymentMethodResponseCreditCardForAccount","data":{"properties":{"cardNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked credit card number."},"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":"cardNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the following fields will not be returned:"},"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":"expirationMonth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expirationYear"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderInfo"},"children":[]}]}]}]}],"type":"string"},"expirationMonth":{"description":"One or two digits expiration month (1-12).\n","type":"integer"},"expirationYear":{"description":"Four-digit expiration year.\n","type":"integer"},"securityCode":{"description":"The CVV or CVV2 security code for the credit card or debit card.\n            Only required if changing expirationMonth, expirationYear, or cardHolderName.\n            To ensure PCI compliance, this value isn''t stored and can''t be queried. \n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponsePayPalForAccount":{"id":"components/schemas/GETPaymentMethodResponsePayPalForAccount","kind":"json-schema","title":"GETPaymentMethodResponsePayPalForAccount","data":{"properties":{"BAID":{"description":"ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.\n","type":"string"},"email":{"description":"Email address associated with the PayPal payment method. \n","type":"string"},"preapprovalKey":{"description":"The PayPal preapproval key.                \n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponseGooglePayForAccount":{"id":"components/schemas/GETPaymentMethodResponseGooglePayForAccount","kind":"json-schema","title":"GETPaymentMethodResponseGooglePayForAccount","data":{"properties":{"googleBIN":{"description":"This field is only available for Google Pay payment methods.\n","type":"string"},"googleCardNumber":{"description":"This field is only available for Google Pay payment methods.\n","type":"string"},"googleCardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for Google Pay payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Google Pay payment methods on Adyen, the first 100 characters of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.adyen.com/development-resources/paymentmethodvariant"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentMethodVariant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned from Adyen are stored in this field."},"children":[]}]}]}],"type":"string"},"googleExpiryDate":{"description":"This field is only available for Google Pay payment methods.\n","type":"string"},"googleGatewayToken":{"description":"This field is only available for Google Pay payment methods.\n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponseApplePayForAccount":{"id":"components/schemas/GETPaymentMethodResponseApplePayForAccount","kind":"json-schema","title":"GETPaymentMethodResponseApplePayForAccount","data":{"properties":{"appleBIN":{"description":"This field is only available for Apple Pay payment methods.\n","type":"string"},"appleCardNumber":{"description":"This field is only available for Apple Pay payment methods.\n","type":"string"},"appleCardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for Apple Pay payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Apple Pay payment methods on Adyen, the first 100 characters of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.adyen.com/development-resources/paymentmethodvariant"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentMethodVariant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned from Adyen are stored in this field."},"children":[]}]}]}],"type":"string"},"appleExpiryDate":{"description":"This field is only available for Apple Pay payment methods.\n","type":"string"},"appleGatewayToken":{"description":"This field is only available for Apple Pay payment methods.\n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponseForAccount":{"id":"components/schemas/GETPaymentMethodResponseForAccount","kind":"json-schema","title":"GETPaymentMethodResponseForAccount","data":{"allOf":[{"properties":{"accountHolderInfo":{"$ref":"#/components/schemas/GETAccountPMAccountHolderInfo"},"accountVerificationService":{"description":"Displays the name of the service provider. For example, Plaid.\n","type":"string"},"accountVerificationStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the status of the account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access token is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access token has expired and must be linked again."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expiring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access token will expire in few days(7 days for Plaid) and must be linked again"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The end customer has revoked the account pemission. The end customer can login again and select the same method for the access token to be linked again."},"children":[]}]}]}]}],"enum":["Active","Expired","Expiring","Inactive"],"type":"string"},"bankIdentificationNumber":{"description":"The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method.\n","type":"string"},"createdBy":{"description":"ID of the user who created this payment method.","type":"string"},"createdOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment method was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"cardNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked credit card number, such as:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"*********1112\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"*********1112\n"},"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 only returned for Credit Card Reference Transaction payment type."},"children":[]}]}]}],"type":"string"},"creditCardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the credit card or debit card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JCB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Diners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about credit card types supported by different payment gateways, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Payment Gateways"},"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":"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 only returned for the Credit Card and Debit Card payment types."},"children":[]}]}]}],"type":"string"},"deviceSessionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The session ID of the user when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created or updated."},"children":[]}]}]}],"type":"string","nullable":true},"existingMandate":{"description":"Indicates whether the mandate is an existing mandate.\n","enum":["Yes","No"],"type":"string","nullable":true},"id":{"description":"The payment method ID.\n","type":"string"},"ipAddress":{"description":"The IP address of the user when the payment method was created or updated.\n","type":"string","nullable":true},"isDefault":{"description":"Indicates whether this payment method is the default payment method for the account.\n","type":"boolean"},"lastFailedSaleTransactionDate":{"description":"The date of the last failed attempt to collect payment with this payment method.\n","type":"string","nullable":true},"lastTransaction":{"description":"Indicates the occurrence and status of the last transaction.","type":"string"},"lastTransactionTime":{"description":"The time when the last transaction of this payment method happened.","format":"date-time","type":"string"},"mandateInfo":{"$ref":"#/components/schemas/POSTAccountPMMandateInfo"},"maxConsecutivePaymentFailures":{"description":"The number of allowable consecutive failures Zuora attempts with the payment method before stopping.\n","type":"integer","nullable":true},"numConsecutiveFailures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of consecutive failed payments for this payment method. It is reset to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" upon successful payment."},"children":[]}]}]}],"format":"int32","type":"integer"},"paymentRetryWindow":{"description":"The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.\n","type":"integer","nullable":true},"secondTokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A gateway unique identifier that replaces sensitive payment method data."},"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 only returned for the Credit Card Reference Transaction payment type."},"children":[]}]}]}],"type":"string"},"status":{"description":"The status of the payment method.\n","enum":["Active","Closed","Scrubbed"],"type":"string"},"tokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile."},"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 only returned for the Credit Card Reference Transaction payment type."},"children":[]}]}]}],"type":"string"},"totalNumberOfErrorPayments":{"description":"The number of error payments that used this payment method.\n","format":"int32","type":"integer"},"totalNumberOfProcessedPayments":{"description":"The number of successful payments that used this payment method.\n","format":"int32","type":"integer"},"type":{"description":"The type of the payment method.\n","type":"string","enum":["CreditCard","CreditCardReferenceTransaction","ACH","SEPA","Betalingsservice","Autogiro","Bacs","Becs","Becsnz","PAD","PayPalCP","PayPalEC","PayPalNativeEC","PayPalAdaptive","AdyenApplePay","AdyenGooglePay","GooglePay"]},"updatedBy":{"description":"ID of the user who made the last update to this payment method.","type":"string"},"updatedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last date and time when the payment method was updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"useDefaultRetryRule":{"description":"Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.\n","type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFieldsForAccount"},{"$ref":"#/components/schemas/GETPaymentMethodResponseBankTransferForAccount"},{"$ref":"#/components/schemas/GETPaymentMethodResponseACHForAccount"},{"$ref":"#/components/schemas/GETPaymentMethodResponseCreditCardForAccount"},{"$ref":"#/components/schemas/GETPaymentMethodResponsePayPalForAccount"},{"$ref":"#/components/schemas/GETPaymentMethodResponseGooglePayForAccount"},{"$ref":"#/components/schemas/GETPaymentMethodResponseApplePayForAccount"}]}},"components/schemas/CustomAccountPaymentMethod":{"id":"components/schemas/CustomAccountPaymentMethod","kind":"json-schema","title":"CustomPaymentMethod","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for custom payment methods created through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-specialized-payment-connections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open Payment Method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" service."},"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 response could return more than one custom payment methods."},"children":[]}]}]}],"title":"Custom Payment Method","type":"object"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for custom payment methods created through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-specialized-payment-connections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open Payment Method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" service."},"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 response could return more than one custom payment methods."},"children":[]}]}]}],"title":"CustomPaymentMethod","type":"object"}},"components/schemas/GETAccountPaymentMethodType":{"id":"components/schemas/GETAccountPaymentMethodType","kind":"json-schema","title":"GETAccountPaymentMethodType","data":{"allOf":[{"properties":{"defaultPaymentMethodId":{"description":"ID of the default payment method for the account.\n","type":"string"},"paymentGateway":{"description":"The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.\n","type":"string","nullable":true},"returnedPaymentMethodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for a specific type of payment method on the customer account. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditcard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debitcard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditcardreferencetransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc. Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnedPaymentMethodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array contains one or more payment methods of that payment method type."},"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 response could return more than one payment method type arrays. See "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response samples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as an example."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/GETPaymentMethodResponseForAccount"},"title":"Payment Method Type","type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/CustomAccountPaymentMethod"}]}},"components/schemas/GetCascadingPaymentMethodsConfigurationResponse":{"id":"components/schemas/GetCascadingPaymentMethodsConfigurationResponse","kind":"json-schema","title":"GetCascadingPaymentMethodsConfigurationResponse","data":{"properties":{"consent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent from your customer to use the Cascading Payment Method feature was collected. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent was not collected and the Cascading Payment Method feature is not enabled."},"children":[]}]}]}]},"priorities":{"type":"array","description":"Container for the priority configuration of payment methods. \n","items":{"type":"object","properties":{"paymentMethodId":{"type":"string","description":"The ID of a payment method.\n","nullable":true},"order":{"type":"integer","minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order of the payment method in the priority list. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the payment method is the first one in the priority list, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates it is the second."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first payment method in the priority list is the default payment method of the customer account."},"children":[]}]}]}]}}},"title":"priority"},"success":{"type":"boolean","description":"Indicates whether the call succeeded.\n"}},"type":"object"}},"components/schemas/PutCascadingPaymentMethodsConfigurationRequest":{"id":"components/schemas/PutCascadingPaymentMethodsConfigurationRequest","kind":"json-schema","title":"PutCascadingPaymentMethodsConfigurationRequest","data":{"properties":{"consent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that you have collected consent from your customer to use the Cascading Payment Method feature. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent was not collected and the Cascading Payment Method feature is not enabled."},"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":"priorities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field can be specified only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent"},"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":[]}]}]}]},"priorities":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the priority configuration of payment methods. You can add up to three payment methods to this container. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-cascade-payment-methods","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cascade payment methods"},"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":"code","inline":true,"attributes":{"content":"priorities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent"},"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":[]}]}]}],"items":{"type":"object","properties":{"paymentMethodId":{"type":"string","description":"The ID of a payment method.\n"},"order":{"type":"integer","minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order of the payment method in the priority list. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the payment method is the first one in the priority list, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates it is the second."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first payment method in the priority list will be the default payment method of the customer account."},"children":[]}]}]}]}},"required":["paymentMethodId","order"]},"title":"priority"}},"type":"object","example":{"consent":true,"priorities":[{"paymentMethodId":"2c92c0f95be68649015bf14e001f2760","order":1},{"paymentMethodId":"2c92c0f95be68649015bf14e001f2761","order":2},{"paymentMethodId":"2c92c0f95be68649015bf14e001f2762","order":3}]}}},"components/schemas/GETAccountSummaryTypeBasicInfo":{"id":"components/schemas/GETAccountSummaryTypeBasicInfo","kind":"json-schema","title":"basicInfo","data":{"allOf":[{"properties":{"accountNumber":{"description":"Account number.\n","type":"string"},"additionalEmailAddresses":{"description":"A list of additional email addresses to receive email notifications.\n","items":{"type":"string"},"type":"array"},"autoPay":{"description":"Whether future payments are automatically collected when they are due during a payment run.\n","type":"boolean"},"balance":{"description":"Current outstanding balance.\n","format":"decimal","type":"string"},"batch":{"description":"The alias name given to a batch. A string of 50 characters or less.\n","type":"string"},"billCycleDay":{"description":"Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.\n","type":"string"},"bcdSettingOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill cycle day setting option. Indicates whether the account’s bill cycle day is managed manually or automatically."},"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":"ManualSet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The bill cycle day is explicitly set to a specific day of the month (1–31)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AutoSet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The bill cycle day is automatically determined by Zuora. The bill cycle day is assigned when the first subscription is created for the account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is system-derived and read-only. Its value is automatically determined based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string","enum":["ManualSet","AutoSet"]},"currency":{"description":"A currency as defined in Billing Settings in the Zuora UI.\n","type":"string"},"defaultPaymentMethod":{"description":"Information of the default payment method for the account.\n","properties":{"creditCardExpirationMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-digit numeric card expiration month as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"creditCardExpirationYear":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Four-digit card expiration year as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"creditCardNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit card number, 16 characters or less, displayed in masked format (e.g., ************1234)."},"children":[]}]}]}],"type":"string"},"creditCardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the credit card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values  include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JCB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Diners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about credit card types supported by different payment gateways, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Payment Methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"id":{"description":"ID of the default payment method associated with this account.\n","type":"string"},"paymentMethodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the payment method. For non-Credit-Card payment methods, only the "},"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":"paymentMethodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are returned."},"children":[]}]}]}],"type":"string","enum":["CreditCard","CreditCardReferenceTransaction","ACH","BankTransfer","PayPal","AdyenApplePay","AdyenGooglePay","GooglePay"]}},"type":"object"},"id":{"description":"Account ID.\n","type":"string"},"invoiceDeliveryPrefsEmail":{"description":"Whether the customer wants to receive invoices through email. \n","type":"boolean"},"invoiceDeliveryPrefsPrint":{"description":"Whether the customer wants to receive printed invoices, such as through postal mail.\n","type":"boolean"},"lastInvoiceDate":{"description":"Date of the most recent invoice for the account; null if no invoice has ever been generated.\n","format":"date","type":"string"},"lastMetricsUpdate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when account metrics are last updated, if the account is a partner account."},"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":":"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Reseller Account feature enabled, and set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an account, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastMetricsUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you ever set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an account, the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastMetricsUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is the time when the account metrics are last updated."},"children":[]}]}]}]}],"type":"string"},"lastPaymentAmount":{"description":"Amount of the most recent payment collected for the account; null if no payment has ever been collected.\n","format":"decimal","type":"string"},"lastPaymentDate":{"description":"Date of the most recent payment collected for the account. Null if no payment has ever been collected.\n","format":"date","type":"string"},"name":{"description":"Account name.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"partnerAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer account is a partner, distributor, or reseller."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"paymentMethodCascadingConsent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent from your customer to use the Cascading Payment Method feature was collected."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent was not collected and the Cascading Payment Method feature is not enabled."},"children":[]}]}]}],"type":"boolean"},"purchaseOrderNumber":{"description":"The purchase order number provided by your customer for services, products, or both purchased.","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account status; possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"tags":{"description":"","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/AccountObjectNSFields"},{"$ref":"#/components/schemas/AccountObjectCustomFields"}],"description":"Container for basic information about the account.\n","title":"basicInfo"}},"components/schemas/GETAccountSummaryTypeBillToContact":{"id":"components/schemas/GETAccountSummaryTypeBillToContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"asBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a bill-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asShipTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a ship-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asSoldTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a sold-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"city":{"description":"City, 40 characters or less.\n","type":"string"},"country":{"description":"Full country name. This field does not contain the ISO-standard abbreviation of the country name.\n","type":"string","nullable":true},"county":{"description":"County; 32 characters or less. Zuora Tax uses this information to calculate county taxation.          ","type":"string","nullable":true},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"id":{"description":"Contact ID.\n","type":"string"},"isSpecifiedInSubscription":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this contact is specified at the subscription level and is not inherited from the customer account."},"children":[]}]}]}],"type":"boolean","default":false},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"state":{"description":"Full state name. This field does not contain the ISO-standard abbreviation of the state name.\n","type":"string"},"taxRegion":{"description":"A region string, defined in your Zuora tax rules.\n","type":"string","nullable":true},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for bill-to contact information."},"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":"Notes"},"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 bill-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the bill-to contact on the subscription, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Flexible Billing Attributes"},"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 bill-to contact is not specified on the subscription, the bill-to contact on the invoice owner account will be populated in this field."},"children":[]}]}]}]}],"title":"Contact"}},"components/schemas/GETAccountSummaryInvoiceType":{"id":"components/schemas/GETAccountSummaryInvoiceType","kind":"json-schema","title":"invoices","data":{"properties":{"amount":{"description":"Invoice amount before adjustments, discounts, and similar items.\n","type":"number"},"balance":{"description":"Balance due on the invoice.\n","format":"decimal","type":"string"},"dueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due date as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"id":{"description":"Invoice ID.\n","type":"string"},"invoiceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice date as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"invoiceNumber":{"description":"Invoice number.\n","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice status - not the payment status of the invoice, just the status of the invoice itself."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Posted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"title":"invoices","type":"object"}},"components/schemas/GETAccountSummaryPaymentInvoiceType":{"id":"components/schemas/GETAccountSummaryPaymentInvoiceType","kind":"json-schema","title":"paidInvoices","data":{"properties":{"appliedPaymentAmount":{"description":"Amount of payment applied to the invoice.\n","format":"decimal","type":"string"},"invoiceId":{"description":"Invoice ID.\n","type":"string"},"invoiceNumber":{"description":"Invoice number.\n","type":"string"}},"title":"paidInvoices","type":"object"}},"components/schemas/GETAccountSummaryPaymentType":{"id":"components/schemas/GETAccountSummaryPaymentType","kind":"json-schema","title":"payments","data":{"properties":{"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Effective date as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"id":{"description":"Payment ID.\n","type":"string"},"paidInvoices":{"description":"Container for paid invoices for this subscription.\n","items":{"$ref":"#/components/schemas/GETAccountSummaryPaymentInvoiceType"},"type":"array"},"paymentNumber":{"description":"Payment number.\n","type":"string"},"paymentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment type; possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Electronic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment status. Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Posted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"title":"payments","type":"object"}},"components/schemas/GetAccountSummaryTypeShipToContact":{"id":"components/schemas/GetAccountSummaryTypeShipToContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"asBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a bill-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asShipTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a ship-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asSoldTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a sold-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"city":{"description":"City, 40 characters or less.\n","type":"string"},"country":{"description":"Full country name. This field does not contain the ISO-standard abbreviation of the country name.\n","type":"string","nullable":true},"county":{"description":"County; 32 characters or less. Zuora Tax uses this information to calculate county taxation.          ","type":"string","nullable":true},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"id":{"description":"Contact ID.\n","type":"string"},"isSpecifiedInSubscription":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this contact is specified at the subscription level and is not inherited from the customer account."},"children":[]}]}]}],"type":"boolean","default":false},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"state":{"description":"Full state name. This field does not contain the ISO-standard abbreviation of the state name.\n","type":"string"},"taxRegion":{"description":"A region string, defined in your Zuora tax rules.\n","type":"string"},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for ship-to contact information."},"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":"Notes"},"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 ship-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the ship-to contact on the subscription, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Flexible Billing Attributes"},"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 ship-to contact is not specified on the subscription, the ship-to contact on the subscription owner account will be populated in this field."},"children":[]}]}]}]}],"title":"Contact"}},"components/schemas/GETAccountSummaryTypeSoldToContact":{"id":"components/schemas/GETAccountSummaryTypeSoldToContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"asBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a bill-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asShipTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a ship-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asSoldTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a sold-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"city":{"description":"City, 40 characters or less.\n","type":"string"},"country":{"description":"Full country name. This field does not contain the ISO-standard abbreviation of the country name.\n","type":"string","nullable":true},"county":{"description":"County; 32 characters or less. Zuora Tax uses this information to calculate county taxation.          ","type":"string","nullable":true},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","type":"string"},"id":{"description":"Contact ID.\n","type":"string"},"isSpecifiedInSubscription":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this contact is specified at the subscription level and is not inherited from the customer account."},"children":[]}]}]}],"type":"boolean","default":false},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string"},"state":{"description":"Full state name. This field does not contain the ISO-standard abbreviation of the state name.\n","type":"string"},"taxRegion":{"description":"A region string, defined in your Zuora tax rules.\n","type":"string","nullable":true},"workEmail":{"description":"Work email address, 80 characters or less.\n","type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for sold-to contact information."},"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":"Notes"},"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 sold-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the sold-to contact on the subscription, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Flexible Billing Attributes"},"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 sold-to contact is not specified on the subscription, the sold-to contact on the subscription owner account will be populated in this field."},"children":[]}]}]}]}],"title":"Contact"}},"components/schemas/GETAccountSummarySubscriptionRatePlanType":{"id":"components/schemas/GETAccountSummarySubscriptionRatePlanType","kind":"json-schema","title":"ratePlans","data":{"properties":{"productId":{"description":"Product ID.\n","type":"string"},"productName":{"description":"Product name.\n","type":"string"},"productRatePlanId":{"description":"Product Rate Plan ID.\n","type":"string"},"productSku":{"description":"","type":"string"},"ratePlanName":{"description":"Rate plan name.\n","type":"string"}},"title":"ratePlans","type":"object"}},"components/schemas/GETAccountSummarySubscriptionType":{"id":"components/schemas/GETAccountSummarySubscriptionType","kind":"json-schema","title":"subscriptions","data":{"allOf":[{"properties":{"autoRenew":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", auto-renew is enabled. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", auto-renew is disabled."},"children":[]}]}]}],"type":"boolean"},"id":{"description":"Subscription ID.\n","type":"string"},"initialTerm":{"description":"Duration of the initial subscription term in whole months. \n","type":"string"},"ratePlans":{"description":"Container for rate plans for this subscription.\n","items":{"$ref":"#/components/schemas/GETAccountSummarySubscriptionRatePlanType"},"type":"array"},"renewalTerm":{"description":"Duration of the renewal term in whole months.\n","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription status; possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PendingActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PendingAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"subscriptionNumber":{"description":"Subscription Number.\n","type":"string"},"subscriptionStartDate":{"description":"Subscription start date.\n","format":"date","type":"string"},"termEndDate":{"description":"End date of the subscription term. If the subscription is evergreen, this is either null or equal to the cancellation date, as appropriate.\n","format":"date","type":"string"},"termStartDate":{"description":"Start date of the subscription term. If this is a renewal subscription, this date is different than the subscription start date.\n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/SubscriptionObjectQTFields"},{"$ref":"#/components/schemas/SubscriptionObjectNSFields"},{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"}],"title":"subscriptions"}},"components/schemas/GETAccountSummaryUsageType":{"id":"components/schemas/GETAccountSummaryUsageType","kind":"json-schema","title":"usage","data":{"properties":{"quantity":{"description":"Number of units used.\n","format":"decimal","type":"string"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of a usage period as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Zuora uses this field value to determine the usage date."},"children":[]}]}]}],"format":"date","type":"string"},"unitOfMeasure":{"description":"Unit by which consumption is measured, as configured in the Billing Settings section of the web-based UI.\n","type":"string"}},"title":"usage","type":"object"}},"components/schemas/GETAccountSummaryType":{"id":"components/schemas/GETAccountSummaryType","kind":"json-schema","title":"GETAccountSummaryType","data":{"properties":{"basicInfo":{"$ref":"#/components/schemas/GETAccountSummaryTypeBasicInfo"},"billToContact":{"$ref":"#/components/schemas/GETAccountSummaryTypeBillToContact"},"invoices":{"description":"Container for invoices. Only returns the last 6 invoices.\n","items":{"$ref":"#/components/schemas/GETAccountSummaryInvoiceType"},"type":"array"},"payments":{"description":"Container for payments. Only returns the last 6 payments.\n","items":{"$ref":"#/components/schemas/GETAccountSummaryPaymentType"},"type":"array"},"shipToContact":{"$ref":"#/components/schemas/GetAccountSummaryTypeShipToContact"},"soldToContact":{"$ref":"#/components/schemas/GETAccountSummaryTypeSoldToContact"},"subscriptions":{"description":"Container for subscriptions.\n","items":{"$ref":"#/components/schemas/GETAccountSummarySubscriptionType"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"taxInfo":{"description":"Container for tax exempt information, used to establish the tax exempt status of a customer account.\n","properties":{"VATId":{"description":"EU Value Added Tax ID.\n","type":"string"},"companyCode":{"description":"Unique code that identifies a company account in Avalara.\n","type":"string"},"exemptCertificateId":{"description":"ID of the customer tax exemption certificate.\n","type":"string"},"exemptCertificateType":{"description":"Type of tax exemption certificate that the customer holds.\n","type":"string"},"exemptDescription":{"description":"Description of the tax exemption certificate that the customer holds.\n","type":"string"},"exemptEffectiveDate":{"description":"Date when the customer tax exemption starts.\n","format":"date","type":"string"},"exemptEntityUseCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique entity use code to apply exemptions in Avalara AvaTax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This account-level field is required only when you choose Avalara as your tax engine. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.avalara.com/avatax/handling-tax-exempt-customers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exempt Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more details."},"children":[]}]}]}],"maxLength":64,"type":"string"},"exemptExpirationDate":{"description":"Date when the customer tax exemption expires.\n","format":"date","type":"string"},"exemptIssuingJurisdiction":{"description":"Jurisdiction in which the customer tax exemption certificate was issued.\n","type":"string"},"exemptStatus":{"description":"Status of the account tax exemption.\n","type":"string"}},"type":"object"},"usage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for usage data. Only returns the last 6 months of usage."},"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":" If the Active Rating feature is enabled, no usage data is returned in the response body field."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/GETAccountSummaryUsageType"},"type":"array"}},"type":"object"}},"components/schemas/POSTContactType":{"id":"components/schemas/POSTContactType","kind":"json-schema","title":"POSTContactType","data":{"allOf":[{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the account associated with the contact."},"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":": When creating a contact, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both in the request body. If both fields are specified, they must correspond to the same account."},"children":[]}]}]}],"type":"string"},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the customer account associated with the contact."},"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":": When creating a contact, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both in the request body. If both fields are specified, they must correspond to the same account."},"children":[]}]}]}],"type":"string"},"address1":{"description":"The first line of the contact's address, which is often a street address or business name.\n","maxLength":255,"type":"string"},"address2":{"description":"The second line of the contact's address.\n","maxLength":255,"type":"string"},"asBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a bill-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asShipTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a ship-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asSoldTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a sold-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"city":{"description":"The city of the contact's address.\n","maxLength":100,"type":"string"},"contactDescription":{"description":"A description for the contact.\n","maxLength":100,"type":"string"},"country":{"description":"The country of the contact's address. Either a full name or an ISO code is supported.\n","maxLength":64,"type":"string"},"county":{"description":"The county. May optionally be used by Zuora Tax to calculate county tax.\n","maxLength":100,"type":"string"},"fax":{"description":"The contact's fax number.\n","maxLength":40,"type":"string"},"firstName":{"description":"The contact's first name.\n","maxLength":100,"type":"string"},"homePhone":{"description":"The contact's home phone number.\n","maxLength":40,"type":"string"},"lastName":{"description":"The contact's last name.\n","maxLength":100,"type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact.\n","maxLength":100,"type":"string"},"nickname":{"description":"A nickname for the contact.\n","maxLength":100,"type":"string"},"otherPhone":{"description":"An additional phone number for the contact.\n","maxLength":40,"type":"string"},"otherPhoneType":{"description":"The type of the additional phone number.\n","enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"The contact's personal email address.\n","maxLength":80,"type":"string","format":"email"},"state":{"description":"The state or province of the contact's address. Either a full name or an abbreviation code is supported.\n","maxLength":100,"type":"string"},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n","maxLength":100,"type":"string"},"workEmail":{"description":"The contact's business email address.\n","maxLength":80,"type":"string"},"workPhone":{"description":"The contact's business phone number.\n","maxLength":40,"type":"string"},"zipCode":{"description":"The zip code for the contact's address.\n","maxLength":20,"type":"string"}},"required":["firstName","lastName"],"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"example":{"accountId":"6e767220676e6e61206776652075207570","accountNumber":"A00000001","address1":"314, Bongora","address2":"near Tech City","city":"GHY","contactDescription":"This is a description for the contact","country":"India","fax":"6174","firstName":"Kuhi","homePhone":"1234123","lastName":"Das","mobilePhone":"123213","nickname":"Dorimi","otherPhone":"2314213","otherPhoneType":"Work","personalEmail":"kuhiroll@example.com","state":"Assam","zipCode":"123456"}}},"components/schemas/ContactResponse":{"id":"components/schemas/ContactResponse","kind":"json-schema","title":"ContactResponse","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the account associated with the contact.\n","type":"string"},"accountNumber":{"description":"The number of the customer account associated with the contact.\n","type":"string"},"address1":{"description":"The first line of the contact's address, which is often a street address or business name.\n","maxLength":255,"type":"string"},"address2":{"description":"The second line of the contact's address.\n","maxLength":255,"type":"string"},"asBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a bill-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asShipTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a ship-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asSoldTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a sold-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"city":{"description":"The city of the contact's address.\n","maxLength":40,"type":"string"},"contactDescription":{"description":"A description for the contact.\n","maxLength":100,"type":"string"},"country":{"description":"The full country name of the contact's address.\n","maxLength":64,"type":"string"},"county":{"description":"The county. May optionally be used by Zuora Tax to calculate county tax.\n","maxLength":32,"type":"string","nullable":true},"fax":{"description":"The contact's fax number. \n","maxLength":40,"type":"string"},"firstName":{"description":"The contact's first name.\n","maxLength":100,"type":"string"},"homePhone":{"description":"The contact's home phone number.\n","maxLength":40,"type":"string"},"lastName":{"description":"The contact's last name.\n","maxLength":100,"type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact.\n","maxLength":100,"type":"string"},"nickname":{"description":"A nickname for the contact.\n","maxLength":100,"type":"string"},"otherPhone":{"description":"An additional phone number for the contact.\n","maxLength":40,"type":"string"},"otherPhoneType":{"description":"The type of the additional phone number.\n","enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"The contact's personal email address.\n","maxLength":80,"type":"string"},"state":{"description":"The full state or province name of the contact's address.\n","maxLength":40,"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n","maxLength":32,"type":"string"},"workEmail":{"description":"The contact's business email address.\n","maxLength":80,"type":"string"},"workPhone":{"description":"The contact's business phone number.\n","maxLength":40,"type":"string"},"zipCode":{"description":"The zip code for the contact's address.\n","maxLength":20,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}]}},"components/schemas/PUTContactType":{"id":"components/schemas/PUTContactType","kind":"json-schema","title":"PUTContactType","data":{"allOf":[{"properties":{"address1":{"description":"The first line of the contact's address, which is often a street address or business name.\n","maxLength":255,"type":"string"},"address2":{"description":"The second line of the contact's address.\n","maxLength":255,"type":"string"},"asBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a bill-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asShipTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a ship-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asSoldTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a sold-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"city":{"description":"The city of the contact's address.\n","maxLength":100,"type":"string"},"contactDescription":{"description":"A description for the contact.\n","maxLength":100,"type":"string"},"country":{"description":"The country of the contact's address. Either a full name or an ISO code is supported.\n","maxLength":64,"type":"string"},"county":{"description":"The county. May optionally be used by Zuora Tax to calculate county tax.\n","maxLength":100,"type":"string"},"fax":{"description":"The contact's fax number.\n","maxLength":40,"type":"string"},"firstName":{"description":"The contact's first name.\n","maxLength":100,"type":"string"},"homePhone":{"description":"The contact's home phone number.\n","maxLength":40,"type":"string"},"lastName":{"description":"The contact's last name.\n","maxLength":100,"type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact.\n","maxLength":100,"type":"string"},"nickname":{"description":"A nickname for the contact.\n","maxLength":100,"type":"string"},"otherPhone":{"description":"An additional phone number for the contact.\n","maxLength":40,"type":"string"},"otherPhoneType":{"description":"The type of the additional phone number.\n","enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"The contact's personal email address.\n","maxLength":80,"type":"string"},"state":{"description":"The state or province of the contact's address. Either a full name or an abbreviation code is supported.\n","maxLength":100,"type":"string"},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n","maxLength":100,"type":"string"},"workEmail":{"description":"The contact's business email address.\n","maxLength":80,"type":"string"},"workPhone":{"description":"The contact's business phone number.\n","maxLength":40,"type":"string"},"zipCode":{"description":"The zip code for the contact's address.\n","maxLength":20,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}],"example":{"address1":"new Address","city":"Mumbai","contactDescription":"This is the new Description","mobilePhone":123213,"zipCode":123134}}},"components/schemas/PUTTransferContact":{"id":"components/schemas/PUTTransferContact","kind":"json-schema","title":"PUTTransferContact","data":{"type":"object","properties":{"destinationAccountKey":{"description":"The ID or number of the destination account.\n","type":"string"}},"example":{"destinationAccountKey":"A00000135"}}},"components/schemas/ContactSnapshotObjectCustomFields":{"id":"components/schemas/ContactSnapshotObjectCustomFields","kind":"json-schema","title":"contactSnapshotFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Contact Snapshot object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-custom-field-management-with-object-manager","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage custom fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":"Container for custom fields of a Contact Snapshot object.\n","title":"contactSnapshotFieldsCustom","type":"object"}},"components/schemas/GETContactSnapshotResponse":{"id":"components/schemas/GETContactSnapshotResponse","kind":"json-schema","title":"GETContactSnapshotResponse","data":{"allOf":[{"properties":{"address1":{"description":"The first line for the address of the contact, which is often a street address or business name.\n","type":"string"},"address2":{"description":"The second line for the address of the contact, which is mostly the locality.\n","type":"string"},"asBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a bill-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asShipTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a ship-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"asSoldTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the contact can be specified as a sold-to contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"city":{"description":"The city for the address of the contact.\n","type":"string"},"contactId":{"description":"The Zuora ID of the contact who the snapshot belongs to.\n","type":"string"},"country":{"description":"The country for the address of the contact.\n","type":"string","nullable":true},"county":{"description":"The county for the address of the contact. The field value might optionally be used by Zuora Tax to calculate county tax.\n","type":"string","nullable":true},"description":{"description":"A description of the contact.\n","type":"string","nullable":true},"fax":{"description":"The fax number of the contact.\n","format":"number","type":"string"},"firstName":{"description":"The first name of the contact.\n","type":"string"},"homePhone":{"description":"The home phone number of the contact.\n","format":"number","type":"string"},"id":{"description":"The unique ID of the contact snapshot.\n","type":"string"},"lastName":{"description":"The last name of the contact.\n","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact.\n","format":"number","type":"string"},"nickname":{"description":"A nickname for the contact.\n","type":"string"},"otherPhone":{"description":"An additional phone number for the contact.\n","type":"string"},"otherPhoneType":{"description":"The type of the additional phone number.\n","enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"The personal email address of the contact.\n","type":"string","maxLength":80},"postalCode":{"description":"The postal code for the address of the contact.\n","format":"number","type":"string"},"state":{"description":"The state or province for the address of the contact.\n","type":"string"},"taxRegion":{"description":"If using Zuora Tax rules.\n","type":"string"},"workEmail":{"description":"The business email address of the contact.\n","type":"string"},"workPhone":{"description":"The business email address of the contact.\n","format":"number","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ContactSnapshotObjectCustomFields"}]}},"components/schemas/CustomFields":{"id":"components/schemas/CustomFields","kind":"json-schema","title":"CustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Sign up API is based on Orders. The root element uses the custom field defintion on an \"Order\" object, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses the custom field defintion on an \"Account\" object, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses the custom field defintion on an \"Order Action\" object (not on an \"Subscription\" object)."},"children":[]}]}]}]},"description":"Container for custom fields.\n","title":"CustomFields","type":"object"}},"components/schemas/ContactInfo":{"id":"components/schemas/ContactInfo","kind":"json-schema","title":"ContactInfo","data":{"allOf":[{"description":"Contact details associated with an account.\n","properties":{"address1":{"description":"First line of the contact's address. This is often a street address or a business name.\n","maxLength":255,"type":"string"},"address2":{"description":"Second line of the contact's address.\n","maxLength":255,"type":"string"},"city":{"description":"City of the contact's address.\n","maxLength":100,"type":"string"},"contactDescription":{"description":"A description for the contact.\n","maxLength":100,"type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country; must be a valid country name or abbreviation. If using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-zuora-tax-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify a country in the bill-to contact to calculate tax."},"children":[]}]}]}],"maxLength":64,"type":"string"},"county":{"description":"County of the contact's address.\n","maxLength":100,"type":"string"},"customFields":{"$ref":"#/components/schemas/CustomFields"},"fax":{"description":"Fax number of the contact.\n","maxLength":40,"type":"string"},"firstName":{"description":"First name of the contact.\n","maxLength":100,"type":"string"},"homePhone":{"description":"Home phone number of the contact.\n","maxLength":40,"type":"string"},"lastName":{"description":"","maxLength":100,"type":"string"},"mobilePhone":{"description":"Mobile phone number of the contact.\n","maxLength":40,"type":"string"},"nickname":{"description":"Nickname of the contact.\n","maxLength":100,"type":"string"},"otherPhone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional phone number of the contact. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhoneType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the type of phone number."},"children":[]}]}]}],"maxLength":40,"type":"string"},"otherPhoneType":{"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 phone number in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"Personal email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"postalCode":{"description":"ZIP code or other postal code of the contact's address.\n","maxLength":20,"type":"string"},"state":{"description":"State or province of the contact's address.\n","maxLength":100,"type":"string"},"taxRegion":{"description":"Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n","maxLength":100,"type":"string"},"workEmail":{"description":"Business email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"workPhone":{"description":"Business phone number of the contact.\n","maxLength":40,"type":"string"}},"required":["firstName","lastName"],"type":"object"},{}]}},"components/schemas/SignUpCreatePaymentMethodCreditCardReferenceTransaction":{"id":"components/schemas/SignUpCreatePaymentMethodCreditCardReferenceTransaction","kind":"json-schema","title":"SignUpCreatePaymentMethodCreditCardReferenceTransaction","data":{"properties":{"secondTokenId":{"description":"The second token id of CreditCardReferenceTransaction.\n","type":"string"},"tokenId":{"description":"The token id of payment method, required field of CreditCardReferenceTransaction type.\n","type":"string"}},"type":"object"}},"components/schemas/SignUpCreatePMPayPalECPayPalNativeEC":{"id":"components/schemas/SignUpCreatePMPayPalECPayPalNativeEC","kind":"json-schema","title":"SignUpCreatePMPayPalECPayPalNativeEC","data":{"properties":{"BAID":{"description":"ID of a PayPal billing agreement, for example, I-1TJ3GAGG82Y9.\n","type":"string"},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address associated with the payment method. This field is only supported for PayPal payment methods and is required if you want to create any of the following PayPal payment methods:"},"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":"PayPal Express Checkout payment method"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal Adaptive payment method"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal Commerce Platform payment method"},"children":[]}]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/SignUpCreatePaymentMethodPayPalAdaptive":{"id":"components/schemas/SignUpCreatePaymentMethodPayPalAdaptive","kind":"json-schema","title":"SignUpCreatePaymentMethodPayPalAdaptive","data":{"properties":{"preapprovalKey":{"description":"The PayPal preapproval key.\n","type":"string"}},"type":"object"}},"components/schemas/SignUpCreatePaymentMethodCardholderInfo":{"id":"components/schemas/SignUpCreatePaymentMethodCardholderInfo","kind":"json-schema","title":"cardHolderInfo","data":{"description":"Container for cardholder information. If provided, Zuora will\nonly use this information for this card. Otherwise, Zuora will use\nthe account''s existing bill-to contact information for this card.\n","properties":{"addressLine1":{"description":"First address line, 255 characters or less.\n","type":"string"},"addressLine2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"cardHolderName":{"description":"The card holder's full name as it appears on the card, e.g., \"John J Smith\", 50 characters or less.\n","type":"string"},"city":{"description":"City, 40 characters or less.\n","type":"string"},"country":{"description":"Country, must be a valid country name or abbreviation.\n","type":"string"},"email":{"description":"Card holder's email address, 80 characters or less.\n","type":"string"},"phone":{"description":"Phone number, 40 characters or less.\n","type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State; must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","type":"string"}},"required":["cardHolderName"],"title":"cardHolderInfo","type":"object"}},"components/schemas/SignUpCreatePaymentMethodCreditCard":{"id":"components/schemas/SignUpCreatePaymentMethodCreditCard","kind":"json-schema","title":"SignUpCreatePaymentMethodCreditCard","data":{"properties":{"cardHolderInfo":{"$ref":"#/components/schemas/SignUpCreatePaymentMethodCardholderInfo"},"cardNumber":{"description":"Credit card number.\n","type":"string"},"cardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the credit card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JCB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Diners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about credit card types supported by different payment gateways, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Payment Gateways"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"checkDuplicated":{"type":"boolean"},"expirationMonth":{"description":"One or two digit expiration month (1-12) of the credit card.\n","type":"string"},"expirationYear":{"description":"Four-digit expiration year of the credit card.\n","type":"string"},"mitConsentAgreementRef":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":128,"type":"string"},"mitConsentAgreementSrc":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Specifies how the consent agreement has been established with the customer. The allowed value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["External"],"type":"string"},"mitNetworkTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the ID of a network transaction. Only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Persist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":128,"type":"string"},"mitProfileAction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora creates and activates the stored credential profile. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["Activate","Persist"],"type":"string"},"mitProfileAgreedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the profile is agreed. The date format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"mitProfileType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["Recurring"],"type":"string"},"securityCode":{"description":"CVV or CVV2 security code of the credit card.\n\nTo ensure PCI compliance, this value is not stored and cannot be queried.\n","type":"string"}},"type":"object"}},"components/schemas/SignUpCreatePaymentMethodCommon":{"id":"components/schemas/SignUpCreatePaymentMethodCommon","kind":"json-schema","title":"SignUpCreatePaymentMethodCommon","data":{"properties":{"accountKey":{"description":"Internal ID of the customer account that will own the payment method.\n","type":"string"},"authGateway":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not set this field, Zuora will use one of the following payment gateways instead:"},"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 default payment gateway of the customer account that owns the payment method, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default payment gateway of your Zuora tenant, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set."},"children":[]}]}]}]}],"type":"string"},"ipAddress":{"description":"The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. \n\nIf the IP address length is beyond 45 characters, a validation error occurs.\n","type":"string"},"makeDefault":{"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 the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/SignUpPaymentMethodObjectCustomFields":{"id":"components/schemas/SignUpPaymentMethodObjectCustomFields","kind":"json-schema","title":"paymentMethodFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the payment method. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a payment method object.\n","title":"paymentMethodFieldsCustom","type":"object"}},"components/schemas/SignUpPaymentMethod":{"id":"components/schemas/SignUpPaymentMethod","kind":"json-schema","title":"SignUpPaymentMethod","data":{"allOf":[{"properties":{"type":{"description":"Type of payment method. The following types of the payment method are supported:\n","enum":["PayPalEC","PayPalNativeEC","PayPalAdaptive","CreditCard","CreditCardReferenceTransaction"],"type":"string"}},"required":["type"],"type":"object"},{"$ref":"#/components/schemas/SignUpCreatePaymentMethodCreditCardReferenceTransaction"},{"$ref":"#/components/schemas/SignUpCreatePMPayPalECPayPalNativeEC"},{"$ref":"#/components/schemas/SignUpCreatePaymentMethodPayPalAdaptive"},{"$ref":"#/components/schemas/SignUpCreatePaymentMethodCreditCard"},{"$ref":"#/components/schemas/SignUpCreatePaymentMethodCommon"},{"$ref":"#/components/schemas/SignUpPaymentMethodObjectCustomFields"}]}},"components/schemas/SignUpTaxInfo":{"id":"components/schemas/SignUpTaxInfo","kind":"json-schema","title":"taxInfo","data":{"description":"Information about the tax exempt status of a customer account.\n","properties":{"VATId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU Value Added Tax ID."},"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":25,"type":"string"},"companyCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara."},"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":50,"type":"string"},"exemptCertificateId":{"description":"ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.\n","maxLength":32,"type":"string"},"exemptCertificateType":{"description":"Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n","maxLength":32,"type":"string"},"exemptDescription":{"description":"Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n","maxLength":500,"type":"string"},"exemptEffectiveDate":{"description":"Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.\n","format":"date","type":"string"},"exemptExpirationDate":{"description":"Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.\n","format":"date","type":"string"},"exemptIssuingJurisdiction":{"description":"Jurisdiction in which the customer tax exemption certificate was issued.\n","maxLength":32,"type":"string"},"exemptStatus":{"default":"No","description":"Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. \n","enum":["No","Yes","PendingVerification"],"type":"string"}},"title":"taxInfo","type":"object"}},"components/schemas/AccountData":{"id":"components/schemas/AccountData","kind":"json-schema","title":"AccountData","data":{"description":"The information of the account that you are to create through the \"Sign up\" operation.\n","properties":{"accountNumber":{"maxLength":70,"type":"string"},"autoPay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether future payments are to be automatically billed when they are due. Possible values are "},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"batch":{"description":[{"$$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":": By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=performance-booster-elite","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance Booster Elite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" package."},"children":[]}]}]}],"type":"string"},"billCycleDay":{"description":"Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".","maximum":31,"minimum":0,"type":"integer"},"billToContact":{"$ref":"#/components/schemas/ContactInfo"},"communicationProfileId":{"type":"string"},"creditMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the credit memo template, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b."},"children":[]}]}]}],"type":"string"},"crmId":{"maxLength":100,"type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 uppercase character currency code."},"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":": Specify this field only for a new account to be created; do not specify this field to update an existing account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For payment method authorization, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used. Otherwise, this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/CustomFields"},"debitMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the debit memo template, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2."},"children":[]}]}]}],"type":"string"},"invoiceTemplateId":{"type":"string"},"name":{"maxLength":255,"type":"string"},"notes":{"maxLength":65535,"type":"string"},"organizationLabel":{"type":"string","description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"},"paymentMethod":{"$ref":"#/components/schemas/SignUpPaymentMethod"},"paymentTerm":{"type":"string"},"purchaseOrderNumber":{"description":"The number of the purchase order associated with this account. Purchase order information generally comes from customers.\n","maxLength":100,"type":"string"},"sequenceSetId":{"description":"The ID of the billing document sequence set to assign to the customer account. \n\nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\n","type":"string","nullable":true},"shipToContact":{"$ref":"#/components/schemas/ContactInfo"},"soldToContact":{"$ref":"#/components/schemas/ContactInfo"},"taxInfo":{"$ref":"#/components/schemas/SignUpTaxInfo"}},"required":["billCycleDay","billToContact","currency","name"],"type":"object"}},"components/schemas/Options":{"id":"components/schemas/Options","kind":"json-schema","title":"Options","data":{"description":"Invoice or Payment.","properties":{"billingTargetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice is generated. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-bill-runs-creation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is a Target Date?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"collectPayment":{"description":"Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.","type":"boolean"},"maxSubscriptionsPerAccount":{"type":"number"},"runBilling":{"description":"Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.","type":"boolean"}},"type":"object"}},"components/schemas/PaymentData":{"id":"components/schemas/PaymentData","kind":"json-schema","title":"PaymentData","data":{"properties":{"authTransactionId":{"description":"The authorization transaction ID from the payment gateway.\n","type":"string"},"authorizedAmount":{"description":"The amount that is authorized before this API call. Only used for the Delay Capture function.\n","format":"double","type":"number"},"authorizedCurrency":{"description":"The authorization of currency code that occurs before this API call. We will verify whether it is same as the account's currency.","type":"string"}},"type":"object"}},"components/schemas/RatePlan":{"id":"components/schemas/RatePlan","kind":"json-schema","title":"RatePlan","data":{"properties":{"customFields":{"$ref":"#/components/schemas/CustomFields"},"productRatePlanId":{"description":"Internal identifier of the product rate plan that the rate plan is based on.\n","type":"string"}},"type":"object"}},"components/schemas/RatePlans":{"id":"components/schemas/RatePlans","kind":"json-schema","title":"RatePlans","data":{"items":{"$ref":"#/components/schemas/RatePlan"},"type":"array"}},"components/schemas/TermInfo_initialTerm":{"id":"components/schemas/TermInfo_initialTerm","kind":"json-schema","title":"TermInfo_initialTerm","data":{"description":"Information about the first term of the subscription.\n","properties":{"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the first term in months, years, days, or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"periodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time that the first term is measured in. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Month","Year","Day","Week"],"type":"string"},"startDate":{"description":"Start date of the first term, in YYYY-MM-DD format.\n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the first term. If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the first term has a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the first term does not have a predefined duration."},"children":[]}]}]}],"enum":["TERMED","EVERGREEN"],"type":"string"}},"required":["termType"],"type":"object"}},"components/schemas/TermInfo_renewalTerms":{"id":"components/schemas/TermInfo_renewalTerms","kind":"json-schema","title":"TermInfo_renewalTerms","data":{"properties":{"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the renewal term in months, years, days, or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"periodType":{"description":"Unit of time that the renewal term is measured in.\n","enum":["Month","Year","Day","Week"],"type":"string"}},"type":"object"}},"components/schemas/TermInfo":{"id":"components/schemas/TermInfo","kind":"json-schema","title":"TermInfo","data":{"description":"Container for the terms and renewal settings of the subscription.\n","properties":{"autoRenew":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"initialTerm":{"$ref":"#/components/schemas/TermInfo_initialTerm"},"renewalSetting":{"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 the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"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":"code","inline":true,"attributes":{"content":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each renewal term has a predefined duration. The first entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the duration of the second term of the subscription, the second entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the duration of the third term of the subscription, and so on. The last entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the ultimate duration of each renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_TO_EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The second term of the subscription does not have a predefined duration."},"children":[]}]}]}]}],"enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"type":"string"},"renewalTerms":{"$ref":"#/components/schemas/TermInfo_renewalTerms"}},"required":["initialTerm"],"type":"object"}},"components/schemas/SubscriptionData":{"id":"components/schemas/SubscriptionData","kind":"json-schema","title":"SubscriptionData","data":{"properties":{"customFields":{"$ref":"#/components/schemas/CustomFields"},"invoiceSeparately":{"description":"Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.\n","type":"boolean"},"notes":{"description":"Notes about the subscription. These notes are only visible to Zuora users.\n","maxLength":500,"type":"string"},"ratePlans":{"$ref":"#/components/schemas/RatePlans"},"startDate":{"format":"date","type":"string"},"subscriptionNumber":{"description":"Subscription number of the subscription to create, for example, A-S00000001.\n\nIf you do not set this field, Zuora will generate a subscription number.\n","maxLength":100,"type":"string"},"terms":{"$ref":"#/components/schemas/TermInfo"}},"type":"object"}},"components/schemas/SignUpRequest":{"id":"components/schemas/SignUpRequest","kind":"json-schema","title":"SignUpRequest","data":{"example":{"accountData":{"autoPay":false,"billCycleDay":15,"billToContact":{"country":"US","firstName":"foo","lastName":"bar","state":"California"},"currency":"USD","customFields":{"CustomerUserId__c":"User_269145114619000"},"name":"User","paymentMethod":{"makeDefault":true,"secondTokenId":"010","tokenId":"User_269145114619000","type":"CreditCardReferenceTransaction"}},"accountIdentifierField":"CustomerUserId__c","options":{"billingTargetDate":"2021-07-01","collectPayment":true,"maxSubscriptionsPerAccount":0,"runBilling":true},"subscriptionData":{"invoiceSeparately":false,"ratePlans":[{"productRatePlanId":"4028818284f5f8130184f5fe1a73101f"}],"startDate":"2021-04-15","terms":{"autoRenew":false,"initialTerm":{"period":6,"periodType":"Month","startDate":"2021-04-15","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":[{"period":6,"periodType":"Month"}]}}},"properties":{"accountData":{"$ref":"#/components/schemas/AccountData"},"accountIdentifierField":{"description":"Specify the name of the field that holds external account id","type":"string"},"customFields":{"$ref":"#/components/schemas/CustomFields"},"options":{"$ref":"#/components/schemas/Options"},"paymentData":{"$ref":"#/components/schemas/PaymentData"},"subscriptionData":{"$ref":"#/components/schemas/SubscriptionData"}},"type":"object"}},"components/schemas/SignUpResponse_reasons":{"id":"components/schemas/SignUpResponse_reasons","kind":"json-schema","title":"SignUpResponse_reasons","data":{"properties":{"code":{"description":"The error code of response.\n","type":"string"},"message":{"description":"The detail information of the error response\n","type":"string"}},"type":"object"}},"components/schemas/SignUpResponse":{"id":"components/schemas/SignUpResponse","kind":"json-schema","title":"SignUpResponse","data":{"properties":{"accountId":{"description":"The account id for the order.","type":"string"},"accountNumber":{"description":"The account number for the order.","type":"string"},"creditMemoId":{"description":"An array of the credit memo id generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled.","type":"string"},"creditMemoNumber":{"description":"An array of the credit memo numbers generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled.","type":"string"},"invoiceId":{"description":"The invoice id generated in this order request","type":"string"},"invoiceNumber":{"description":"The invoice number generated in this order request","type":"string"},"orderNumber":{"description":"The order number of the order created.","type":"string"},"paidAmount":{"description":"The total amount collected in this order request.","type":"string"},"paymentId":{"description":"The payment id that is collected in this order request.","type":"string"},"paymentNumber":{"description":"The payment number that is collected in this order request.","type":"string"},"processId":{"description":"The Id of the process that handles the operation.\n","type":"string"},"reasons":{"items":{"$ref":"#/components/schemas/SignUpResponse_reasons"},"type":"array"},"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 order. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only applicable for an order that contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action."},"children":[]}]}]}],"enum":["Completed","Pending"],"type":"string"},"subscriptionId":{"description":"The subscription id of the order.","type":"string"},"subscriptionNumber":{"description":"The subscription number of the order.","type":"string"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/OrderObjectCustomFields":{"id":"components/schemas/OrderObjectCustomFields","kind":"json-schema","title":"OrderCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Order object.\n","title":"OrderCustomFields","type":"object"}},"components/schemas/OrderLineItemCustomFields":{"id":"components/schemas/OrderLineItemCustomFields","kind":"json-schema","title":"OrderLineItemCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order Line Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Order Line Item object.\n","title":"OrderLineItemCustomFields","type":"object"}},"components/schemas/OrderLineItemCommonPostOrder":{"id":"components/schemas/OrderLineItemCommonPostOrder","kind":"json-schema","title":"OrderLineItem","data":{"properties":{"UOM":{"description":"Specifies the units to measure usage.\n","type":"string"},"accountingCode":{"description":"The accounting code for the Order Line Item.\n","type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"amountPerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual charged amount per unit for the Order Line Item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"type":"number"},"billTargetDate":{"description":"The target date for the Order Line Item to be picked up by bill run for billing.\n","format":"date","type":"string"},"billTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact of an order line item. Specify an existing contact under the billing account as the bill-to contact of the order line item. The billing account is the order account."},"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":": If an order's category is set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a return Order Line Item, it will inherit the original Order Line Item's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contact automatically. You cannot specify a different value."},"children":[]}]}]}],"type":"string"},"billingRule":{"default":"TriggerWithoutFulfillment","description":"The billing rule for the Order Line Item.\n","enum":["TriggerWithoutFulfillment","TriggerAsFulfillmentOccurs"],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"currency":{"description":"The currency for the order line item. You can specify a currency when creating an order line item through the \"Create an order\" operation.\n","type":"string"},"customFields":{"$ref":"#/components/schemas/OrderLineItemCustomFields"},"deferredRevenueAccountingCode":{"description":"The deferred revenue accounting code for the Order Line Item.\n","type":"string"},"description":{"description":"The description of the Order Line Item.\n","type":"string","maxLength":500},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude Order Line Item from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"inlineDiscountPerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field in accordance with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, in the following manner:"},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount percentage is 5%."},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount amount on each unit of the order line item is 10."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"type":"number"},"inlineDiscountType":{"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 specify the inline discount type, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"None"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"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 field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"enum":["Percentage","FixedAmount","None"],"type":"string"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"itemCategory":{"default":"Sales","description":"The category for the Order Line Item, to indicate a product sale or return.\n","enum":["Sales","Return"],"type":"string"},"itemName":{"description":"The name of the Order Line Item.\n","type":"string"},"itemNumber":{"description":"The number of the Order Line Item. Use this field to specify a custom item number for your Order Line Item. If you are to use this field,  you must set all the item numbers in an order when there are several order line items in the order.\n","type":"string"},"itemState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of an Order Line Item. If you want to generate billing documents for order line items, you must set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For invoice preview, you do not need to set this field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State transitions for an order, order line item, and fulfillment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["Draft","Executing","Booked","SentToBilling","Complete","Cancelled"],"type":"string"},"itemType":{"description":"The type of the Order Line Item.\n","enum":["Product","Fee","Services"],"type":"string"},"listPricePerUnit":{"description":"The list price per unit for the Order Line Item.\n","type":"number"},"originalOrderLineItemNumber":{"description":"The number of the original sale order line item for a return order line item. \n","type":"string"},"originalOrderNumber":{"description":"The number of the original sale order for a return order line item. \n","type":"string"},"ownerAccountNumber":{"description":"Use this field to assign an existing account as the owner of an order line item.\n","type":"string"},"productCode":{"description":"The product code for the Order Line Item.\n","type":"string"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of a product rate plan charge. Only one-time charges are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Order Line Items Without Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" billing permission, you must specify this field to create the order line item from an existing product rate plan charge."},"children":[]}]}]}],"type":"string"},"purchaseOrderNumber":{"description":"Used by customers to specify the Purchase Order Number provided by the buyer.\n","type":"string"},"quantity":{"description":"The quantity of units, such as the number of authors in a hosted wiki service.\n","type":"number"},"recognizedRevenueAccountingCode":{"description":"The recognized revenue accounting code for the Order Line Item.\n","type":"string"},"relatedSubscriptionNumber":{"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 relate an order line item to a subscription when you create the order line item."},"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 relate an order line item to a new subscription which is yet to create in the same \"Create an order\" call, use this field in combination with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the \"Create an order\" operation. Specify this field to the same value as that of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when you make the \"Create an order\" call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription."},"children":[]}]}]}]}],"type":"string"},"revenueRecognitionRule":{"description":"The Revenue Recognition rule for the Order Line Item.\n","type":"string"},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-grouping"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Grouping"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify this field on a sales order line item when its state (that is, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string","maxLength":255,"nullable":true},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the order line item."},"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":":"},"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":"This field is only available in the request body if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Otherwise, the response value for this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"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 you don't specify this field in the request during the creation, OLI uses the value from the account automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify this field on a sales order line item when its state (that is, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment term name associated with the order line item."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you don't specify this field in the request during the creation, OLI uses the value from the account automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify this field on a sales order line item when its state (that is, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string"},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the order line item."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you don't specify this field in the request during the creation, OLI uses the value from the account automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify this field on a sales order line item when its state (that is, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string"},"shipTo":{"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 assign an existing account as the ship-to contact of an order line item, by the following rules:"},"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":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item."},"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":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item. The billing account is the order account."},"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":": If an order's category is set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a return Order Line Item, it will inherit the original Order Line Item's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contact automatically. You cannot specify a different value."},"children":[]}]}]}],"type":"string"},"soldTo":{"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 assign an existing account as the sold-to contact of an order line item, by the following rules:"},"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":"ownerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item."},"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":"ownerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item. The billing account is the order account."},"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":": If an order's category is set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a return Order Line Item, it will inherit the original Order Line Item's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contact automatically. You cannot specify a different value."},"children":[]}]}]}]},"taxCode":{"description":"The tax code for the Order Line Item.\n","type":"string"},"taxMode":{"description":"The tax mode for the Order Line Item.\n","enum":["TaxInclusive","TaxExclusive"],"type":"string"},"transactionEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"format":"date","type":"string"},"transactionStartDate":{"description":"The date a transaction starts. The default value of this field is the order date.\n","format":"date","type":"string"},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"title":"OrderLineItem","type":"object"}},"components/schemas/CreateOrderOrderLineItem":{"id":"components/schemas/CreateOrderOrderLineItem","kind":"json-schema","title":"CreateOrderOrderLineItem","data":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemCommonPostOrder"}]}},"components/schemas/PreviewContactInfo":{"id":"components/schemas/PreviewContactInfo","kind":"json-schema","title":"PreviewContactInfo","data":{"description":"Contact details associated with an account.\n","properties":{"address1":{"description":"First line of the contact's address. This is often a street address or a business name.\n","maxLength":255,"type":"string"},"address2":{"description":"Second line of the contact's address.\n","maxLength":255,"type":"string"},"city":{"maxLength":100,"type":"string"},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country to calculate tax.","maxLength":64,"type":"string"},"county":{"maxLength":100,"type":"string"},"postalCode":{"maxLength":20,"type":"string"},"state":{"maxLength":100,"type":"string"},"taxRegion":{"maxLength":100,"type":"string"}},"type":"object"}},"components/schemas/TaxInfo":{"id":"components/schemas/TaxInfo","kind":"json-schema","title":"taxInfo","data":{"description":"Information about the tax exempt status of a customer account.\n","properties":{"VATId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU Value Added Tax ID."},"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":25,"type":"string"},"companyCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara."},"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":50,"type":"string"},"exemptCertificateId":{"description":"ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.\n","maxLength":32,"type":"string"},"exemptCertificateType":{"description":"Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n","maxLength":32,"type":"string"},"exemptDescription":{"description":"Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n","maxLength":500,"type":"string"},"exemptEffectiveDate":{"description":"Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.\n","format":"date","type":"string"},"exemptExpirationDate":{"description":"Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.\n","format":"date","type":"string"},"exemptIssuingJurisdiction":{"description":"Jurisdiction in which the customer tax exemption certificate was issued.\n","maxLength":32,"type":"string"},"exemptStatus":{"default":"No","description":"Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. \n","enum":["No","Yes","PendingVerification"],"type":"string"}},"title":"taxInfo","type":"object"}},"components/schemas/PreviewAccountInfo":{"id":"components/schemas/PreviewAccountInfo","kind":"json-schema","title":"previewAccountInfo","data":{"description":"Information about the account that will own the order.\n","properties":{"billCycleDay":{"description":"Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".","maximum":31,"minimum":0,"type":"integer"},"currency":{"description":"ISO 3-letter currency code (uppercase). For example, USD.\n","maxLength":3,"type":"string"},"customFields":{"$ref":"#/components/schemas/AccountObjectCustomFields"},"shipToContact":{"$ref":"#/components/schemas/PreviewContactInfo"},"soldToContact":{"$ref":"#/components/schemas/PreviewContactInfo"},"taxInfo":{"$ref":"#/components/schemas/TaxInfo"}},"required":["currency","billCycleDay"],"title":"previewAccountInfo","type":"object"}},"components/schemas/PreviewOptions":{"id":"components/schemas/PreviewOptions","kind":"json-schema","title":"PreviewOptions","data":{"properties":{"previewNumberOfPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of periods to preview when the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewThroughType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NumberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"type":"integer"},"previewThruType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The options on how the preview through date is calculated. Available for preview only."},"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":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify a specific date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificPreviewThruDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If you also set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billTargetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderLineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, order line items whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billTargetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is no later than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificPreviewThruDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned."},"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":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NumberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewNumberOfPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify how many periods you want to preview. In case the order only contains an order line item but not contains a subscription, if you also set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billTargetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderLineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, order line items whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billTargetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is no later than today are returned."},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option is invalid when any subscription included in this order is evergreen. In case the order only contains an order line item but not contains a subscription, if you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billTargetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderLineItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, order line items whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billTargetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is no later than today are returned."},"children":[]}]}]}]}]}],"enum":["SpecificDate","TermEnd","NumberOfPeriods"],"type":"string"},"previewTypes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more types of the preview. It can include:"},"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":"ChargeMetrics: charge level metrics will be returned in the response, including: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cmrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tcv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tcb"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax"},"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":"BillingDocs: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditMemos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned in the response. Note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditMemos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available if the Invoice Settlement feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OrderDeltaMetrics: order delta metrics will be returned in the response, including: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderDeltaMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderDeltaTcb"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderDeltaTcv"},"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":"OrderMetrics: order metrics will be returned in the response, including: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tcb"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tcv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"elp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"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":" As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The new methodologies are reflected in the OrderDeltaMetrics. It is recommended that all customers use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you are an existing "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer and want to migrate to Order Delta Metrics, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Whereas new customers, and existing customers not currently on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RampMetrics: ramp metrics will be returned in the response, including: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tcb"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tcv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" metrics for each charge and each ramp interval."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RampDeltaMetrics: ramp metrics changes will be returned in the response, including: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deltaQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deltaMrr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deltaTcb"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deltaTcv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" metrics for each charge and each ramp interval."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds: fund preview will be returned in the response under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", grouped by subscription with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionFunds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" per subscription. This field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}]}],"items":{"enum":["ChargeMetrics","BillingDocs","OrderDeltaMetrics","OrderMetrics","RampMetrics","RampDeltaMetrics","Funds"],"type":"string"},"type":"array"},"skipTax":{"type":"boolean","description":"If set to true, the system will bypass the tax calculation during order preview.","default":false},"specificPreviewThruDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the order preview. You can preview the invoice charges through the preview through date. (Invoice preview only)"},"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 only applicable if the 'previewThruType' field is set to 'SpecificDate'."},"children":[]}]}]}],"format":"date","type":"string"},"validateScheduledOrders":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, scheduled orders are validated during order preview to ensure all orders can be executed successfully. If you do not want to validate all scheduled orders during order preview, set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":true,"type":"boolean"},"chargeTypeToExclude":{"description":"The charge types to exclude from the forecast run.\n","items":{"type":"string","enum":["OneTime","Recurring","Usage"]},"type":"array"}},"type":"object"}},"components/schemas/EndConditions":{"id":"components/schemas/EndConditions","kind":"json-schema","title":"endDate","data":{"description":"Specifies when a charge becomes inactive.\n","properties":{"endDateCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become inactive."},"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 value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge is active for a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Specific_End_Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes inactive."},"children":[]}]}]}]}],"enum":["Subscription_End","Fixed_Period","Specific_End_Date","One_Time"],"type":"string","nullable":true},"endDatePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date policy of the discount charge to become active when the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply to billing period partially"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" checkbox is selected from the product catalog UI or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyToBillingPeriodPartially"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as true from the \"CRUD: Create a product rate plan charge\" operation."},"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 value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge is active for a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"SpecificEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes inactive."},"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":"Notes"},"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":"You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDatePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to define when a discount charge ends, but not both at the same time."},"children":[]}]}]}]}],"enum":["AlignToApplyToCharge","SpecificEndDate","FixedPeriod"],"type":"string"},"specificEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date in YYYY-MM-DD format. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_End_Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"upToPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the charge in billing periods, days, weeks, months, or years, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer","nullable":true},"upToPeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time that the charge duration is measured in. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Billing_Periods","Days","Weeks","Months","Years"],"type":"string","nullable":true}},"title":"endDate","type":"object"}},"components/schemas/NegotiatedItems":{"id":"components/schemas/NegotiatedItems","kind":"json-schema","title":"NegotiatedItems","data":{"properties":{"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate card entry object."},"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":" For more information, refer to the rate card definition in the product catalog."},"children":[]}]}]}],"additionalProperties":true,"type":"object"}},"type":"object"}},"components/schemas/ChargeTier":{"id":"components/schemas/ChargeTier","kind":"json-schema","title":"chargeTier","data":{"properties":{"endingUnit":{"description":"Limit on the number of units for which the tier is effective.\n","type":"number"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price or per-unit price of the tier, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceFormat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"number"},"priceFormat":{"description":"Specifies whether the tier has a fixed price or a per-unit price.\n","enum":["FlatFee","PerUnit"],"type":"string"},"startingUnit":{"description":"Number of units at which the tier becomes effective.\n","type":"number"},"tier":{"description":"Index of the tier in the charge.\n","minimum":1,"type":"integer"}},"required":["tier","startingUnit","price","priceFormat"],"title":"chargeTier","type":"object"}},"components/schemas/ChargeModelDataOverride":{"id":"components/schemas/ChargeModelDataOverride","kind":"json-schema","title":"chargeModelData","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for charge model configuration data."},"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 only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"properties":{"chargeModelConfiguration":{"properties":{"customFieldPerUnitRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field that carries the per-unit rate for each usage record. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"perUnitAmount__c"},"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 field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"type":"string"},"customFieldTotalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field that carries the total amount to charge for a usage record. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount__c"},"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 field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"type":"string"},"formula":{"description":"The pricing formula to calculate actual rating amount.\n\nThis field is only available for charges that use the Multi-Attribute Pricing charge model.\n","type":"string"}},"type":"object"},"quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of units purchased. This field is used if the Multi-Attribute Pricing formula uses the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" function."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for one-time and recurring charges that use the Multi-Attribute Pricing charge model."},"children":[]}]}]}],"minimum":0,"type":"number"},"tiers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of cumulative pricing tiers in the charge."},"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":": When you override the tiers of a usage-based charge using High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"}},"title":"chargeModelData","type":"object"}},"components/schemas/DiscountApplyDetail":{"id":"components/schemas/DiscountApplyDetail","kind":"json-schema","title":"discountApplyDetail","data":{"properties":{"productRatePlanChargeId":{"description":"Product Rate Plan Charge Id of the discount apply to.\n","type":"string"},"productRatePlanId":{"description":"Product Rate Plan Id of the discount apply to.\n","type":"string"}},"required":["productRatePlanId","productRatePlanChargeId"],"title":"discountApplyDetail","type":"object"}},"components/schemas/DiscountPricingOverride":{"id":"components/schemas/DiscountPricingOverride","kind":"json-schema","title":"discount","data":{"description":"Pricing information about a discount charge.\n","properties":{"applyDiscountTo":{"description":"Specifies which type of charge the discount charge applies to.\n","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"],"type":"string"},"applyToBillingPeriodPartially":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow the discount duration to be aligned with the billing period partially."},"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":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}],"type":"boolean"},"discountAmount":{"description":"Only applicable if the discount charge is a fixed-amount discount.\n","type":"number"},"discountApplyDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge list of discount be applied to."},"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":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/DiscountApplyDetail"},"type":"array"},"discountClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The discount class defines the sequence in which discount product rate plan charges are applied."},"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":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}],"type":"string"},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account"],"type":"string"},"discountPercentage":{"description":"Only applicable if the discount charge is a percentage discount.\n","type":"number"},"originalDiscountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The manufacturer's suggested retail discount price for standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if the standalone discount charge is a fixed-amount discount."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"number"},"originalDiscountPercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The manufacturer's suggested retail discount percentage for standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if the standalone discount charge is a percentage discount."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"number"},"originalListDiscountAmount":{"description":"The original discount amount listed for sale by a manufacturer or retailer.\n","type":"number"},"originalListDiscountPercentage":{"description":"The original discount percentage listed for sale by a manufacturer or retailer.\n","type":"number"},"priceChangeOption":{"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"type":"string"}},"title":"discount","type":"object"}},"components/schemas/OneTimeFlatFeePricingOverride":{"id":"components/schemas/OneTimeFlatFeePricingOverride","kind":"json-schema","title":"oneTimeFlatFee","data":{"description":"Pricing information about a one-time charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n","properties":{"listPrice":{"description":"Price of the charge.\n","type":"number"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"}},"required":["listPrice"],"title":"oneTimeFlatFee","type":"object"}},"components/schemas/OneTimePerUnitPricingOverride":{"id":"components/schemas/OneTimePerUnitPricingOverride","kind":"json-schema","title":"oneTimePerUnit","data":{"description":"Pricing information about a one-time charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n","properties":{"listPrice":{"description":"Per-unit price of the charge.\n","type":"number"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"},"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"number"}},"title":"oneTimePerUnit","type":"object"}},"components/schemas/OneTimeTieredPricingOverride":{"id":"components/schemas/OneTimeTieredPricingOverride","kind":"json-schema","title":"oneTimeTiered","data":{"description":"Pricing information about a one-time charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n","properties":{"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"tiers":{"description":"List of cumulative pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"number"}},"title":"oneTimeTiered","type":"object"}},"components/schemas/OneTimeVolumePricingOverride":{"id":"components/schemas/OneTimeVolumePricingOverride","kind":"json-schema","title":"oneTimeVolume","data":{"description":"Pricing information about a one-time charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n","properties":{"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"tiers":{"description":"List of variable pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"number"}},"title":"oneTimeVolume","type":"object"}},"components/schemas/RecurringCalculatedPricingOverride":{"id":"components/schemas/RecurringCalculatedPricingOverride","kind":"json-schema","title":"recurringCalculated","data":{"allOf":[{"properties":{"clearingExistingMinimumAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reset the minimum amount to null."},"children":[]}]}]}],"type":"boolean"},"clearingExistingMaximumAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reset the maximum amount to null."},"children":[]}]}]}],"type":"boolean"},"eligibleAccountConditions":{"additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A filter expression (single condition or nested condition groups with logical relations) that defines which accounts’ charges are considered in the calculation. If omitted, the system defaults to the calculated charge’s subscription account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"relation: the logical relation with the condition group. Supported values are: and, or. Only two levels of nested condition groups are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conditions:"},"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":"field: name of the condition field. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/set-up-product-catalog/create-product-rate-plan-charges/configure-calculated-percentage-of-spend-charges/define-the-scope-of-eligible-charges","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legitimate condition fields"},"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":"operator: the logical operator. Supported values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"neq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (is null), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nnl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (is not null)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value: the value of the condition field. You can either enter specific values manually or use the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/set-up-product-catalog/create-product-rate-plan-charges/configure-calculated-percentage-of-spend-charges/define-the-scope-of-eligible-charges","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"predefined condition values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"type":"object"},"eligibleChargeConditions":{"additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A filter expression (single condition or nested condition groups with logical relations) that defines which rate plan charges contribute to the calculation; if omitted, the scope defaults to “All charges” (i.e., all charges under the selected accounts are eligible)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"relation: the logical relation with the condition group. Supported values are: and, or. Only two levels of nested condition groups are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conditions:"},"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":"field: name of the condition field. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/set-up-product-catalog/create-product-rate-plan-charges/configure-calculated-percentage-of-spend-charges/define-the-scope-of-eligible-charges","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legitimate condition fields"},"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":"operator: the logical operator. Supported values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"neq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (is null), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nnl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (is not null)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value: the value of the condition field. You can either enter specific values manually or use the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/set-up-product-catalog/create-product-rate-plan-charges/configure-calculated-percentage-of-spend-charges/define-the-scope-of-eligible-charges","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"predefined condition values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"type":"object"},"minimumAmount":{"description":"Non-negative currency amount that establishes the lower bound for the calculated charge in a billing period. If the calculated amount is less than this value, the invoice amount will be set to the minimum value.\n","type":"number"},"maximumAmount":{"description":"Non-negative currency amount that establishes the upper bound for the calculated charge in a billing period. If the calculated amount exceeds this value, the invoice amount will be set to the maximum value.\n","type":"number"},"percentage":{"description":"The specific rate applied to the total eligible spend to determine the base invoice amount before any minimum or maximum amount is applied.\n","type":"number"}},"type":"object"}],"required":["percentage"],"description":"Pricing information about a recurring charge that uses the \"calculated\" charge model.\n","title":"recurringCalculated"}},"components/schemas/PriceChangeParams":{"id":"components/schemas/PriceChangeParams","kind":"json-schema","title":"PriceChangeParams","data":{"properties":{"priceChangeOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora changes the price of the charge each time the subscription renews."},"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":"SpecificPercentageValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceIncreasePercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify how much the price of the charge should change."},"children":[]}]}]}],"enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"type":"string"},"priceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceChangeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minimum":-100,"type":"number"}},"type":"object"}},"components/schemas/DeliveryScheduleParams":{"id":"components/schemas/DeliveryScheduleParams","kind":"json-schema","title":"DeliveryScheduleParams","data":{"properties":{"frequency":{"description":"Specifies the frequency for delivery schedule\n","enum":["Weekly"],"type":"string"},"friday":{"description":"Indicates whether delivery on friday.\n","type":"boolean"},"monday":{"description":"Indicates whether delivery on monday.\n","type":"boolean"},"saturday":{"description":"Indicates whether delivery on saturday.\n","type":"boolean"},"sunday":{"description":"Indicates whether delivery on sunday.\n","type":"boolean"},"thursday":{"description":"Indicates whether delivery on thursday.\n","type":"boolean"},"tuesday":{"description":"Indicates whether delivery on tuesday.\n","type":"boolean"},"wednesday":{"description":"Indicates whether delivery on wednesday.\n","type":"boolean"}},"type":"object"}},"components/schemas/RecurringDeliveryPricingOverride":{"id":"components/schemas/RecurringDeliveryPricingOverride","kind":"json-schema","title":"recurringDelivery","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"deliverySchedule":{"$ref":"#/components/schemas/DeliveryScheduleParams"},"listPrice":{"description":"Price of the charge in each recurring period.\n","type":"number"}}}],"description":"Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled.\n","title":"recurringDelivery"}},"components/schemas/RecurringFlatFeePricingOverride":{"id":"components/schemas/RecurringFlatFeePricingOverride","kind":"json-schema","title":"recurringFlatFee","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"listPrice":{"description":"Price of the charge in each recurring period.\n","type":"number"},"listPriceBase":{"description":"Specifies the duration of each recurring period.\n","enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months","Per_Validity_Period"],"type":"string"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer"}},"type":"object"}],"description":"Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n","title":"recurringFlatFee"}},"components/schemas/RecurringPerUnitPricingOverride":{"id":"components/schemas/RecurringPerUnitPricingOverride","kind":"json-schema","title":"recurringPerUnit","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"listPrice":{"description":"Per-unit price of the charge in each recurring period.\n","type":"number"},"listPriceBase":{"description":"Specifies the duration of each recurring period.\n","enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months","Per_Validity_Period"],"type":"string"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"},"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"number"}},"type":"object"}],"description":"Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n","title":"recurringPerUnit"}},"components/schemas/RecurringTieredPricingOverride":{"id":"components/schemas/RecurringTieredPricingOverride","kind":"json-schema","title":"recurringTiered","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"listPriceBase":{"description":"Specifies the duration of each recurring period.\n","enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months","Per_Validity_Period"],"type":"string"},"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer"},"tiers":{"description":"List of cumulative pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"number"}},"type":"object"}],"description":"Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n","title":"recurringTiered"}},"components/schemas/RecurringVolumePricingOverride":{"id":"components/schemas/RecurringVolumePricingOverride","kind":"json-schema","title":"recurringVolume","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"listPriceBase":{"description":"Specifies the duration of each recurring period.\n","enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months","Per_Validity_Period"],"type":"string"},"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer"},"tiers":{"description":"List of variable pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"number"}},"type":"object"}],"description":"Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n","title":"recurringVolume"}},"components/schemas/PreviewOrderTriggerParams":{"id":"components/schemas/PreviewOrderTriggerParams","kind":"json-schema","title":"startDate","data":{"description":"Specifies when a charge becomes active.\n","properties":{"specificTriggerDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date in YYYY-MM-DD format. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"While this field is applicable, if this field is not set, your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action creates a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription. If at the same time the service activation date is required and not set, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription is created."},"children":[]}]}]}],"format":"date","type":"string"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become active."},"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":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes active."},"children":[]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance","SpecificDate"],"type":"string"}},"title":"startDate","type":"object"}},"components/schemas/PreviewOrderChargeOverride":{"id":"components/schemas/PreviewOrderChargeOverride","kind":"json-schema","title":"charge","data":{"description":"Charge associated with a rate plan.\n","properties":{"accountReceivableAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accountReceivableAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"billing":{"description":"Billing information about the charge.\n","properties":{"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the month that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maximum":31,"minimum":0,"type":"integer"},"billCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines the day that each billing period begins on."},"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":"DefaultFromCustomer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the bill cycle day of the account that owns the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the month that each billing period begins on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionStartDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeTriggerDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeklyBillCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the week that each billing period begins on."},"children":[]}]}]}]}],"enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek"],"type":"string"},"billingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing frequency of the charge. The value of this field controls the duration of each billing period."},"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":"Specific_Days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the duration of each billing period."},"children":[]}]}]}],"enum":["Month","Quarter","Semi_Annual","Annual","Eighteen_Months","Two_Years","Three_Years","Five_Years","Specific_Months","Subscription_Term","Week","Specific_Weeks","Specific_Days"],"type":"string"},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges."},"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":"AlignToCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for information about how Zuora determines the billing day."},"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 not supported in one time charges."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart"],"type":"string"},"billingTiming":{"description":"Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of each billing period in months or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"weeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the week that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"type":"object"},"chargeFunction":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["CommitmentTrueUp","CreditCommitment"],"type":"string"},"creditOption":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"chargeModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeModel of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported charge models:"},"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":"code","inline":true,"attributes":{"content":"FlatFee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerUnit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountFixedAmount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge number of the charge. For example, C-00000307."},"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 you do not set this field, Zuora will generate a charge number starting with a default prefix, for example, C-. This default prefix is predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"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 you want to use a custom charge number, do not use the default prefix predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use your own prefix, for example, SC-."},"children":[]}]}]}]}],"maxLength":50,"type":"string"},"chargeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeType of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported charge types:"},"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":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractAssetAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractRecognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deferredRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"description":{"description":"Description of the charge.\n","maxLength":500,"type":"string"},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"drawdownScope":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prepayment"},"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":"code","inline":true,"attributes":{"content":"SUBSCRIPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges of the same subscription can be drawn down."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges in the same account (subscription owner) can be drawn down."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["SUBSCRIPTION","ACCOUNT"]},"drawdownPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown priority for consumption ordering. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"endDate":{"$ref":"#/components/schemas/EndConditions"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and want to create a completed order and an active subscription, you must specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field:"},"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":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in pending status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in active status."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both the following features are enabled in your tenant, you must ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in a Create Subscription or Add Product order action is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this order action to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Prepaid with Drawdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both the following features are enabled in your tenant, you must ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set consistently for a prepayment charge and the corresponding drawdown charge."},"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":"Prepaid with Drawdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"fundSupportAccountHierarchy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to enable sub-account's usage to drawdown from the parent's funds."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isRollover":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"True\" or \"False\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"negotiatedPriceTable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of negotiated price table information. The rate card entries provided in the array will override"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the existing rate card entries in the standard price table to form a negotiated price table that will be"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used during pricing evaluation."},"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":" To enable the Negotiated Price Table feature, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/NegotiatedItems"},"type":"array"},"pobPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pobPolicy of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"prepaymentUnitType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit type of the prepayment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["UNIT"]},"pricing":{"description":"Pricing information about the charge.\n","properties":{"chargeModelData":{"$ref":"#/components/schemas/ChargeModelDataOverride"},"discount":{"$ref":"#/components/schemas/DiscountPricingOverride"},"oneTimeFlatFee":{"$ref":"#/components/schemas/OneTimeFlatFeePricingOverride"},"oneTimePerUnit":{"$ref":"#/components/schemas/OneTimePerUnitPricingOverride"},"oneTimeTiered":{"$ref":"#/components/schemas/OneTimeTieredPricingOverride"},"oneTimeVolume":{"$ref":"#/components/schemas/OneTimeVolumePricingOverride"},"recurringCalculated":{"$ref":"#/components/schemas/RecurringCalculatedPricingOverride"},"recurringDeliveryBased":{"$ref":"#/components/schemas/RecurringDeliveryPricingOverride"},"recurringFlatFee":{"$ref":"#/components/schemas/RecurringFlatFeePricingOverride"},"recurringPerUnit":{"$ref":"#/components/schemas/RecurringPerUnitPricingOverride"},"recurringTiered":{"$ref":"#/components/schemas/RecurringTieredPricingOverride"},"recurringVolume":{"$ref":"#/components/schemas/RecurringVolumePricingOverride"}},"type":"object"},"pricingAttributes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values are used to get the charge’s list price from the product catalog. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically."},"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":" To enable Dynamic Pricing, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","additionalProperties":true},"productCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productCategory of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productClass of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productFamily":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productFamily of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productLine":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productLine of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal identifier of the product rate plan charge that the charge is based on. You can specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When subscribing to a hard bundle, include the optional component charge’s ID explicitly in order to add it to the subscription."},"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":"isAddingSubsetCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true, the product rate charge specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is added to the existing rate plan specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeNumber":{"description":"Number of a product rate-plan charge for this subscription.\n","type":"string"},"prorationOption":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge Level Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-usage-charge-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage charge proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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":"You can use this field to specify the charge-level proration option for a usage charge or recurring charge when you create or add a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"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":"NoProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeBasedProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeFullPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"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":"When the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, the possible options 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":"text","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides."},"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":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the customization rules using these options in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod","CustomizeProrationOptionOverrides"],"type":"string"},"ratingPropertiesOverride":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field is used only when the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prorationOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"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 field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"object","properties":{"isProratePartialMonth":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify whether to prorate the recurring charge for a partial month. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"boolean"},"prepaymentChargeProrationRule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define whether to prorate the charge amount or not. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProrateAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the proration rules via the options under this section."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["ProrateAmount","ChargeFullAmount"]},"prorationUnit":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the unit of proration for a recurring charge. The tenant-level proration option will be overridden."},"children":[]}]}]}],"enum":["ProrateByDay","ProrateByMonthFirst"],"type":"string"},"daysInMonth":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the number of days counted for a month when prorating a recurring charge. The tenant-level proration option will be overridden. See more details for each of the following enum values in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["UseActualDays","Assume30Days","Assume30DaysStrict"],"type":"string"}}},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"Revenue Recognition Code\n","maxLength":70,"type":"string"},"revRecTriggerCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition trigger condition."},"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":"Contract Effective Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Service Activation Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Customer Acceptance Date"},"children":[]}]}]}]}],"enum":["Contract Effective Date","Service Activation Date","Customer Acceptance Date"],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition rule, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize upon invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize daily over time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have both the Order to Revenue feature and the Standalone Orders feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have both the Order to Revenue feature and the Standalone Orders feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"rolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicit cutoff date when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverEndDateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"rolloverEndDateType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover cutoff strategy determining when the rollover eligibility will end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"ChargeEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the subscription term end."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at an explicit date specified in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RolloverEndDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeEndDate","SubscriptionTerm","SpecificDate"]},"rolloverFundPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for rolled-over funds. Lower value means that it will be consumed first. When Enhanced Unit-Based Prepaid with Drawdown feature is enabled, you can customize a single rollover period length together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriodType"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"rolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can customize a single rollover period length together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"rolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"rolloverPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit for rollover period length."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"Day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Day-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Month-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quarter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Quarter-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Annual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Annual rollover periods."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["Day","Month","Quarter","Annual"]},"startDate":{"$ref":"#/components/schemas/PreviewOrderTriggerParams"},"unBilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unBilledReceivablesAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"uniqueToken":{"description":"Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n","maxLength":50,"type":"string"},"upsellOriginChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the original upselling charge associated with the current charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a termed subscription, you can now use the \"Create an order\" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:"},"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":"Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell."},"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":"In the preceding charge to add, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upsellOriginChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the existing rate plan charge for which you want to make the quantity upsell."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription."},"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 Quantity Upsell feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"validityPeriodType":{"description":[{"$$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 only available if you have enabled either 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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field in the following scenarios:"},"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":"When you create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use this field to define the period in which the prepayment units are valid to use."},"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":"When you override the setting of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commitment true-up charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the product catalog, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When you use a standalone order to create a commitment true-up charge, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can also choose from the following options: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Specify the actual number in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificValidityPeriodLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"type":"string"},"specificValidityPeriodLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of days, weeks, or months for the validity period when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidityPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"validityPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the anchor date for validity period (VP) boundaries. The anchor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date defines the recurring grid — VP boundaries fall at every VP-length step"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the anchor. The charge's start and end dates then determine which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"portion of this grid is covered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ChargeStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - Anchor date is the charge start date. Simplest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"option with no partial first VP."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is the subscription term start date. Aligns all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges on the same subscription to a common grid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is derived by walking backward from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription term end date. Last VP always ends cleanly at term end;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partial VP (if any) is at the start."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAnchorDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom alignment for special billing arrangements."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeStart","TermStart","TermEnd","SpecificDate"]},"validityPeriodAnchorDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The anchor date for validity period alignment. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAlignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"validityPeriodProrationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls what happens to units when a validity period (VP) is partial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ProrateUnits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant partial units, the number is prorated based on the overlap ratio."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NoProrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant full units."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ProrateUnits","NoProrate"]},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code of a charge. This field is available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode of a charge.  This field is available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["TaxInclusive","TaxExclusive"],"type":"string"},"taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag indicates whether the charge is taxable. If this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"type":"boolean"}},"required":["productRatePlanChargeId"],"title":"charge","type":"object"}},"components/schemas/OrdersRatePlanObjectCustomFields":{"id":"components/schemas/OrdersRatePlanObjectCustomFields","kind":"json-schema","title":"RatePlanCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.\n","title":"RatePlanCustomFields","type":"object"}},"components/schemas/RatePlanFeatureOverrideCustomFields":{"id":"components/schemas/RatePlanFeatureOverrideCustomFields","kind":"json-schema","title":"ratePlanFeatureCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the feature. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-custom-field-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"A container for custom fields of the feature.\n","title":"ratePlanFeatureCustom","type":"object"}},"components/schemas/CreateOrderRatePlanFeatureOverride":{"id":"components/schemas/CreateOrderRatePlanFeatureOverride","kind":"json-schema","title":"ratePlanFeature","data":{"description":"Information about feature in rate plan.\n","properties":{"customFields":{"$ref":"#/components/schemas/RatePlanFeatureOverrideCustomFields"},"description":{"description":"A description of the feature.","maxLength":500,"type":"string"},"featureId":{"description":"Internal identifier of the feature in the product catalog.\n","type":"string"}},"required":["featureId"],"title":"ratePlanFeature","type":"object"}},"components/schemas/PreviewOrderRatePlanOverride":{"id":"components/schemas/PreviewOrderRatePlanOverride","kind":"json-schema","title":"ratePlan","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"chargeOverrides":{"description":"List of charges associated with the rate plan.\n","items":{"$ref":"#/components/schemas/PreviewOrderChargeOverride"},"type":"array"},"clearingExistingFeatures":{"description":"Specifies whether all features in the rate plan will be cleared.\n","type":"boolean"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"isAddingSubsetCharges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to add a subset of charges to the subscription."},"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":" To access this field for adding a subset of charges, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isFromExternalCatalog":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"boolean"},"productRatePlanId":{"description":"Internal identifier of the product rate plan that the rate plan is based on.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the standalone rate plan."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"subscriptionProductFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of features associated with the rate plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system compares the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the request with the counterpart fields in a rate plan. The comparison results are 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":"If there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the field is empty, features in the rate plan remain unchanged. But if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingExistingFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is additionally set to true, all features in the rate plan are cleared."},"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":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, as well as the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderRatePlanFeatureOverride"},"type":"array"},"uniqueToken":{"description":"Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n","maxLength":50,"type":"string"},"subscriptionRatePlanNumber":{"description":"Number of a subscription rate plan for this subscription.\n","maxLength":50,"type":"string"}},"required":["productRatePlanId"],"title":"ratePlan","type":"object"}},"components/schemas/CancelSubscription":{"id":"components/schemas/CancelSubscription","kind":"json-schema","title":"cancelSubscription","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CancelSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"cancellationEffectiveDate":{"format":"date","type":"string"},"cancellationPolicy":{"enum":["EndOfCurrentTerm","EndOfLastInvoicePeriod","SpecificDate"],"type":"string"}},"required":["cancellationPolicy"],"title":"cancelSubscription","type":"object"}},"components/schemas/CreateOrderTriggerParams":{"id":"components/schemas/CreateOrderTriggerParams","kind":"json-schema","title":"startDate","data":{"description":"Specifies when a charge becomes active.\n","properties":{"periodsAfterChargeStart":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the discount charge in days, weeks, months, or years, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDatePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodAfterApplyToChargeStartDate"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}],"type":"integer"},"specificTriggerDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date in YYYY-MM-DD format. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"While this field is applicable, if this field is not set, your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action creates a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription. If at the same time the service activation date is required and not set, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While this field is applicable, if this field is not set, the following order actions create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order but do not impact the subscription status. "},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you want to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"AddProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TermsAndConditions"},"children":[]}]}]}]}],"format":"date","type":"string"},"startDatePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date policy of the discount charge to become active when the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply to billing period partially"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" checkbox is selected from the product catalog UI or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyToBillingPeriodPartially"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as true from the \"CRUD: Create a product rate plan charge\" operation."},"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 value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"FixedPeriodAfterApplyToChargeStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge is active for a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"Notes"},"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":"You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDatePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to define when a discount charge starts, but not both at the same time."},"children":[]}]}]}]}],"enum":["AlignToApplyToCharge","SpecificDate","EndOfLastInvoicePeriodOfApplyToCharge","FixedPeriodAfterApplyToChargeStartDate"],"type":"string"},"startPeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time that the discount charge duration is measured in. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDatePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodAfterApplyToChargeStartDate"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}],"enum":["Days","Weeks","Months","Years"],"type":"string"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become active. If this field is not specified, the value of the field will be defaulted to the trigger event value defined in the product catalog."},"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":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes active."},"children":[]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance","SpecificDate"],"type":"string"}},"title":"startDate","type":"object"}},"components/schemas/PreviewOrderChangePlanChargeOverride":{"id":"components/schemas/PreviewOrderChangePlanChargeOverride","kind":"json-schema","title":"charge","data":{"description":"Charge associated with a rate plan.\n","properties":{"accountReceivableAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accountReceivableAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"billing":{"description":"Billing information about the charge.\n","properties":{"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the month that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maximum":31,"minimum":0,"type":"integer"},"billCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines the day that each billing period begins on."},"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":"DefaultFromCustomer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the bill cycle day of the account that owns the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the month that each billing period begins on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionStartDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeTriggerDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeklyBillCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the week that each billing period begins on."},"children":[]}]}]}]}],"enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek"],"type":"string"},"billingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing frequency of the charge. The value of this field controls the duration of each billing period."},"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":"Specific_Days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the duration of each billing period."},"children":[]}]}]}],"enum":["Month","Quarter","Semi_Annual","Annual","Eighteen_Months","Two_Years","Three_Years","Five_Years","Specific_Months","Subscription_Term","Week","Specific_Weeks","Specific_Days"],"type":"string"},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges."},"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":"AlignToCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for information about how Zuora determines the billing day."},"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 not supported in one time charges."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart"],"type":"string"},"billingTiming":{"description":"Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of each billing period in months or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"weeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the week that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"type":"object"},"chargeFunction":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["CommitmentTrueUp","CreditCommitment"],"type":"string"},"creditOption":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"chargeModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeModel of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported charge models:"},"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":"code","inline":true,"attributes":{"content":"FlatFee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerUnit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountFixedAmount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge number of the charge. For example, C-00000307."},"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 you do not set this field, Zuora will generate a charge number starting with a default prefix, for example, C-. This default prefix is predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"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 you want to use a custom charge number, do not use the default prefix predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use your own prefix, for example, SC-."},"children":[]}]}]}]}],"maxLength":50,"type":"string"},"chargeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeType of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported charge types:"},"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":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractAssetAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractRecognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deferredRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"description":{"description":"Description of the charge.\n","maxLength":500,"type":"string"},"drawdownPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown priority for consumption ordering. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"drawdownScope":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prepayment"},"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":"code","inline":true,"attributes":{"content":"SUBSCRIPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges of the same subscription can be drawn down."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges in the same account (subscription owner) can be drawn down."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["SUBSCRIPTION","ACCOUNT"]},"endDate":{"$ref":"#/components/schemas/EndConditions"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and want to create a completed order and an active subscription, you must specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field:"},"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":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in pending status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in active status."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"fundSupportAccountHierarchy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to enable sub-account's usage to drawdown from the parent's funds."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isRollover":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"True\" or \"False\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"negotiatedPriceTable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of negotiated price table information. The rate card entries provided in the array will override"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the existing rate card entries in the standard price table to form a negotiated price table that will be"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used during pricing evaluation."},"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":" To enable the Negotiated Price Table feature, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/NegotiatedItems"},"type":"array"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"pobPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pobPolicy of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"prepaymentUnitType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit type of the prepayment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["UNIT"]},"pricing":{"description":"Pricing information about the charge.\n","properties":{"chargeModelData":{"$ref":"#/components/schemas/ChargeModelDataOverride"},"discount":{"$ref":"#/components/schemas/DiscountPricingOverride"},"oneTimeFlatFee":{"$ref":"#/components/schemas/OneTimeFlatFeePricingOverride"},"oneTimePerUnit":{"$ref":"#/components/schemas/OneTimePerUnitPricingOverride"},"oneTimeTiered":{"$ref":"#/components/schemas/OneTimeTieredPricingOverride"},"oneTimeVolume":{"$ref":"#/components/schemas/OneTimeVolumePricingOverride"},"recurringCalculated":{"$ref":"#/components/schemas/RecurringCalculatedPricingOverride"},"recurringDeliveryBased":{"$ref":"#/components/schemas/RecurringDeliveryPricingOverride"},"recurringFlatFee":{"$ref":"#/components/schemas/RecurringFlatFeePricingOverride"},"recurringPerUnit":{"$ref":"#/components/schemas/RecurringPerUnitPricingOverride"},"recurringTiered":{"$ref":"#/components/schemas/RecurringTieredPricingOverride"},"recurringVolume":{"$ref":"#/components/schemas/RecurringVolumePricingOverride"}},"type":"object"},"pricingAttributes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values are used to get the charge’s list price from the product catalog. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically."},"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":" To enable Dynamic Pricing, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","additionalProperties":true},"productCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productCategory of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productClass of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productFamily":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productFamily of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productLine":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productLine of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal identifier of the product rate plan charge that the charge is based on. You can specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When subscribing to a hard bundle, include the optional component charge’s ID explicitly in order to add it to the subscription."},"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":"isAddingSubsetCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true, the product rate charge specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is added to the existing rate plan specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeNumber":{"description":"Number of a product rate-plan charge for this subscription.\n","type":"string"},"prorationOption":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge Level Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-usage-charge-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage charge proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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":"You can use this field to specify the charge-level proration option for a usage charge or recurring charge when you create or add a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"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":"NoProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeBasedProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeFullPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"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":"When the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, the possible options 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":"text","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides."},"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":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the customization rules using these options in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod","CustomizeProrationOptionOverrides"],"type":"string"},"ratingPropertiesOverride":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field is used only when the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prorationOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"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 field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"object","properties":{"isProratePartialMonth":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify whether to prorate the recurring charge for a partial month. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"boolean"},"prepaymentChargeProrationRule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define whether to prorate the charge amount or not. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProrateAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the proration rules via the options under this section."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["ProrateAmount","ChargeFullAmount."]},"prorationUnit":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge Level Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the unit of proration for a recurring charge. The tenant-level proration option will be overridden."},"children":[]}]}]}],"enum":["ProrateByDay","ProrateByMonthFirst"],"type":"string"},"daysInMonth":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the number of days counted for a month when prorating a recurring charge. The tenant-level proration option will be overridden. See more details for each of the following enum values in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["UseActualDays","Assume30Days","Assume30DaysStrict"],"type":"string"}}},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"Revenue Recognition Code\n","maxLength":70,"type":"string"},"revRecTriggerCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition trigger condition."},"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":"Contract Effective Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Service Activation Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Customer Acceptance Date"},"children":[]}]}]}]}],"enum":["Contract Effective Date","Service Activation Date","Customer Acceptance Date"],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition rule, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize upon invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize daily over time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have both the Order to Revenue feature and the Standalone Orders feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have both the Order to Revenue feature and the Standalone Orders feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"rolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicit cutoff date when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverEndDateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"rolloverEndDateType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover cutoff strategy determining when the rollover eligibility will end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"ChargeEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the subscription term end."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at an explicit date specified in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RolloverEndDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeEndDate","SubscriptionTerm","SpecificDate"]},"rolloverFundPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for rolled-over funds. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"rolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period length of the rollover fund. When the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can customize a single rollover period length together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"rolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"rolloverPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit for rollover period length."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"Day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Day-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Month-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quarter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Quarter-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Annual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Annual rollover periods."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["Day","Month","Quarter","Annual"]},"specificValidityPeriodLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of days, weeks, or months for the validity period when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidityPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"startDate":{"$ref":"#/components/schemas/CreateOrderTriggerParams"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The taxCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The taxMode of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"TaxExclusive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxInclusive"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"unBilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unBilledReceivablesAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"uniqueToken":{"description":"Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n","maxLength":50,"type":"string"},"upsellOriginChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the original upselling charge associated with the current charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a termed subscription, you can now use the \"Create an order\" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:"},"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":"Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell."},"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":"In the preceding charge to add, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upsellOriginChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the existing rate plan charge for which you want to make the quantity upsell."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription."},"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 Quantity Upsell feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"validityPeriodType":{"description":[{"$$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 only available if you have enabled either 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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field in the following scenarios:"},"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":"When you create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use this field to define the period in which the prepayment units are valid to use."},"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":"When you override the setting of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commitment true-up charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the product catalog, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When you use a standalone order to create a commitment true-up charge, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can also choose from the following options: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Specify the actual number in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificValidityPeriodLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]}]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"type":"string"},"validityPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the anchor date for validity period (VP) boundaries. The anchor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date defines the recurring grid — VP boundaries fall at every VP-length step"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the anchor. The charge's start and end dates then determine which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"portion of this grid is covered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ChargeStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - Anchor date is the charge start date. Simplest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"option with no partial first VP."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is the subscription term start date. Aligns all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges on the same subscription to a common grid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is derived by walking backward from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription term end date. Last VP always ends cleanly at term end;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partial VP (if any) is at the start."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAnchorDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom alignment for special billing arrangements."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeStart","TermStart","TermEnd","SpecificDate"]},"validityPeriodAnchorDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The anchor date for validity period alignment. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAlignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"validityPeriodProrationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls what happens to units when a validity period (VP) is partial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ProrateUnits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant partial units, the number is prorated based on the overlap ratio."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NoProrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant full units."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ProrateUnits","NoProrate"]}},"required":["productRatePlanChargeId"],"title":"charge","type":"object"}},"components/schemas/PreviewOrderChangePlanRatePlanOverride":{"id":"components/schemas/PreviewOrderChangePlanRatePlanOverride","kind":"json-schema","title":"ratePlan","data":{"description":"Information about the new product rate plan to add. \n","properties":{"chargeOverrides":{"description":"List of charges associated with the rate plan.\n","items":{"$ref":"#/components/schemas/PreviewOrderChangePlanChargeOverride"},"type":"array"},"clearingExistingFeatures":{"description":"Specifies whether all features in the rate plan will be cleared.\n","type":"boolean"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"externallyManagedPlanId":{"description":"Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"subscriptionRatePlanNumber":{"description":"Number of a subscription rate plan for this subscription.\n","maxLength":50,"type":"string"},"isFromExternalCatalog":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"boolean"},"productRatePlanId":{"description":"Internal identifier of the product rate plan that the rate plan is based on.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the standalone rate plan."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"subscriptionProductFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of features associated with the rate plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system compares the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the request with the counterpart fields in a rate plan. The comparison results are 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":"If there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the field is empty, features in the rate plan remain unchanged. But if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingExistingFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is additionally set to true, all features in the rate plan are cleared."},"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":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, as well as the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderRatePlanFeatureOverride"},"type":"array"},"uniqueToken":{"description":"Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n","maxLength":50,"type":"string"}},"title":"ratePlan","type":"object"}},"components/schemas/PreviewOrderCreateChangePlan":{"id":"components/schemas/PreviewOrderCreateChangePlan","kind":"json-schema","title":"createChangePlan","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChangePlan"},"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 the change plan type of order action to replace the existing rate plans in a subscription with other rate plans."},"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 change plan type of order action is supported for the  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. However, it is currently not supported for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to create a pending order through the \"change plan\" order action, and if the charge's trigger condition is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must set a charge number in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for the \"change plan\" order action. In this case, if you do not set it, Zuora will not generate the charge number for you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See more information about pending orders in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-pending-orders-and-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending orders and subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"effectivePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectivePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field 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":"If the rate plan change (from old to new) is an upgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveImmediately"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the rate plan change (from old to new) is a downgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"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":"Notes"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you cannot set the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-trigger-dates-updation-for-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing trigger dates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the subscription as the system will automatically set the trigger dates to the end of billing period, and you cannot set the following billing trigger date settings to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Require Customer Acceptance of Orders?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Require Service Activation of Orders?"},"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":"When setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the contract effective date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerDates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field 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":"Set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a date for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]}]}]}]}]}],"enum":["EffectiveImmediately","EffectiveEndOfBillingPeriod","SpecificDate"],"type":"string"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan. However, if there are multiple rate plans with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value existing in the subscription, you must use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to remove the rate plan. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be used to distinguish multiple rate plans in this case."},"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":" Please provide only one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If more than 1 field is provided then the request would fail."},"children":[]}]}]}],"type":"string"},"newProductRatePlan":{"$ref":"#/components/schemas/PreviewOrderChangePlanRatePlanOverride"},"productRatePlanId":{"description":"ID of the product rate plan that the removed rate plan is based on.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the rate plan to remove. This can be the latest version or any history version of ID. Note that the removal of a rate plan through the Change Plan order action supports the function of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-rate-plans-removal-from-subscriptions-before-future-dated-removals","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removal before future-dated removals"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as in a Remove Product order action."},"children":[]}]}]}],"type":"string"},"resetBcd":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD."},"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":": If the rate plan change is an upgrade (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Upgrade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), then the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveImmediately"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default. In this case, if you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resetBcd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the system sets this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while BCD is the effective date."},"children":[]}]}]}],"type":"boolean"},"subType":{"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 choose the sub type for your change plan order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, if you do not set this field, the field will be automatically generated by the system according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are within the same Grading catalog group:"},"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 grade of new plan is greater than that of the old plan, this is an \"Upgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan is less than that of the old plan, this is a \"Downgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan equals that of the old plan, this is a \"Crossgrade\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\"."},"children":[]}]}]}],"enum":["Upgrade","Downgrade","Crossgrade","PlanChanged"],"type":"string"},"subscriptionRatePlanNumber":{"description":"Number of a rate plan for this subscription.\n","type":"string"}},"required":["newProductRatePlan"],"title":"createChangePlan","type":"object"}},"components/schemas/PhoneType":{"id":"components/schemas/PhoneType","kind":"json-schema","title":"PhoneType","data":{"enum":["Work","Mobile","Home","Other"],"description":"Specifies the type of phone number.","type":"string"}},"components/schemas/UpdateAccountContact":{"id":"components/schemas/UpdateAccountContact","kind":"json-schema","title":"Contact","data":{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","type":"string","maxLength":255},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string","maxLength":255},"city":{"description":"City, 100 characters or less.\n","type":"string","maxLength":100},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora\nTax, you must specify a country in the sold-to contact to calculate\ntax. A bill-to contact may be used if no sold-to contact is provided.","type":"string","maxLength":64},"county":{"description":"County; 100 characters or less. May optionally be used by Zuora Tax to\ncalculate county tax.","type":"string","maxLength":100},"fax":{"description":"Fax phone number, 40 characters or less.\n","type":"string","maxLength":40},"firstName":{"description":"First name, 100 characters or less.\n","type":"string","maxLength":100,"minLength":1},"homePhone":{"description":"Home phone number, 40 characters or less.\n","type":"string","maxLength":40},"lastName":{"description":"Last name, 100 characters or less.\n","type":"string","maxLength":100,"minLength":1},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","type":"string","maxLength":40},"nickname":{"description":"Nickname for this contact\n","type":"string","maxLength":100},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","type":"string","maxLength":40},"otherPhoneType":{"$ref":"#/components/schemas/PhoneType"},"personalEmail":{"description":"Personal email address, 80 characters or less.\n","type":"string","format":"email","maxLength":80},"postalCode":{"description":"Postal code, 20 characters or less.\n","type":"string","maxLength":20},"state":{"description":"State; must be a valid state or province name or 2-character\nabbreviation. If using Zuora Tax, be aware that Zuora Tax requires a\nstate (in the US) or province (in Canada) in this field for the\nsold-to contact to calculate tax, and that a bill-to contact may be\nused if no sold-to contact is provided.","type":"string","maxLength":100},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax\nrules. Not required.","type":"string","maxLength":100},"workEmail":{"description":"Work email address, 80 characters or less.\n","format":"email","type":"string","maxLength":80},"workPhone":{"description":"Work phone number, 40 characters or less.\n","type":"string","maxLength":40}},"required":["firstName","lastName"],"type":"object","additionalProperties":true,"description":"Container for bill-to/sold-to/ship-to contact information for this account.\n","title":"Contact"}},"components/schemas/CreateAccountContact":{"id":"components/schemas/CreateAccountContact","kind":"json-schema","title":"Contact","data":{"allOf":[{"$ref":"#/components/schemas/UpdateAccountContact"},{"type":"object","properties":{"contactDescription":{"description":"A description for the contact.\n","maxLength":100,"type":"string"}}}],"additionalProperties":true,"required":["firstName","lastName"],"description":"Container for bill-to/sold-to/ship-to contact information for this account.\n","title":"Contact"}},"components/schemas/BillToContactPostOrder":{"id":"components/schemas/BillToContactPostOrder","kind":"json-schema","title":"BillToContactPostOrder","data":{"allOf":[{"description":"Contact details associated with an account.\n","properties":{"address1":{"description":"First line of the contact's address. This is often a street address or a business name.\n","maxLength":255,"type":"string"},"address2":{"description":"Second line of the contact's address.\n","maxLength":255,"type":"string"},"city":{"description":"City of the contact's address.\n","maxLength":100,"type":"string"},"contactDescription":{"description":"A description for the contact.\n","maxLength":100,"type":"string"},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the bill-to contact to calculate tax.\n","maxLength":64,"type":"string"},"county":{"description":"County of the contact's address.\n","maxLength":100,"type":"string"},"fax":{"description":"Fax number of the contact.\n","maxLength":40,"type":"string"},"firstName":{"description":"First name of the contact.\n","maxLength":100,"type":"string"},"homePhone":{"description":"Home phone number of the contact.\n","maxLength":40,"type":"string"},"lastName":{"description":"Last name of the contact.\n","maxLength":100,"type":"string"},"mobilePhone":{"description":"Mobile phone number of the contact.\n","maxLength":40,"type":"string"},"nickname":{"description":"Nickname of the contact.\n","maxLength":100,"type":"string"},"otherPhone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional phone number of the contact. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhoneType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the type of phone number."},"children":[]}]}]}],"maxLength":40,"type":"string"},"otherPhoneType":{"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 phone number in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"Personal email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"postalCode":{"description":"ZIP code or other postal code of the contact's address.\n","maxLength":20,"type":"string"},"state":{"description":"State or province of the contact's address.\n","maxLength":100,"type":"string"},"taxRegion":{"description":"Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n","maxLength":100,"type":"string","nullable":true},"workEmail":{"description":"Business email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"workPhone":{"description":"Business phone number of the contact.\n","maxLength":40,"type":"string"}},"required":["firstName","lastName"],"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}]}},"components/schemas/AccountCreditCardHolder":{"id":"components/schemas/AccountCreditCardHolder","kind":"json-schema","title":"AccountCreditCardHolder","data":{"description":"Information about the cardholder of a credit card payment method associated with an account. If you do not provide information about the cardholder, Zuora uses the account's bill-to contact.\n","properties":{"addressLine1":{"description":"First line of the cardholder's address.\n","maxLength":255,"type":"string"},"addressLine2":{"description":"Second line of the cardholder's address.\n","maxLength":255,"type":"string"},"cardHolderName":{"description":"Full name of the cardholder as it appears on the card. For example, \"John J Smith\", 50 characters or less. The value must consist only of US-ASCII characters and must not  include special characters.","maxLength":50,"type":"string"},"city":{"description":"City of the cardholder's address.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","maxLength":40,"type":"string"},"country":{"description":"Country of the cardholder's address. The value of this field must be a valid country name or abbreviation.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","maxLength":64,"type":"string"},"email":{"description":"Email address of the cardholder.\n","maxLength":80,"type":"string"},"phone":{"description":"Phone number of the cardholder.\n","maxLength":40,"type":"string"},"state":{"description":"State or province of the cardholder's address.\n","maxLength":50,"type":"string"},"zipCode":{"description":"ZIP code or other postal code of the cardholder's address.\n","maxLength":20,"type":"string"}},"type":"object"}},"components/schemas/creditCard":{"id":"components/schemas/creditCard","kind":"json-schema","title":"creditCard","data":{"description":"Default payment method associated with an account. Only credit card payment methods are supported.\n","properties":{"cardHolderInfo":{"$ref":"#/components/schemas/AccountCreditCardHolder"},"cardNumber":{"description":"Card number. Once set, you cannot update or query the value of this field. The value of this field is only available in masked format. For example, XXXX-XXXX-XXXX-1234 (hyphens must not be used when you set the credit card number).\n","type":"string"},"cardType":{"description":"Type of card.\n","enum":["Visa","MasterCard","AmericanExpress","Discover","JCB","Diners","CUP","Maestro","Electron","AppleVisa","AppleMasterCard","AppleAmericanExpress","AppleDiscover","AppleJCB","Elo","Hipercard","Naranja","Nativa","TarjetaShopping","Cencosud","Argencard","Cabal"],"type":"string"},"expirationMonth":{"description":"Expiration date of the card.\n","maximum":12,"minimum":1,"type":"integer"},"expirationYear":{"description":"Expiration year of the card.\n","maximum":2500,"minimum":1980,"type":"integer"},"securityCode":{"description":"CVV or CVV2 security code of the card. To ensure PCI compliance, Zuora does not store the value of this field.\n","type":"string"}},"type":"object"}},"components/schemas/SoldToContactPostOrder":{"id":"components/schemas/SoldToContactPostOrder","kind":"json-schema","title":"SoldToContactPostOrder","data":{"allOf":[{"description":"Contact details associated with an account.\n","properties":{"address1":{"description":"First line of the contact's address. This is often a street address or a business name.\n","maxLength":255,"type":"string"},"address2":{"description":"Second line of the contact's address.\n","maxLength":255,"type":"string"},"city":{"description":"City of the contact's address.\n","maxLength":100,"type":"string"},"contactDescription":{"description":"A description for the contact.          \n","maxLength":100,"type":"string"},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n","maxLength":64,"type":"string"},"county":{"description":"County of the contact's address.\n","maxLength":100,"type":"string"},"fax":{"description":"Fax number of the contact.\n","maxLength":40,"type":"string"},"firstName":{"description":"First name of the contact.\n","maxLength":100,"type":"string"},"homePhone":{"description":"Home phone number of the contact.\n","maxLength":40,"type":"string"},"lastName":{"description":"Last name of the contact.\n","maxLength":100,"type":"string"},"mobilePhone":{"description":"Mobile phone number of the contact.\n","maxLength":40,"type":"string"},"nickname":{"description":"Nickname of the contact.\n","maxLength":100,"type":"string"},"otherPhone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional phone number of the contact. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhoneType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the type of phone number."},"children":[]}]}]}],"maxLength":40,"type":"string"},"otherPhoneType":{"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 phone number in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"Personal email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"postalCode":{"description":"ZIP code or other postal code of the contact's address.\n","maxLength":20,"type":"string"},"state":{"description":"State or province of the contact's address.\n","maxLength":100,"type":"string"},"taxRegion":{"description":"Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n","maxLength":100,"type":"string","nullable":true},"workEmail":{"description":"Business email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"workPhone":{"description":"Business phone number of the contact.\n","maxLength":40,"type":"string"}},"required":["firstName","lastName"],"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}]}},"components/schemas/RenewalTerm":{"id":"components/schemas/RenewalTerm","kind":"json-schema","title":"RenewalTerm","data":{"properties":{"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the renewal term in months, years, days, or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"periodType":{"description":"Unit of time that the renewal term is measured in.\n","enum":["Month","Year","Day","Week"],"type":"string"}},"type":"object"}},"components/schemas/PreviewOrderCreateSubscription":{"id":"components/schemas/PreviewOrderCreateSubscription","kind":"json-schema","title":"createSubscription","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"billToContact":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new bill-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice owner account"},"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":"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 mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot specify both."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}]},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed."},"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":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"maxLength":3,"type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-grouping"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Grouping"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","maxLength":255,"nullable":true},"invoiceSeparately":{"description":"Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.\n","type":"boolean"},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"newSubscriptionOwnerAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not set this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"properties":{"accountNumber":{"description":"Account number. For example, A00000001.\n","maxLength":70,"type":"string"},"additionalEmailAddresses":{"description":"List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.\n","maxLength":1200,"type":"string"},"allowInvoiceEdit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if associated invoices can be edited."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]}]}],"type":"boolean"},"autoPay":{"description":"Specifies whether future payments are automatically billed when they are due.\n","type":"boolean"},"batch":{"description":"Name of the billing batch that the account belongs to. For example, Batch1.\n","type":"string"},"billCycleDay":{"description":"Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".\n","maximum":31,"minimum":0,"type":"integer"},"billToContact":{"$ref":"#/components/schemas/BillToContactPostOrder"},"communicationProfileId":{"description":"Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.\n","type":"string"},"creditCard":{"$ref":"#/components/schemas/creditCard"},"creditMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the credit memo template, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b."},"children":[]}]}]}],"type":"string"},"crmId":{"description":"External identifier of the account in a CRM system.\n","maxLength":100,"type":"string"},"currency":{"description":"ISO 3-letter currency code (uppercase). For example, USD.\n","type":"string"},"customFields":{"$ref":"#/components/schemas/AccountObjectCustomFields"},"customerServiceRepName":{"description":"Name of the account's customer service representative, if applicable.\n","maxLength":50,"type":"string"},"debitMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the debit memo template, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2."},"children":[]}]}]}],"type":"string"},"hpmCreditCardPaymentMethodId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"autoPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must provide the credit card payment method ID for either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a specified credit card payment method, it is recommended that "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-stored-credential-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the support for stored credential transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this payment method is already enabled."},"children":[]}]}]}],"type":"string"},"invoiceDeliveryPrefsEmail":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to turn on the invoice delivery method 'Email' for the new account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Turn on the invoice delivery method 'Email' for the new account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Turn off the invoice delivery method 'Email' for the new account."},"children":[]}]}]}]}],"type":"boolean"},"invoiceDeliveryPrefsPrint":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to turn on the invoice delivery method 'Print' for the new account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Turn on the invoice delivery method 'Print' for the new account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Turn off the invoice delivery method 'Print' for the new account."},"children":[]}]}]}]}],"type":"boolean"},"invoiceTemplateId":{"description":"Internal identifier of the invoice template that Zuora uses when generating invoices for the account.\n","type":"string"},"name":{"description":"Account name.\n","maxLength":255,"type":"string"},"notes":{"description":"Notes about the account. These notes are only visible to Zuora users.\n","maxLength":65535,"type":"string"},"parentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the parent customer account for this Account object. Use this field if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}],"type":"string"},"paymentGateway":{"description":"The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.\n","maxLength":40,"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/POSTPaymentMethodRequest"},"paymentTerm":{"description":"Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.\n","type":"string"},"purchaseOrderNumber":{"description":"The number of the purchase order associated with this account. Purchase order information generally comes from customers.\n","maxLength":100,"type":"string"},"salesRep":{"description":"The name of the sales representative associated with this account, if applicable.\n","maxLength":50,"type":"string"},"soldToContact":{"$ref":"#/components/schemas/SoldToContactPostOrder"},"taxInfo":{"$ref":"#/components/schemas/TaxInfo"}},"required":["name","currency","billCycleDay","billToContact"],"type":"object"},"notes":{"description":"Notes about the subscription. These notes are only visible to Zuora users.\n","maxLength":500,"type":"string"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"shipToContact":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new ship-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription owner account"},"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":"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 mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot specify both."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}]},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the subscription. It must be a contact of the subscription owner."},"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":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"soldToContact":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new sold-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription owner account"},"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":"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 mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot specify both."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}]},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"subscribeToRatePlans":{"description":"List of rate plans associated with the subscription.\n","items":{"$ref":"#/components/schemas/PreviewOrderRatePlanOverride"},"type":"array"},"subscriptionNumber":{"description":"Subscription number of the subscription. For example, A-S00000001.\n\nIf you do not set this field, Zuora will generate the subscription number.\n","maxLength":100,"type":"string"},"subscriptionOwnerAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number of an existing account that will own the subscription. For example, A00000001."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not set this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newSubscriptionOwnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newSubscriptionOwnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":70,"type":"string"},"invoiceOwnerAccountNumber":{"description":"Account number of an existing account that will own the invoice. For example, A00000001. If you do not set this field, the account that owns the order will also own this invoice.\n","maxLength":70,"type":"string"},"terms":{"description":"Container for the terms and renewal settings of the subscription.\n","properties":{"autoRenew":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"initialTerm":{"description":"Information about the first term of the subscription.\n","properties":{"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the first term in months, years, days, or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"periodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time that the first term is measured in. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Month","Year","Day","Week"],"type":"string"},"startDate":{"description":"Start date of the first term, in YYYY-MM-DD format.\n","format":"date","type":"string"},"endDate":{"description":"End date of the first term, in YYYY-MM-DD format.\n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the first term. If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the first term has a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the first term does not have a predefined duration."},"children":[]}]}]}],"enum":["TERMED","EVERGREEN"],"type":"string"}},"required":["termType"],"type":"object"},"renewalSetting":{"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 the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"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":"code","inline":true,"attributes":{"content":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each renewal term has a predefined duration. The first entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the duration of the second term of the subscription, the second entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the duration of the third term of the subscription, and so on. The last entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the ultimate duration of each renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_TO_EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The second term of the subscription does not have a predefined duration."},"children":[]}]}]}]}],"enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"type":"string"},"renewalTerms":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of renewal terms of the subscription. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/RenewalTerm"},"type":"array"}},"required":["initialTerm"],"type":"object"}},"title":"createSubscription","type":"object"}},"components/schemas/OrderActionObjectCustomFields":{"id":"components/schemas/OrderActionObjectCustomFields","kind":"json-schema","title":"orderActionFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order Action object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Order Action object.\n","title":"orderActionFieldsCustom","type":"object"}},"components/schemas/OwnerTransfer":{"id":"components/schemas/OwnerTransfer","kind":"json-schema","title":"ownerTransfer","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OwnerTransfer"},"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":"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 Owner Transfer feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"billToContact":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new bill-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination invoice owner account"},"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":"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 mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot specify both."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}]},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact id of the bill to contact that the subscription is being transferred to."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"clearingExistingBillToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingInvoiceGroupNumber":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceGroupNumber"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingInvoiceTemplate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingPaymentTerm":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTerm"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSequenceSet":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingShipToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSoldToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"destinationAccountNumber":{"description":"The account number of the account that the subscription is being transferred to.\n","type":"string"},"destinationInvoiceAccountNumber":{"description":"The account number of the invoice owner account that the subscription is being transferred to.\n","type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-grouping"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Grouping"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","maxLength":255,"nullable":true},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"paymentProfile":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for payment gateway and payment method details of a payment. If you do not set this field, the payment method and payment gateway values cannot be set in the subscription."},"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":"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 multiple order actions are specified, they will be applied in the same order they appear in the API payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If one or more of these order actions include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" element, the changes will be applied in sequence, and the result will be consistent with the last "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" element."},"children":[]}]}]}]}],"properties":{"paymentGatewayId":{"description":"The ID of the gateway instance that processes the payment.\n\nThis field remains unset, if you do not provide value.\n","type":"string"},"paymentMethodId":{"description":"The ID of the payment method.\n\nThis field remains unset, if you do not provide value.\n","type":"string"}},"type":"object"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"shipToContact":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new ship-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination subscription owner account"},"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":"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 mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot specify both."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}]},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the subscription."},"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":": To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"soldToContact":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new sold-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination subscription owner account"},"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":"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 mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot specify both."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}]},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"}},"title":"ownerTransfer","type":"object"}},"components/schemas/OrderActionRatePlanChargeRemove":{"id":"components/schemas/OrderActionRatePlanChargeRemove","kind":"json-schema","title":"OrderActionRatePlanChargeRemove","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The JSON object containing the information for a charge update(custom fields only) in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'RemoveProduct' type order action."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom field of rate plan charge can be updated from a subscription through one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order action."},"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 you update customFields of a charge while removing a rate plan, specify 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":"chargeNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueToken"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]}]}]}]}]}]}],"example":{"chargeNumber":"chargeNumber","productRatePlanChargeId":"productRatePlanChargeId","productRatePlanNumber":"productRatePlanNumber","uniqueToken":"uniqueToken","customFields":{"key":"{}"}},"properties":{"chargeNumber":{"description":"Read only. Identifies the charge to be updated.\n","type":"string"},"productRatePlanChargeId":{"description":"Identifier of the rate plan that was updated.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"uniqueToken":{"description":"A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.\n","type":"string"},"customFields":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan Charge object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-custom-field-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"object"},"description":"Container for custom fields of a Rate Plan Charge object.\n","title":"ratePlanChargeFieldsCustom","type":"object"}},"type":"object"}},"components/schemas/RemoveProduct":{"id":"components/schemas/RemoveProduct","kind":"json-schema","title":"removeProduct","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan. However, if there are multiple rate plans with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value existing in the subscription, you must use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to remove the rate plan. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be used to distinguish multiple rate plans in this case."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanId":{"description":"ID of the rate plan to remove. This can be the latest version or any history version of ID.\n","type":"string"},"subscriptionRatePlanNumber":{"description":"Number of a rate plan for this subscription.\n","type":"string"},"uniqueToken":{"description":"Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.","type":"string"},"customFields":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan object. The name of each custom field has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-custom-field-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Custom"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"type":"object"},"description":"Container for custom fields of a Rate Plan object.\n","title":"RatePlanCustomFields","type":"object"},"chargeUpdates":{"items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeRemove"},"type":"array"}},"title":"removeProduct","type":"object"}},"components/schemas/RenewSubscription":{"id":"components/schemas/RenewSubscription","kind":"json-schema","title":"RenewSubscription","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"billToContact":{"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new bill-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice owner account"},"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":"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 mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You can use this field only when you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"clearingExistingBillToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingInvoiceGroupNumber":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceGroupNumber"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingInvoiceTemplate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingPaymentTerm":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTerm"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSequenceSet":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingShipToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSoldToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-grouping"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Grouping"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","maxLength":255,"nullable":true},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body.."},"children":[]}]}]}]}],"type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"shipToContact":{"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new ship-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription owner account"},"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":"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 mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You can use this field only when you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the subscription."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"soldToContact":{"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new sold-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Owner Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"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":"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 mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You can use this field only when you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription owner account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"}},"title":"RenewSubscription","type":"object"}},"components/schemas/CreateOrderResume":{"id":"components/schemas/CreateOrderResume","kind":"json-schema","title":"Resume","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Resume"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"extendsTerm":{"description":"Specifies whether to extend the subscription term by the length of time the suspension is in effect.\n","type":"boolean"},"resumePeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriodsType"},"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":"The total number of the periods used to specify when a subscription resumption takes effect. The subscription resumption will take place after the specified time frame ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from today's date."},"children":[]}]}]}],"type":"integer"},"resumePeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriods"},"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":"The period type used to specify when a subscription resumption takes effect. The subscription suspension will take place after the specified time frame ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from today's date."},"children":[]}]}]}],"enum":["Day","Week","Month","Year"],"type":"string"},"resumePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resume methods. Specify a way to resume a subscription. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-subscriptions-resumption"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resume Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"SuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specfied, the resumption will take place on the same day as the suspension."},"children":[]}]}]}],"enum":["Today","FixedPeriodsFromSuspendDate","FixedPeriodsFromToday","SpecificDate","SuspendDate"],"type":"string"},"resumeSpecificDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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 specific date when the subscription resumption takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription suspension date."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["resumePolicy"],"title":"Resume","type":"object"}},"components/schemas/CreateOrderSuspend":{"id":"components/schemas/CreateOrderSuspend","kind":"json-schema","title":"Suspend","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Suspend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"suspendPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"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":"The total number of the periods used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from today's date."},"children":[]}]}]}],"type":"integer"},"suspendPeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"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":"The period type used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from today's date."},"children":[]}]}]}],"enum":["Day","Week","Month","Year"],"type":"string"},"suspendPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suspend methods. Specify a way to suspend a subscription. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-considerations-of-suspend-a-subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suspend Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["Today","EndOfLastInvoicePeriod","FixedPeriodsFromToday","SpecificDate"],"type":"string"},"suspendSpecificDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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 specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription's contract effective date or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" than the subscription's term end date."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["suspendPolicy"],"title":"Suspend","type":"object"}},"components/schemas/LastTerm":{"id":"components/schemas/LastTerm","kind":"json-schema","title":"LastTerm","data":{"description":"The length of the period for the current subscription term.","properties":{"period":{"description":"Specify only when the termType is 'TERMED'.","minimum":0,"type":"integer"},"periodType":{"description":"Specify only when the termType is 'TERMED'.","enum":["Month","Year","Day","Week"],"type":"string"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the current term. You can change the term start date of a renewed subscription through a T&Cs order action. However, when changing it to an earlier date, this date must not be earlier than the term start date of the current term before this T&Cs."},"children":[]}]}]}],"format":"date","type":"string"},"endDate":{"description":"The end date of the current term, in YYYY-MM-DD format.\n","format":"date","type":"string"},"termType":{"enum":["TERMED","EVERGREEN"],"type":"string"}},"required":["termType"],"type":"object"}},"components/schemas/CreateOrderTermsAndConditions":{"id":"components/schemas/CreateOrderTermsAndConditions","kind":"json-schema","title":"termsAndConditions","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermsAndConditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"autoRenew":{"type":"boolean"},"billToContact":{"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new bill-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice owner account"},"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":"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 mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You can use this field only when you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"clearingExistingBillToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingInvoiceGroupNumber":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceGroupNumber"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingInvoiceTemplate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingPaymentTerm":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTerm"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSequenceSet":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingShipToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSoldToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the subscription."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string"},"clearingExistingCommunicationProfile":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing communication profile at the subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-grouping"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Grouping"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","maxLength":255,"nullable":true},"invoiceSeparately":{"description":"Specifies whether the subscription appears on a separate invoice while generating invoices.","type":"boolean"},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"lastTerm":{"$ref":"#/components/schemas/LastTerm"},"paymentProfile":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for payment gateway and payment method details of a payment. If you do not set this field, the payment method and payment gateway values cannot be set in the subscription."},"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":"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 multiple order actions are specified, they will be applied in the same order they appear in the API payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If one or more of these order actions include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" element, the changes will be applied in sequence, and the result will be consistent with the last "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" element."},"children":[]}]}]}]}],"properties":{"paymentGatewayId":{"description":"The ID of the gateway instance that processes the payment.\n\nThis field remains unset, if you do not provide value.\n","type":"string"},"paymentMethodId":{"description":"The ID of the payment method.\n\nThis field remains unset, if you do not provide value.\n","type":"string"}},"type":"object"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"renewalSetting":{"enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"type":"string"},"renewalTerms":{"items":{"$ref":"#/components/schemas/RenewalTerm"},"type":"array"},"scheduledCancelDate":{"description":"The date when the subscription is scheduled to be canceled. The subscription is not canceled until the date specified in this field.\n","format":"date","type":"string"},"scheduledSuspendDate":{"description":"The date when the subscription is scheduled to be suspended. The subscription is not suspended until the date specified in this field. \n","format":"date","type":"string"},"scheduledResumeDate":{"description":"The date when the subscription is scheduled to be resumed. The subscription is not resumed until the date specified in this field. \n","format":"date","type":"string"},"clearingScheduledCancelDate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledCancelDate"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Do not set this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledCancelDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field simultaneously."},"children":[]}]}]}],"type":"boolean"},"clearingScheduledSuspendDate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledSuspendDate"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Do not set this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field simultaneously."},"children":[]}]}]}],"type":"boolean"},"clearingScheduledResumeDate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledResumeDate"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Do not set this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledResumeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field simultaneously."},"children":[]}]}]}],"type":"boolean"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"shipToContact":{"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new ship-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription owner account"},"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":"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 mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You can use this field only when you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the subscription."},"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":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"soldToContact":{"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new sold-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription owner account"},"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":"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 mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You can use this field only when you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"}},"title":"termsAndConditions","type":"object"}},"components/schemas/TriggerDate":{"id":"components/schemas/TriggerDate","kind":"json-schema","title":"triggerDate","data":{"properties":{"name":{"description":"Name of the trigger date of the order action.\n","enum":["ContractEffective","ServiceActivation","CustomerAcceptance"],"type":"string"},"triggerDate":{"description":"Trigger date in YYYY-MM-DD format.\n","format":"date","type":"string"}},"title":"triggerDate","type":"object"}},"components/schemas/BillingUpdate":{"id":"components/schemas/BillingUpdate","kind":"json-schema","title":"BillingUpdate","data":{"properties":{"billingPeriodAlignment":{"description":[{"$$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 not supported in one time charges."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart"],"type":"string","nullable":true}},"type":"object"}},"components/schemas/DiscountPricingUpdate":{"id":"components/schemas/DiscountPricingUpdate","kind":"json-schema","title":"DiscountPricingUpdate","data":{"properties":{"applyDiscountTo":{"description":"Specifies which type of charge the discount charge applies to.\n","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"],"type":"string"},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account"],"type":"string"},"discountPercentage":{"description":"The amount of the discount as a percentage. This field is only used for percentage discounts.\n","type":"number"},"originalListDiscountPercentage":{"description":"The original discount percentage listed for sale by a manufacturer or retailer.\n","type":"number"},"priceChangeOption":{"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n","enum":["NoChange","UseLatestProductCatalogPricing"],"type":"string"}},"type":"object"}},"components/schemas/RecurringCalculatedPricingUpdate":{"id":"components/schemas/RecurringCalculatedPricingUpdate","kind":"json-schema","title":"recurringCalculated","data":{"properties":{"clearingExistingMinimumAmount":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reset the minimum amount to null."},"children":[]}]}]}]},"clearingExistingMaximumAmount":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reset the maximum amount to null."},"children":[]}]}]}]},"minimumAmount":{"description":"Non-negative currency amount that establishes the lower bound for the calculated charge in a billing period. If the calculated amount is less than this value, the invoice amount will be set to the minimum value.\n","type":"number"},"maximumAmount":{"type":"number","description":"Non-negative currency amount that establishes the upper bound for the calculated charge in a billing period. If the calculated amount exceeds this value, the invoice amount will be set to the maximum value.\n"},"percentage":{"type":"number","description":"The specific rate applied to the total eligible spend to determine the base invoice amount before any minimum or maximum amount is applied.\n"}},"type":"object","required":["percentage"],"description":"Pricing information about a recurring charge that uses the \"calculated\" charge model.\n","title":"recurringCalculated"}},"components/schemas/RecurringFlatFeePricingUpdate":{"id":"components/schemas/RecurringFlatFeePricingUpdate","kind":"json-schema","title":"RecurringFlatFeePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"listPrice":{"type":"number"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"}},"type":"object"}]}},"components/schemas/RecurringPerUnitPricingUpdate":{"id":"components/schemas/RecurringPerUnitPricingUpdate","kind":"json-schema","title":"RecurringPerUnitPricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"listPrice":{"type":"number"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"},"quantity":{"minimum":0,"type":"number"}},"type":"object"}]}},"components/schemas/RecurringTieredPricingUpdate":{"id":"components/schemas/RecurringTieredPricingUpdate","kind":"json-schema","title":"RecurringTieredPricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"quantity":{"minimum":0,"type":"number"},"tiers":{"items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"}},"type":"object"}]}},"components/schemas/RecurringVolumePricingUpdate":{"id":"components/schemas/RecurringVolumePricingUpdate","kind":"json-schema","title":"RecurringVolumePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"quantity":{"minimum":0,"type":"number"},"tiers":{"items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"}},"type":"object"}]}},"components/schemas/PreviewOrderPricingUpdate":{"id":"components/schemas/PreviewOrderPricingUpdate","kind":"json-schema","title":"PreviewOrderPricingUpdate","data":{"properties":{"chargeModelData":{"allOf":[{"$ref":"#/components/schemas/ChargeModelDataOverride"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for charge model configuration data."},"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 only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}]},"discount":{"allOf":[{"$ref":"#/components/schemas/DiscountPricingUpdate"}],"description":"Pricing information about a discount charge.\n"},"recurringCalcualated":{"$ref":"#/components/schemas/RecurringCalculatedPricingUpdate"},"recurringFlatFee":{"allOf":[{"$ref":"#/components/schemas/RecurringFlatFeePricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"},"recurringPerUnit":{"allOf":[{"$ref":"#/components/schemas/RecurringPerUnitPricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"},"recurringTiered":{"allOf":[{"$ref":"#/components/schemas/RecurringTieredPricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"},"recurringVolume":{"allOf":[{"$ref":"#/components/schemas/RecurringVolumePricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"}},"type":"object"}},"components/schemas/PreviewOrderChargeUpdate":{"id":"components/schemas/PreviewOrderChargeUpdate","kind":"json-schema","title":"PreviewOrderChargeUpdate","data":{"properties":{"billing":{"$ref":"#/components/schemas/BillingUpdate"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the charge to be updated. The value of this field is inherited from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderActions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"},"description":{"type":"string"},"effectiveDate":{"$ref":"#/components/schemas/PreviewOrderTriggerParams"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"negotiatedPriceTable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of negotiated price table information. The rate card entries provided in the array will override the existing rate card entries in the standard price table to form a negotiated price table that will be"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used during pricing evaluation."},"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":" To enable the Negotiated Price Table feature, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/NegotiatedItems"},"type":"array"},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"pricingAttributes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values included in the array will update the existing values. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically."},"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":" To enable Dynamic Pricing, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","additionalProperties":true},"pricing":{"allOf":[{"$ref":"#/components/schemas/PreviewOrderPricingUpdate"}],"description":"Pricing information about the charge.\n"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of a product rate plan charge for this subscription. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAddingSubsetCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true, the product rate charge specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is added to the existing rate plan specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of a product rate plan charge for this subscription. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAddingSubsetCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true, the product rate charge specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is added to the existing rate plan specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"uniqueToken":{"description":"A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.\n","type":"string"}},"type":"object"}},"components/schemas/RecurringCalculatedPricingOverrideGetOrder":{"id":"components/schemas/RecurringCalculatedPricingOverrideGetOrder","kind":"json-schema","title":"recurringCalculated","data":{"allOf":[{"properties":{"clearingExistingMinimumAmount":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reset the minimum amount to null."},"children":[]}]}]}]},"clearingExistingMaximumAmount":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reset the maximum amount to null."},"children":[]}]}]}]},"eligibleAccountConditions":{"additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A filter expression (single condition or nested condition groups with logical relations) that defines which accounts’ charges are considered in the calculation."},"children":[]}]}]}],"type":"object"},"eligibleChargeConditions":{"additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A filter expression (single condition or nested condition groups with logical relations) that defines which rate plan charges contribute to the calculation; if omitted, the scope defaults to “All charges” (i.e., all charges under the selected accounts are eligible)."},"children":[]}]}]}],"type":"object"},"minimumAmount":{"description":"Non-negative currency amount that establishes the lower bound for the calculated charge in a billing period. If the calculated amount is less than this value, the invoice amount will be set to the minimum value.\n","type":"number"},"maximumAmount":{"type":"number","description":"Non-negative currency amount that establishes the upper bound for the calculated charge in a billing period. If the calculated amount exceeds this value, the invoice amount will be set to the maximum value.\n"},"percentage":{"type":"number","description":"The specific rate applied to the total eligible spend to determine the base invoice amount before any minimum or maximum amount is applied.  \n"}},"type":"object"}],"required":["percentage"],"description":"Pricing information about a recurring charge that uses the \"calculated\" charge model.\n","title":"recurringCalculated"}},"components/schemas/UsageFlatFeePricingOverride":{"id":"components/schemas/UsageFlatFeePricingOverride","kind":"json-schema","title":"usageFlatFee","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"listPrice":{"description":"Price of the charge.\n","type":"number"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n","title":"usageFlatFee"}},"components/schemas/UsageOveragePricingOverride":{"id":"components/schemas/UsageOveragePricingOverride","kind":"json-schema","title":"usageOverage","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"includedUnits":{"description":"Number of free units that may be consumed.\n","minimum":0,"type":"number"},"numberOfPeriods":{"description":"Number of periods that Zuora considers when calculating overage charges with overage smoothing.\n","minimum":1,"type":"integer"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"},"overagePrice":{"description":"Price per overage unit consumed.\n","type":"number"},"overageUnusedUnitsCreditOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to credit the customer for unused units."},"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":"CreditBySpecificRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unusedUnitsCreditRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the rate at which to credit the customer for unused units."},"children":[]}]}]}],"enum":["NoCredit","CreditBySpecificRate"],"type":"string"},"unusedUnitsCreditRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageUnusedUnitsCreditOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditBySpecificRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n","title":"usageOverage"}},"components/schemas/UsagePerUnitPricingOverride":{"id":"components/schemas/UsagePerUnitPricingOverride","kind":"json-schema","title":"usagePerUnit","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"listPrice":{"description":"Per-unit price of the charge.\n","type":"number"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"},"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora groups usage records when rating usage. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-usage-rating-by-group"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage Rating by Group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"ByBillingPeriod (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageStartDate: The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageRecord: The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file."},"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":" For usage charges with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled that use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object field to determine the price automatically, you cannot override the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defined in the product catalog."},"children":[]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload"],"type":"string"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"number"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n","title":"usagePerUnit"}},"components/schemas/UsageTieredPricingOverride":{"id":"components/schemas/UsageTieredPricingOverride","kind":"json-schema","title":"usageTiered","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora groups usage records when rating usage. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-usage-rating-by-group"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage Rating by Group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"ByBillingPeriod (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageStartDate: The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageRecord: The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file."},"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":" For usage charges with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled that use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object field to determine the price automatically, you cannot override the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defined in the product catalog."},"children":[]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload"],"type":"string"},"tiers":{"description":"List of cumulative pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n","title":"usageTiered"}},"components/schemas/UsageTieredWithOveragePricingOverride":{"id":"components/schemas/UsageTieredWithOveragePricingOverride","kind":"json-schema","title":"usageTieredWithOverage","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"numberOfPeriods":{"description":"Number of periods that Zuora considers when calculating overage charges with overage smoothing.\n","minimum":1,"type":"integer"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.        \n","type":"number"},"overagePrice":{"description":"Price per overage unit consumed.\n","type":"number"},"overageUnusedUnitsCreditOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to credit the customer for unused units."},"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":"CreditBySpecificRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unusedUnitsCreditRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the rate at which to credit the customer for unused units."},"children":[]}]}]}],"enum":["NoCredit","CreditBySpecificRate"],"type":"string"},"tiers":{"description":"List of cumulative pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"},"unusedUnitsCreditRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageUnusedUnitsCreditOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditBySpecificRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n","title":"usageTieredWithOverage"}},"components/schemas/UsageVolumePricingOverride":{"id":"components/schemas/UsageVolumePricingOverride","kind":"json-schema","title":"usageVolume","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora groups usage records when rating usage. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-usage-rating-by-group"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage Rating by Group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"ByBillingPeriod (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageStartDate: The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageRecord: The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file."},"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":" For usage charges with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled that use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object field to determine the price automatically, you cannot override the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defined in the product catalog."},"children":[]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload"],"type":"string"},"tiers":{"description":"List of variable pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"},"uom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measure of the standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"number"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n","title":"usageVolume"}},"components/schemas/TriggerParams":{"id":"components/schemas/TriggerParams","kind":"json-schema","title":"startDate","data":{"description":"Specifies when a charge becomes active.\n","properties":{"periodsAfterChargeStart":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the discount charge in days, weeks, months, or years, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDatePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodAfterApplyToChargeStartDate"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}],"type":"integer"},"specificTriggerDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date in YYYY-MM-DD format. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"While this field is applicable, if this field is not set, your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action creates a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription. If at the same time the service activation date is required and not set, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While this field is applicable, if this field is not set, the following order actions create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order but do not impact the subscription status. "},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you want to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"AddProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TermsAndConditions"},"children":[]}]}]}]}],"format":"date","type":"string","nullable":true},"startDatePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date policy of the discount charge to become active when the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply to billing period partially"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" checkbox is selected from the product catalog UI or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyToBillingPeriodPartially"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as true from the \"CRUD: Create a product rate plan charge\" operation."},"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 value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"FixedPeriodAfterApplyToChargeStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge is active for a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"Notes"},"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":"You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDatePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to define when a discount charge starts, but not both at the same time."},"children":[]}]}]}]}],"enum":["AlignToApplyToCharge","SpecificDate","EndOfLastInvoicePeriodOfApplyToCharge","FixedPeriodAfterApplyToChargeStartDate"],"type":"string"},"startPeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time that the discount charge duration is measured in. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDatePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodAfterApplyToChargeStartDate"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}],"enum":["Days","Weeks","Months","Years"],"type":"string"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become active. If this field is not specified, the value of the field will be defaulted to the trigger event value defined in the product catalog."},"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":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes active."},"children":[]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance","SpecificDate"],"type":"string"}},"title":"startDate","type":"object"}},"components/schemas/ChargeOverride":{"id":"components/schemas/ChargeOverride","kind":"json-schema","title":"charge","data":{"description":"Charge associated with a rate plan.\n","properties":{"accountReceivableAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accountReceivableAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"billing":{"description":"Billing information about the charge.\n","properties":{"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the month that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maximum":31,"minimum":0,"type":"integer"},"billCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines the day that each billing period begins on."},"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":"DefaultFromCustomer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the bill cycle day of the account that owns the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the month that each billing period begins on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionStartDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeTriggerDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeklyBillCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the week that each billing period begins on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermStartDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The start day of the term."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEndDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The End day of the term."},"children":[]}]}]}]}],"enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek","TermStartDay","TermEndDay"],"type":"string","nullable":true},"billingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing frequency of the charge. The value of this field controls the duration of each billing period."},"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":"Specific_Days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the duration of each billing period."},"children":[]}]}]}],"enum":["Month","Quarter","Semi_Annual","Annual","Eighteen_Months","Two_Years","Three_Years","Five_Years","Specific_Months","Subscription_Term","Week","Specific_Weeks","Specific_Days"],"type":"string","nullable":true},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges."},"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":"AlignToCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This field is available only for prepayment charges by default. To enable this value for non-prepaid recurring charges, contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for information about how Zuora determines the billing day."},"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 not supported in one time charges."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart","AlignToTermEnd"],"type":"string","nullable":true},"billingTiming":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears). This field is only used if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanChargeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["IN_ADVANCE","IN_ARREARS"],"type":"string","nullable":true},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of each billing period in months or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer","nullable":true},"weeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the week that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string","nullable":true}},"type":"object"},"chargeFunction":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"Standard: Normal charge with no Prepayment or Commitment or Drawdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepayment: For recurring charges. Unit or currency based prepaid charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown: For usage charges. Drawdown from prepaid funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"],"type":"string"},"creditOption":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"chargeModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeModel of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"enum":["FlatFee","PerUnit","Volume","Tiered","TieredWithOverage","DiscountFixedAmount","DiscountPercentage","MultiAttributePricing","PreratedPerUnit","PreratedPricing","HighWatermarkVolumePricing","HighWatermarkTieredPricing","Delivery","Calculated"],"type":"string"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge number of the charge. For example, C-00000307."},"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 you do not set this field, Zuora will generate a charge number starting with a default prefix, for example, C-. This default prefix is predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"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 you want to use a custom charge number, do not use the default prefix predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use your own prefix, for example, SC-."},"children":[]}]}]}]}],"maxLength":50,"type":"string"},"chargeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeType of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string","enum":["OneTime","Recurring","Usage","Others"]},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractAssetAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractRecognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deferredRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"description":{"description":"Description of the charge.\n","maxLength":500,"type":"string","nullable":true},"drawdownPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown priority for consumption ordering. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"drawdownScope":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prepayment"},"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":"code","inline":true,"attributes":{"content":"SUBSCRIPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges of the same subscription can be drawn down."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges in the same account (subscription owner) can be drawn down."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["SUBSCRIPTION","ACCOUNT"]},"endDate":{"$ref":"#/components/schemas/EndConditions"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and want to create a completed order and an active subscription, you must specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field:"},"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":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in pending status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in active status."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both the following features are enabled in your tenant, you must ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in an Create Subscription or Add Product order action is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this order action to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Prepaid with Drawdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both the following features are enabled in your tenant, you must ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set consistently for a prepayment charge and the corresponding drawdown charge."},"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":"Prepaid with Drawdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"fundSupportAccountHierarchy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to enable sub-account's usage to drawdown from the parent's funds."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isRollover":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"True\" or \"False\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"negotiatedPriceTable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of negotiated price table rate card entries in the order request."},"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":" To enable the Negotiated Price Table feature, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/NegotiatedItems"},"type":"array"},"pobPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pobPolicy of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"prepaymentUnitType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit type of the prepayment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges."},"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 prepaid charge is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it will create a fund with given prepaidUom."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the prepaid charge is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it will create a fund with the currency amount calculated in list price."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["UNIT","CURRENCY"]},"pricing":{"description":"Pricing information about the charge.\n","properties":{"chargeModelData":{"$ref":"#/components/schemas/ChargeModelDataOverride"},"discount":{"$ref":"#/components/schemas/DiscountPricingOverride"},"oneTimeFlatFee":{"$ref":"#/components/schemas/OneTimeFlatFeePricingOverride"},"oneTimePerUnit":{"$ref":"#/components/schemas/OneTimePerUnitPricingOverride"},"oneTimeTiered":{"$ref":"#/components/schemas/OneTimeTieredPricingOverride"},"oneTimeVolume":{"$ref":"#/components/schemas/OneTimeVolumePricingOverride"},"recurringCalculated":{"$ref":"#/components/schemas/RecurringCalculatedPricingOverrideGetOrder"},"recurringDelivery":{"$ref":"#/components/schemas/RecurringDeliveryPricingOverride"},"recurringFlatFee":{"$ref":"#/components/schemas/RecurringFlatFeePricingOverride"},"recurringPerUnit":{"$ref":"#/components/schemas/RecurringPerUnitPricingOverride"},"recurringTiered":{"$ref":"#/components/schemas/RecurringTieredPricingOverride"},"recurringVolume":{"$ref":"#/components/schemas/RecurringVolumePricingOverride"},"usageFlatFee":{"$ref":"#/components/schemas/UsageFlatFeePricingOverride"},"usageOverage":{"$ref":"#/components/schemas/UsageOveragePricingOverride"},"usagePerUnit":{"$ref":"#/components/schemas/UsagePerUnitPricingOverride"},"usageTiered":{"$ref":"#/components/schemas/UsageTieredPricingOverride"},"usageTieredWithOverage":{"$ref":"#/components/schemas/UsageTieredWithOveragePricingOverride"},"usageVolume":{"$ref":"#/components/schemas/UsageVolumePricingOverride"}},"type":"object"},"pricingAttributes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for pricing attribute and value in the order request."},"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":" To enable Dynamic Pricing, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","additionalProperties":true},"productCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productCategory of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productClass of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productFamily":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productFamily of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productLine":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productLine of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeNumber":{"description":"Number of a product rate-plan charge for this subscription.\n","type":"string"},"productRateplanChargeId":{"description":"Internal identifier of the product rate plan charge that the charge is based on.\n","type":"string"},"prorationOption":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge Level Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-usage-charge-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage charge proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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":"You can use this field to specify the charge-level proration option for a usage charge or recurring charge when you create or add a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"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":"NoProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeBasedProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeFullPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"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":"When the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, the possible options 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":"text","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides."},"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":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the customization rules using these options in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod","CustomizeProrationOptionOverrides"],"type":"string"},"ratingPropertiesOverride":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field is used only when the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prorationOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"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 field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"object","properties":{"isProratePartialMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to prorate the charge for the partial month."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge Level Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify whether to prorate the recurring charge for a partial month. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"boolean"},"prepaymentChargeProrationRule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define whether to prorate the charge amount or not. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProrateAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the proration rules via the options under this section."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["ProrateAmount","ChargeFullAmount"]},"prorationUnit":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the unit of proration for a recurring charge. The tenant-level proration option will be overridden."},"children":[]}]}]}],"enum":["ProrateByDay","ProrateByMonthFirst"],"type":"string"},"daysInMonth":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the number of days counted for a month when prorating a recurring charge. The tenant-level proration option will be overridden. See more details for each of the following enum values in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["UseActualDays","Assume30Days","Assume30DaysStrict"],"type":"string"}}},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"Revenue Recognition Code\n","maxLength":70,"type":"string"},"revRecTriggerCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition trigger condition."},"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":"Contract Effective Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Service Activation Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Customer Acceptance Date"},"children":[]}]}]}]}],"enum":["Contract Effective Date","Service Activation Date","Customer Acceptance Date"],"type":"string"},"revenueRecognitionRuleName":{"description":"Specifies the revenue recognition rule.\n","enum":["Recognize upon invoicing","Recognize daily over time"],"type":"string"},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"rolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicit cutoff date when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverEndDateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"rolloverEndDateType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover cutoff strategy determining when the rollover eligibility will end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"ChargeEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the subscription term end."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at an explicit date specified in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RolloverEndDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeEndDate","SubscriptionTerm","SpecificDate"]},"rolloverFundPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority override for rolled-over funds. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can customize a single rollover period length together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"rolloverPeriodLength":{"default":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rollover period length. When the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can customize a single rollover period length together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriodType"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year. When the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can customize a single rollover period length together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"rolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"rolloverPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit for rollover period length."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"Day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Day-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Month-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quarter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Quarter-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Annual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Annual rollover periods."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["Day","Month","Quarter","Annual"]},"startDate":{"$ref":"#/components/schemas/TriggerParams"},"specificValidityPeriodLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of days, weeks, or months for the validity period when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidityPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code of a charge. This field is available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode of a charge.  This field is available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive"],"type":"string"},"taxable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag indicates whether the charge is taxable. If this field is set to "},"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":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields must be specified."},"children":[]}]}]}],"type":"boolean"},"unBilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unBilledReceivablesAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"uniqueToken":{"description":"Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n","maxLength":50,"type":"string","nullable":true},"validityPeriodType":{"description":[{"$$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 only available if you have enabled either 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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field in the following scenarios:"},"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":"When you create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use this field to define the period in which the prepayment units are valid to use."},"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":"When you override the setting of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commitment true-up charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the product catalog, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When you use a standalone order to create a commitment true-up charge, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can also choose from the following options: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Specify the actual number in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificValidityPeriodLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"type":"string"},"validityPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the anchor date for validity period (VP) boundaries. The anchor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date defines the recurring grid — VP boundaries fall at every VP-length step"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the anchor. The charge's start and end dates then determine which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"portion of this grid is covered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ChargeStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - Anchor date is the charge start date. Simplest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"option with no partial first VP."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is the subscription term start date. Aligns all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges on the same subscription to a common grid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is derived by walking backward from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription term end date. Last VP always ends cleanly at term end;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partial VP (if any) is at the start."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAnchorDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom alignment for special billing arrangements."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeStart","TermStart","TermEnd","SpecificDate"]},"validityPeriodAnchorDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The anchor date for validity period alignment. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAlignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"validityPeriodProrationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls what happens to units when a validity period (VP) is partial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ProrateUnits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant partial units, the number is prorated based on the overlap ratio."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NoProrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant full units."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ProrateUnits","NoProrate"]}},"required":["productRateplanChargeId"],"title":"charge","type":"object"}},"components/schemas/ChargeRemoval":{"id":"components/schemas/ChargeRemoval","kind":"json-schema","title":"ChargeRemoval","data":{"title":"ChargeRemoval","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The JSON object containing information for removing a charge in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type order action."},"children":[]}]}]}],"properties":{"chargeNumber":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the charge to be removed. This must be an optional charge in a bundle rate plan."},"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":" You must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueToken"},"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":"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 requires the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"uniqueToken":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique string to represent the charge in the order. Use this to reference a charge"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that was added in a previous order action within the same order using the same uniqueToken."},"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":" You must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":{"type":"string","maxLength":500,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of why the charge is being removed."},"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 does not accept JavaScript or HTML script content for security reasons."},"children":[]}]}]}]}},"type":"object","additionalProperties":false,"example":{"uniqueToken":"TK-001","description":"Removing optional premium support charge from bundle"}}},"components/schemas/PreviewOrderRatePlanUpdate":{"id":"components/schemas/PreviewOrderRatePlanUpdate","kind":"json-schema","title":"updateProduct","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"chargeUpdates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of the JSON objects containing the information for a charge update in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type of order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When previewing an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action, either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required to specify the charge to update."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PreviewOrderChargeUpdate"},"type":"array"},"chargeOverrides":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section is only available for hard bundle rate plans. To include additional charges to the subscribed hard bundle, specify the product rate plan charge ID and its 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 only available when the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled. The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ChargeOverride"},"type":"array"},"chargeRemovals":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section is only available for hard bundle rate plans. To remove optional component charges from the subscribed hard bundle, specify its subscription rate plan charge number or unique token."},"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 only available when the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled. The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ChargeRemoval"},"type":"array"},"clearingExistingFeatures":{"description":"Specifies whether all features in the rate plan will be cleared.\n","type":"boolean"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"isAddingSubsetCharges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to add a subset of charges to the subscription."},"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":" To access this field for adding a subset of charges, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanId":{"description":"The id of the rate plan to be updated. It can be the latest version or any history version id.\n","type":"string"},"specificUpdateDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date when the Update Product order action takes effect.  This field allows you to update a charge before a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd."},"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":": After you use this option, the charge's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TriggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field value will be changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-update-products-on-subscriptions-future-dated-updates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Product on Subscription with Future-dated Updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about this feature."},"children":[]}]}]}],"format":"date","type":"string"},"subscriptionProductFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of features associated with the rate plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system compares the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the request with the counterpart fields in a rate plan. The comparison results are 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":"If there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the field is empty, features in the rate plan remain unchanged. But if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingExistingFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is additionally set to true, all features in the rate plan are cleared."},"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":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, as well as the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderRatePlanFeatureOverride"},"type":"array"},"subscriptionRatePlanNumber":{"description":"Number of a rate plan for this subscription.\n","type":"string"},"uniqueToken":{"description":"A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.\n","type":"string"}},"title":"updateProduct","type":"object"}},"components/schemas/PreviewOrderOrderAction":{"id":"components/schemas/PreviewOrderOrderAction","kind":"json-schema","title":"PreviewOrderOrderAction","data":{"properties":{"addProduct":{"$ref":"#/components/schemas/PreviewOrderRatePlanOverride"},"cancelSubscription":{"$ref":"#/components/schemas/CancelSubscription"},"changePlan":{"$ref":"#/components/schemas/PreviewOrderCreateChangePlan"},"changeReason":{"description":"The change reason set for an order action when an order is created.\n","type":"string"},"createSubscription":{"$ref":"#/components/schemas/PreviewOrderCreateSubscription"},"customFields":{"$ref":"#/components/schemas/OrderActionObjectCustomFields"},"ownerTransfer":{"$ref":"#/components/schemas/OwnerTransfer"},"removeProduct":{"$ref":"#/components/schemas/RemoveProduct"},"renewSubscription":{"$ref":"#/components/schemas/RenewSubscription"},"resume":{"$ref":"#/components/schemas/CreateOrderResume"},"suspend":{"$ref":"#/components/schemas/CreateOrderSuspend"},"termsAndConditions":{"$ref":"#/components/schemas/CreateOrderTermsAndConditions"},"triggerDates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the contract effective, service activation, and customer acceptance dates of the order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the service activation date is set as a required field in Default Subscription Settings, skipping this field in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action of your JSON request will result in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the customer acceptance date is set as a required field in Default Subscription Settings, skipping this field in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action of your JSON request will result in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription. If the service activation date field is at the same time required and skipped (or set as null), it will be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TriggerDate"},"type":"array"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unless the type of order action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must use the corresponding field to provide information about the order action. For example, if the type of order action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addProduct"},"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":"Zuora returns an error if you set a field that corresponds to a different type of order action. For example, if the type of order action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns an error if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateProduct"},"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":"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 change plan type of order action is supported for the  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. However, it is currently not supported for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing."},"children":[]}]}]}],"enum":["CreateSubscription","TermsAndConditions","AddProduct","UpdateProduct","RemoveProduct","RenewSubscription","CancelSubscription","OwnerTransfer","Suspend","Resume","ChangePlan","Revert"],"type":"string"},"updateProduct":{"$ref":"#/components/schemas/PreviewOrderRatePlanUpdate"}},"required":["type"],"type":"object"}},"components/schemas/QuoteObjectFields":{"id":"components/schemas/QuoteObjectFields","kind":"json-schema","title":"quote","data":{"description":"The fields populated for a quote when a quote is sent to Zuora Billing from Zuora Quote.\n","properties":{"OpportunityCloseDate__QT":{"description":"The closing date of the Opportunity.\n\nThis field is used in Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n","type":"string"},"OpportunityName__QT":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the Opportunity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used in the Zuora Reporting Data Sources to report on Subscription metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 100"},"children":[]}]}]}],"type":"string"},"QuoteBusinessType__QT":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used in the Zuora Reporting Data Sources to report on Subscription metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32"},"children":[]}]}]}],"type":"string"},"QuoteNumber__QT":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the Quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used in the Zuora Reporting Data Sources to report on Subscription metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32"},"children":[]}]}]}],"type":"string"},"QuoteType__QT":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used in the Zuora Reporting Data Sources to report on Subscription metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32"},"children":[]}]}]}],"type":"string"}},"title":"quote","type":"object"}},"components/schemas/RampChargeRequest":{"id":"components/schemas/RampChargeRequest","kind":"json-schema","title":"RampCharge","data":{"properties":{"chargeNumber":{"description":"The number of the rate plan charge.","type":"string"},"uniqueToken":{"description":"Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n","type":"string"}},"title":"RampCharge","type":"object"}},"components/schemas/RampIntervalRequest":{"id":"components/schemas/RampIntervalRequest","kind":"json-schema","title":"intervals","data":{"description":"Container for the intervals that the ramp is split into in its timeline. Zuora can report metrics for this specific period.\n","properties":{"description":{"description":"The short description of the interval.","type":"string"},"endDate":{"description":"The end date of the interval.","format":"date","type":"string"},"name":{"description":"The name of the interval.","type":"string"},"startDate":{"description":"The start date of the interval.","format":"date","type":"string"}},"required":["startDate","endDate"],"title":"intervals","type":"object"}},"components/schemas/RampRequest":{"id":"components/schemas/RampRequest","kind":"json-schema","title":"Ramp","data":{"description":"Container of the ramp definitions. It is used to create, update, or remove the ramp definition for the new subscription.\n","properties":{"charges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the rate plan charges that are considered as part of the ramp deal."},"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 field is not specified, all the one-time and recurring regular charges of the new subscription are automatically considered as part of the ramp deal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, either 'chargeNumber' or 'uniqueToken' must be specified."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/RampChargeRequest"},"type":"array"},"delete":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to remove the ramp definition from the new subscription. If you want to remove the ramp definition, this field is the only required field for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ramp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"type":"boolean"},"description":{"description":"The short description of the ramp.","type":"string"},"intervals":{"description":"Container for the intervals that the ramp is split into in its timeline. \n\nIt is required when you want to create or update the ramp definition. The ramp intervals cannot have any overlap or gap between each other.\n","items":{"$ref":"#/components/schemas/RampIntervalRequest"},"type":"array"},"name":{"description":"The name of the ramp.","type":"string"}},"title":"Ramp","type":"object"}},"components/schemas/POSTOrderPreviewRequestType":{"id":"components/schemas/POSTOrderPreviewRequestType","kind":"json-schema","title":"POSTOrderPreviewRequestType","data":{"example":{"existingAccountNumber":"A00000097","orderDate":"2024-07-01","previewOptions":{"previewTypes":["BillingDocs"],"previewThruType":"SpecificDate","specificPreviewThruDate":"2024-07-31"},"subscriptions":[{"orderActions":[{"type":"CreateSubscription","createSubscription":{"terms":{"initialTerm":{"period":12,"periodType":"Month","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":{"period":12,"periodType":"Month"}},"subscribeToRatePlans":[{"productRatePlanId":"8ad081dd9096ef9501909b40bb4e74a4"}]},"triggerDates":[{"name":"ContractEffective","triggerDate":"2024-07-01"},{"name":"ServiceActivation","triggerDate":"2024-07-01"},{"name":"CustomerAcceptance","triggerDate":"2024-07-01"}]}]}]},"properties":{"category":{"default":"NewSales","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the order to indicate a product sale or return. Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NewSales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["NewSales","Return"],"type":"string"},"customFields":{"$ref":"#/components/schemas/OrderObjectCustomFields"},"description":{"description":"A description of the order.","maxLength":500,"type":"string"},"existingAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account ID under which this order will be created.  This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order.  To override these defaults for individual subscriptions, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, but not both."},"children":[]}]}]}],"type":"string"},"existingAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number under which this order will be created.  This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":70,"type":"string"},"orderDate":{"description":"The date when the order is signed. All of the order actions under this order will use this order date as the contract effective date.","format":"date","type":"string"},"orderLineItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Order Line Items Without Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" billing permission, you can only create order  line items from existing products by specifying the product rate plan charge ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field.  For more information about billing permissions, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderOrderLineItem"},"type":"array"},"orderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number of this order."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"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 characters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"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":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not allowed in this field. Additionally, to ensure compatibility with the UI when viewing orders, use only the following special characters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"previewAccountInfo":{"$ref":"#/components/schemas/PreviewAccountInfo"},"previewOptions":{"$ref":"#/components/schemas/PreviewOptions"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values of reason code configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through Zuora UI. Indicates the reason when a return order line item occurs."},"children":[]}]}]}],"maxLength":255,"type":"string"},"subscriptions":{"description":"Each item includes a set of order actions, which will be applied to the same base subscription. When you create an order that involves multiple subscriptions, these subscriptions can have different invoice owner accounts or subscription owner accounts. ","items":{"properties":{"customFields":{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"},"notes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes about the subscription. These notes are only visible to Zuora users. Notes set in this field will override the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the createSubscription order action."},"children":[]}]}]}],"type":"string","maxLength":1000},"orderActions":{"description":"The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.","items":{"$ref":"#/components/schemas/PreviewOrderOrderAction"},"type":"array"},"quote":{"$ref":"#/components/schemas/QuoteObjectFields"},"ramp":{"$ref":"#/components/schemas/RampRequest"},"subscriptionNumber":{"description":"Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.\n","type":"string"}},"type":"object"},"type":"array"}},"required":["orderDate","previewOptions"],"type":"object"}},"components/schemas/ChargePreviewMetrics":{"id":"components/schemas/ChargePreviewMetrics","kind":"json-schema","title":"ChargePreviewMetrics","data":{"properties":{"chargeNumber":{"type":"string"},"cmrr":{"properties":{"discount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total discountCmrr of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order. Only selects the applied discount charge when its endDateCondition is \"Subscription_End\"."},"children":[]}]}]}],"type":"number"},"discountDelta":{"description":"Delta discountCmrr value between the order base and the latest subscription version.","type":"number"},"regular":{"type":"number"},"regularDelta":{"type":"number"}},"type":"object"},"originRatePlanId":{"type":"string"},"productRatePlanChargeId":{"type":"string"},"productRatePlanId":{"type":"string"},"subscriptionRatePlanNumber":{"type":"string","description":"Number of a subscription rate plan for this subscription.\n"},"tax":{"properties":{"discount":{"description":"Total tax amount of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order.","type":"number"},"discountDelta":{"description":"Delta discount TAX value between the base and the latest subscription version in the order for the specific recurring charge.","type":"number"},"regular":{"type":"number"},"regularDelta":{"description":"Delta tax value between the base and the latest subscription version in the order.","type":"number"}},"type":"object"},"tcb":{"properties":{"discount":{"description":"Total contract billing amount of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order.","type":"number"},"discountDelta":{"description":"Delta discount TCB value between the base and the latest subscription version for specific recurring charge in the order.","type":"number"},"regular":{"type":"number"},"regularDelta":{"description":"Delta TCB value between the base and the latest subscription version in the order.","type":"number"}},"type":"object"},"tcv":{"properties":{"discount":{"description":"Always equals to discountTcb.","type":"number"},"discountDelta":{"description":"Always equals to delta discountTcb.","type":"number"},"regular":{"type":"number"},"regularDelta":{"type":"number"}},"type":"object"}},"type":"object"}},"components/schemas/InvoiceItemPreviewResult":{"id":"components/schemas/InvoiceItemPreviewResult","kind":"json-schema","title":"InvoiceItemPreviewResult","data":{"properties":{"additionalInfo":{"properties":{"numberOfDeliveries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of deliveries dedicated to the Delivery Pricing charges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the Delivery Pricing feature enabled."},"children":[]}]}]}],"type":"number"},"quantity":{"type":"number"},"unitOfMeasure":{"type":"string"}},"type":"object"},"amountWithoutTax":{"type":"number"},"appliedToChargeNumber":{"description":"Available when the chargeNumber of the charge that discount applies to was specified in the request or when the order is amending an existing subscription.","type":"string"},"chargeDescription":{"type":"string"},"chargeName":{"type":"string"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field was specified in the request or when the order is amending an existing subscription."},"children":[]}]}]}],"type":"string","nullable":true},"orderLineItemNumber":{"description":"A sequential number auto-assigned for each of order line items in a order, used as an index, for example, \"1\".","type":"string","nullable":true},"processingType":{"enum":["Charge","Discount","Tax"],"type":"string"},"productName":{"type":"string"},"productRatePlanChargeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product rate plan charge ID in this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field belongs to a product rate plan specified through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscribeToRatePlans"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Therefore, this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field has a value only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscribeToRatePlans"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified during the subscription creation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field does not indicate a product rate plan charge associated with an order line item."},"children":[]}]}]}]},"serviceEndDate":{"format":"date","type":"string"},"serviceStartDate":{"format":"date","type":"string"},"subscriptionNumber":{"type":"string","nullable":true,"description":"The number of the subscription.\n"},"taxAmount":{"type":"number"},"taxationItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of taxation items."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"309.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"properties":{"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","type":"number"},"id":{"description":"The ID of the taxation item.\n","type":"string"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":"The identifier for the location based on the value of the taxCode field.\n","type":"string"},"name":{"description":"The name of the taxation item.\n","type":"string"},"taxAmount":{"description":"The amount of the tax applied to the invoice.\n","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific invoice.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":"The date when the tax is applied to the invoice.\n","type":"string"},"taxRate":{"description":"The tax rate applied to the invoice.\n","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"Enum:\"Percentage\" \"FlatFee\". The type of the tax rate applied to the invoice.\n","enum":["Percentage","FlatFee"],"type":"string"}},"type":"object"},"type":"array"},"unitPrice":{"description":"The per-unit price of the invoice item.\n","type":"number"}},"type":"object"}},"components/schemas/PreviewOrderFundPreviewItem":{"id":"components/schemas/PreviewOrderFundPreviewItem","kind":"json-schema","title":"SubscriptionFund","data":{"title":"SubscriptionFund","properties":{"id":{"description":"Fund ID. Null for preview subscriptions or preview charge numbers.","type":"string","nullable":true},"sourceId":{"description":"Source entity ID. Null for preview subscriptions or preview charge numbers.","type":"string","nullable":true},"sourceType":{"description":"Source entity type.","type":"string"},"startDate":{"description":"Start date of the fund period.","format":"date","type":"string"},"endDate":{"description":"End date of the fund period.","format":"date","type":"string"},"validityPeriodStartDate":{"description":"Start date of the fund validity period.","format":"date","type":"string"},"validityPeriodEndDate":{"description":"End date of the fund validity period.","format":"date","type":"string"},"balance":{"description":"Remaining available balance of the fund.","format":"decimal","type":"string"},"fundedBalance":{"description":"Total funded amount of the fund.","format":"decimal","type":"string"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge number used to map to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlans[].​ratePlanCharges[].​number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"originalChargeId":{"description":"Original charge ID. Null for preview subscriptions or preview charge numbers.","type":"string","nullable":true},"segment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segment number used to map to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlans[].​ratePlanCharges[].​chargeSegments[].​segment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"prepaymentUnitType":{"description":"Prepayment unit type.","type":"string"},"fundingPrice":{"description":"Monetary price allocated to the fund.","format":"decimal","type":"string"}},"type":"object"}},"components/schemas/PreviewOrderResultFunds":{"id":"components/schemas/PreviewOrderResultFunds","kind":"json-schema","title":"Fund","data":{"title":"Fund","properties":{"subscriptionNumber":{"description":"The number of the subscription that has been affected by this order. When\ncreating a subscription, this value will not show if the subscription\nnumber was not specified in the request.","type":"string"},"subscriptionFunds":{"description":"Fund preview items for the subscription.","items":{"$ref":"#/components/schemas/PreviewOrderFundPreviewItem"},"type":"array"}},"type":"object"}},"components/schemas/InvoiceItemSummary":{"id":"components/schemas/InvoiceItemSummary","kind":"json-schema","title":"InvoiceItemSummary","data":{"type":"object","properties":{"previewInvoiceSequence":{"type":"number","description":"The sequence number of the invoice to be billed.\n"},"subTotal":{"type":"number","format":"double","description":"The aggregated subtotal amount of the invoice.\n"},"discountAmount":{"type":"number","format":"double","description":"The aggregated discount amount of the invoice.\n"},"taxAmount":{"type":"number","format":"double","description":"The aggregated tax amount of the invoice.\n"},"total":{"type":"number","format":"double","description":"The aggregated total amount of the invoice.\n"},"servicePeriodStartDate":{"type":"string","format":"date","description":"The start date of the period being billed.\n"},"servicePeriodEndDate":{"type":"string","format":"date","description":"The end date of the period being billed.\n"}}}},"components/schemas/OrderDeltaMetric":{"id":"components/schemas/OrderDeltaMetric","kind":"json-schema","title":"OrderDeltaMetric","data":{"properties":{"chargeNumber":{"description":"The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"currency":{"description":"ISO 3-letter currency code (uppercase). For example, USD.\n","type":"string"},"endDate":{"description":"The end date for the order delta metric.\n","format":"date","type":"string"},"grossAmount":{"description":"The gross amount for the metric. The is the amount excluding applied discount.\n","type":"number"},"netAmount":{"description":"The net amount for the metric. The is the amount with discounts applied\n","type":"number"},"orderActionId":{"description":"The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"orderActionSequence":{"description":"The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"orderActionType":{"description":"The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"productRatePlanChargeId":{"description":"The Id for the associated Product Rate Plan Charge. This field can be null if the Order Line Item is not associated with a Product Rate Plan Charge.\n","type":"string"},"ratePlanChargeId":{"description":"The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"startDate":{"description":"The start date for the order delta metric.\n","format":"date","type":"string"},"subscriptionNumber":{"description":"The number of the subscription. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"}},"type":"object"}},"components/schemas/OrderDeltaMrr":{"id":"components/schemas/OrderDeltaMrr","kind":"json-schema","title":"OrderDeltaMrr","data":{"allOf":[{"$ref":"#/components/schemas/OrderDeltaMetric"}],"description":"Order Delta Mrr. This is a metric that reflects the change to the TCV on rate plan charge object as the result of the order.\n","type":"object"}},"components/schemas/OrderDeltaTcb":{"id":"components/schemas/OrderDeltaTcb","kind":"json-schema","title":"OrderDeltaTcb","data":{"allOf":[{"properties":{"chargeNumber":{"description":"The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"currency":{"description":"ISO 3-letter currency code (uppercase).\n","type":"string","example":"USD"},"endDate":{"description":"The end date for the order delta metric.\n","format":"date","type":"string"},"grossAmount":{"description":"The gross amount for the metric. The is the amount excluding applied discount.\n","type":"number"},"netAmount":{"description":"The net amount for the metric. The is the amount with discounts applied\n","type":"number"},"orderActionId":{"description":"The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item.      \n","type":"string"},"orderActionSequence":{"description":"The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"orderActionType":{"description":"The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item.       \n","type":"string"},"orderLineItemId":{"description":"The sytem generated Id for the Order Line Item. This field can be null if the metric is generated for a Rate Plan Charge.\n","format":"UUID","type":"string"},"orderLineItemNumber":{"description":"A sequential number auto-assigned for each of order line items in a order, used as an index, for example, \"1\". This field can be null\nif the metric is generated for a Rate Plan Charge.\n"},"productRatePlanChargeId":{"description":"The Id for the associated Product Rate Plan Charge. This field can be null if the Order Line Item is not associated with a Product Rate Plan Charge.\n","type":"string"},"ratePlanChargeId":{"description":"The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"startDate":{"description":"The start date for the order delta metric.\n","format":"date","type":"string"},"subscriptionNumber":{"description":"The number of the subscription. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"}},"type":"object"}],"description":"Order Delta Tcb. This is a metric that reflects the change to the estimated billing on Rate Plan Charge object, or the estimated billing for an Order Line Item as the result of the order\n","type":"object"}},"components/schemas/OrderDeltaTcv":{"id":"components/schemas/OrderDeltaTcv","kind":"json-schema","title":"OrderDeltaTcv","data":{"allOf":[{"properties":{"chargeNumber":{"description":"The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"currency":{"description":"ISO 3-letter currency code (uppercase).\n","type":"string","example":"USD"},"endDate":{"description":"The end date for the order delta metric.\n","format":"date","type":"string"},"grossAmount":{"description":"The gross amount for the metric. The is the amount excluding applied discount.\n","type":"number"},"netAmount":{"description":"The net amount for the metric. The is the amount with discounts applied\n","type":"number"},"orderActionId":{"description":"The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item.      \n","type":"string"},"orderActionSequence":{"description":"The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"orderActionType":{"description":"The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item.        \n","type":"string"},"orderLineItemId":{"description":"The sytem generated Id for the Order Line Item. This field can be null if the metric is generated for a rate plan charge.\n","nullable":true,"format":"UUID","type":"string"},"orderLineItemNumber":{"description":"A sequential number auto-assigned for each of order line items in a order, used as an index, for example, \"1\". This field can be null\nif the metric is generated for a Rate Plan Charge.\n"},"productRatePlanChargeId":{"description":"The Id for the associated Product Rate Plan Charge. This field can be null if the Order Line Item is not associated with a Product Rate Plan Charge.\n","type":"string"},"ratePlanChargeId":{"description":"The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"},"startDate":{"description":"The start date for the order delta metric.\n","format":"date","type":"string"},"subscriptionNumber":{"description":"The number of the subscription. This field can be null if the metric is generated for an Order Line Item.\n","type":"string"}},"type":"object"}],"description":"Order Delta Tcv. This is a metric that reflects the change to the TCV on Rate Plan Charge object, or the Total Contracted Value for an Order Line Item as the result of the order\n","type":"object"}},"components/schemas/OrderItem":{"id":"components/schemas/OrderItem","kind":"json-schema","title":"OrderItem","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents an order item. An order item is a sales item within an order in the context of the recurring subscription business model. It can be a unit of products or a service, but defined by both quantity and term (the start and end dates)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the one time and the recurring charge types, if an order action causes a quantity metric creation (when the delta quantity equals to or is greater than zero), an order item is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following order actions will create an order item for the one time and recurring charges. The other order actions will refer to an existing order item. Also, the Owner Transfer order action always creates an order item whose quantity field is zero."},"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":"Create Subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms and Conditions - Extend Term"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Renewal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Product - Increase Quantity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add product"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Owner Transfer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the usage charge type, if the order action causes a usage increase, an order item is created, and the quantity field of the order item is always zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following order actions will create an order item for for the usage charges."},"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":"Create Subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms and Conditions - Extend Term"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Renewal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add product"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Owner Transfer"},"children":[]}]}]}]}],"properties":{"endDate":{"description":"The order item's effective end date, aligned with the end date of an increased quantity order metrics.","format":"date","type":"string"},"id":{"description":"The ID of the order item.","type":"string"},"orderActionId":{"description":"Specify the order action that creates this order item.","type":"string"},"quantity":{"description":"The order item quantity. For the usage charge type, the value of this field is always zero. Also, the Owner Transfer order action always creates an order item whose Quantity field is zero.","type":"number"},"scId":{"description":"The ID of the charge segment that gets newly generated when the order item is created.","type":"string"},"startDate":{"description":"The order item's effective start date, aligned with the start date of an increased quantity order metrics.","format":"date","type":"string"}},"type":"object"}},"components/schemas/TimeSlicedElpNetMetrics":{"id":"components/schemas/TimeSlicedElpNetMetrics","kind":"json-schema","title":"TimeSlicedElpNetMetrics","data":{"properties":{"amount":{"description":"The extended list price which is calculated by the original product catalog list price multiplied by the delta quantity.","type":"number"},"endDate":{"description":"The latest date that the metric applies.","format":"date","type":"string"},"generatedReason":{"description":"Specify the reason why the metrics are generated by the certain order action.\n","enum":["IncreaseQuantity","DecreaseQuantity","ChangePrice","Extension","Contraction"],"type":"string"},"invoiceOwner":{"description":"The acount number of the billing account that is billed for the subscription.","type":"string"},"orderItemId":{"description":"The ID of the order item referenced by the order metrics.","type":"string"},"startDate":{"description":"The earliest date that the metric applies.","format":"date","type":"string"},"subscriptionOwner":{"description":"The acount number of the billing account that owns the subscription.","type":"string"},"tax":{"description":"The tax amount in the metric when the tax permission is enabled.","type":"number"},"termNumber":{"format":"long","type":"number"},"type":{"description":"The type for ELP is always \"Regular\".","enum":["Regular","Discount"],"type":"string"}},"type":"object"}},"components/schemas/TimeSlicedNetMetrics":{"id":"components/schemas/TimeSlicedNetMetrics","kind":"json-schema","title":"TimeSlicedNetMetrics","data":{"properties":{"amount":{"type":"number"},"discountChargeNumber":{"type":"string"},"endDate":{"format":"date","type":"string"},"generatedReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the reason why the metrics are generated by the certain order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available to existing Orders customers who already have access to the field."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"children":[]}]}]}],"enum":["IncreaseQuantity","DecreaseQuantity","ChangePrice","Extension","Contraction"],"type":"string"},"invoiceOwner":{"description":"The acount number of the billing account that is billed for the subscription.","type":"string"},"orderItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the order item referenced by the order metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available to existing Orders customers who already have access to the field."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"children":[]}]}]}],"type":"string"},"startDate":{"format":"date","type":"string"},"subscriptionOwner":{"description":"The acount number of the billing account that owns the subscription.","type":"string"},"termNumber":{"format":"long","type":"number"},"type":{"description":"Indicates whether this metrics is for a regular charge or a discount charge.","enum":["Regular","Discount"],"type":"string"}},"type":"object"}},"components/schemas/TimeSlicedMetrics":{"id":"components/schemas/TimeSlicedMetrics","kind":"json-schema","title":"TimeSlicedMetrics","data":{"properties":{"amount":{"type":"number"},"endDate":{"format":"date","type":"string"},"generatedReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the reason why the metrics are generated by the certain order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available to existing Orders customers who already have access to the field."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"children":[]}]}]}],"enum":["IncreaseQuantity","DecreaseQuantity","ChangePrice","Extension","Contraction"],"type":"string"},"invoiceOwner":{"description":"The acount number of the billing account that is billed for the subscription.","type":"string"},"orderItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the order item referenced by the order metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available to existing Orders customers who already have access to the field."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"children":[]}]}]}],"type":"string"},"startDate":{"format":"date","type":"string"},"subscriptionOwner":{"description":"The acount number of the billing account that owns the subscription.","type":"string"},"termNumber":{"format":"long","type":"number"}},"type":"object"}},"components/schemas/TimeSlicedTcbNetMetrics":{"id":"components/schemas/TimeSlicedTcbNetMetrics","kind":"json-schema","title":"TimeSlicedTcbNetMetrics","data":{"properties":{"amount":{"type":"number"},"discountChargeNumber":{"type":"string"},"endDate":{"format":"date","type":"string"},"generatedReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the reason why the metrics are generated by the certain order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available to existing Orders customers who already have access to the field."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"children":[]}]}]}],"enum":["IncreaseQuantity","DecreaseQuantity","ChangePrice","Extension","Contraction"],"type":"string"},"invoiceOwner":{"description":"The acount number of the billing account that is billed for the subscription.","type":"string"},"orderItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the order item referenced by the order metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available to existing Orders customers who already have access to the field."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"children":[]}]}]}],"type":"string"},"startDate":{"format":"date","type":"string"},"subscriptionOwner":{"description":"The acount number of the billing account that owns the subscription.","type":"string"},"tax":{"type":"number"},"termNumber":{"format":"long","type":"number"},"type":{"description":"Indicates whether this metrics is for a regular charge or a discount charge.","enum":["Regular","Discount"],"type":"string"}},"type":"object"}},"components/schemas/orderMetric":{"id":"components/schemas/orderMetric","kind":"json-schema","title":"orderMetric","data":{"description":"The set of order metrics for an order action.","properties":{"chargeNumber":{"type":"string"},"elp":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The extended list price which is calculated by the original product catalog list price multiplied by the delta quantity."},"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":"elp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested field is only available to existing Orders customers who already have access to the field."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TimeSlicedElpNetMetrics"},"type":"array"},"mrr":{"items":{"$ref":"#/components/schemas/TimeSlicedNetMetrics"},"type":"array"},"originRatePlanId":{"type":"string"},"productRatePlanChargeId":{"type":"string"},"productRatePlanId":{"type":"string"},"subscriptionRatePlanNumber":{"type":"string","description":"Number of a subscription rate plan for this subscription.\n"},"quantity":{"items":{"$ref":"#/components/schemas/TimeSlicedMetrics"},"type":"array"},"tcb":{"description":"Total contracted billing which is the forecast value for the total invoice amount.","items":{"$ref":"#/components/schemas/TimeSlicedTcbNetMetrics"},"type":"array"},"tcv":{"description":"Total contracted value.","items":{"$ref":"#/components/schemas/TimeSlicedNetMetrics"},"type":"array"}},"type":"object"}},"components/schemas/RampIntervalChargeDeltaMetrics":{"id":"components/schemas/RampIntervalChargeDeltaMetrics","kind":"json-schema","title":"intervalDeltaMetrics","data":{"properties":{"chargeNumber":{"description":"The number of the rate plan charge.","type":"string"},"deltaDiscountTcb":{"description":"The discount delta amount for the TCB.","type":"number"},"deltaDiscountTcv":{"description":"The discount delta amount for the TCV.","type":"number"},"deltaGrossTcb":{"description":"The TCB delta value before discount charges are applied.","type":"number"},"deltaGrossTcv":{"description":"The TCV delta value before discount charges are applied.","type":"number"},"deltaMrr":{"description":"The MRR changing history of the current rate plan charge in the current ramp interval.","items":{"properties":{"discount":{"description":"The discount delta amount for the MRR.","type":"number"},"endDate":{"description":"The end date.","format":"date","type":"string"},"gross":{"description":"The MRR delta amount before discounts charges are applied.","type":"number"},"net":{"description":"The MRR delta amount after discounts charges are applied.","type":"number"},"startDate":{"description":"The start date.","format":"date","type":"string"}},"type":"object"},"type":"array"},"deltaNetTcb":{"description":"The TCB delta value after discount charges are applied.","type":"number"},"deltaNetTcv":{"description":"The TCV delta value after discount charges are applied.","type":"number"},"deltaQuantity":{"description":"The charge quantity changing history of the current rate plan charge in the current ramp interval.","items":{"properties":{"amount":{"description":"The delta amount of the charge quantity.","type":"number"},"endDate":{"description":"The end date.","format":"date","type":"string"},"startDate":{"description":"The start date.","format":"date","type":"string"}},"type":"object"},"type":"array"},"productRatePlanChargeId":{"description":"The ID of the corresponding product rate plan charge.","type":"string"},"subscriptionNumber":{"description":"The number of the subscription that the current rate plan charge belongs to.","type":"string"}},"title":"intervalDeltaMetrics","type":"object"}},"components/schemas/RampIntervalChargeMetrics":{"id":"components/schemas/RampIntervalChargeMetrics","kind":"json-schema","title":"intervalMetrics","data":{"properties":{"chargeNumber":{"description":"The number of the charge.","type":"string"},"discountTcb":{"description":"The discount amount for the TCB.","type":"number"},"discountTcv":{"description":"The discount amount for the TCV.","type":"number"},"endDate":{"description":"The end date of the rate plan charge in the current ramp interval.","format":"date","type":"string"},"grossTcb":{"description":"The gross TCB value before discount charges are applied.","type":"number"},"grossTcv":{"description":"The gross TCV value before discount charges are applied.","type":"number"},"mrr":{"description":"The MRR changing history of the current rate plan charge in the current ramp interval.","items":{"properties":{"discount":{"description":"The discount amount for the MRR.","type":"number"},"endDate":{"description":"The end date.","format":"date","type":"string"},"gross":{"description":"The gross MRR amount before discounts charges are applied.","type":"number"},"net":{"description":"The net MRR amount after discounts charges are applied.","type":"number"},"startDate":{"description":"The start date.","format":"date","type":"string"}},"type":"object"},"type":"array"},"netTcb":{"description":"The net TCB value after discount charges are applied.","type":"number"},"netTcv":{"description":"The net TCV value after discount charges are applied.","type":"number"},"productRatePlanChargeId":{"description":"The ID of the corresponding product rate plan charge.","type":"string"},"quantity":{"description":"The quantity of the rate plan charge.","type":"number"},"ratePlanChargeId":{"description":"The ID of the rate plan charge.","type":"string"},"startDate":{"description":"The start date of the rate plan charge in the current ramp interval.","format":"date","type":"string"},"subscriptionNumber":{"description":"The number of the subscription that the current rate plan charge belongs to.","type":"string"}},"title":"intervalMetrics","type":"object"}},"components/schemas/OrderRampIntervalMetrics":{"id":"components/schemas/OrderRampIntervalMetrics","kind":"json-schema","title":"RampIntervalMetrics","data":{"properties":{"description":{"description":"The short description of the interval.","type":"string"},"discountTcb":{"description":"The discount amount for the TCB.","type":"number"},"discountTcv":{"description":"The discount amount for the TCV.","type":"number"},"endDate":{"description":"The end date of the interval.","format":"date","type":"string"},"grossTcb":{"description":"The gross TCB value before discount charges are applied.","type":"number"},"grossTcv":{"description":"The gross TCV value before discount charges are applied.","type":"number"},"intervalDeltaMetrics":{"description":"Container for the delta metrics for each rate plan charge in each ramp interval. The delta is the difference of the subscription metrics between before and after the order.","items":{"$ref":"#/components/schemas/RampIntervalChargeDeltaMetrics"},"type":"array"},"intervalMetrics":{"description":"Container for the detailed metrics for each rate plan charge in each ramp interval.","items":{"$ref":"#/components/schemas/RampIntervalChargeMetrics"},"type":"array"},"name":{"description":"The name of the interval.","type":"string"},"netTcb":{"description":"The net TCB value after discount charges are applied.","type":"number"},"netTcv":{"description":"The net TCV value after discount charges are applied.","type":"number"},"startDate":{"description":"The start date of the interval.","format":"date","type":"string"}},"title":"RampIntervalMetrics","type":"object"}},"components/schemas/OrderRampMetrics":{"id":"components/schemas/OrderRampMetrics","kind":"json-schema","title":"RampMetrics","data":{"properties":{"description":{"description":"The short description of the ramp.","type":"string"},"discountTcb":{"description":"The discount amount for the TCB.","type":"number"},"discountTcv":{"description":"The discount amount for the TCV.","type":"number"},"grossTcb":{"description":"The gross TCB value before discount charges are applied.","type":"number"},"grossTcv":{"description":"The gross TCV value before discount charges are applied.","type":"number"},"intervals":{"description":"The ramp metrics for each ramp intervals in its timeline.","items":{"$ref":"#/components/schemas/OrderRampIntervalMetrics"},"type":"array"},"name":{"description":"The name of the ramp.","type":"string"},"netTcb":{"description":"The net TCB value after discount charges are applied.","type":"number"},"netTcv":{"description":"The net TCV value after discount charges are applied.","type":"number"},"number":{"description":"The number of the ramp. It is automaticcally generated by the billing system.","type":"string"}},"title":"RampMetrics","type":"object"}},"components/schemas/PreviewOrderResult":{"id":"components/schemas/PreviewOrderResult","kind":"json-schema","title":"PreviewOrderResult","data":{"description":"The result of each type of preview. Returned only when the current request is preview call.","properties":{"chargeMetrics":{"items":{"properties":{"charges":{"items":{"$ref":"#/components/schemas/ChargePreviewMetrics"},"type":"array"},"subscriptionNumber":{"description":"The number of the subscription that has been affected by this order. When creating a subscription, this value will not show if the subscription number was not specified in the request.","type":"string"}},"type":"object"},"type":"array"},"creditMemos":{"description":"This field is only available if you have the Invoice Settlement feature enabled.","items":{"properties":{"amount":{"type":"number"},"amountWithoutTax":{"type":"number"},"creditMemoItems":{"items":{"$ref":"#/components/schemas/InvoiceItemPreviewResult"},"type":"array"},"targetDate":{"format":"date","type":"string"},"taxAmount":{"type":"number"}},"type":"object"},"type":"array"},"funds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fund preview grouped by subscription. Each entry contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionFunds"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for that subscription. Requires the Prepaid Drawdown feature and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funds"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"preview type."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PreviewOrderResultFunds"},"type":"array"},"invoices":{"items":{"properties":{"amount":{"type":"number","description":"The total amount of the invoice.\n"},"amountWithoutTax":{"type":"number","description":"The amount of the invoice without tax.\n"},"invoiceItems":{"description":"The invoice items on the invoice.\n","items":{"$ref":"#/components/schemas/InvoiceItemPreviewResult"},"type":"array"},"targetDate":{"format":"date","type":"string","description":"The target date to bill the invoice.\n"},"taxAmount":{"type":"number","description":"The total tax amount of the invoice.\n"},"invoiceItemSummary":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The aggregated summary data for all future invoices to be billed within the preview period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is returned only if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"summarizeInvoiceItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/InvoiceItemSummary"}}},"type":"object"},"type":"array"},"orderDeltaMetrics":{"description":[{"$$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":" As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The new methodologies are reflected in the following Order Delta Metrics objects."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-mrr"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Mrr"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-tcv"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Tcv"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-tcb"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Tcb"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is recommended that all customers use the new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you are an existing "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer and want to migrate to Order Delta Metrics, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"orderDeltaMrr":{"items":{"$ref":"#/components/schemas/OrderDeltaMrr"},"type":"array"},"orderDeltaTcb":{"items":{"$ref":"#/components/schemas/OrderDeltaTcb"},"type":"array"},"orderDeltaTcv":{"items":{"$ref":"#/components/schemas/OrderDeltaTcv"},"type":"array"}},"type":"object"},"orderMetrics":{"description":[{"$$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":" As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The new methodologies are reflected in the following Order Delta Metrics objects."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-mrr"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Mrr"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-tcv"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Tcv"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-tcb"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Tcb"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is recommended that all customers use the new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you are an existing "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer and want to migrate to Order Delta Metrics, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"Whereas new customers, and existing customers not currently on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported."},"children":[]}]}]}],"items":{"properties":{"orderActions":{"items":{"properties":{"orderItems":{"description":[{"$$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":"orderItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested field is only available to existing Orders customers who already have access to the field."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OrderItem"},"type":"array"},"orderMetrics":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for order metrics."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/orderMetric"},"type":"array"},"sequence":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"subscriptionNumber":{"type":"string"}},"type":"object"},"type":"array"},"rampMetrics":{"description":[{"$$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 only available if you have the Ramps feature enabled. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must be enabled before you can access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information coming October 2020."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ramp metrics."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OrderRampMetrics"},"type":"array"}},"type":"object"}},"components/schemas/PostOrderPreviewResponseType":{"id":"components/schemas/PostOrderPreviewResponseType","kind":"json-schema","title":"PostOrderPreviewResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"previewResult":{"$ref":"#/components/schemas/PreviewOrderResult"}},"type":"object"}]}},"components/schemas/POSTOrderPreviewAsyncRequestType":{"id":"components/schemas/POSTOrderPreviewAsyncRequestType","kind":"json-schema","title":"POSTOrderPreviewAsyncRequestType","data":{"example":{"existingAccountNumber":"A00000097","orderDate":"2024-07-01","previewOptions":{"previewTypes":["BillingDocs"],"previewThruType":"SpecificDate","specificPreviewThruDate":"2024-07-31"},"subscriptions":[{"orderActions":[{"type":"CreateSubscription","createSubscription":{"terms":{"initialTerm":{"period":12,"periodType":"Month","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":[{"period":12,"periodType":"Month"}]},"subscribeToRatePlans":[{"productRatePlanId":"8ad081dd9096ef9501909b40bb4e74a4"}]},"triggerDates":[{"name":"ContractEffective","triggerDate":"2024-07-01"},{"name":"ServiceActivation","triggerDate":"2024-07-01"},{"name":"CustomerAcceptance","triggerDate":"2024-07-01"}]}]}]},"properties":{"category":{"default":"NewSales","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the order to indicate a product sale or return. Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NewSales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["NewSales","Return"],"type":"string"},"customFields":{"$ref":"#/components/schemas/OrderObjectCustomFields"},"description":{"description":"A description of the order.","maxLength":500,"type":"string"},"existingAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account ID under which this order will be created.  This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order.  To override these defaults for individual subscriptions, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, but not both."},"children":[]}]}]}],"type":"string"},"existingAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number under which this order will be created.  This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":70,"type":"string"},"orderDate":{"description":"The date when the order is signed. All of the order actions under this order will use this order date as the contract effective date.","format":"date","type":"string"},"orderLineItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Order Line Items Without Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" billing permission, you can only create order  line items from existing products by specifying the product rate plan charge ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field.  For more information about billing permissions, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderOrderLineItem"},"type":"array"},"orderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number of this order."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"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 characters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"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":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not allowed in this field. Additionally, to ensure compatibility with the UI when viewing orders, use only the following special characters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"previewAccountInfo":{"$ref":"#/components/schemas/PreviewAccountInfo"},"previewOptions":{"$ref":"#/components/schemas/PreviewOptions"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values of reason code configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through Zuora UI. Indicates the reason when a return order line item occurs."},"children":[]}]}]}],"maxLength":255,"type":"string"},"subscriptions":{"description":"Each item includes a set of order actions, which will be applied to the same base subscription. When you create an order that involves multiple subscriptions, these subscriptions can have different invoice owner accounts or subscription owner accounts. ","items":{"properties":{"customFields":{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"},"notes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes about the subscription. These notes are only visible to Zuora users. Notes set in this field will override the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the createSubscription order action."},"children":[]}]}]}],"type":"string","maxLength":1000},"orderActions":{"description":"The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.","items":{"$ref":"#/components/schemas/PreviewOrderOrderAction"},"type":"array"},"quote":{"$ref":"#/components/schemas/QuoteObjectFields"},"ramp":{"$ref":"#/components/schemas/RampRequest"},"subscriptionNumber":{"description":"Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.\n","type":"string"}},"type":"object"},"type":"array"}},"required":["orderDate","previewOptions"],"type":"object"}},"components/schemas/CommitmentTypeEnum":{"id":"components/schemas/CommitmentTypeEnum","kind":"json-schema","title":"CommitmentTypeEnum","data":{"type":"string","enum":["MinCommitment","MaxCommitment"],"description":"The type of the commitment.\n"}},"components/schemas/CommitmentPrepaymentTypeEnum":{"id":"components/schemas/CommitmentPrepaymentTypeEnum","kind":"json-schema","title":"CommitmentPrepaymentTypeEnum","data":{"type":"string","description":"The prepayment type of the commitment.","example":"FullyPrepaid","enum":["NotPrepaid","FullyPrepaid"]}},"components/schemas/PeriodAlignmentOptionEnum":{"id":"components/schemas/PeriodAlignmentOptionEnum","kind":"json-schema","title":"PeriodAlignmentOptionEnum","data":{"type":"string","default":"CommitmentStartDate","enum":["CommitmentStartDate","SpecificDate"],"description":"Options for aligning the commitment periods within a commitment.\n"}},"components/schemas/ActionType":{"id":"components/schemas/ActionType","kind":"json-schema","title":"ActionType","data":{"type":"string","enum":["create","update","cancel"],"description":"The action type of the commitment.\n"}},"components/schemas/AmountBaseEnum":{"id":"components/schemas/AmountBaseEnum","kind":"json-schema","title":"AmountBaseEnum","data":{"title":"AmountBaseEnum","type":"string","description":"The level for which the committed amount applies to.","default":"CommitmentPeriod","enum":["CommitmentPeriod"]}},"components/schemas/PeriodTypeEnum":{"id":"components/schemas/PeriodTypeEnum","kind":"json-schema","title":"PeriodTypeEnum","data":{"title":"PeriodTypeEnum","type":"string","default":"Month","enum":["Month","Quarter","SemiAnnual","Year","SpecificMonths","SinglePeriod"],"description":"The frequency type of the period of the commitment schedule.\n"}},"components/schemas/PrepaymentFrequencyEnum":{"id":"components/schemas/PrepaymentFrequencyEnum","kind":"json-schema","title":"PrepaymentFrequencyEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The prepayment frequency for the prepayment definition. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the duration."},"children":[]}]}]}],"enum":["Month","Quarter","Semi_Annual","Annual","Eighteen_Months","Two_Years","Three_Years","Five_Years","Specific_Months","Week","Specific_Weeks","Specific_Days"]}},"components/schemas/PrepaymentDefinition":{"id":"components/schemas/PrepaymentDefinition","kind":"json-schema","title":"PrepaymentDefinition","data":{"type":"object","title":"PrepaymentDefinition","description":"The prepayment definition for the commitment schedule.","properties":{"prepaymentFrequency":{"$ref":"#/components/schemas/PrepaymentFrequencyEnum"},"specificFrequency":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific frequency length. This field is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepaymentFrequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"customFields":{"type":"object","additionalProperties":true,"description":"Container for custom fields of a prepayment definition object."}}}},"components/schemas/CommitmentBaseAttributesListOrders":{"id":"components/schemas/CommitmentBaseAttributesListOrders","kind":"json-schema","title":"CommitmentBaseAttributesListOrders","data":{"type":"object","title":"CommitmentBaseAttributesListOrders","properties":{"commitmentNumber":{"description":"The commitment number.\n","type":"string","maxLength":100},"id":{"description":"ID of the Commitment.","type":"string"},"name":{"description":"The name of the commitment. \n","type":"string","maxLength":255},"type":{"$ref":"#/components/schemas/CommitmentTypeEnum"},"description":{"description":"The description of the commitment. \n","type":"string","maxLength":500},"prepaymentType":{"$ref":"#/components/schemas/CommitmentPrepaymentTypeEnum"},"priority":{"description":"It defines the evaluation order of the commitment. The lower the number, the higher the priority.\nWhen two commitments have the same priority, the commitment that was created initially will be evaluated first.\n","type":"integer"},"customFields":{"type":"object","additionalProperties":true,"description":"Container for custom fields of a Commitment object.","title":"CommitmentCustomFields"},"specificPeriodAlignmentDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date for the period alignment. This field is required only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodAlignmentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","example":"2020-01-15"},"periodAlignmentOption":{"$ref":"#/components/schemas/PeriodAlignmentOptionEnum"},"schedules":{"description":"A list of Commitment schedule objects.\n","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the schedule."},"startDate":{"type":"string","description":"The start date of the schedule."},"endDate":{"type":"string","description":"The end date of the schedule."},"totalAmount":{"type":"number","format":"double","description":"The total amount of the schedule."},"action":{"$ref":"#/components/schemas/ActionType"},"amountBase":{"$ref":"#/components/schemas/AmountBaseEnum"},"periodType":{"$ref":"#/components/schemas/PeriodTypeEnum"},"prepaymentDefinition":{"$ref":"#/components/schemas/PrepaymentDefinition"},"specificPeriodLength":{"type":"integer","description":"The specific period length of each period in the schedule."}}}}}}},"components/schemas/CommonRevenueAttributes":{"id":"components/schemas/CommonRevenueAttributes","kind":"json-schema","title":"CommonRevenueAttributes","data":{"type":"object","properties":{"accountReceivableAccountingCode":{"description":"The accounting code on the Commitment object for customers. \n","type":"string","maxLength":100},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","maxLength":100},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","maxLength":100},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","maxLength":100},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","maxLength":100},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"maxLength":100},"deferredRevenueAccountingCode":{"description":"The deferred revenue accounting code for the commitment.\n","type":"string","maxLength":100},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude commitment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the commitment is allocation eligible in revenue recognition."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue recognition."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"recognizedRevenueAccountingCode":{"description":"The recognized revenue accounting code for the commitment.\n","type":"string","maxLength":100},"revenueAmortizationMethod":{"description":"This field is used to dictate the type of revenue amortization method.\n","type":"string","maxLength":200},"revenueRecognitionRule":{"description":"The revenue recognition rule for the commitment.\n","type":"string","maxLength":255},"revenueRecognitionTiming":{"description":"This field is used to dictate the type of revenue recognition timing.\n","type":"string","maxLength":200},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","maxLength":100}}}},"components/schemas/CommonTaxationAttributes":{"id":"components/schemas/CommonTaxationAttributes","kind":"json-schema","title":"CommonTaxationAttributes","data":{"type":"object","properties":{"taxable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to indicate whether the charge is taxable. If this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", both the fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required."},"children":[]}]}]}]},"taxCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code of a charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100},"taxMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode of a charge. This field is available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["TaxInclusive","TaxExclusive"]}}}},"components/schemas/EligibleAccountConditionOrders":{"id":"components/schemas/EligibleAccountConditionOrders","kind":"json-schema","title":"EligibleAccountConditionOrders","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 the accounts to which the commitment applies. Only charges belonging to a matching account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will trigger drawdowns against this commitment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The condition value supports order context variables resolved at the commitment creation time."},"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":"{{Order.Account.<field>}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reference the account that submitted the order."},"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":"{{Order.Account.accountNumber}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lets you create a condition that refers back to the account submitting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the order, without any requirement to know the account number in advance."},"children":[]}]}]}],"properties":{"field":{"type":"string","description":"The field name of a single condition.\n"},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operator of a single condition."},"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":"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":"eq: equal, field = value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"neq: not equal, field != value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gt: greater than, field > value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lt: less than, field < value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gte: greater than or equal, field >= value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lte: less than or equal, field <= value - lk: like, field like value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in: in, field in value, multiple values are separated by commas"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nl: null, field is null"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nnl: not null, field is not null"},"children":[]}]}]}]}],"enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of a single condition, which can be a list of values separated by commas."},"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":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Account Condition only contains account related fields. Support is provided only for the indexed custom fields."},"children":[]}]}]}]},"conditions":{"type":"array","description":"The conditions will be combined by the relation.\n","items":{"$ref":"#/components/schemas/EligibleAccountConditionOrders"}},"relation":{"type":"string","description":"The relation among the conditions.\n","enum":["and","or"]}}}},"components/schemas/GetEligibleChargeConditionOrders":{"id":"components/schemas/GetEligibleChargeConditionOrders","kind":"json-schema","title":"GetEligibleChargeConditionOrders","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 which charges trigger drawdowns against this commitment. Only charges whose attributes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"match all the conditions will reduce the commitment balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The condition value supports order context variables resolved at commitment creation time."},"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":"{{Order.Subscription[N].<field>}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (zero-based index) to reference a subscription being created in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the same order. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{Order.Subscription[0].id}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the first subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without knowing its ID in advance. Supported operators include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To match multiple"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptions, use nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" conditions with one variable per value — comma-separated variables"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a single value are not supported. Variables are case-insensitive. An out-of-bounds index,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unavailable object type, or unrecognized field returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HTTP 400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"field":{"type":"string","description":"The field name of a single condition.\n"},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operator of a single condition."},"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":"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":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": equal, field = value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"neq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": not equal, field != value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": greater than, field > value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": less than, field < value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": greater than or equal, field >= value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": less than or equal, field <= value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": like, field like value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": in, field in value, multiple values are separated by commas"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": null, field is null"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nnl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": not null, field is not null"},"children":[]}]}]}]}],"enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of a single condition, which can be a list of values separated by commas."},"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":"Notes:"},"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":"PPDD (PrePaid DrawDown) charge will not be loaded during evaluation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge condition only contains charge related fields. Support is provided only for the indexed custom fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge types support only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"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":"Charge models support only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FlatFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Overage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume Tiered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TieredWithOverage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Calculated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}]}]},"conditions":{"type":"array","description":"The conditions will be combined by the relation.\n","items":{"$ref":"#/components/schemas/GetEligibleChargeConditionOrders"}},"relation":{"type":"string","description":"The relation among the conditions.\n","enum":["and","or"]}}}},"components/schemas/CommitmentSettlementType":{"id":"components/schemas/CommitmentSettlementType","kind":"json-schema","title":"CommitmentSettlementType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement type for commitment cancellation."},"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":"NoSettlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - No settlement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FullMinimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Full minimum due (evaluate the commitment until the commitment end)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CurrentPeriodOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Period minimum due (evaluate the commitment through the cancellation period end)"},"children":[]}]}]}]}],"enum":["NoSettlement","FullMinimum","CurrentPeriodOnly"]}},"components/schemas/CommitmentCancellationPolicy":{"id":"components/schemas/CommitmentCancellationPolicy","kind":"json-schema","title":"CommitmentCancellationPolicy","data":{"type":"object","description":"Cancellation policy for a commitment. Defines how settlements are handled when a commitment is cancelled.","properties":{"settlementType":{"$ref":"#/components/schemas/CommitmentSettlementType"}}}},"components/schemas/GetCommitmentOutputListOrders":{"id":"components/schemas/GetCommitmentOutputListOrders","kind":"json-schema","title":"GetCommitmentOutputListOrders","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/CommitmentBaseAttributesListOrders"},{"$ref":"#/components/schemas/CommonRevenueAttributes"},{"$ref":"#/components/schemas/CommonTaxationAttributes"},{"properties":{"id":{"type":"string","description":"ID of the commitment.\n"},"version":{"type":"integer","description":"Version of the commitment.\n"},"currency":{"type":"string","description":"Currency of the commitment.\n"},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","default":true,"description":"The flag to exclude Commitment period from revenue accounting."},"eligibleAccountConditions":{"$ref":"#/components/schemas/EligibleAccountConditionOrders"},"eligibleChargeConditions":{"$ref":"#/components/schemas/GetEligibleChargeConditionOrders"},"cancellationEffectiveDate":{"description":"The date when the cancellation takes effect.\n","type":"string","format":"date"},"cancellationPolicyOverride":{"$ref":"#/components/schemas/CommitmentCancellationPolicy"},"status":{"type":"string","description":"The status of the commitment.","enum":["Cancel1ed","Active","Evaluated","CancelledPendingEvaluation"]},"action":{"$ref":"#/components/schemas/ActionType"}}}]}},"components/schemas/OrderLineItemCommonRetrieveOrder":{"id":"components/schemas/OrderLineItemCommonRetrieveOrder","kind":"json-schema","title":"OrderLineItem","data":{"properties":{"UOM":{"description":"Specifies the units to measure usage.\n","type":"string"},"accountingCode":{"description":"The accounting code for the Order Line Item.\n","type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"amountPerUnit":{"description":"The actual charged amount per unit for the Order Line Item.\n","type":"number"},"billTargetDate":{"description":"The target date for the Order Line Item to be picked up by bill run for billing.\n","format":"date","type":"string"},"billTo":{"description":"The ID of the bill-to contact of an order line item. An existing contact under the billing account is specified as the bill-to contact of the order line item. The billing account is the order account.\n","type":"string"},"billToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the bill-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"billingRule":{"description":"The billing rule of the Order Line Item.\n","enum":["TriggerWithoutFulfillment","TriggerAsFulfillmentOccurs"],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"currency":{"description":"The currency for the order line item. You can specify a currency when creating an order line item through the \"Create an order\" operation.\n","type":"string"},"customFields":{"$ref":"#/components/schemas/OrderLineItemCustomFields"},"deferredRevenueAccountingCode":{"description":"The deferred revenue accounting code for the Order Line Item.\n","type":"string"},"description":{"description":"The description of the Order Line Item.\n","type":"string"},"discount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field shows the total discount amount that is applied to an order line item after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The inline discount is applied to the list price of an order line item (see the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field)."},"children":[]}]}]}],"type":"number"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude Order Line Item from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"inlineDiscountPerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used in accordance with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, in the following manner:"},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount percentage is 5%."},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount amount on each unit of the order line item is 10."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"type":"number"},"inlineDiscountType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to specify the inline discount type, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"None"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"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 field is used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"enum":["Percentage","FixedAmount","None"],"type":"string"},"invoiceOwnerAccountId":{"description":"The account ID of the invoice owner of the order line item.\n","type":"string"},"invoiceOwnerAccountName":{"description":"The account name of the invoice owner of the order line item.\n","type":"string"},"invoiceOwnerAccountNumber":{"description":"The account number of the invoice owner of the order line item.\n","type":"string"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"itemCategory":{"default":"Sales","description":"The category of the Order Line Item, to indicate a product sale or return.\n","enum":["Sales","Return"],"type":"string"},"itemName":{"description":"The name of the Order Line Item.\n","type":"string"},"itemState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of an Order Line Item. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State transitions for an order, order line item, and fulfillment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["Draft","Executing","Booked","SentToBilling","Complete","Cancelled"],"type":"string"},"itemType":{"description":"The type of the Order Line Item.\n","enum":["Product","Fee","Services"],"type":"string"},"listPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity"},"children":[]}]}]}],"type":"number"},"listPricePerUnit":{"description":"The list price per unit for the Order Line Item.\n","type":"number"},"originalOrderId":{"description":"The ID of the original sale order for a return order line item. \n","type":"string"},"originalOrderLineItemId":{"description":"The ID of the original sale order line item for a return order line item. \n","type":"string"},"originalOrderLineItemNumber":{"description":"The number of the original sale order line item for a return order line item. \n","type":"string"},"originalOrderNumber":{"description":"The number of the original sale order for a return order line item. \n","type":"string"},"ownerAccountId":{"description":"The account ID of the owner of the order line item.\n","type":"string"},"ownerAccountName":{"description":"The account name of the owner of the order line item.\n","type":"string"},"ownerAccountNumber":{"description":"The account number of the owner of the order line item.\n","type":"string"},"productCode":{"description":"The product code for the Order Line Item.\n","type":"string"},"productRatePlanChargeId":{"description":"Id of a Product Rate Plan Charge. Only one-time charges are supported.\n","type":"string"},"purchaseOrderNumber":{"description":"Used by customers to specify the Purchase Order Number provided by the buyer.\n","type":"string"},"quantity":{"description":"The quantity of units, such as the number of authors in a hosted wiki service.\n","type":"number"},"quantityAvailableForReturn":{"description":"The quantity that can be returned for an order line item. \n","type":"number"},"quantityFulfilled":{"description":"The fulfilled quantity for an order line item.\n","type":"number"},"quantityPendingFulfillment":{"description":"The quantity to fulfill for an order line item. \n","type":"number"},"recognizedRevenueAccountingCode":{"description":"The recognized revenue accounting code for the Order Line Item.\n","type":"string"},"relatedSubscriptionNumber":{"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 relate an order line item to a subscription when you create the order line item."},"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 relate an order line item to a new subscription which is yet to create in the same \"Create an order\" call, use this field in combination with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the \"Create order\" operation. Specify this field to the same value as that of the 'subscriptions' > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when you make the \"Create order\" call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription."},"children":[]}]}]}]}],"type":"string"},"requiresFulfillment":{"description":"The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.\n","type":"boolean"},"revenueRecognitionRule":{"description":"The Revenue Recognition rule for the Order Line Item.\n","type":"string"},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"sequenceSetId":{"description":"The ID of the sequence set associated with the OrderLineItem.\n","type":"string","nullable":true},"shipTo":{"description":"The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the ship-to contact of an order line item. The billing account is the order account.\n","type":"string"},"shipToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the ship-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"soldTo":{"description":"The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item. The billing account is the order account.\n","type":"string"},"soldToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"taxCode":{"description":"The tax code for the Order Line Item.\n","type":"string"},"taxMode":{"description":"The tax mode for the Order Line Item.\n","enum":["TaxInclusive","TaxExclusive"],"type":"string"},"transactionEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"format":"date","type":"string"},"transactionStartDate":{"description":"The date a transaction starts. The default value of this field is the order date.\n","format":"date","type":"string"},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"title":"OrderLineItem","type":"object"}},"components/schemas/OrderLineItemRetrieveOrder":{"id":"components/schemas/OrderLineItemRetrieveOrder","kind":"json-schema","title":"OrderLineItemRetrieveOrder","data":{"allOf":[{"properties":{"amendedByOrderOn":{"description":"The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n","type":"string"},"amount":{"description":"The calculated gross amount for the Order Line Item.\n","type":"number"},"amountWithoutTax":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The calculated gross amount for an order line item excluding tax. If the tax mode is tax exclusive, the value of this field equals that of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"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 tax mode of an order line item is not set, the system treats it as tax exclusive by default. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountWithoutTax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field equals that of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"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 you create an order line item from the product catalog, the tax mode and tax code of the product rate plan charge are used for the order line item by default. You can still overwrite this default set-up by setting the tax mode and tax code of the order line item."},"children":[]}]}]}],"type":"number"},"id":{"description":"The sytem generated Id for the Order Line Item.\n","format":"UUID","type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature disabled."},"children":[]}]}]}],"type":"string"},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the order line item."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string","nullable":true},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment term name associated with the order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature disabled."},"children":[]}]}]}],"type":"string"},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature disabled."},"children":[]}]}]}],"type":"string"},"itemNumber":{"description":"The number for the Order Line Item.\n","type":"string"},"originalOrderDate":{"description":"The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n","format":"date","type":"string"},"quantityFulfilled":{"description":"The quantity that has been fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state.\n","type":"number"},"quantityPendingFulfillment":{"description":"The quantity that's need to be fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state.\n","type":"number"}},"type":"object"},{"$ref":"#/components/schemas/OrderLineItemCommonRetrieveOrder"}]}},"components/schemas/CommitmentOutput":{"id":"components/schemas/CommitmentOutput","kind":"json-schema","title":"UpsertOrderCommitmentResponse","data":{"type":"object","description":"The Commitment object in the \"Create an order\" or \"Update an order\" response.\n","title":"UpsertOrderCommitmentResponse","properties":{"id":{"type":"string","description":"ID of the commitment\n"},"commitmentNumber":{"type":"string","description":"Number of the commitment.\n"},"prepaymentType":{"$ref":"#/components/schemas/CommitmentPrepaymentTypeEnum"},"type":{"$ref":"#/components/schemas/CommitmentTypeEnum"},"startDate":{"type":"string","format":"date","description":"The start date of the commitment.\n"},"endDate":{"type":"string","format":"date","description":"The end date of the commitment.\n"},"status":{"type":"string","description":"The status of the commitment.","enum":["Cancel1ed","Active","Evaluated","CancelledPendingEvaluation"]},"totalAmount":{"type":"number","format":"double","description":"The total amount of the commitment."},"schedules":{"description":"A list of Commitment schedule objects.\n","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the schedule."},"startDate":{"type":"string","description":"The start date of the schedule."},"endDate":{"type":"string","description":"The end date of the schedule."},"prepaymentDefinition":{"$ref":"#/components/schemas/PrepaymentDefinition"},"totalAmount":{"type":"number","format":"double","description":"The total amount of the schedule."},"status":{"type":"string","description":"The status of the schedule.","enum":["Active","Evaluated","Cancelled","CancelledPendingEvaluation"]}}}}}}},"components/schemas/CreateOrderResult":{"id":"components/schemas/CreateOrderResult","kind":"json-schema","title":"CreateOrderResult","data":{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account ID for the order. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":32,"type":"string"},"accountNumber":{"description":"The account number for the order.","maxLength":70,"type":"string"},"commitments":{"description":"The commitments created by this order request.","items":{"$ref":"#/components/schemas/CommitmentOutput"},"type":"array"},"creditMemoIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of the credit memo IDs generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditMemoNumbers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","maxLength":32},"type":"array"},"creditMemoNumbers":{"description":"An array of the credit memo numbers generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled.","items":{"type":"string","maxLength":255},"type":"array"},"invoiceIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of the invoice IDs generated in this order request. Normally it includes one invoice ID only, but can include multiple items when a subscription was tagged as invoice separately. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceNumbers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","maxLength":32},"type":"array"},"invoiceNumbers":{"description":"An array of the invoice numbers generated in this order request. Normally it includes one invoice number only, but can include multiple items when a subscription was tagged as invoice separately.","items":{"type":"string","maxLength":255},"type":"array"},"orderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the order created. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":32,"type":"string"},"orderLineItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]}],"items":{"properties":{"id":{"description":"The sytem generated Id for the Order Line Item.","maxLength":32,"type":"string"},"itemNumber":{"description":"The number for the Order Line Item.","maxLength":100,"type":"string"}},"type":"object"},"type":"array"},"orderNumber":{"description":"The order number of the order created.","maxLength":100,"type":"string"},"paidAmount":{"description":"The total amount collected in this order request.","maxLength":22,"minLength":9,"type":"string"},"paymentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment Id that is collected in this order request. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":32,"type":"string"},"paymentNumber":{"description":"The payment number that is collected in this order request.","maxLength":32,"type":"string"},"paymentStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the outcome of payment collection for the order. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectPayment"},"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":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowPaymentFailure"},"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 order can still succeed even when payment does not, and this field shows the payment result in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The possible values 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":"text","inline":true,"attributes":{"content":"Error: Payment failed with a gateway decline, while the order, subscription, and invoice were still created successfully when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowPaymentFailure"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing: Payment was still in progress or not finalized in the response example for a simulated payment timeout, while the order succeeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed: Payment failed and the response included "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", while the order still completed successfully."},"children":[]}]}]}]}],"type":"string","enum":["Error","Processing","Failed"]},"ramps":{"description":[{"$$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 only available if you have the Ramps feature enabled. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must be enabled before you can access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information coming October 2020."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ramp definitions created by this order request."},"children":[]}]}]}],"items":{"properties":{"rampNumber":{"description":"The number of the ramp definition.","maxLength":50,"type":"string"},"subscriptionNumber":{"description":"The number of the subscription that this ramp deal definition is applied to.","maxLength":150,"type":"string"}},"type":"object"},"type":"array"},"reAssociationResult":{"$ref":"#/components/schemas/ReAssociationResult"},"refunds":{"description":"Container for refunds.","items":{"properties":{"number":{"description":"The refund number.","example":"R-00009564","maxLength":32,"type":"string"},"refundInvoiceNumbers":{"description":"An array of the refunded invoice numbers generated in this order request.","items":{"type":"string","maxLength":255},"type":"array"},"status":{"description":"The status of the refund.","enum":["Success","Error"],"type":"string"}},"type":"object"},"type":"array"},"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 order. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only applicable for an order that contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action."},"children":[]}]}]}],"enum":["Draft","Pending","Completed","Scheduled"],"type":"string"},"subscriptionIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the subscription IDs of the subscriptions in an order. This field is returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","maxLength":32},"type":"array"},"subscriptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you are on the latest Zuora API minor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"223.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"later available version. To use this field in the method, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to the minor version number in the request header."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the subscription numbers and statuses in an order."},"children":[]}]}]}],"items":{"properties":{"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. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are only applicable for an order that contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action."},"children":[]}]}]}],"enum":["Active","Pending Activation","Pending Acceptance","Cancelled","Suspended"],"type":"string"},"subscriptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription ID of the subscription included in this order. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":32,"type":"string"},"subscriptionNumber":{"description":"Subscription number of the subscription included in this order.\n","maxLength":150,"type":"string"},"subscriptionOwnerId":{"description":"Subscription owner account id of the subscription.\n","type":"string"},"subscriptionOwnerNumber":{"description":"Subscription owner account number of the subscription.\n","type":"string"}},"type":"object"}},"writeOff":{"description":"Container for write-offs.","items":{"properties":{"amount":{"description":"The amount written off from the invoice balance.","maximum":22,"minimum":9,"type":"number"},"failedReason":{"description":"The reason of write-off failure.","type":"string"},"invoiceNumber":{"description":"The number of the invoice that is written off.","example":"INV00051208","maxLength":255,"type":"string"},"status":{"description":"The status of the write-off.","enum":["Success","Failed"],"type":"string"},"writeOffCreditMemoNumber":{"description":"The number of the credit memo that is written off.","maxLength":255,"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/PostOrderResponseType":{"id":"components/schemas/PostOrderResponseType","kind":"json-schema","title":"PostOrderResponseType","data":{"description":"Response information of orders.","allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"$ref":"#/components/schemas/CreateOrderResult"}]}},"components/schemas/RatePlanFeatureOverride":{"id":"components/schemas/RatePlanFeatureOverride","kind":"json-schema","title":"ratePlanFeature","data":{"description":"Information about feature in rate plan.\n","properties":{"customFields":{"$ref":"#/components/schemas/RatePlanFeatureOverrideCustomFields"},"description":{"description":"A description of the feature.","maxLength":500,"type":"string"},"featureId":{"description":"Internal identifier of the feature in the product catalog.\n","type":"string"},"id":{"description":"Internal identifier of the rate plan feature override.\n","type":"string"}},"title":"ratePlanFeature","type":"object"}},"components/schemas/RatePlanOverride":{"id":"components/schemas/RatePlanOverride","kind":"json-schema","title":"ratePlan","data":{"description":"Rate plan associated with a subscription.\n","properties":{"chargeOverrides":{"description":"List of charges associated with the rate plan.\n","items":{"$ref":"#/components/schemas/ChargeOverride"},"type":"array"},"clearingExistingFeatures":{"description":"Specifies whether all features in the rate plan will be cleared.\n","type":"boolean"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"externallyManagedPlanId":{"description":"Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"isFromExternalCatalog":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"boolean"},"newRatePlanId":{"description":"Internal identifier of the rate plan.\n","type":"string"},"productRatePlanId":{"description":"Internal identifier of the product rate plan that the rate plan is based on.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the standalone rate plan."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"subscriptionProductFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of features associated with the rate plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system compares the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the request with the counterpart fields in a rate plan. The comparison results are 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":"If there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the field is empty, features in the rate plan remain unchanged. But if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingExistingFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is additionally set to true, all features in the rate plan are cleared."},"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":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, as well as the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/RatePlanFeatureOverride"},"type":"array"},"uniqueToken":{"description":"Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n","maxLength":50,"type":"string","nullable":true},"subscriptionRatePlanNumber":{"description":"Number of a subscription rate plan for this subscription.\n","maxLength":50,"type":"string"}},"required":["productRatePlanId"],"title":"ratePlan","type":"object"}},"components/schemas/ChangePlanChargeOverrideGetOrder":{"id":"components/schemas/ChangePlanChargeOverrideGetOrder","kind":"json-schema","title":"charge","data":{"description":"Charge associated with a rate plan.\n","properties":{"accountReceivableAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accountReceivableAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"billing":{"description":"Billing information about the charge.\n","properties":{"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the month that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maximum":31,"minimum":0,"type":"integer"},"billCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines the day that each billing period begins on."},"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":"DefaultFromCustomer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the bill cycle day of the account that owns the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the month that each billing period begins on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionStartDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeTriggerDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeklyBillCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the week that each billing period begins on."},"children":[]}]}]}]}],"enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek"],"type":"string"},"billingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing frequency of the charge. The value of this field controls the duration of each billing period."},"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":"Specific_Days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the duration of each billing period."},"children":[]}]}]}],"enum":["Month","Quarter","Semi_Annual","Annual","Eighteen_Months","Two_Years","Three_Years","Five_Years","Specific_Months","Subscription_Term","Week","Specific_Weeks","Specific_Days"],"type":"string"},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges."},"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":"AlignToCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for information about how Zuora determines the billing day."},"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 not supported in one time charges."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart"],"type":"string"},"billingTiming":{"description":"Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of each billing period in months or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"weeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the week that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"type":"object"},"chargeFunction":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["CommitmentTrueUp","CreditCommitment"],"type":"string"},"creditOption":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"chargeModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeModel of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported charge models:"},"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":"code","inline":true,"attributes":{"content":"FlatFee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerUnit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountFixedAmount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge number of the charge. For example, C-00000307."},"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 you do not set this field, Zuora will generate a charge number starting with a default prefix, for example, C-. This default prefix is predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"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 you want to use a custom charge number, do not use the default prefix predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use your own prefix, for example, SC-."},"children":[]}]}]}]}],"maxLength":50,"type":"string"},"chargeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeType of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported charge types:"},"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":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractAssetAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractRecognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deferredRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"description":{"description":"Description of the charge.\n","maxLength":500,"type":"string"},"drawdownPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown priority for consumption ordering. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"drawdownScope":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prepayment"},"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":"code","inline":true,"attributes":{"content":"SUBSCRIPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges of the same subscription can be drawn down."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges in the same account (subscription owner) can be drawn down."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["SUBSCRIPTION","ACCOUNT"]},"endDate":{"$ref":"#/components/schemas/EndConditions"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and want to create a completed order and an active subscription, you must specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field:"},"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":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in pending status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in active status."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"fundSupportAccountHierarchy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicate whether to enable sub-account's charge to drawdown from the parent's funds."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isRollover":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"True\" or \"False\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"negotiatedPriceTable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of negotiated price table information. The rate card entries provided in the array will override the existing rate card entries in the standard price table to form a negotiated price table that will be"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used during pricing evaluation."},"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":" To enable the Negotiated Price Table feature, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/NegotiatedItems"},"type":"array","additionalProperties":true},"pobPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pobPolicy of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"prepaymentUnitType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit type of the prepayment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["UNIT"]},"pricing":{"description":"Pricing information about the charge.\n","properties":{"chargeModelData":{"$ref":"#/components/schemas/ChargeModelDataOverride"},"discount":{"$ref":"#/components/schemas/DiscountPricingOverride"},"oneTimeFlatFee":{"$ref":"#/components/schemas/OneTimeFlatFeePricingOverride"},"oneTimePerUnit":{"$ref":"#/components/schemas/OneTimePerUnitPricingOverride"},"oneTimeTiered":{"$ref":"#/components/schemas/OneTimeTieredPricingOverride"},"oneTimeVolume":{"$ref":"#/components/schemas/OneTimeVolumePricingOverride"},"recurringCalculated":{"$ref":"#/components/schemas/RecurringCalculatedPricingOverrideGetOrder"},"recurringDeliveryBased":{"$ref":"#/components/schemas/RecurringDeliveryPricingOverride"},"recurringFlatFee":{"$ref":"#/components/schemas/RecurringFlatFeePricingOverride"},"recurringPerUnit":{"$ref":"#/components/schemas/RecurringPerUnitPricingOverride"},"recurringTiered":{"$ref":"#/components/schemas/RecurringTieredPricingOverride"},"recurringVolume":{"$ref":"#/components/schemas/RecurringVolumePricingOverride"},"usageFlatFee":{"$ref":"#/components/schemas/UsageFlatFeePricingOverride"},"usageOverage":{"$ref":"#/components/schemas/UsageOveragePricingOverride"},"usagePerUnit":{"$ref":"#/components/schemas/UsagePerUnitPricingOverride"},"usageTiered":{"$ref":"#/components/schemas/UsageTieredPricingOverride"},"usageTieredWithOverage":{"$ref":"#/components/schemas/UsageTieredWithOveragePricingOverride"},"usageVolume":{"$ref":"#/components/schemas/UsageVolumePricingOverride"}},"type":"object"},"pricingAttributes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values are used to get the charge’s list price from the product catalog. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically."},"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":" To enable Dynamic Pricing, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","additionalProperties":true},"productCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productCategory of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productClass of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productFamily":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productFamily of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productLine":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productLine of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal identifier of the product rate plan charge that the charge is based on. You can specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of a product rate-plan charge for this subscription. You can specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"prorationOption":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge Level Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-usage-charge-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage charge proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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":"You can use this field to specify the charge-level proration option for a usage charge or recurring charge when you create or add a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"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":"NoProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeBasedProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeFullPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"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":"When the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, the possible options 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":"text","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides."},"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":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the customization rules using these options in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod","CustomizeProrationOptionOverrides"],"type":"string"},"ratingPropertiesOverride":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field is used only when the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prorationOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"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 field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"object","properties":{"isProratePartialMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to prorate the charge for the partial month."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge Level Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/build-product-and-prices/set-up-product-catalog/create-product-rate-plan-charges/create-a-product-rate-plan-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify whether to prorate the recurring charge for a partial month. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"boolean"},"prorationUnit":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the unit of proration for a recurring charge. The tenant-level proration option will be overridden."},"children":[]}]}]}],"enum":["ProrateByDay","ProrateByMonthFirst"],"type":"string"},"prepaymentChargeProrationRule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define whether to prorate the charge amount or not. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProrateAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the proration rules via the options under this section."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["ProrateAmount","ChargeFullAmount"]},"daysInMonth":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the number of days counted for a month when prorating a recurring charge. The tenant-level proration option will be overridden. See more details for each of the following enum values in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["UseActualDays","Assume30Days","Assume30DaysStrict"],"type":"string"}}},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"Revenue Recognition Code\n","maxLength":70,"type":"string"},"revRecTriggerCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition trigger condition."},"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":"Contract Effective Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Service Activation Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Customer Acceptance Date"},"children":[]}]}]}]}],"enum":["Contract Effective Date","Service Activation Date","Customer Acceptance Date"],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition rule, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize upon invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize daily over time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have both the Order to Revenue feature and the Standalone Orders feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have both the Order to Revenue feature and the Standalone Orders feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"rolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicit cutoff date when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverEndDateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"rolloverEndDateType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover cutoff strategy determining when the rollover eligibility will end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"ChargeEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the subscription term end."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at an explicit date specified in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RolloverEndDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeEndDate","SubscriptionTerm","SpecificDate"]},"rolloverFundPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for rolled-over funds. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"rolloverPeriodLength":{"default":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rollover period length."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year. When the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can customize a single rollover period length together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"rolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"rolloverPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit for rollover period length."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"Day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Day-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Month-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quarter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Quarter-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Annual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Annual rollover periods."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["Day","Month","Quarter","Annual"]},"specificValidityPeriodLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of days, weeks, or months for the validity period when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidityPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"startDate":{"$ref":"#/components/schemas/CreateOrderTriggerParams"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The taxCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The taxMode of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"TaxExclusive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxInclusive"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"unBilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unBilledReceivablesAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"uniqueToken":{"description":"Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n","maxLength":50,"type":"string"},"upsellOriginChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the original upselling charge associated with the current charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a termed subscription, you can now use the \"Create an order\" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:"},"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":"Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell."},"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":"In the preceding charge to add, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upsellOriginChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the existing rate plan charge for which you want to make the quantity upsell."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription."},"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 Quantity Upsell feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"validityPeriodType":{"description":[{"$$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 only available if you have enabled either 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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field in the following scenarios:"},"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":"When you create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use this field to define the period in which the prepayment units are valid to use."},"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":"When you override the setting of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commitment true-up charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the product catalog, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When you use a standalone order to create a commitment true-up charge, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can also choose from the following options: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Specify the actual number in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificValidityPeriodLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"type":"string"},"validityPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the anchor date for validity period (VP) boundaries. The anchor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date defines the recurring grid — VP boundaries fall at every VP-length step"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the anchor. The charge's start and end dates then determine which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"portion of this grid is covered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ChargeStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - Anchor date is the charge start date. Simplest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"option with no partial first VP."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is the subscription term start date. Aligns all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges on the same subscription to a common grid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is derived by walking backward from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription term end date. Last VP always ends cleanly at term end;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partial VP (if any) is at the start."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAnchorDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom alignment for special billing arrangements."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeStart","TermStart","TermEnd","SpecificDate"]},"validityPeriodAnchorDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The anchor date for validity period alignment. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAlignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"validityPeriodProrationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls what happens to units when a validity period (VP) is partial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ProrateUnits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant partial units, the number is prorated based on the overlap ratio."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NoProrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant full units."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ProrateUnits","NoProrate"]}},"required":["productRatePlanChargeId"],"title":"charge","type":"object"}},"components/schemas/ChangePlanRatePlanOverride":{"id":"components/schemas/ChangePlanRatePlanOverride","kind":"json-schema","title":"ratePlan","data":{"description":"Information about the new product rate plan to add. \n","properties":{"chargeOverrides":{"description":"List of charges associated with the rate plan.\n","items":{"$ref":"#/components/schemas/ChangePlanChargeOverrideGetOrder"},"type":"array"},"clearingExistingFeatures":{"description":"Specifies whether all features in the rate plan will be cleared.\n","type":"boolean"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"externallyManagedPlanId":{"description":"Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"productRatePlanId":{"description":"Internal identifier of the product rate plan that the rate plan is based on.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"subscriptionProductFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of features associated with the rate plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system compares the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the request with the counterpart fields in a rate plan. The comparison results are 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":"If there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the field is empty, features in the rate plan remain unchanged. But if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingExistingFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is additionally set to true, all features in the rate plan are cleared."},"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":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, as well as the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/RatePlanFeatureOverride"},"type":"array"},"uniqueToken":{"description":"Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n","maxLength":50,"type":"string"}},"title":"ratePlan","type":"object"}},"components/schemas/ChangePlan":{"id":"components/schemas/ChangePlan","kind":"json-schema","title":"changePlan","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChangePlan"},"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":"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 change plan type of order action is supported for the  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. However, it is currently not supported for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing."},"children":[]}]}]}],"properties":{"effectivePolicy":{"description":[{"$$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 rate plan change (from old to new) is an upgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveImmediately"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the rate plan change (from old to new) is a downgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]}]}],"enum":["EffectiveImmediately","EffectiveEndOfBillingPeriod","SpecificDate"],"type":"string"},"newProductRatePlan":{"$ref":"#/components/schemas/ChangePlanRatePlanOverride"},"productRatePlanId":{"description":"ID of the rate plan to remove. This can be the latest version or any history version of ID.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanId":{"description":"ID of the rate plan to remove. This can be the latest version or any history version of ID.\n","type":"string"},"subType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to choose the sub type for your change plan order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, if you do not set this field, the field will be automatically generated by the system according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are within the same Grading catalog group:"},"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 grade of new plan is greater than that of the old plan, this is an \"Upgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan is less than that of the old plan, this is a \"Downgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan equals that of the old plan, this is a \"Crossgrade\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\"."},"children":[]}]}]}],"enum":["Upgrade","Downgrade","Crossgrade","PlanChanged"],"type":"string"},"subscriptionRatePlanNumber":{"description":"Number of a rate plan for this subscription.\n","type":"string"}},"title":"changePlan","type":"object"}},"components/schemas/BillToContact":{"id":"components/schemas/BillToContact","kind":"json-schema","title":"BillToContact","data":{"allOf":[{"description":"Contact details associated with an account.\n","properties":{"address1":{"description":"First line of the contact's address. This is often a street address or a business name.\n","maxLength":255,"type":"string"},"address2":{"description":"Second line of the contact's address.\n","maxLength":255,"type":"string"},"city":{"description":"City of the contact's address.\n","maxLength":40,"type":"string"},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the bill-to contact to calculate tax.\n","maxLength":64,"type":"string"},"county":{"description":"County of the contact's address.\n","maxLength":32,"type":"string"},"fax":{"description":"Fax number of the contact.\n","maxLength":40,"type":"string"},"firstName":{"description":"First name of the contact.\n","maxLength":100,"type":"string"},"homePhone":{"description":"Home phone number of the contact.\n","maxLength":40,"type":"string"},"lastName":{"description":"Last name of the contact.\n","maxLength":100,"type":"string"},"mobilePhone":{"description":"Mobile phone number of the contact.\n","maxLength":40,"type":"string"},"nickname":{"description":"Nickname of the contact.\n","maxLength":100,"type":"string"},"otherPhone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional phone number of the contact. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhoneType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the type of phone number."},"children":[]}]}]}],"maxLength":40,"type":"string"},"otherPhoneType":{"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 phone number in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"Personal email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"postalCode":{"description":"ZIP code or other postal code of the contact's address.\n","maxLength":20,"type":"string"},"state":{"description":"State or province of the contact's address.\n","maxLength":40,"type":"string"},"taxRegion":{"description":"Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n","maxLength":32,"type":"string"},"workEmail":{"description":"Business email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"workPhone":{"description":"Business phone number of the contact.\n","maxLength":40,"type":"string"}},"required":["firstName","lastName"],"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}]}},"components/schemas/SoldToContact":{"id":"components/schemas/SoldToContact","kind":"json-schema","title":"SoldToContact","data":{"allOf":[{"description":"Contact details associated with an account.\n","properties":{"address1":{"description":"First line of the contact's address. This is often a street address or a business name.\n","maxLength":255,"type":"string"},"address2":{"description":"Second line of the contact's address.\n","maxLength":255,"type":"string"},"city":{"description":"City of the contact's address.\n","maxLength":40,"type":"string"},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n","maxLength":64,"type":"string"},"county":{"description":"County of the contact's address.\n","maxLength":32,"type":"string"},"fax":{"description":"Fax number of the contact.\n","maxLength":40,"type":"string"},"firstName":{"description":"First name of the contact.\n","maxLength":100,"type":"string"},"homePhone":{"description":"Home phone number of the contact.\n","maxLength":40,"type":"string"},"lastName":{"description":"Last name of the contact.\n","maxLength":100,"type":"string"},"mobilePhone":{"description":"Mobile phone number of the contact.\n","maxLength":40,"type":"string"},"nickname":{"description":"Nickname of the contact.\n","maxLength":100,"type":"string"},"otherPhone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional phone number of the contact. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhoneType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the type of phone number."},"children":[]}]}]}],"maxLength":40,"type":"string"},"otherPhoneType":{"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 phone number in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"Personal email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"postalCode":{"description":"ZIP code or other postal code of the contact's address.\n","maxLength":20,"type":"string"},"state":{"description":"State or province of the contact's address.\n","maxLength":40,"type":"string"},"taxRegion":{"description":"Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n","maxLength":32,"type":"string","nullable":true},"workEmail":{"description":"Business email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"workPhone":{"description":"Business phone number of the contact.\n","maxLength":40,"type":"string"}},"required":["firstName","lastName"],"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}]}},"components/schemas/CreateSubscription":{"id":"components/schemas/CreateSubscription","kind":"json-schema","title":"createSubscription","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"maxLength":3,"type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-grouping"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Grouping"},"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 value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","maxLength":255,"nullable":true},"invoiceSeparately":{"description":"Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.\n","type":"boolean","nullable":true},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"newSubscriptionOwnerAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature."},"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 Owner Transfer feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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 you do not set this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"properties":{"accountNumber":{"description":"Account number. For example, A00000001.\n","maxLength":70,"type":"string"},"autoPay":{"description":"Specifies whether future payments are automatically billed when they are due.\n","type":"boolean"},"batch":{"description":"Name of the billing batch that the account belongs to. For example, Batch1.\n","type":"string"},"billCycleDay":{"description":"Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".\n","maximum":31,"minimum":0,"type":"integer"},"billToContact":{"$ref":"#/components/schemas/BillToContact"},"communicationProfileId":{"description":"Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.\n","type":"string"},"creditCard":{"$ref":"#/components/schemas/creditCard"},"crmId":{"description":"External identifier of the account in a CRM system.\n","maxLength":100,"type":"string"},"currency":{"description":"ISO 3-letter currency code (uppercase). For example, USD.\n","type":"string"},"customFields":{"$ref":"#/components/schemas/AccountObjectCustomFields"},"hpmCreditCardPaymentMethodId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"autoPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must provide the credit card payment method ID for either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a CC Reference Transaction payment method for an account."},"children":[]}]}]}],"type":"string"},"invoiceDeliveryPrefsEmail":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to turn on the invoice delivery method 'Email' for the new account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Turn on the invoice delivery method 'Email' for the new account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Turn off the invoice delivery method 'Email' for the new account."},"children":[]}]}]}]}],"type":"boolean"},"invoiceDeliveryPrefsPrint":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to turn on the invoice delivery method 'Print' for the new account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Turn on the invoice delivery method 'Print' for the new account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Turn off the invoice delivery method 'Print' for the new account."},"children":[]}]}]}]}],"type":"boolean"},"invoiceTemplateId":{"description":"Internal identifier of the invoice template that Zuora uses when generating invoices for the account.\n","type":"string"},"name":{"description":"Account name.\n","maxLength":70,"type":"string"},"notes":{"description":"Notes about the account. These notes are only visible to Zuora users.\n","maxLength":65535,"type":"string"},"parentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the parent customer account for this Account object. Use this field if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}],"type":"string"},"paymentGateway":{"description":"The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.\n","maxLength":40,"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/POSTPaymentMethodRequest"},"paymentTerm":{"description":"Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.\n","type":"string"},"soldToContact":{"$ref":"#/components/schemas/SoldToContact"},"taxInfo":{"$ref":"#/components/schemas/TaxInfo"}},"required":["name","currency","billCycleDay","billToContact"],"type":"object"},"notes":{"description":"Notes about the subscription. These notes are only visible to Zuora users.\n","maxLength":500,"type":"string","nullable":true},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the subscription."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"subscribeToRatePlans":{"description":"List of rate plans associated with the subscription.\n","items":{"$ref":"#/components/schemas/RatePlanOverride"},"type":"array"},"subscriptionNumber":{"description":"Subscription number of the subscription. For example, A-S00000001.\n\nIf you do not set this field, Zuora will generate the subscription number.\n","maxLength":100,"type":"string"},"subscriptionOwnerAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number of an existing account that will own the subscription. For example, A00000001."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not set this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newSubscriptionOwnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newSubscriptionOwnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":70,"type":"string"},"invoiceOwnerAccountNumber":{"description":"Account number of an existing account that will own the invoice. For example, A00000001. If you do not set this field, the account that owns the order will also own this invoice.\n","maxLength":70,"type":"string"},"terms":{"description":"Container for the terms and renewal settings of the subscription.\n","properties":{"autoRenew":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"initialTerm":{"description":"Information about the first term of the subscription.\n","properties":{"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the first term in months, years, days, or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"periodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time that the first term is measured in. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Month","Year","Day","Week"],"type":"string"},"startDate":{"description":"Start date of the first term, in YYYY-MM-DD format.\n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the first term. If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the first term has a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the first term does not have a predefined duration."},"children":[]}]}]}],"enum":["TERMED","EVERGREEN"],"type":"string"}},"required":["termType"],"type":"object"},"renewalSetting":{"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 the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"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":"code","inline":true,"attributes":{"content":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each renewal term has a predefined duration. The first entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the duration of the second term of the subscription, the second entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the duration of the third term of the subscription, and so on. The last entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the ultimate duration of each renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_TO_EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The second term of the subscription does not have a predefined duration."},"children":[]}]}]}]}],"enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"type":"string"},"renewalTerms":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of renewal terms of the subscription. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/RenewalTerm"},"type":"array"}},"required":["initialTerm","renewalTerms"],"type":"object"}},"title":"createSubscription","type":"object"}},"components/schemas/GetOrderResume":{"id":"components/schemas/GetOrderResume","kind":"json-schema","title":"Resume","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Resume"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"extendsTerm":{"description":"Specifies whether to extend the subscription term by the length of time the suspension is in effect. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.\n","type":"boolean"},"resumeDate":{"description":"The resume date when the resumption takes effect.\n","format":"date","type":"string"},"resumePeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the periods used to specify when a subscription resumption takes effect. The subscription resumption will take place after the specified time frame ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from today's date."},"children":[]}]}]}],"type":"integer"},"resumePeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to specify when a subscription resumption takes effect. The subscription suspension will take place after the specified time frame ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from today's date."},"children":[]}]}]}],"enum":["Day","Week","Month","Year"],"type":"string"},"resumePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resume methods. Specify a way to resume a subscription. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-subscriptions-resumption"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resume Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration."},"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":"SuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specfied, the resumption will take place on the same day as the suspension."},"children":[]}]}]}],"enum":["Today","FixedPeriodsFromSuspendDate","FixedPeriodsFromToday","SpecificDate","SuspendDate"],"type":"string"},"resumeSpecificDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A specific date when the subscription resumption takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription suspension date."},"children":[]}]}]}],"format":"date","type":"string","nullable":true}},"title":"Resume","type":"object"}},"components/schemas/GetOrderSuspend":{"id":"components/schemas/GetOrderSuspend","kind":"json-schema","title":"Suspend","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Suspend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"suspendDate":{"description":"The suspend date when the suspension takes effect. \n","format":"date","type":"string"},"suspendPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the periods used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from today's date."},"children":[]}]}]}],"type":"integer","nullable":true},"suspendPeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from today's date."},"children":[]}]}]}],"enum":["Day","Week","Month","Year"],"type":"string","nullable":true},"suspendPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suspend methods. Specify a way to suspend a subscription. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-considerations-of-suspend-a-subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suspend Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration."},"children":[]}]}]}],"enum":["Today","EndOfLastInvoicePeriod","FixedPeriodsFromToday","SpecificDate"],"type":"string","nullable":true},"suspendSpecificDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription's contract effective date or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" than the subscription's term end date."},"children":[]}]}]}],"format":"date","type":"string","nullable":true}},"title":"Suspend","type":"object"}},"components/schemas/InitialTerm":{"id":"components/schemas/InitialTerm","kind":"json-schema","title":"InitialTerm","data":{"description":"The length of the period for the current subscription term.","properties":{"period":{"description":"Specify only when the termType is 'TERMED'.","minimum":0,"type":"integer"},"periodType":{"description":"Specify only when the termType is 'TERMED'.","enum":["Month","Year","Day","Week"],"type":"string"},"startDate":{"description":"The start date of the current term.\n","format":"date","type":"string"},"endDate":{"description":"The end date of the current term.\n","format":"date","type":"string"},"termType":{"enum":["TERMED","EVERGREEN"],"type":"string"}},"required":["termType"],"type":"object"}},"components/schemas/TermsAndConditions":{"id":"components/schemas/TermsAndConditions","kind":"json-schema","title":"termsAndConditions","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermsAndConditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"autoRenew":{"type":"boolean"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"clearingExistingBillToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingInvoiceGroupNumber":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceGroupNumber"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingInvoiceTemplate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingPaymentTerm":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTerm"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSequenceSet":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingShipToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"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":"To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSoldToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"initialTerm":{"$ref":"#/components/schemas/InitialTerm"},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the subscription."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string","nullable":true},"clearingExistingCommunicationProfile":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing communication profile at the subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-grouping"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Grouping"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","maxLength":255,"nullable":true},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"scheduledCancelDate":{"description":"The date when the subscription is scheduled to be canceled. The subscription is not canceled until the date specified in this field.","type":"string","format":"date"},"scheduledSuspendDate":{"description":"The date when the subscription is scheduled to be suspended. The subscription is not suspended until the date specified in this field.","type":"string","format":"date"},"scheduledResumeDate":{"description":"The date when the subscription is scheduled to be resumed. The subscription is not resumed until the date specified in this field.","type":"string","format":"date"},"clearingScheduledCancelDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledCancelDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"clearingScheduledSuspendDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"clearingScheduledResumeDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledResumeDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"renewalSetting":{"enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"type":"string"},"renewalTerms":{"items":{"$ref":"#/components/schemas/RenewalTerm"},"type":"array"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the subscription."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"}},"title":"termsAndConditions","type":"object"}},"components/schemas/RecurringCalculatedPricingUpdateGetOrder":{"id":"components/schemas/RecurringCalculatedPricingUpdateGetOrder","kind":"json-schema","title":"recurringCalculated","data":{"allOf":[{"properties":{"minimumAmount":{"description":"Non-negative currency amount that establishes the lower bound for the calculated charge in a billing period. If the calculated amount is less than this value, the invoice amount will be set to the minimum value.\n","type":"number"},"maximumAmount":{"type":"number","description":"Non-negative currency amount that establishes the upper bound for the calculated charge in a billing period. If the calculated amount exceeds this value, the invoice amount will be set to the maximum value.\n"},"percentage":{"type":"number","description":"The specific rate applied to the total eligible spend to determine the base invoice amount before any minimum or maximum amount is applied.\n"}},"type":"object"}],"required":["percentage"],"description":"Pricing information about a recurring charge that uses the \"calculated\" charge model.\n","title":"recurringCalculated"}},"components/schemas/RecurringDeliveryPricingUpdate":{"id":"components/schemas/RecurringDeliveryPricingUpdate","kind":"json-schema","title":"RecurringDeliveryPricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"deliverySchedule":{"$ref":"#/components/schemas/DeliveryScheduleParams"},"listPrice":{"type":"number"}},"type":"object"}]}},"components/schemas/UsageFlatFeePricingUpdate":{"id":"components/schemas/UsageFlatFeePricingUpdate","kind":"json-schema","title":"UsageFlatFeePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"listPrice":{"type":"number"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"}},"type":"object"}]}},"components/schemas/UsageOveragePricingUpdate":{"id":"components/schemas/UsageOveragePricingUpdate","kind":"json-schema","title":"UsageOveragePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"includedUnits":{"description":"A certain quantity of units for free in the overage charge model. It cannot be negative. It must be 0 and above. Decimals are allowed.\n","type":"number"},"overagePrice":{"type":"number"}},"type":"object"}]}},"components/schemas/UsagePerUnitPricingUpdate":{"id":"components/schemas/UsagePerUnitPricingUpdate","kind":"json-schema","title":"UsagePerUnitPricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"listPrice":{"type":"number"},"originalListPrice":{"description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n","type":"number"}},"type":"object"}]}},"components/schemas/UsageTieredPricingUpdate":{"id":"components/schemas/UsageTieredPricingUpdate","kind":"json-schema","title":"UsageTieredPricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"tiers":{"items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"}},"type":"object"}]}},"components/schemas/UsageTieredWithOveragePricingUpdate":{"id":"components/schemas/UsageTieredWithOveragePricingUpdate","kind":"json-schema","title":"UsageTieredWithOveragePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"overagePrice":{"type":"number"},"tiers":{"items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"}},"type":"object"}]}},"components/schemas/UsageVolumePricingUpdate":{"id":"components/schemas/UsageVolumePricingUpdate","kind":"json-schema","title":"UsageVolumePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/PriceChangeParams"},{"properties":{"tiers":{"items":{"$ref":"#/components/schemas/ChargeTier"},"type":"array"}},"type":"object"}]}},"components/schemas/PricingUpdate":{"id":"components/schemas/PricingUpdate","kind":"json-schema","title":"PricingUpdate","data":{"properties":{"chargeModelData":{"allOf":[{"$ref":"#/components/schemas/ChargeModelDataOverride"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for charge model configuration data."},"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 only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}]},"discountdiscount":{"allOf":[{"$ref":"#/components/schemas/DiscountPricingUpdate"}],"description":"Pricing information about a discount charge.\n"},"recurringCalculated":{"$ref":"#/components/schemas/RecurringCalculatedPricingUpdateGetOrder"},"recurringDelivery":{"allOf":[{"$ref":"#/components/schemas/RecurringDeliveryPricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"delivery\" charge model. This field is only available if you have the Delivery Pricing charge model enabled.\n"},"recurringFlatFee":{"allOf":[{"$ref":"#/components/schemas/RecurringFlatFeePricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"},"recurringPerUnit":{"allOf":[{"$ref":"#/components/schemas/RecurringPerUnitPricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"},"recurringTiered":{"allOf":[{"$ref":"#/components/schemas/RecurringTieredPricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"},"recurringVolume":{"allOf":[{"$ref":"#/components/schemas/RecurringVolumePricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"},"usageFlatFee":{"allOf":[{"$ref":"#/components/schemas/UsageFlatFeePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"},"usageOverage":{"allOf":[{"$ref":"#/components/schemas/UsageOveragePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n"},"usagePerUnit":{"allOf":[{"$ref":"#/components/schemas/UsagePerUnitPricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n"},"usageTiered":{"allOf":[{"$ref":"#/components/schemas/UsageTieredPricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n"},"usageTieredWithOverage":{"allOf":[{"$ref":"#/components/schemas/UsageTieredWithOveragePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n"},"usageVolume":{"allOf":[{"$ref":"#/components/schemas/UsageVolumePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n"}},"type":"object"}},"components/schemas/ChargeUpdate":{"id":"components/schemas/ChargeUpdate","kind":"json-schema","title":"ChargeUpdate","data":{"description":"The JSON object containing the information for a charge update in the 'UpdateProduct' type order action.","properties":{"billing":{"$ref":"#/components/schemas/BillingUpdate"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the charge to be updated. The value of this field is inherited from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderActions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"},"description":{"type":"string","nullable":true},"effectiveDate":{"$ref":"#/components/schemas/TriggerParams"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"pricing":{"allOf":[{"$ref":"#/components/schemas/PricingUpdate"}],"description":"Pricing information about the charge.\n"},"uniqueToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"description: |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions."},"children":[]}]}]}],"type":"string","nullable":true}},"type":"object"}},"components/schemas/RatePlanUpdate":{"id":"components/schemas/RatePlanUpdate","kind":"json-schema","title":"updateProduct","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"chargeUpdates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of the JSON objects containing the information for a charge update in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type of order action."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ChargeUpdate"},"type":"array"},"chargeOverrides":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section is only available for hard bundle rate plans. To include additional charges to the subscribed hard bundle, specify the product rate plan charge ID and its 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 only available when the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled. The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ChargeOverride"},"type":"array"},"chargeRemovals":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section is only available for hard bundle rate plans. To remove optional component charges from the subscribed hard bundle, specify its subscription rate plan charge number or unique token."},"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 only available when the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled. The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early availability before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ChargeRemoval"},"type":"array"},"clearingExistingFeatures":{"description":"Specifies whether all features in the rate plan will be cleared.\n","type":"boolean"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"externallyManagedPlanId":{"description":"Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"newRatePlanId":{"description":"Internal identifier of the updated rate plan in the new subscription version.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanId":{"description":"Internal identifier of the rate plan that was updated. It can be the latest version or any history version id.\n","type":"string"},"specificUpdateDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date when the Update Product order action takes effect.  This field allows you to update a charge before a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd."},"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":": After you use this option, the charge's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TriggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field value will be changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-update-products-on-subscriptions-future-dated-updates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Product on Subscription with Future-dated Updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about this feature."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"subscriptionProductFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of features associated with the rate plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system compares the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the request with the counterpart fields in a rate plan. The comparison results are 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":"If there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the field is empty, features in the rate plan remain unchanged. But if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingExistingFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is additionally set to true, all features in the rate plan are cleared."},"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":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, as well as the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/RatePlanFeatureOverride"},"type":"array"},"subscriptionRatePlanNumber":{"description":"Number of a rate plan for this subscription.\n","type":"string"},"uniqueToken":{"description":"A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.\n","type":"string","nullable":true}},"title":"updateProduct","type":"object"}},"components/schemas/OrderAction":{"id":"components/schemas/OrderAction","kind":"json-schema","title":"OrderAction","data":{"description":"Represents the processed order action.","properties":{"addProduct":{"$ref":"#/components/schemas/RatePlanOverride"},"cancelSubscription":{"$ref":"#/components/schemas/CancelSubscription"},"changePlan":{"$ref":"#/components/schemas/ChangePlan"},"changeReason":{"description":"The change reason set for an order action when an order is created.\n","type":"string"},"createSubscription":{"$ref":"#/components/schemas/CreateSubscription"},"customFields":{"$ref":"#/components/schemas/OrderActionObjectCustomFields"},"id":{"description":"The Id of the order action processed in the order.","type":"string"},"orderItems":{"description":[{"$$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":"orderItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested field is only available to existing Orders customers who already have access to the field."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OrderItem"},"type":"array"},"orderMetrics":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for order metrics."},"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 following objects and fields of the Order Metrics are end of support. Any new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-orders-harmonization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders Harmonization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not get these metrics."},"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 Order ELP and Order Item objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora no longer provides product support, and bug fixes or security issues are no longer addressed."},"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":" As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The new methodologies are reflected in the following Order Delta Metrics objects."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-mrr"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Mrr"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-tcv"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Tcv"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-tcb"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Tcb"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is recommended that all customers use the new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-delta-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you are an existing "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer and want to migrate to Order Delta Metrics, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"Whereas new customers, and existing customers not currently on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/orderMetric"},"type":"array"},"ownerTransfer":{"$ref":"#/components/schemas/OwnerTransfer"},"removeProduct":{"$ref":"#/components/schemas/RemoveProduct"},"renewSubscription":{"$ref":"#/components/schemas/RenewSubscription"},"resume":{"$ref":"#/components/schemas/GetOrderResume"},"sequence":{"description":"The sequence of the order actions processed in the order.","type":"integer"},"suspend":{"$ref":"#/components/schemas/GetOrderSuspend"},"termsAndConditions":{"$ref":"#/components/schemas/TermsAndConditions"},"triggerDates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the contract effective, service activation, and customer acceptance dates of the order action."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora is configured to require service activation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription are created."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora is configured to require customer acceptance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription are created. At the same time, if the service activation date field is also required and not set, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription are created instead."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora is configured to require service activation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set for either of the following order actions, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order is created. The subscription status is not impacted. "},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you want to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"AddProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TermsAndConditions"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora is configured to require customer acceptance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set for either of the following order actions, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order is created. The subscription status is not impacted. "},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you want to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"AddProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TermsAndConditions"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/TriggerDate"},"type":"array"},"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 order action."},"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 change plan type of order action is supported for the  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. However, it is currently not supported for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing."},"children":[]}]}]}],"enum":["CreateSubscription","TermsAndConditions","AddProduct","UpdateProduct","RemoveProduct","RenewSubscription","CancelSubscription","OwnerTransfer","Suspend","Resume","ChangePlan","Revert"],"type":"string"},"updateProduct":{"$ref":"#/components/schemas/RatePlanUpdate","description":""}},"type":"object"}},"components/schemas/RampChargeResponse":{"id":"components/schemas/RampChargeResponse","kind":"json-schema","title":"charges","data":{"properties":{"chargeNumber":{"description":"The number of the rate plan charge.","type":"string"}},"title":"charges","type":"object"}},"components/schemas/RampIntervalResponse":{"id":"components/schemas/RampIntervalResponse","kind":"json-schema","title":"intervals","data":{"properties":{"description":{"description":"The short description of the interval.","type":"string"},"endDate":{"description":"The end date of the interval.","format":"date","type":"string"},"name":{"description":"The name of the interval.","type":"string"},"startDate":{"description":"The start date of the interval.","format":"date","type":"string"}},"title":"intervals","type":"object"}},"components/schemas/RampResponse":{"id":"components/schemas/RampResponse","kind":"json-schema","title":"Ramp","data":{"properties":{"charges":{"description":"Container for the rate plan charges that are considered as part of the ramp deal.","items":{"$ref":"#/components/schemas/RampChargeResponse"},"type":"array"},"description":{"description":"The short description of the ramp.","type":"string"},"id":{"description":"The ID of the ramp.","type":"string"},"intervals":{"description":"Container for the intervals that the ramp is split into in its timeline.","items":{"$ref":"#/components/schemas/RampIntervalResponse"},"type":"array"},"name":{"description":"The name of the ramp.","type":"string"},"number":{"description":"The number of the ramp. It is automaticcally generated by the billing system.","type":"string"},"subscriptionNumber":{"description":"The number of the subscription that is considered as part of the ramp deal.","type":"string"}},"title":"Ramp","type":"object","description":[{"$$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 only available if you have the Ramps feature"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature must be enabled before you can access the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature. The Ramps feature is available for customers with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise and Nine editions by default. If you are a Growth"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Editions"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for pricing information coming October 2020."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ramp definition."},"children":[]}]}]}]}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"description":"Represents the order information that will be returned in the GET call.","properties":{"category":{"default":"NewSales","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the order to indicate a product sale or return. Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NewSales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["NewSales","Return"],"type":"string"},"commitments":{"items":{"$ref":"#/components/schemas/GetCommitmentOutputListOrders"},"type":"array","description":"A list of commitments.\n"},"createdBy":{"description":"The ID of the user who created this order.","type":"string"},"createdDate":{"description":"The time that the order gets created in the system.","type":"string"},"currency":{"description":"Currency code.","type":"string"},"customFields":{"$ref":"#/components/schemas/OrderObjectCustomFields"},"description":{"description":"A description of the order.","maxLength":500,"type":"string","nullable":true},"existingAccountNumber":{"description":"The account number that this order has been created under.\n","type":"string"},"existingAccountDetails":{"description":"The account basic information that this order has been created under.\n","properties":{"basicInfo":{"$ref":"#/components/schemas/GETAccountTypeBasicInfo"},"billToContact":{"$ref":"#/components/schemas/GETAccountTypeBillToContact"}},"type":"object"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the order."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-get-started-billing-schedule","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"orderDate":{"description":"The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if no additinal contractEffectiveDate is provided.","format":"date","type":"string"},"orderLineItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models."},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OrderLineItemRetrieveOrder"},"type":"array"},"orderNumber":{"description":"The order number of the order.","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values of reason code configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through Zuora UI. Indicates the reason when a return order line item occurs."},"children":[]}]}]}],"maxLength":255,"type":"string"},"schedulingOptions":{"description":"Information of scheduled order.\n","properties":{"scheduledDate":{"description":"The date for the order scheduled.\n","format":"date","type":"string"},"scheduledDatePolicy":{"description":"Date policy of the scheduled order.","enum":["SpecificDate"],"type":"string"}},"type":"object"},"scheduledOrderActivationResponse":{"$ref":"#/components/schemas/PostOrderResponseType"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the order. If the order contains any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription, the order status will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; If the order is in draft status, the order status will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; otherwise the order status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"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 available order statuses are as follow:"},"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":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in draft status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in pending status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in completed status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The draft or scheduled order is cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The scheduled order has failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reverted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order has been reverted."},"children":[]}]}]}]}],"enum":["Draft","Pending","Completed","Cancelled","Scheduled","Executing","Failed","Reverted"],"type":"string"},"subscriptions":{"description":"Represents a processed subscription, including the origin request (order actions) that create this version of subscription and the processing result (order metrics). The reference part in the request will be overridden with the info in the new subscription version.","items":{"properties":{"baseVersion":{"description":"The base version of the subscription.","type":"integer","nullable":true},"customFields":{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"},"externallyManagedBy":{"description":"An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n","enum":["Amazon","Apple","Google","Roku"],"type":"string","nullable":true},"newVersion":{"description":"The latest version of the subscription.","type":"integer"},"notes":{"description":"Notes about the subscription.","type":"string"},"orderActions":{"items":{"$ref":"#/components/schemas/OrderAction"},"type":"array"},"quote":{"$ref":"#/components/schemas/QuoteObjectFields"},"ramp":{"$ref":"#/components/schemas/RampResponse"},"sequence":{"description":"The sequence number of a certain subscription processed by the order.","type":"integer"},"subscriptionNumber":{"description":"The new subscription number for a new subscription created, or the existing subscription number. Unlike the order request, the subscription number here always has a value.","type":"string"},"subscriptionOwnerAccountNumber":{"description":"The number of the account that owns the subscription.","type":"string"},"subscriptionOwnerAccountDetails":{"description":"The account basic information that this order has been created under. This is\nalso the invoice owner of the subscriptions included in this order.\n","properties":{"basicInfo":{"$ref":"#/components/schemas/GETAccountTypeBasicInfo"},"soldToContact":{"$ref":"#/components/schemas/GETAccountTypeSoldToContact"}},"type":"object"}},"type":"object"},"type":"array"},"updatedBy":{"description":"The ID of the user who updated this order.","type":"string"},"updatedDate":{"description":"The time that the order gets updated in the system(for example, an order description update).","type":"string"}},"type":"object"}},"components/schemas/GetAllOrdersResponseType":{"id":"components/schemas/GetAllOrdersResponseType","kind":"json-schema","title":"GetAllOrdersResponseType","data":{"properties":{"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"orders":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/CommitmentBaseAttributesRequest":{"id":"components/schemas/CommitmentBaseAttributesRequest","kind":"json-schema","title":"UpsertOrderCommitmentBaseAttributes","data":{"type":"object","title":"UpsertOrderCommitmentBaseAttributes","properties":{"commitmentNumber":{"description":"The commitment number.\n","type":"string","maxLength":100},"name":{"description":"The name of the commitment. \n","type":"string","maxLength":255},"type":{"$ref":"#/components/schemas/CommitmentTypeEnum"},"description":{"description":"The description of the commitment. \n","type":"string","maxLength":500},"priority":{"description":"It defines the evaluation order of the commitment. The lower the number, the higher the priority.\nWhen two commitments have the same priority, the commitment that was created initially will be evaluated first.\n","type":"integer"},"customFields":{"type":"object","additionalProperties":true,"description":"Custom fields of an Commitment object.\n","title":"CommitmentCustomFields"},"prepaymentType":{"$ref":"#/components/schemas/CommitmentPrepaymentTypeEnum"},"specificPeriodAlignmentDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date for the period alignment. This field is required only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodAlignmentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","example":"2020-01-15"},"periodAlignmentOption":{"$ref":"#/components/schemas/PeriodAlignmentOptionEnum"}},"required":["name","type","priority"]}},"components/schemas/EligibleChargeConditionOrders":{"id":"components/schemas/EligibleChargeConditionOrders","kind":"json-schema","title":"EligibleChargeConditionOrders","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 which charges trigger drawdowns against this commitment. Only charges whose attributes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"match all the conditions will reduce the commitment balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The condition value supports order context variables resolved at commitment creation time."},"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":"{{Order.Subscription[N].<field>}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (zero-based index) to reference a subscription being created in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the same order. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{Order.Subscription[0].id}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the first subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without knowing its ID in advance. Supported operators include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To match multiple"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptions, use nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" conditions with one variable per value — comma-separated variables"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a single value are not supported. Variables are case-insensitive. An out-of-bounds index,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unavailable object type, or unrecognized field returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HTTP 400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"field":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field name of a single condition."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API supports additional enum values beyond these examples. However, not every field on an object or custom field is 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":"code","inline":true,"attributes":{"content":"RatePlanCharge.UniqueToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unique identifier of a charge declared in the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions[].orderActions[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" charge overrides"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeUpdates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueToken"},"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":"code","inline":true,"attributes":{"content":"RatePlan.UniqueToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unique identifier of a rate plan declared in the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions[].orderActions[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rate plan overrides"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanOverride.uniqueToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"enum":["RatePlanCharge.UniqueToken","RatePlan.UniqueToken"]},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operator of a single condition."},"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":"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":"eq: equal, field = value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"neq: not equal, field != value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gt: greater than, field > value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lt: less than, field < value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gte: greater than or equal, field >= value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lte: less than or equal, field <= value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lk: like, field like value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in: in, field in value, multiple values are separated by commas"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nl: null, field is null"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nnl: not null, field is not null"},"children":[]}]}]}]}],"enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of a single condition, which can be a list of values separated by commas."},"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":"Notes:"},"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":"PPDD (PrePaid DrawDown) charge will not be loaded during evaluation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge condition only contains charge related fields. Support is provided only for the indexed custom fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge types supports only the OneTime, Recurring and Usage values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge models supports only the FlatFee, PerUnit, Overage, Volume Tiered, TieredWithOverage, and Calculated values."},"children":[]}]}]}]}]},"conditions":{"type":"array","description":"The conditions will be combined by the relation.\n","items":{"$ref":"#/components/schemas/EligibleChargeConditionOrders"}},"relation":{"type":"string","description":"The relation among the conditions.\n","enum":["and","or"]}}}},"components/schemas/CommitmentInput":{"id":"components/schemas/CommitmentInput","kind":"json-schema","title":"CreateCommitmentRequest","data":{"type":"object","title":"CreateCommitmentRequest","allOf":[{"$ref":"#/components/schemas/CommitmentBaseAttributesRequest"},{"$ref":"#/components/schemas/CommonRevenueAttributes"},{"$ref":"#/components/schemas/CommonTaxationAttributes"},{"properties":{"currency":{"type":"string","description":"Currency of the commitment.\n"},"eligibleAccountConditions":{"$ref":"#/components/schemas/EligibleAccountConditionOrders"},"eligibleChargeConditions":{"$ref":"#/components/schemas/EligibleChargeConditionOrders"}}}],"required":["eligibleAccountConditions","currency"]}},"components/schemas/ActionTypeCreate":{"id":"components/schemas/ActionTypeCreate","kind":"json-schema","title":"ActionTypeCreate","data":{"type":"string","enum":["create"],"description":"Indicates whether to create a commitment.\n"}},"components/schemas/CommitmentScheduleAttributes":{"id":"components/schemas/CommitmentScheduleAttributes","kind":"json-schema","title":"CommitmentScheduleAttributes","data":{"title":"CommitmentScheduleAttributes","type":"object","properties":{"amount":{"type":"number","description":"The amount of each period in the schedule."},"amountBase":{"$ref":"#/components/schemas/AmountBaseEnum"},"periodType":{"$ref":"#/components/schemas/PeriodTypeEnum"},"specificPeriodLength":{"type":"integer","description":"The specific period length of each period in the schedule."},"startDate":{"description":"Ths start date of the schedule.","type":"string","format":"date"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the schedule."},"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":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A commitment can contain a maximum of 100 periods."},"children":[]}]}]}],"type":"string","format":"date"},"prepaymentDefinition":{"$ref":"#/components/schemas/PrepaymentDefinition"}},"required":["startDate","endDate","amount"]}},"components/schemas/UpsertCreateCommitmentInput":{"id":"components/schemas/UpsertCreateCommitmentInput","kind":"json-schema","title":"UpsertCreateCommitmentInput","data":{"title":"UpsertCreateCommitmentInput","description":"create a new Commitment.","properties":{"action":{"$ref":"#/components/schemas/ActionTypeCreate"},"childCommitments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of child commitment relationships to declare on this commitment. Each entry specifies an action (ADD or REMOVE) and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifying the child. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitment number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitment ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[N].id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reference a commitment created earlier in the same order request."},"children":[]}]}]}],"type":"array","items":{"type":"object","properties":{"commitmentKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the child commitment. Accepts a commitment number, commitment ID, or [N].id index reference for same-order creation."},"children":[]}]}]}]},"action":{"type":"string","enum":["ADD","REMOVE"],"description":"Whether to attach or detach the child commitment."}},"required":["action","commitmentKey"]}},"schedules":{"description":"The new schedules which are required when creating a new commitment.","type":"array","items":{"type":"object","properties":{"action":{"type":"string","enum":["create"]}},"allOf":[{"$ref":"#/components/schemas/CommitmentScheduleAttributes"}]}}},"allOf":[{"$ref":"#/components/schemas/CommitmentInput"}],"required":["action","schedules"]}},"components/schemas/CommitmentScheduleAttributesUpdate":{"id":"components/schemas/CommitmentScheduleAttributesUpdate","kind":"json-schema","title":"CommitmentScheduleAttributes","data":{"title":"CommitmentScheduleAttributes","type":"object","properties":{"amount":{"type":"number","description":"The amount of each period in the schedule."},"amountBase":{"$ref":"#/components/schemas/AmountBaseEnum"},"periodType":{"$ref":"#/components/schemas/PeriodTypeEnum"},"specificPeriodLength":{"type":"integer","description":"The specific period length of each period in the schedule."},"startDate":{"description":"Ths start date of the schedule.","type":"string","format":"date"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the schedule."},"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":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A commitment can contain a maximum of 100 periods."},"children":[]}]}]}],"type":"string","format":"date"}},"required":["startDate","endDate","amount"]}},"components/schemas/ActionTypeSchedule":{"id":"components/schemas/ActionTypeSchedule","kind":"json-schema","title":"ActionTypeSchedule","data":{"type":"string","enum":["create","update"],"description":"The action type of the schedule.\n"}},"components/schemas/UpsertCreateCommitmentScheduleInput":{"id":"components/schemas/UpsertCreateCommitmentScheduleInput","kind":"json-schema","title":"UpsertCreateCommitmentScheduleInput","data":{"description":"Create a new schedule.","type":"object","required":["action"],"allOf":[{"$ref":"#/components/schemas/CommitmentScheduleAttributesUpdate"},{"properties":{"action":{"$ref":"#/components/schemas/ActionTypeSchedule"}}}]}},"components/schemas/UpsertUpdateCommitmentScheduleInput":{"id":"components/schemas/UpsertUpdateCommitmentScheduleInput","kind":"json-schema","title":"UpsertUpdateCommitmentScheduleInput","data":{"description":"Update an existing commitment schedule.","required":["action","id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the schedule."},"action":{"$ref":"#/components/schemas/ActionTypeSchedule"},"amount":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of each period in the schedule."},"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":"Notes:"},"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 none of the periods in a schedule have drawdown, you can update the amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any period in a schedule has drawdown (but none are evaluated), you can update the amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any period in a schedule has been evaluated, you cannot update the amount."},"children":[]}]}]}]}]},"endDate":{"type":"string","format":"date","description":"The end date of the schedule. The schedule end date is exclusive in the schedule, same as the commitment end date."},"periodType":{"$ref":"#/components/schemas/PeriodTypeEnum"},"specificPeriodLength":{"type":"integer","description":"The specific period length of each period in the schedule."},"startDate":{"type":"string","format":"date","description":"The start date of the schedule."}}}},"components/schemas/UpsertCommitmentScheduleInput":{"id":"components/schemas/UpsertCommitmentScheduleInput","kind":"json-schema","title":"UpsertCommitmentSheduleInput","data":{"title":"UpsertCommitmentSheduleInput","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert an schedule, when the action is create, create a new schedule, when the action is update, update the schedule."},"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":"Notes:"},"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 none of the periods in a schedule has drawdown, you can not only update the schedule amount, but also delete the schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any period in a schedule has drawdown, you can update the schedule amount, but you cannot delete the schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any period in a schedule has been evaluated, you cannot update the schedule amount. Also, you cannot delete the schedule."},"children":[]}]}]}]}],"type":"object","discriminator":{"propertyName":"action","mapping":{"create":"#/components/schemas/UpsertCreateCommitmentScheduleInput","update":"#/components/schemas/UpsertUpdateCommitmentScheduleInput"}},"oneOf":[{"$ref":"#/components/schemas/UpsertCreateCommitmentScheduleInput"},{"$ref":"#/components/schemas/UpsertUpdateCommitmentScheduleInput"}]}},"components/schemas/UpsertUpdateCommitmentInput":{"id":"components/schemas/UpsertUpdateCommitmentInput","kind":"json-schema","title":"UpsertUpdateCommitmentInput","data":{"type":"object","description":"Update the existing commitment by the commitment number.","required":["action","commitmentNumber"],"properties":{"action":{"$ref":"#/components/schemas/ActionType"},"childCommitments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of child commitment relationships to declare on this commitment. Each entry specifies an action (ADD or REMOVE) and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifying the child. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitmentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitment number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commitment ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[N].id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reference a commitment created earlier in the same order request."},"children":[]}]}]}],"type":"array","items":{"type":"object","properties":{"commitmentKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the child commitment. Accepts a commitment number, commitment ID, or [N].id index reference for same-order creation."},"children":[]}]}]}]},"action":{"type":"string","enum":["ADD","REMOVE"],"description":"Whether to attach or detach the child commitment."}}}},"commitmentNumber":{"type":"string","description":"The number of the Commitment."},"name":{"description":"The value to update. Set to null to clear the existing value.","type":"string"},"description":{"description":"The value to update. Set to null to clear the existing value.","type":"string"},"customFields":{"type":"object","additionalProperties":true,"description":"Container for custom fields of an commitment object.","title":"CommitmentSegmentCustomFields"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the commitment."},"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":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When the status of the commitment is updated as canceled, a commitment or schedule can be canceled only if none of its periods have been drawdowned."},"children":[]}]}]}],"enum":["Canceled"]},"schedules":{"$ref":"#/components/schemas/UpsertCommitmentScheduleInput"}}}},"components/schemas/UpsertCancelCommitmentInput":{"id":"components/schemas/UpsertCancelCommitmentInput","kind":"json-schema","title":"UpsertCancelCommitmentInput","data":{"title":"UpsertCancelCommitmentInput","description":"Cancel an existing commitment by the commitment number.","type":"object","required":["action","commitmentNumber"],"properties":{"action":{"$ref":"#/components/schemas/ActionType"},"commitmentNumber":{"type":"string","description":"The number of the Commitment to cancel.","maxLength":100},"cancellationEffectiveDate":{"type":"string","format":"date","description":"The date when the cancellation takes effect."},"cancellationPolicyOverride":{"$ref":"#/components/schemas/CommitmentCancellationPolicy"}}}},"components/schemas/UpsertCommitmentInput":{"id":"components/schemas/UpsertCommitmentInput","kind":"json-schema","title":"UpsertCommitmentInput","data":{"title":"UpsertCommitmentInput","description":"Using the action to indicate whether to create or update the commitment.","type":"object","required":["action"],"properties":{"action":{"$ref":"#/components/schemas/ActionType"}},"oneOf":[{"$ref":"#/components/schemas/UpsertCreateCommitmentInput"},{"$ref":"#/components/schemas/UpsertUpdateCommitmentInput"},{"$ref":"#/components/schemas/UpsertCancelCommitmentInput"}],"discriminator":{"propertyName":"action","mapping":{"create":"#/components/schemas/UpsertCreateCommitmentInput","update":"#/components/schemas/UpsertUpdateCommitmentInput","cancel":"#/components/schemas/UpsertCancelCommitmentInput"}}}},"components/schemas/ShipToContactPostOrder":{"id":"components/schemas/ShipToContactPostOrder","kind":"json-schema","title":"ShipToContactPostOrder","data":{"allOf":[{"description":"Contact details associated with an account.\n","properties":{"address1":{"description":"First line of the contact's address. This is often a street address or a business name.\n","maxLength":255,"type":"string"},"address2":{"description":"Second line of the contact's address.\n","maxLength":255,"type":"string"},"city":{"description":"City of the contact's address.\n","maxLength":100,"type":"string"},"contactDescription":{"description":"A description for the contact.          \n","maxLength":100,"type":"string"},"country":{"description":"Country; must be a valid country name or abbreviation.\n","maxLength":64,"type":"string"},"county":{"description":"County of the contact's address.\n","maxLength":100,"type":"string"},"fax":{"description":"Fax number of the contact.\n","maxLength":40,"type":"string"},"firstName":{"description":"First name of the contact.\n","maxLength":100,"type":"string"},"homePhone":{"description":"Home phone number of the contact.\n","maxLength":40,"type":"string"},"lastName":{"description":"Last name of the contact.\n","maxLength":100,"type":"string"},"mobilePhone":{"description":"Mobile phone number of the contact.\n","maxLength":40,"type":"string"},"nickname":{"description":"Nickname of the contact.\n","maxLength":100,"type":"string"},"otherPhone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional phone number of the contact. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhoneType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the type of phone number."},"children":[]}]}]}],"maxLength":40,"type":"string"},"otherPhoneType":{"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 phone number in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherPhone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"Personal email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"postalCode":{"description":"ZIP code or other postal code of the contact's address.\n","maxLength":20,"type":"string"},"state":{"description":"State or province of the contact's address.\n","maxLength":100,"type":"string"},"taxRegion":{"description":"Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n","maxLength":100,"type":"string","nullable":true},"workEmail":{"description":"Business email address of the contact.\n","format":"email","maxLength":80,"type":"string"},"workPhone":{"description":"Business phone number of the contact.\n","maxLength":40,"type":"string"}},"required":["firstName","lastName"],"type":"object"},{"$ref":"#/components/schemas/ContactObjectCustomFields"}]}},"components/schemas/DataAccessControlField":{"id":"components/schemas/DataAccessControlField","kind":"json-schema","title":"dataAccessControlField","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field for data access control. The name of the data access control field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__h"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The data access control field is case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-access-control"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Access Control"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"description":"Container for the data access control field.\n","title":"dataAccessControlField","type":"object"}},"components/schemas/CreateOrderNewAccount":{"id":"components/schemas/CreateOrderNewAccount","kind":"json-schema","title":"CreateOrderNewAccount","data":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The information of the new account to be created with the order. To create the new account, either a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditCard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" structure or the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hpmCreditCardPaymentMethodId"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field (but not both) should be provided. The one provided becomes the default payment method for this account. If the credit card information is declined or can't be verified, then the account is not created."},"children":[]}]}]}],"properties":{"accountNumber":{"maxLength":70,"type":"string"},"additionalEmailAddresses":{"description":"List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.\n","maxLength":1200,"type":"string"},"allowInvoiceEdit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if associated invoices can be edited."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]}]}],"type":"boolean"},"associateCommitmentNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of an existing commitment to re-associate with this new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account. Only applies when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processingOptions.reAssociation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":[]}]}]}],"maxLength":255,"type":"string"},"autoPay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether future payments are to be automatically billed when they are due. Possible values are "},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"batch":{"description":[{"$$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":": By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=performance-booster-elite","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance Booster Elite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" package."},"children":[]}]}]}],"type":"string"},"billCycleDay":{"description":"Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".","maximum":31,"minimum":0,"type":"integer"},"billToContact":{"$ref":"#/components/schemas/BillToContactPostOrder"},"communicationProfileId":{"type":"string"},"creditCard":{"$ref":"#/components/schemas/creditCard"},"creditMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the credit memo template, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b."},"children":[]}]}]}],"type":"string"},"crmId":{"maxLength":100,"type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 uppercase character currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For payment method authorization, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used. Otherwise, this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/AccountObjectCustomFields"},"customerServiceRepName":{"description":"Name of the account's customer service representative, if applicable.\n","maxLength":50,"type":"string"},"debitMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the debit memo template, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2."},"children":[]}]}]}],"type":"string"},"hpmCreditCardPaymentMethodId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"autoPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must provide the credit card payment method ID for either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a CC Reference Transaction payment method for an account."},"children":[]}]}]}],"type":"string"},"invoiceDeliveryPrefsEmail":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to turn on the invoice delivery method 'Email' for the new account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Turn on the invoice delivery method 'Email' for the new account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Turn off the invoice delivery method 'Email' for the new account."},"children":[]}]}]}]}],"type":"boolean"},"invoiceDeliveryPrefsPrint":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to turn on the invoice delivery method 'Print' for the new account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Turn on the invoice delivery method 'Print' for the new account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Turn off the invoice delivery method 'Print' for the new account."},"children":[]}]}]}]}],"type":"boolean"},"invoiceTemplateId":{"type":"string"},"name":{"maxLength":255,"type":"string"},"notes":{"maxLength":65535,"type":"string"},"organizationLabel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the organization to which the account belongs."},"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 available only when you have enabled the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}],"type":"string"},"parentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the parent customer account for this Account object. Use this field if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}],"type":"string"},"partnerAccount":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer account is a partner, distributor, or reseller."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"paymentGateway":{"maxLength":40,"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/POSTPaymentMethodRequest"},"paymentTerm":{"description":[{"$$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":": If you want to specify a payment term when creating a new account, you must set a value in this field. If you do not set a value in this field, Zuora will use the default value set in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Terms"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from Zuora UI."},"children":[]}]}]}],"type":"string"},"purchaseOrderNumber":{"description":"The number of the purchase order associated with this account. Purchase order information generally comes from customers.\n","maxLength":100,"type":"string"},"salesRep":{"description":"The name of the sales representative associated with this account, if applicable.\n","maxLength":50,"type":"string"},"sequenceSetId":{"description":"The ID of the sequence set to assign to the customer account. \n\nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\n","type":"string","nullable":true},"shipToContact":{"$ref":"#/components/schemas/ShipToContactPostOrder"},"shipToSameAsBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the ship-to contact and bill-to contact are the same entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The created account has the same bill-to contact and ship-to contact entity only when all the following conditions are met in the request body:"},"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":"This field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"A bill-to contact is specified."},"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":"No ship-to contact is specified."},"children":[]}]}]}]}]}],"type":"boolean"},"soldToContact":{"$ref":"#/components/schemas/SoldToContactPostOrder"},"soldToSameAsBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the sold-to contact and bill-to contact are the same entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The created account has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:"},"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":"This field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"A bill-to contact is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No sold-to contact is specified."},"children":[]}]}]}]}],"type":"boolean"},"taxInfo":{"$ref":"#/components/schemas/TaxInfo"}},"required":["name","currency","billCycleDay","billToContact"],"type":"object"},{"$ref":"#/components/schemas/DataAccessControlField"}]}},"components/schemas/processingOptionsOrdersWithDelayedCapturePayment":{"id":"components/schemas/processingOptionsOrdersWithDelayedCapturePayment","kind":"json-schema","title":"processingOptionsOrdersWithDelayedCapturePayment","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for billing processing options and payment processing options."},"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":"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":"This field is not supported in draft orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you use the \"Create an order\" operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. In this case, neither the invoice will be generated, nor the subscription nor the account will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you use the \"Create an order\" operation to cancel a subscription with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"writeOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"writeOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fails, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" still can succeed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you use the \"Create an order\" operation, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields cannot be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" simultaneously.  Otherwise, the order will not be proceeded."},"children":[]}]}]}]}],"properties":{"allowPaymentFailure":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to create the order even if payment collection fails. If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectPayment"},"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":", Zuora creates the order if order validation, persistence, activation, and invoice generation succeed."},"children":[]}]}]}],"type":"boolean","default":false},"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply to invoices."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply credit memos or unapplied payments, or both to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"applyCreditBalance":{"description":"Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.\n","type":"boolean"},"billingOptions":{"properties":{"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"documentDate":{"description":"The invoice date displayed on the invoice.\n","format":"date","type":"string"},"generateDraftInvoice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the current request needs to generate a draft invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice is generated. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-bill-runs-creation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is a Target Date?"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you do not specify this field, today's date is used by default."},"children":[]}]}]}],"format":"date","type":"string"},"chargeTypeToExclude":{"description":"The types of the charges to be excluded from the generation of billing documents.\n","items":{"type":"string","enum":["OneTime","Recurring","Usage"]},"type":"array"}},"type":"object"},"collectPayment":{"description":"Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.\n","type":"boolean"},"electronicPaymentOptions":{"description":"Container for the electronic payment options.\n","properties":{"authTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authorization transaction ID from the payment gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you create a payment to capture the funds that have been authorized through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateAuthorization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. It is highly recommended to also pass in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewayOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that you used when authorizing the funds. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewayOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional."},"children":[]}]}]}],"maxLength":50,"type":"string"},"gatewayOrderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateways check duplicates on the gateway order ID to ensure that the same transaction is not entered twice accidentally."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you create a payment to capture the funds that have been authorized through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreateAuthorization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. It is highly recommended to also pass in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewayOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that you used when authorizing the funds. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewayOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional."},"children":[]}]}]}],"maxLength":50,"type":"string"},"paymentGatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the ID of a payment gateway to override the default gateway."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-gateway-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Gateway Routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled:"},"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 field is not specified, gateway routing rules will be invoked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Payment Gateway Routing is disabled:"},"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 field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"children":[]}]}]}]}],"type":"string"},"paymentMethodId":{"description":"Specifies an electronic payment method. It can be one that has already been associated with an invoice owner, or an orphan payment method, which is not associated with any invoice owner. For an orphan payment method, this operation will then associate it with the account that this order will be created under.\n","type":"string"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields supported by gateways vary. For more information, see the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify any unsupported gateway option parameters, they will be ignored"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without error prompts."},"children":[]}]}]}],"type":"object","title":"gatewayOptions","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gateway options specification consists of key-value pairs:"},"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":"Field name: The name of a gateway-specific parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: The value of the gateway-specific parameter."},"children":[]}]}]}]}]}},"mitTransactionSource":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment transaction source used by the Chase payment gateway to differentiate the transaction source in Stored Credential Transaction framework."},"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":"C_Unscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchant-initiated transaction (MIT) that occurs at regular intervals."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_Unscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates."},"children":[]}]}]}]}],"enum":["C_Unscheduled","M_Recurring","M_Unscheduled"],"type":"string"}},"type":"object"},"reAssociation":{"description":"Indicates whether to re-associate an existing commitment with the new account\ncreated in this order.","type":"boolean"},"refund":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to refund after subscription cancelation. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": When refunding a subscription that is not invoiced separately, if you do not enable the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”"},"children":[]}]}]}],"type":"boolean"},"refundAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the amount to be refunded. Required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"refundReasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the reason for the refund transaction. The value must be an existing payment refund reason code listed in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you do not specify the field or leave the field with an empty value, Zuora uses the default payment refund reason code."},"children":[]}]}]}],"type":"string"},"runBilling":{"description":"Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order. \n","type":"boolean"},"writeOff":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to write off the outstanding balance on the invoice after refund. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"When refunding a subscription that is not invoiced separately, if you do not enable the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must have been enabled for write-off."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the generated credit memos have a reason code of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Write-off"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and it cannot be overridden."},"children":[]}]}]}]}],"type":"boolean"},"writeOffBehavior":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The financial information of the credit memo items generated to write off the invoice balance."},"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":"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":"All the credit memo items that are used to write off the invoice will be applied with the same financial information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit memo items generated from the unconsumed services of the canceled subscription will not be applied with the finance information specified here."},"children":[]}]}]}]}],"properties":{"financeInformation":{"description":"Container for the finance information related to the credit memo items that are created for invoice write-off.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","maxLength":100,"minLength":0,"type":"string"},"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","maxLength":100,"minLength":0,"type":"string"},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"components/schemas/CreateOrderChargeOverride":{"id":"components/schemas/CreateOrderChargeOverride","kind":"json-schema","title":"charge","data":{"description":"Charge associated with a rate plan.\n","properties":{"accountReceivableAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accountReceivableAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"billing":{"description":"Billing information about the charge.\n","properties":{"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the month that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maximum":31,"minimum":0,"type":"integer"},"billCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines the day that each billing period begins on."},"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":"DefaultFromCustomer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the bill cycle day of the account that owns the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the month that each billing period begins on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionStartDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeTriggerDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeklyBillCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the week that each billing period begins on."},"children":[]}]}]}]}],"enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek"],"type":"string"},"billingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing frequency of the charge. The value of this field controls the duration of each billing period."},"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":"Specific_Days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the duration of each billing period."},"children":[]}]}]}],"enum":["Month","Quarter","Semi_Annual","Annual","Eighteen_Months","Two_Years","Three_Years","Five_Years","Specific_Months","Subscription_Term","Week","Specific_Weeks","Specific_Days"],"type":"string"},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges."},"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":"AlignToCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for information about how Zuora determines the billing day."},"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 not supported in one time charges."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart"],"type":"string"},"billingTiming":{"description":"Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of each billing period in months or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"weeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the week that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"type":"object"},"chargeFunction":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["CommitmentTrueUp","CreditCommitment"],"type":"string"},"creditOption":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"chargeModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeModel of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported charge models:"},"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":"code","inline":true,"attributes":{"content":"FlatFee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerUnit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountFixedAmount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge number of the charge. For example, C-00000307."},"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 you do not set this field, Zuora will generate a charge number starting with a default prefix, for example, C-. This default prefix is predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"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 you want to use a custom charge number, do not use the default prefix predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use your own prefix, for example, SC-."},"children":[]}]}]}]}],"maxLength":50,"type":"string"},"chargeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeType of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported charge types:"},"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":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractAssetAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractRecognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deferredRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"description":{"description":"Description of the charge.\n","maxLength":500,"type":"string"},"drawdownPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown priority for consumption ordering. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"drawdownScope":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prepayment"},"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":"code","inline":true,"attributes":{"content":"SUBSCRIPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges of the same subscription can be drawn down."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges in the same account (subscription owner) can be drawn down."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["SUBSCRIPTION","ACCOUNT"]},"endDate":{"$ref":"#/components/schemas/EndConditions"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and want to create a completed order and an active subscription, you must specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field:"},"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":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in pending status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in active status."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both the following features are enabled in your tenant, you must ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in a Create Subscription or Add Product order action is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this order action to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Prepaid with Drawdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both the following features are enabled in your tenant, you must ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set consistently for a prepayment charge and the corresponding drawdown charge."},"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":"Prepaid with Drawdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"fundSupportAccountHierarchy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to enable sub-account's usage to drawdown from the parent's funds."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isRollover":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"True\" or \"False\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"negotiatedPriceTable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of negotiated price table information. The rate card entries provided in the array will override the existing rate card entries in the standard price table to form a negotiated price table that will be used during pricing evaluation."},"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":" To enable the Negotiated Price Table feature, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/NegotiatedItems"},"type":"array"},"pobPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pobPolicy of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"prepaymentUnitType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit type of the prepayment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["UNIT"]},"pricing":{"description":"Pricing information about the charge.\n","properties":{"chargeModelData":{"$ref":"#/components/schemas/ChargeModelDataOverride"},"discount":{"$ref":"#/components/schemas/DiscountPricingOverride"},"oneTimeFlatFee":{"$ref":"#/components/schemas/OneTimeFlatFeePricingOverride"},"oneTimePerUnit":{"$ref":"#/components/schemas/OneTimePerUnitPricingOverride"},"oneTimeTiered":{"$ref":"#/components/schemas/OneTimeTieredPricingOverride"},"oneTimeVolume":{"$ref":"#/components/schemas/OneTimeVolumePricingOverride"},"recurringCalculated":{"$ref":"#/components/schemas/RecurringCalculatedPricingOverride"},"recurringDeliveryBased":{"$ref":"#/components/schemas/RecurringDeliveryPricingOverride"},"recurringFlatFee":{"$ref":"#/components/schemas/RecurringFlatFeePricingOverride"},"recurringPerUnit":{"$ref":"#/components/schemas/RecurringPerUnitPricingOverride"},"recurringTiered":{"$ref":"#/components/schemas/RecurringTieredPricingOverride"},"recurringVolume":{"$ref":"#/components/schemas/RecurringVolumePricingOverride"},"usageFlatFee":{"$ref":"#/components/schemas/UsageFlatFeePricingOverride"},"usageOverage":{"$ref":"#/components/schemas/UsageOveragePricingOverride"},"usagePerUnit":{"$ref":"#/components/schemas/UsagePerUnitPricingOverride"},"usageTiered":{"$ref":"#/components/schemas/UsageTieredPricingOverride"},"usageTieredWithOverage":{"$ref":"#/components/schemas/UsageTieredWithOveragePricingOverride"},"usageVolume":{"$ref":"#/components/schemas/UsageVolumePricingOverride"}},"type":"object"},"pricingAttributes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values are used to get the charge’s list price from the product catalog. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically."},"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":" To enable Dynamic Pricing, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","additionalProperties":true},"productCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productCategory of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productClass of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productFamily":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productFamily of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productLine":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productLine of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal identifier of the product rate plan charge that the charge is based on. You can specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When subscribing to a hard bundle, include the optional component charge’s ID explicitly in order to add it to the subscription."},"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":"isAddingSubsetCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true, the product rate charge specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is added to the existing rate plan specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of a product rate-plan charge for this subscription. You can specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"prorationOption":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge Level Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-usage-charge-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage charge proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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":"You can use this field to specify the charge-level proration option for a usage charge or recurring charge when you create or add a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"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":"NoProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeBasedProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeFullPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"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":"When the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, the possible options 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":"text","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides."},"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":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the customization rules using these options in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod","CustomizeProrationOptionOverrides"],"type":"string"},"ratingPropertiesOverride":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field is used only when the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prorationOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"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 field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"object","properties":{"isProratePartialMonth":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify whether to prorate the recurring charge for a partial month. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"boolean"},"prepaymentChargeProrationRule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define whether to prorate the charge amount or not. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProrateAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the proration rules via the options under this section."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["ProrateAmount","ChargeFullAmount"]},"prorationUnit":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the unit of proration for a recurring charge. The tenant-level proration option will be overridden."},"children":[]}]}]}],"enum":["ProrateByDay","ProrateByMonthFirst"],"type":"string"},"daysInMonth":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the number of days counted for a month when prorating a recurring charge. The tenant-level proration option will be overridden. See more details for each of the following enum values in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["UseActualDays","Assume30Days","Assume30DaysStrict"],"type":"string"}}},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"Revenue Recognition Code\n","maxLength":70,"type":"string"},"revRecTriggerCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition trigger condition."},"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":"Contract Effective Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Service Activation Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Customer Acceptance Date"},"children":[]}]}]}]}],"enum":["Contract Effective Date","Service Activation Date","Customer Acceptance Date"],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition rule, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize upon invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize daily over time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have both the Order to Revenue feature and the Standalone Orders feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have both the Order to Revenue feature and the Standalone Orders feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"rolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicit cutoff date when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverEndDateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"rolloverEndDateType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover cutoff strategy determining when the rollover eligibility will end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"ChargeEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the subscription term end."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at an explicit date specified in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RolloverEndDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeEndDate","SubscriptionTerm","SpecificDate"]},"rolloverFundPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for rolled-over funds. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"rolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year. When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can customize a single rollover period length together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"rolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"rolloverPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit for rollover period length."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"Day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Day-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Month-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quarter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Quarter-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Annual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Annual rollover periods."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["Day","Month","Quarter","Annual"]},"specificValidityPeriodLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of days, weeks, or months for the validity period when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidityPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"startDate":{"$ref":"#/components/schemas/CreateOrderTriggerParams"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code of a charge. This field is available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode of a charge.  This field is available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive"],"type":"string"},"taxable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag indicates whether the charge is taxable. If this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}]},"unBilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unBilledReceivablesAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"uniqueToken":{"description":"Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n","maxLength":50,"type":"string"},"upsellOriginChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the original upselling charge associated with the current charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a termed subscription, you can now use the \"Create an order\" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:"},"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":"Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell."},"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":"In the preceding charge to add, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upsellOriginChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the existing rate plan charge for which you want to make the quantity upsell."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription."},"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 Quantity Upsell feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"validityPeriodType":{"description":[{"$$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 only available if you have enabled either 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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field in the following scenarios:"},"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":"When you create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use this field to define the period in which the prepayment units are valid to use."},"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":"When you override the setting of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commitment true-up charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the product catalog, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When you use a standalone order to create a commitment true-up charge, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can also choose from the following options: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Specify the actual number in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificValidityPeriodLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"type":"string"},"validityPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the anchor date for validity period (VP) boundaries. The anchor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date defines the recurring grid — VP boundaries fall at every VP-length step"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the anchor. The charge's start and end dates then determine which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"portion of this grid is covered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ChargeStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - Anchor date is the charge start date. Simplest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"option with no partial first VP."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is the subscription term start date. Aligns all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges on the same subscription to a common grid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is derived by walking backward from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription term end date. Last VP always ends cleanly at term end;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partial VP (if any) is at the start."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAnchorDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom alignment for special billing arrangements."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeStart","TermStart","TermEnd","SpecificDate"]},"validityPeriodAnchorDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The anchor date for validity period alignment. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAlignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"validityPeriodProrationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls what happens to units when a validity period (VP) is partial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ProrateUnits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant partial units, the number is prorated based on the overlap ratio."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NoProrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant full units."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ProrateUnits","NoProrate"]}},"required":["productRatePlanChargeId"],"title":"charge","type":"object"}},"components/schemas/CreateOrderRatePlanOverride":{"id":"components/schemas/CreateOrderRatePlanOverride","kind":"json-schema","title":"ratePlan","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddProduct"},"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 you want to create a pending order through the \"Add product\" order action, and if the charge's trigger condition is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must set a charge number in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for the \"Add product\" order action. In this case, if you do not set it, Zuora will not generate the charge number for you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See more information about pending orders in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-pending-orders-and-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending orders and subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"chargeOverrides":{"description":"List of charges associated with the rate plan.\n","items":{"$ref":"#/components/schemas/CreateOrderChargeOverride"},"type":"array"},"clearingExistingFeatures":{"description":"Specifies whether all features in the rate plan will be cleared.\n","type":"boolean"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"externallyManagedPlanId":{"description":"Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"isAddingSubsetCharges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to add a subset of charges to the subscription."},"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":" To access this field for adding a subset of charges, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isFromExternalCatalog":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"boolean"},"productRatePlanId":{"description":"Internal identifier of the product rate plan that the rate plan is based on.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the standalone rate plan."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"subscriptionProductFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of features associated with the rate plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system compares the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the request with the counterpart fields in a rate plan. The comparison results are 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":"If there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the field is empty, features in the rate plan remain unchanged. But if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingExistingFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is additionally set to true, all features in the rate plan are cleared."},"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":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, as well as the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderRatePlanFeatureOverride"},"type":"array"},"subscriptionRatePlanNumber":{"description":"Number of a subscription rate plan for this subscription.\n","maxLength":50,"type":"string"},"uniqueToken":{"description":"Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n","maxLength":50,"type":"string"}},"title":"ratePlan","type":"object"}},"components/schemas/ChangePlanChargeOverride":{"id":"components/schemas/ChangePlanChargeOverride","kind":"json-schema","title":"charge","data":{"description":"Charge associated with a rate plan.\n","properties":{"accountReceivableAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accountReceivableAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjustmentRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"billing":{"description":"Billing information about the charge.\n","properties":{"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the month that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maximum":31,"minimum":0,"type":"integer"},"billCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines the day that each billing period begins on."},"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":"DefaultFromCustomer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the bill cycle day of the account that owns the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the month that each billing period begins on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionStartDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeTriggerDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeklyBillCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the week that each billing period begins on."},"children":[]}]}]}]}],"enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek"],"type":"string"},"billingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing frequency of the charge. The value of this field controls the duration of each billing period."},"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":"Specific_Days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the duration of each billing period."},"children":[]}]}]}],"enum":["Month","Quarter","Semi_Annual","Annual","Eighteen_Months","Two_Years","Three_Years","Five_Years","Specific_Months","Subscription_Term","Week","Specific_Weeks","Specific_Days"],"type":"string"},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges."},"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":"AlignToCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for information about how Zuora determines the billing day."},"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 not supported in one time charges."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart"],"type":"string"},"billingTiming":{"description":"Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of each billing period in months or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"weeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the week that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"type":"object"},"chargeFunction":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["CommitmentTrueUp","CreditCommitment"],"type":"string"},"creditOption":{"description":[{"$$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 only available if you have both the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this field, you can use a standalone order to subscribe to a minimum commitment subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"chargeModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeModel of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported charge models:"},"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":"code","inline":true,"attributes":{"content":"FlatFee"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerUnit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountFixedAmount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge number of the charge. For example, C-00000307."},"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 you do not set this field, Zuora will generate a charge number starting with a default prefix, for example, C-. This default prefix is predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"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 you want to use a custom charge number, do not use the default prefix predefined in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define Default Subscription and Order Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use your own prefix, for example, SC-."},"children":[]}]}]}]}],"maxLength":50,"type":"string"},"chargeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chargeType of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported charge types:"},"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":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractAssetAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractLiabilityAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contractRecognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deferredRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"description":{"description":"Description of the charge.\n","maxLength":500,"type":"string"},"drawdownPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown priority for consumption ordering. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"drawdownRate":{"description":[{"$$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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced unit-based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"number"},"drawdownScope":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prepayment"},"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":"code","inline":true,"attributes":{"content":"SUBSCRIPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges of the same subscription can be drawn down."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges in the same account (subscription owner) can be drawn down."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["SUBSCRIPTION","ACCOUNT"]},"endDate":{"$ref":"#/components/schemas/EndConditions"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and want to create a completed order and an active subscription, you must specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field:"},"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":"code","inline":true,"attributes":{"content":"estimatedStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in pending status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The charge will be in active status."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending Subscription Processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is turned on."},"children":[]}]}]}]},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"fundSupportAccountHierarchy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to enable sub-account's usage to drawdown from the parent's funds."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isRollover":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"True\" or \"False\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"negotiatedPriceTable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of negotiated price table information. The rate card entries provided in the array will override the existing rate card entries in the standard price table to form a negotiated price table that will be"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used during pricing evaluation."},"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":" To enable the Negotiated Price Table feature, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/NegotiatedItems"},"type":"array","additionalProperties":true},"pobPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pobPolicy of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"prepaymentUnitType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit type of the prepayment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["UNIT"]},"pricing":{"description":"Pricing information about the charge.\n","properties":{"chargeModelData":{"$ref":"#/components/schemas/ChargeModelDataOverride"},"discount":{"$ref":"#/components/schemas/DiscountPricingOverride"},"oneTimeFlatFee":{"$ref":"#/components/schemas/OneTimeFlatFeePricingOverride"},"oneTimePerUnit":{"$ref":"#/components/schemas/OneTimePerUnitPricingOverride"},"oneTimeTiered":{"$ref":"#/components/schemas/OneTimeTieredPricingOverride"},"oneTimeVolume":{"$ref":"#/components/schemas/OneTimeVolumePricingOverride"},"recurringCalculated":{"$ref":"#/components/schemas/RecurringCalculatedPricingOverride"},"recurringDeliveryBased":{"$ref":"#/components/schemas/RecurringDeliveryPricingOverride"},"recurringFlatFee":{"$ref":"#/components/schemas/RecurringFlatFeePricingOverride"},"recurringPerUnit":{"$ref":"#/components/schemas/RecurringPerUnitPricingOverride"},"recurringTiered":{"$ref":"#/components/schemas/RecurringTieredPricingOverride"},"recurringVolume":{"$ref":"#/components/schemas/RecurringVolumePricingOverride"},"usageFlatFee":{"$ref":"#/components/schemas/UsageFlatFeePricingOverride"},"usageOverage":{"$ref":"#/components/schemas/UsageOveragePricingOverride"},"usagePerUnit":{"$ref":"#/components/schemas/UsagePerUnitPricingOverride"},"usageTiered":{"$ref":"#/components/schemas/UsageTieredPricingOverride"},"usageTieredWithOverage":{"$ref":"#/components/schemas/UsageTieredWithOveragePricingOverride"},"usageVolume":{"$ref":"#/components/schemas/UsageVolumePricingOverride"}},"type":"object"},"pricingAttributes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values are used to get the charge’s list price from the product catalog. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically."},"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":" To enable Dynamic Pricing, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","additionalProperties":true},"productCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productCategory of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productClass of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productFamily":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productFamily of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productLine":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The productLine of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal identifier of the product rate plan charge that the charge is based on. You can specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When subscribing to a hard bundle, include the optional component charge’s ID explicitly in order to add it to the subscription."},"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":"isAddingSubsetCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true, the product rate charge specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is added to the existing rate plan specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of a product rate-plan charge for this subscription. You can specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"prorationOption":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge Level Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-usage-charge-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage charge proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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":"You can use this field to specify the charge-level proration option for a usage charge or recurring charge when you create or add a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"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":"NoProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeBasedProration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeFullPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"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":"When the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, the possible options 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":"text","inline":true,"attributes":{"content":"DefaultFromTenantSetting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides."},"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":"CustomizeProrationOptionOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the customization rules using these options in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratingPropertiesOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod","CustomizeProrationOptionOverrides"],"type":"string"},"ratingPropertiesOverride":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field is used only when the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prorationOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomizeProrationOptionOverrides"},"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 field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"object","properties":{"isProratePartialMonth":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify whether to prorate the recurring charge for a partial month. The tenant-level proration option will be overridden."},"children":[]}]}]}],"type":"boolean"},"prepaymentChargeProrationRule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define whether to prorate the charge amount or not. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProrateAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, define the proration rules via the options under this section."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["ProrateAmount","ChargeFullAmount"]},"prorationUnit":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the unit of proration for a recurring charge. The tenant-level proration option will be overridden."},"children":[]}]}]}],"enum":["ProrateByDay","ProrateByMonthFirst"],"type":"string"},"daysInMonth":{"description":[{"$$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 only available if you have the Charge Level Proration feature enabled. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge level proration option for a recurring charge"},"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 field to specify the number of days counted for a month when prorating a recurring charge. The tenant-level proration option will be overridden. See more details for each of the following enum values in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-proration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["UseActualDays","Assume30Days","Assume30DaysStrict"],"type":"string"}}},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"Revenue Recognition Code\n","maxLength":70,"type":"string"},"revRecTriggerCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition trigger condition."},"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":"Contract Effective Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Service Activation Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Customer Acceptance Date"},"children":[]}]}]}]}],"enum":["Contract Effective Date","Service Activation Date","Customer Acceptance Date"],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition rule, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize upon invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize daily over time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have both the Order to Revenue feature and the Standalone Orders feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have both the Order to Revenue feature and the Standalone Orders feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"rolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicit cutoff date when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverEndDateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PPDD Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"rolloverEndDateType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover cutoff strategy determining when the rollover eligibility will end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"ChargeEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the subscription term end."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at an explicit date specified in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RolloverEndDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeEndDate","SubscriptionTerm","SpecificDate"]},"rolloverFundPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority override for rolled-over funds. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PPDD Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"rolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year. When the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can customize a single rollover period length together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"rolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"rolloverPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit for rollover period length."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"Day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Day-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Month-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quarter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Quarter-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Annual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Annual rollover periods."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["Day","Month","Quarter","Annual"]},"specificValidityPeriodLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of days, weeks, or months for the validity period when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidityPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"startDate":{"$ref":"#/components/schemas/CreateOrderTriggerParams"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The taxCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The taxMode of a standalone charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"TaxExclusive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxInclusive"},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"unBilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unBilledReceivablesAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature and the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}],"type":"string"},"uniqueToken":{"description":"Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n","maxLength":50,"type":"string"},"upsellOriginChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the original upselling charge associated with the current charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a termed subscription, you can now use the \"Create an order\" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:"},"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":"Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell."},"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":"In the preceding charge to add, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upsellOriginChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the existing rate plan charge for which you want to make the quantity upsell."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription."},"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 Quantity Upsell feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"validityPeriodType":{"description":[{"$$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 only available if you have enabled either 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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum Commitment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field in the following scenarios:"},"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":"When you create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use this field to define the period in which the prepayment units are valid to use."},"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":"When you override the setting of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-minimum-commitment","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commitment true-up charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the product catalog, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When you use a standalone order to create a commitment true-up charge, set this field consistently with the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this charge."},"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":"When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can also choose from the following options: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Specify the actual number in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificValidityPeriodLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"type":"string"},"validityPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the anchor date for validity period (VP) boundaries. The anchor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date defines the recurring grid — VP boundaries fall at every VP-length step"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the anchor. The charge's start and end dates then determine which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"portion of this grid is covered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ChargeStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - Anchor date is the charge start date. Simplest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"option with no partial first VP."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is the subscription term start date. Aligns all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges on the same subscription to a common grid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is derived by walking backward from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription term end date. Last VP always ends cleanly at term end;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partial VP (if any) is at the start."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAnchorDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom alignment for special billing arrangements."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeStart","TermStart","TermEnd","SpecificDate"]},"validityPeriodAnchorDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The anchor date for validity period alignment. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAlignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PPDD Proration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"validityPeriodProrationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls what happens to units when a validity period (VP) is partial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ProrateUnits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant partial units, the number is prorated based on the overlap ratio."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NoProrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant full units."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ProrateUnits","NoProrate"]}},"required":["productRatePlanChargeId"],"title":"charge","type":"object"}},"components/schemas/CreateOrderChangePlanRatePlanOverride":{"id":"components/schemas/CreateOrderChangePlanRatePlanOverride","kind":"json-schema","title":"ratePlan","data":{"description":"Information about the new product rate plan to add. \n","properties":{"chargeOverrides":{"description":"List of charges associated with the rate plan.\n","items":{"$ref":"#/components/schemas/ChangePlanChargeOverride"},"type":"array"},"clearingExistingFeatures":{"description":"Specifies whether all features in the rate plan will be cleared.\n","type":"boolean"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"externallyManagedPlanId":{"description":"Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"subscriptionRatePlanNumber":{"description":"Number of a subscription rate plan for this subscription.\n","maxLength":50,"type":"string"},"isFromExternalCatalog":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"boolean"},"productRatePlanId":{"description":"Internal identifier of the product rate plan that the rate plan is based on.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the standalone rate plan."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled."},"children":[]}]}]}],"type":"string"},"subscriptionProductFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of features associated with the rate plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system compares the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the request with the counterpart fields in a rate plan. The comparison results are 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":"If there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the field is empty, features in the rate plan remain unchanged. But if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingExistingFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is additionally set to true, all features in the rate plan are cleared."},"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":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, as well as the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderRatePlanFeatureOverride"},"type":"array"},"uniqueToken":{"description":"Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n","maxLength":50,"type":"string"}},"title":"ratePlan","type":"object"}},"components/schemas/CreateChangePlan":{"id":"components/schemas/CreateChangePlan","kind":"json-schema","title":"createChangePlan","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChangePlan"},"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 the change plan type of order action to replace the existing rate plans in a subscription with other rate plans."},"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 change plan type of order action is supported for the  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. However, it is currently not supported for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to create a pending order through the \"change plan\" order action, and if the charge's trigger condition is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must set a charge number in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for the \"change plan\" order action. In this case, if you do not set it, Zuora will not generate the charge number for you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See more information about pending orders in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-pending-orders-and-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending orders and subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"effectivePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectivePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field 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":"If the rate plan change (from old to new) is an upgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveImmediately"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the rate plan change (from old to new) is a downgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"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":"Notes"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you cannot set the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-trigger-dates-updation-for-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing trigger dates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the subscription as the system will automatically set the trigger dates to the end of billing period, and you cannot set the following billing trigger date settings to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Require Customer Acceptance of Orders?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Require Service Activation of Orders?"},"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":"When setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the contract effective date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerDates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field 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":"Set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a date for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]}]}]}]}]}],"enum":["EffectiveImmediately","EffectiveEndOfBillingPeriod","SpecificDate"],"type":"string"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan. However, if there are multiple rate plans with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value existing in the subscription, you must use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to remove the rate plan. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be used to distinguish multiple rate plans in this case."},"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":" Please provide only one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If more than 1 field is provided then the request would fail."},"children":[]}]}]}],"type":"string"},"newProductRatePlan":{"$ref":"#/components/schemas/CreateOrderChangePlanRatePlanOverride"},"productRatePlanId":{"description":"ID of the product rate plan that the removed rate plan is based on.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the rate plan to remove. This can be the latest version or any history version of ID. Note that the removal of a rate plan through the Change Plan order action supports the function of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-rate-plans-removal-from-subscriptions-before-future-dated-removals","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removal before future-dated removals"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as in a Remove Product order action."},"children":[]}]}]}],"type":"string"},"resetBcd":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD."},"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":": If the rate plan change is an upgrade (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Upgrade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), then the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveImmediately"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default. In this case, if you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resetBcd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the system sets this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while BCD is the effective date."},"children":[]}]}]}],"type":"boolean"},"subType":{"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 choose the sub type for your change plan order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, if you do not set this field, the field will be automatically generated by the system according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are within the same Grading catalog group:"},"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 grade of new plan is greater than that of the old plan, this is an \"Upgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan is less than that of the old plan, this is a \"Downgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan equals that of the old plan, this is a \"Crossgrade\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\"."},"children":[]}]}]}],"enum":["Upgrade","Downgrade","Crossgrade","PlanChanged"],"type":"string"},"subscriptionRatePlanNumber":{"description":"Number of a rate plan for this subscription.\n","type":"string"}},"required":["newProductRatePlan"],"title":"createChangePlan","type":"object"}},"components/schemas/CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount":{"id":"components/schemas/CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount","kind":"json-schema","title":"CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount","data":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not set this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"properties":{"accountNumber":{"description":"Account number. For example, A00000001.\n","maxLength":70,"type":"string"},"additionalEmailAddresses":{"description":"List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.\n","maxLength":1200,"type":"string"},"allowInvoiceEdit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if associated invoices can be edited."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]}]}],"type":"boolean"},"associateCommitmentNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of an existing commitment to re-associate with this new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription-owner account. Only applies when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processingOptions.reAssociation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":[]}]}]}],"maxLength":255,"type":"string"},"autoPay":{"description":"Specifies whether future payments are automatically billed when they are due.\n","type":"boolean"},"batch":{"description":"Name of the billing batch that the account belongs to. For example, Batch1.\n","type":"string"},"billCycleDay":{"description":"Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".\n","maximum":31,"minimum":0,"type":"integer"},"billToContact":{"$ref":"#/components/schemas/BillToContactPostOrder"},"communicationProfileId":{"description":"Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.\n","type":"string"},"creditCard":{"$ref":"#/components/schemas/creditCard"},"creditMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the credit memo template, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b."},"children":[]}]}]}],"type":"string"},"crmId":{"description":"External identifier of the account in a CRM system.\n","maxLength":100,"type":"string"},"currency":{"description":"ISO 3-letter currency code (uppercase). For example, USD.\n","type":"string"},"customFields":{"$ref":"#/components/schemas/AccountObjectCustomFields"},"customerServiceRepName":{"description":"Name of the account's customer service representative, if applicable.\n","maxLength":50,"type":"string"},"debitMemoTemplateId":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the debit memo template, configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Billing Document Configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2."},"children":[]}]}]}],"type":"string"},"hpmCreditCardPaymentMethodId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"autoPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must provide the credit card payment method ID for either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to create a CC Reference Transaction payment method for an account."},"children":[]}]}]}],"type":"string"},"invoiceDeliveryPrefsEmail":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to turn on the invoice delivery method 'Email' for the new account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Turn on the invoice delivery method 'Email' for the new account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Turn off the invoice delivery method 'Email' for the new account."},"children":[]}]}]}]}],"type":"boolean"},"invoiceDeliveryPrefsPrint":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to turn on the invoice delivery method 'Print' for the new account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Turn on the invoice delivery method 'Print' for the new account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Turn off the invoice delivery method 'Print' for the new account."},"children":[]}]}]}]}],"type":"boolean"},"invoiceTemplateId":{"description":"Internal identifier of the invoice template that Zuora uses when generating invoices for the account.\n","type":"string"},"name":{"description":"Account name.\n","maxLength":255,"type":"string"},"notes":{"description":"Notes about the account. These notes are only visible to Zuora users.\n","maxLength":65535,"type":"string"},"organizationLabel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the organization to which the account belongs."},"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 available only when you have enabled the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-Org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}],"type":"string"},"parentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the parent customer account for this Account object. Use this field if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}],"type":"string"},"paymentGateway":{"description":"The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.\n","maxLength":40,"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/POSTPaymentMethodRequest"},"paymentTerm":{"description":"Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.\n","type":"string"},"purchaseOrderNumber":{"description":"The number of the purchase order associated with this account. Purchase order information generally comes from customers.\n","maxLength":100,"type":"string"},"salesRep":{"description":"The name of the sales representative associated with this account, if applicable.\n","maxLength":50,"type":"string"},"soldToContact":{"$ref":"#/components/schemas/SoldToContactPostOrder"},"taxInfo":{"$ref":"#/components/schemas/TaxInfo"}},"required":["name","currency","billCycleDay","billToContact"],"type":"object"},{"$ref":"#/components/schemas/DataAccessControlField"}]}},"components/schemas/CreateOrderCreateSubscription":{"id":"components/schemas/CreateOrderCreateSubscription","kind":"json-schema","title":"createSubscription","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"billToContact":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new bill-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice owner account"},"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":"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 mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot specify both."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}]},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed."},"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":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"maxLength":3,"type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-grouping"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Grouping"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","maxLength":255,"nullable":true},"invoiceSeparately":{"description":"Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.\n","type":"boolean"},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"newSubscriptionOwnerAccount":{"$ref":"#/components/schemas/CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount"},"notes":{"description":"Notes about the subscription. These notes are only visible to Zuora users.\n","maxLength":500,"type":"string"},"paymentProfile":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for payment gateway and payment method details of a payment. If you do not set this field, the payment method and payment gateway values cannot be set in the subscription."},"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":"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 multiple order actions are specified, they will be applied in the same order they appear in the API payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If one or more of these order actions include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" element, the changes will be applied in sequence, and the result will be consistent with the last "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" element."},"children":[]}]}]}]}],"properties":{"paymentGatewayId":{"description":"The ID of the gateway instance that processes the payment.\n\nThis field remains unset, if you do not provide value.\n","type":"string"},"paymentMethodId":{"description":"The ID of the payment method.\n\nThis field remains unset, if you do not provide value.\n","type":"string"}},"type":"object"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"shipToContact":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new ship-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription owner account"},"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":"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 mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot specify both."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}]},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the subscription. It must be a contact of the subscription owner."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To access this field, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContactSupport"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. If you want to enable this permission, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"soldToContact":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for creating a new sold-to contact inline for the subscription. The contact will be created under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription owner account"},"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":"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 mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot specify both."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CreateAccountContact"}]},"subscribeToRatePlans":{"description":"List of rate plans associated with the subscription.\n","items":{"$ref":"#/components/schemas/CreateOrderRatePlanOverride"},"type":"array"},"subscriptionNumber":{"description":"Subscription number of the subscription. For example, A-S00000001.\n\nIf you do not set this field, Zuora will generate the subscription number.\n","maxLength":100,"type":"string"},"subscriptionOwnerAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number of an existing account that will own the subscription. For example, A00000001."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not set this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newSubscriptionOwnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newSubscriptionOwnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":70,"type":"string"},"invoiceOwnerAccountNumber":{"description":"Account number of an existing account that will own the invoice. For example, A00000001. If you do not set this field, the account that owns the order will also own this invoice.\n","maxLength":70,"type":"string"},"terms":{"description":"Container for the terms and renewal settings of the subscription.\n","properties":{"autoRenew":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"initialTerm":{"description":"Information about the first term of the subscription.\n","properties":{"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the first term in months, years, days, or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"periodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time that the first term is measured in. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Month","Year","Day","Week"],"type":"string"},"startDate":{"description":"Start date of the first term, in YYYY-MM-DD format.\n","format":"date","type":"string"},"endDate":{"description":"End date of the first term, in YYYY-MM-DD format.\n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the first term. If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the first term has a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the first term does not have a predefined duration."},"children":[]}]}]}],"enum":["TERMED","EVERGREEN"],"type":"string"}},"required":["termType"],"type":"object"},"renewalSetting":{"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 the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"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":"code","inline":true,"attributes":{"content":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each renewal term has a predefined duration. The first entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the duration of the second term of the subscription, the second entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the duration of the third term of the subscription, and so on. The last entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the ultimate duration of each renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_TO_EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The second term of the subscription does not have a predefined duration."},"children":[]}]}]}]}],"enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"type":"string"},"renewalTerms":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of renewal terms of the subscription. Only applicable if the type of the first term is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/RenewalTerm"},"type":"array"}},"required":["initialTerm"],"type":"object"},"uniqueToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique string to represent the subscription in the order. Use this token to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference the subscription in other actions within the same order, such as in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commitment eligibility conditions. Must be unique across all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createSubscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order actions within the same order."},"children":[]}]}]}],"maxLength":50,"type":"string"}},"title":"createSubscription","type":"object"}},"components/schemas/CreateOrderUpdateProductTriggerParams":{"id":"components/schemas/CreateOrderUpdateProductTriggerParams","kind":"json-schema","title":"startDate","data":{"description":"Specifies when a charge becomes active.\n","properties":{"specificTriggerDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date in YYYY-MM-DD format. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"While this field is applicable, if this field is not set, your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action creates a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription. If at the same time the service activation date is required and not set, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While this field is applicable, if this field is not set, the following order actions create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order but do not impact the subscription status. "},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you want to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"AddProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TermsAndConditions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While this field is applicable, for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action, if the Pending order feature as above is not enabled, this field must not be set to null."},"children":[]}]}]}],"format":"date","type":"string"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become active. If this field is not specified, the value of the field will be defaulted to the trigger event value defined in the product catalog."},"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":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes active."},"children":[]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance","SpecificDate"],"type":"string"}},"title":"startDate","type":"object"}},"components/schemas/CreateOrderPricingUpdate":{"id":"components/schemas/CreateOrderPricingUpdate","kind":"json-schema","title":"CreateOrderPricingUpdate","data":{"properties":{"chargeModelData":{"allOf":[{"$ref":"#/components/schemas/ChargeModelDataOverride"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for charge model configuration data."},"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 only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}]},"discount":{"allOf":[{"$ref":"#/components/schemas/DiscountPricingUpdate"}],"description":"Pricing information about a discount charge.\n"},"recurringCalculated":{"allOf":[{"$ref":"#/components/schemas/RecurringCalculatedPricingUpdate"}],"description":"This field is only available if you have the Delivery Pricing charge model enabled.    \n"},"recurringDeliveryBased":{"allOf":[{"$ref":"#/components/schemas/RecurringDeliveryPricingUpdate"}],"description":"This field is only available if you have the Delivery Pricing charge model enabled.\n"},"recurringFlatFee":{"allOf":[{"$ref":"#/components/schemas/RecurringFlatFeePricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"},"recurringPerUnit":{"allOf":[{"$ref":"#/components/schemas/RecurringPerUnitPricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"},"recurringTiered":{"allOf":[{"$ref":"#/components/schemas/RecurringTieredPricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"},"recurringVolume":{"allOf":[{"$ref":"#/components/schemas/RecurringVolumePricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"},"usageFlatFee":{"allOf":[{"$ref":"#/components/schemas/UsageFlatFeePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"},"usageOverage":{"allOf":[{"$ref":"#/components/schemas/UsageOveragePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n"},"usagePerUnit":{"allOf":[{"$ref":"#/components/schemas/UsagePerUnitPricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n"},"usageTiered":{"allOf":[{"$ref":"#/components/schemas/UsageTieredPricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n"},"usageTieredWithOverage":{"allOf":[{"$ref":"#/components/schemas/UsageTieredWithOveragePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n"},"usageVolume":{"allOf":[{"$ref":"#/components/schemas/UsageVolumePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n"}},"type":"object"}},"components/schemas/CreateOrderChargeUpdate":{"id":"components/schemas/CreateOrderChargeUpdate","kind":"json-schema","title":"CreateOrderChargeUpdate","data":{"description":"The JSON object containing the information for a charge update in the 'UpdateProduct' type order action.\n","properties":{"billing":{"$ref":"#/components/schemas/BillingUpdate"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the charge to be updated. The value of this field is inherited from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderActions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"negotiatedPriceTable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of negotiated price table information. The rate card entries provided in the array will override the existing rate card entries in the standard price table to form a negotiated price table that will be"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used during pricing evaluation."},"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":" To enable the Negotiated Price Table feature, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/NegotiatedItems"},"type":"array"},"pricingAttributes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values included in the array will update the existing values. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically."},"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":" To enable Dynamic Pricing, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of a product rate plan charge for this subscription. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAddingSubsetCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true, the product rate charge specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is added to the existing rate plan specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of a product rate plan charge for this subscription. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAddingSubsetCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true, the product rate charge specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is added to the existing rate plan specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"},"description":{"type":"string"},"effectiveDate":{"$ref":"#/components/schemas/CreateOrderUpdateProductTriggerParams"},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"pricing":{"allOf":[{"$ref":"#/components/schemas/CreateOrderPricingUpdate"}],"description":"Pricing information about the charge.\n"},"uniqueToken":{"description":"A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.\n","type":"string"}},"type":"object"}},"components/schemas/CreateOrderRatePlanUpdate":{"id":"components/schemas/CreateOrderRatePlanUpdate","kind":"json-schema","title":"updateRateplan","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"chargeUpdates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of the JSON objects containing the information for a charge update in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type of order action."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderChargeUpdate"},"type":"array"},"chargeOverrides":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section is only available for hard bundle rate plans. To include additional charges to the subscribed hard bundle, specify the product rate plan charge ID and its 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 only available when the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled. The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ChargeOverride"},"type":"array"},"chargeRemovals":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section is only available for hard bundle rate plans. To remove optional component charges from the subscribed hard bundle, specify its subscription rate plan charge number or unique token."},"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 only available when the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled. The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bundle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early availability before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ChargeRemoval"},"type":"array"},"clearingExistingFeatures":{"description":"Specifies whether all features in the rate plan will be cleared.\n","type":"boolean"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan. However, if there are multiple rate plans with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value existing in the subscription, you must use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to update the rate plan. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be used to distinguish multiple rate plans in this case."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"isAddingSubsetCharges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to add a subset of charges to the subscription."},"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":" To access this field for adding a subset of charges, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanId":{"description":"The id of the rate plan to be updated. It can be the latest version or any history version id.\n","type":"string"},"specificUpdateDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date when the Update Product order action takes effect.  This field allows you to update a charge before a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd."},"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":": After you use this option, the charge's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TriggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field value will be changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/products-updation-on-subscriptions-with-future-dated-updates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Product on Subscription with Future-dated Updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about this feature."},"children":[]}]}]}],"format":"date","type":"string"},"subscriptionProductFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of features associated with the rate plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system compares the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the request with the counterpart fields in a rate plan. The comparison results are 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":"If there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the field is empty, features in the rate plan remain unchanged. But if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingExistingFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is additionally set to true, all features in the rate plan are cleared."},"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":"subscriptionProductFeatures"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featureId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, as well as the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderRatePlanFeatureOverride"},"type":"array"},"subscriptionRatePlanNumber":{"description":"Number of a rate plan for this subscription.\n","type":"string"},"uniqueToken":{"description":"A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.\n","type":"string"}},"title":"updateRateplan","type":"object"}},"components/schemas/CreateOrderOrderAction":{"id":"components/schemas/CreateOrderOrderAction","kind":"json-schema","title":"CreateOrderOrderAction","data":{"properties":{"addProduct":{"$ref":"#/components/schemas/CreateOrderRatePlanOverride"},"cancelSubscription":{"$ref":"#/components/schemas/CancelSubscription"},"changePlan":{"$ref":"#/components/schemas/CreateChangePlan"},"changeReason":{"description":"The change reason set for an order action when an order is created.\n","maxLength":255,"type":"string"},"createSubscription":{"$ref":"#/components/schemas/CreateOrderCreateSubscription"},"customFields":{"$ref":"#/components/schemas/OrderActionObjectCustomFields"},"ownerTransfer":{"$ref":"#/components/schemas/OwnerTransfer"},"removeProduct":{"$ref":"#/components/schemas/RemoveProduct"},"renewSubscription":{"$ref":"#/components/schemas/RenewSubscription"},"resume":{"$ref":"#/components/schemas/CreateOrderResume"},"suspend":{"$ref":"#/components/schemas/CreateOrderSuspend"},"termsAndConditions":{"$ref":"#/components/schemas/CreateOrderTermsAndConditions"},"triggerDates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the contract effective, service activation, and customer acceptance dates of the order action."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora is configured to require service activation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription are created."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora is configured to require customer acceptance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription are created. At the same time, if the service activation date field is also required and not set, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription are created instead."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora is configured to require service activation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set for either of the following order actions, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order is created. The subscription status is not impacted. "},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you want to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"AddProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TermsAndConditions"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora is configured to require customer acceptance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set for either of the following order actions, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order is created. The subscription status is not impacted. "},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you want to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"AddProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TermsAndConditions"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/TriggerDate"},"type":"array"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unless the type of order action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must use the corresponding field to provide information about the order action. For example, if the type of order action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addProduct"},"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":"Zuora returns an error if you set a field that corresponds to a different type of order action. For example, if the type of order action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora returns an error if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateProduct"},"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":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-pending-subscriptions-or-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supports the following order actions:"},"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":"CreateSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AddProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TermsAndConditions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ChangePlan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, pending orders created through all order actions except for \"Create new subscription\":"},"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":"Do not impact the subscription status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Are in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you want to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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 pending order is created in either of the following conditions:"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora is configured to require service activation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the service activation date is not set in your \"Create an order\" call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-default-subscription-and-order-settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora is configured to require customer acceptance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the customer acceptance date is not set in your \"Create an order\" call."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a charge in the subscription has its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set in your \"Create an order\" API call."},"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 change plan type of order action is supported for the  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. However, it is currently not supported for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing."},"children":[]}]}]}],"enum":["CreateSubscription","TermsAndConditions","AddProduct","UpdateProduct","RemoveProduct","RenewSubscription","CancelSubscription","OwnerTransfer","Suspend","Resume","ChangePlan","Revert"],"type":"string"},"updateProduct":{"$ref":"#/components/schemas/CreateOrderRatePlanUpdate"}},"required":["type"],"type":"object"}},"components/schemas/POSTOrderRequestType":{"id":"components/schemas/POSTOrderRequestType","kind":"json-schema","title":"POSTOrderRequestType","data":{"example":{"existingAccountNumber":"A00000097","orderDate":"2024-07-01","subscriptions":[{"orderActions":[{"type":"CreateSubscription","createSubscription":{"terms":{"initialTerm":{"period":12,"periodType":"Month","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":[{"period":12,"periodType":"Month"}]},"subscribeToRatePlans":[{"productRatePlanId":"8ad081dd9096ef9501909b40bb4e74a4"}]}}]}]},"properties":{"category":{"default":"NewSales","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the order to indicate a product sale or return. Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NewSales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["NewSales","Return"],"type":"string"},"commitments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It contains a list of commitments to create or update."},"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":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested field to indicate whether to create or update the commitment."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UpsertCommitmentInput"}},"customFields":{"$ref":"#/components/schemas/OrderObjectCustomFields"},"description":{"description":"A description of the order.","maxLength":500,"type":"string"},"existingAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account ID under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If you want to relax the restriction that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be the invoice owner of the subscriptions in this order, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, but not both."},"children":[]}]}]}],"type":"string"},"existingAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If you want to relax the restriction that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be the invoice owner of the subscriptions in this order, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":70,"type":"string"},"newAccount":{"$ref":"#/components/schemas/CreateOrderNewAccount"},"orderDate":{"description":"The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null.","format":"date","type":"string"},"orderLineItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Order Line Items Without Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" billing permission, you can only create order  line items from existing products by specifying the product rate plan charge ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field.  For more information about billing permissions, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderOrderLineItem"},"type":"array"},"orderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number of the new order. If not provided, system will auto-generate a number for this order."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"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 characters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"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":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not allowed in this field. Additionally, to ensure compatibility with the UI when viewing orders, use only the following special characters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"processingOptions":{"$ref":"#/components/schemas/processingOptionsOrdersWithDelayedCapturePayment"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values of reason code configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through Zuora UI. Indicates the reason when a return order line item occurs."},"children":[]}]}]}],"maxLength":255,"type":"string"},"schedulingOptions":{"description":"Information of scheduled order. \n","properties":{"scheduledDate":{"description":"The date for the order scheduled.\n","format":"date","type":"string"},"scheduledDatePolicy":{"description":"Date policy of the scheduled order.","enum":["SpecificDate"],"type":"string"}},"type":"object"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the order. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The following values 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":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in draft status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in pending status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in completed status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The scheduled order has failed."},"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":" If you have the Pending Subscription Processing feature turned on and want to  create a completed order with an active subscription with pending charges, you must specify  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field because the default order status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this scenario."},"children":[]}]}]}],"enum":["Draft","Pending","Completed","Scheduled","Executing","Failed"],"type":"string"},"subscriptions":{"description":"Each item includes a set of order actions, which will be applied to the same base subscription.  When you create an order that involves multiple subscriptions, these subscriptions can have different invoice owner accounts or subscription owner accounts. ","items":{"properties":{"customFields":{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"},"notes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes about the subscription. These notes are only visible to Zuora users. Notes set in this field will override the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the createSubscription order action."},"children":[]}]}]}],"type":"string","maxLength":1000},"orderActions":{"description":"The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.","items":{"$ref":"#/components/schemas/CreateOrderOrderAction"},"type":"array"},"quote":{"$ref":"#/components/schemas/QuoteObjectFields"},"ramp":{"$ref":"#/components/schemas/RampRequest"},"subscriptionNumber":{"description":"Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.\n","type":"string"}},"type":"object"},"type":"array"}},"required":["orderDate"],"type":"object"}},"components/schemas/processingOptionsOrdersAsync":{"id":"components/schemas/processingOptionsOrdersAsync","kind":"json-schema","title":"processingOptionsOrdersAsync","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for billing processing options and payment processing options."},"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 not supported in draft orders."},"children":[]}]}]}],"properties":{"allowPaymentFailure":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to create the order even if payment collection fails. If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectPayment"},"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":", Zuora creates the order if order validation, persistence, activation, and invoice generation succeed."},"children":[]}]}]}],"type":"boolean","default":false},"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply to invoices."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"description":[{"$$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 value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices"},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"applyCreditBalance":{"description":"Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.\n","type":"boolean"},"billingOptions":{"properties":{"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"documentDate":{"description":"The invoice date displayed on the invoice.\n","format":"date","type":"string"},"generateDraftInvoice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the current request needs to generate a draft invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice is generated. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-bill-runs-creation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is a Target Date?"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you do not specify this field, today's date is used by default."},"children":[]}]}]}],"format":"date","type":"string"},"chargeTypeToExclude":{"description":"The types of the charges to be excluded from the generation of billing documents.\n","items":{"type":"string","enum":["OneTime","Recurring","Usage"]},"type":"array"}},"type":"object"},"collectPayment":{"description":"Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.\n","type":"boolean"},"electronicPaymentOptions":{"description":"Container for the electronic payment options.\n","properties":{"paymentGatewayId":{"description":"Specifies the ID of a payment gateway to override the default gateway. If this field is not specified, the default payment gateway will be used to process the payment.\n","type":"string"},"paymentMethodId":{"description":"Specifies an electronic payment method. It can be one that has already been associated with an invoice owner, or an orphan payment method, which is not associated with any invoice owner. For an orphan payment method, this operation will then associate it with the account that this order will be created under.\n","type":"string"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields supported by gateways vary. For more information, see the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify any unsupported gateway option parameters, they will be ignored"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without error prompts."},"children":[]}]}]}],"type":"object","title":"gatewayOptions","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gateway options specification consists of key-value pairs:"},"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":"Field name: The name of a gateway-specific parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: The value of the gateway-specific parameter."},"children":[]}]}]}]}]}}},"type":"object"},"runBilling":{"description":"Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.\n","type":"boolean"}},"type":"object"}},"components/schemas/POSTOrderAsyncRequestType":{"id":"components/schemas/POSTOrderAsyncRequestType","kind":"json-schema","title":"POSTOrderAsyncRequestType","data":{"example":{"existingAccountNumber":"A00000097","orderDate":"2024-07-01","subscriptions":[{"orderActions":[{"type":"CreateSubscription","createSubscription":{"terms":{"initialTerm":{"period":12,"periodType":"Month","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":[{"period":12,"periodType":"Month"}]},"subscribeToRatePlans":[{"productRatePlanId":"8ad081dd9096ef9501909b40bb4e74a4"}]}}]}]},"properties":{"category":{"default":"NewSales","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the order to indicate a product sale or return. Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NewSales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["NewSales","Return"],"type":"string"},"customFields":{"$ref":"#/components/schemas/OrderObjectCustomFields"},"description":{"description":"A description of the order.","maxLength":500,"type":"string"},"existingAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account ID under which this order will be created.  This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order.  To override these defaults for individual subscriptions, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, but not both."},"children":[]}]}]}],"type":"string"},"existingAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number under which this order will be created.  This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":70,"type":"string"},"externallyManagedBy":{"description":"An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n","enum":["Amazon","Apple","Google","Roku"],"type":"string"},"newAccount":{"$ref":"#/components/schemas/CreateOrderNewAccount"},"orderDate":{"description":"The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null.","format":"date","type":"string"},"orderLineItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Order Line Items Without Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" billing permission, you can only create order  line items from existing products by specifying the product rate plan charge ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field.  For more information about billing permissions, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is now generally available to all Zuora customers. You need to enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled by default."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CreateOrderOrderLineItem"},"type":"array"},"orderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number of the new order. If not provided, system will auto-generate a number for this order."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"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 characters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"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":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not allowed in this field. Additionally, to ensure compatibility with the UI when viewing orders, use only the following special characters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"processingOptions":{"$ref":"#/components/schemas/processingOptionsOrdersAsync"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values of reason code configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through Zuora UI. Indicates the reason when a return order line item occurs."},"children":[]}]}]}],"maxLength":255,"type":"string"},"subscriptions":{"description":"Each item includes a set of order actions, which will be applied to the same base subscription. When you create an order that involves multiple subscriptions, these subscriptions can have different invoice owner accounts or subscription owner accounts. ","items":{"properties":{"customFields":{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"},"notes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes about the subscription. These notes are only visible to Zuora users. Notes set in this field will override the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the createSubscription order action."},"children":[]}]}]}],"type":"string","maxLength":1000},"orderActions":{"description":"The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.","items":{"$ref":"#/components/schemas/CreateOrderOrderAction"},"type":"array"},"quote":{"$ref":"#/components/schemas/QuoteObjectFields"},"ramp":{"$ref":"#/components/schemas/RampRequest"},"subscriptionNumber":{"description":"Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.\n","type":"string"}},"type":"object"},"type":"array"}},"required":["orderDate"],"type":"object"}},"components/schemas/GetOrderResponse":{"id":"components/schemas/GetOrderResponse","kind":"json-schema","title":"GetOrderResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"order":{"$ref":"#/components/schemas/Order"}},"type":"object"}]}},"components/schemas/processingOptionsOrders":{"id":"components/schemas/processingOptionsOrders","kind":"json-schema","title":"processingOptionsOrders","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for billing processing options and payment processing options."},"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":"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":"This field is not supported in draft orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you use the \"Create an order\" operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. In this case, neither the invoice will be generated, nor the subscription nor the account will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you use the \"Create an order\" operation to cancel a subscription with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"writeOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"writeOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fails, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" still can succeed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you use the \"Create an order\" operation, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields cannot be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" simultaneously.  Otherwise, the order will not be proceeded."},"children":[]}]}]}]}],"properties":{"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply to invoices."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply credit memos or unapplied payments, or both to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"applyCreditBalance":{"description":"Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.\n","type":"boolean"},"billingOptions":{"properties":{"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"documentDate":{"description":"The invoice date displayed on the invoice.\n","format":"date","type":"string"},"generateDraftInvoice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the current request needs to generate a draft invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice is generated. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-bill-runs-creation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is a Target Date?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"},"collectPayment":{"description":"Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.\n","type":"boolean"},"electronicPaymentOptions":{"description":"Container for the electronic payment options.\n","properties":{"paymentGatewayId":{"description":"Specifies the ID of a payment gateway to override the default gateway. If this field is not specified, the default payment gateway will be used to process the payment.\n","type":"string"},"paymentMethodId":{"description":"Specifies an electronic payment method. It can be one that has already been associated with an invoice owner, or an orphan payment method, which is not associated with any invoice owner. For an orphan payment method, this operation will then associate it with the account that this order will be created under.\n","type":"string"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields supported by gateways vary. For more information, see the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify any unsupported gateway option parameters, they will be ignored"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without error prompts."},"children":[]}]}]}],"type":"object","title":"gatewayOptions","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gateway options specification consists of key-value pairs:"},"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":"Field name: The name of a gateway-specific parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: The value of the gateway-specific parameter."},"children":[]}]}]}]}]}}},"type":"object"},"refund":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to refund after subscription cancelation. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": When refunding a subscription that is not invoiced separately, if you do not enable the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”"},"children":[]}]}]}],"type":"boolean"},"refundAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the amount to be refunded. Required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"refundReasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the reason for the refund transaction. The value must be an existing payment refund reason code listed in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you do not specify the field or leave the field with an empty value, Zuora uses the default payment refund reason code."},"children":[]}]}]}],"type":"string"},"runBilling":{"description":"Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.\n","type":"boolean"},"writeOff":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to write off the outstanding balance on the invoice after refund. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"When refunding a subscription that is not invoiced separately, if you do not enable the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature must have been enabled for write-off."},"children":[]}]}]}]}],"type":"boolean"},"writeOffBehavior":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The financial information of the credit memo items generated to write off the invoice balance."},"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":"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":"All the credit memo items that are used to write off the invoice will be applied with the same financial information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit memo items generated from the unconsumed services of the canceled subscription will not be applied with the finance information specified here."},"children":[]}]}]}]}],"properties":{"financeInformation":{"description":"Container for the finance information related to the credit memo items that are created for invoice write-off.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","maxLength":100,"minLength":0,"type":"string"},"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","maxLength":100,"minLength":0,"type":"string"},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"components/schemas/PUTOrderRequestType":{"id":"components/schemas/PUTOrderRequestType","kind":"json-schema","title":"PUTOrderRequestType","data":{"example":{"existingAccountNumber":"A00000097","orderDate":"2024-11-11","subscriptions":[{"orderActions":[{"createSubscription":{"notes":"Notes about the subscription","terms":{"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","initialTerm":{"startDate":"2024-11-10","period":12,"periodType":"Month","termType":"TERMED"},"renewalTerms":[{"period":6,"periodType":"Month"}]}},"type":"CreateSubscription"}]}]},"properties":{"category":{"default":"NewSales","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the order to indicate a product sale or return. Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NewSales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["NewSales","Return"],"type":"string"},"commitments":{"items":{"$ref":"#/components/schemas/UpsertCommitmentInput"},"type":"array","description":"A list of commitments you want to create or update.\n"},"customFields":{"$ref":"#/components/schemas/OrderObjectCustomFields"},"description":{"description":"A description of the order.","maxLength":500,"type":"string"},"existingAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account ID under which this order will be created.  This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order.  To override these defaults for individual subscriptions, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, but not both."},"children":[]}]}]}],"type":"string"},"existingAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number under which this order will be created.  This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceOwnerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":70,"type":"string"},"orderDate":{"description":"The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null.","format":"date","type":"string"},"orderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number of the new order. If not provided, system will auto-generate a number for this order."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"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 characters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"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":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not allowed in this field."},"children":[]}]}]}],"maxLength":100,"type":"string"},"processingOptions":{"$ref":"#/components/schemas/processingOptionsOrders"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values of reason code configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through Zuora UI. Indicates the reason when a return order line item occurs."},"children":[]}]}]}],"maxLength":255,"type":"string"},"schedulingOptions":{"description":"Information of scheduled order. \n","properties":{"scheduledDate":{"description":"The date for the order scheduled.\n","format":"date","type":"string"},"scheduledDatePolicy":{"description":"Date policy of the scheduled order.","enum":["SpecificDate"],"type":"string"}},"type":"object"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the order. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The following values 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":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in draft status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in pending status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in completed status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The scheduled order has failed."},"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":" If you have the Pending Subscription Processing feature turned on and want to  update a completed order with an active subscription with pending charges, you must specify  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field because the default order status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this scenario."},"children":[]}]}]}],"enum":["Draft","Pending","Completed","Scheduled","Executing","Failed"],"type":"string"},"subscriptions":{"description":"Each item includes a set of order actions, which will be applied to the same base subscription.  When you create an order that involves multiple subscriptions, these subscriptions can have different invoice owner accounts or subscription owner accounts. ","items":{"properties":{"customFields":{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"},"orderActions":{"description":"The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.","items":{"$ref":"#/components/schemas/CreateOrderOrderAction"},"type":"array"},"quote":{"$ref":"#/components/schemas/QuoteObjectFields"},"ramp":{"$ref":"#/components/schemas/RampRequest"},"subscriptionNumber":{"description":"Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.\n","type":"string"}},"type":"object"},"type":"array"}},"required":["orderDate"],"type":"object"}},"components/schemas/PutOrderResponseType":{"id":"components/schemas/PutOrderResponseType","kind":"json-schema","title":"PutOrderResponseType","data":{"description":"Response information of orders.","allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account ID for the order. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":32,"type":"string"},"accountNumber":{"description":"The account number for the order.","maxLength":50,"type":"string"},"creditMemoIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of the credit memo IDs generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditMemoNumbers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","maxLength":32},"type":"array"},"creditMemoNumbers":{"description":"An array of the credit memo numbers generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled.","items":{"type":"string","maxLength":255},"type":"array"},"invoiceIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of the invoice IDs generated in this order request. Normally it includes one invoice ID only, but can include multiple items when a subscription was tagged as invoice separately. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceNumbers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","maxLength":32},"type":"array"},"invoiceNumbers":{"description":"An array of the invoice numbers generated in this order request. Normally it includes one invoice number only, but can include multiple items when a subscription was tagged as invoice separately.","items":{"type":"string","maxLength":255},"type":"array"},"orderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the order created. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":32,"type":"string"},"orderNumber":{"description":"The order number of the order created.","maxLength":100,"type":"string"},"paidAmount":{"description":"The total amount collected in this order request.","maxLength":22,"minLength":9,"type":"string"},"paymentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment Id that is collected in this order request. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":32,"type":"string"},"paymentNumber":{"description":"The payment number that is collected in this order request.","maxLength":32,"type":"string"},"ramps":{"description":[{"$$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 only available if you have the Ramps feature enabled.  The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  feature must be enabled before you can access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature.  The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=zuora-editions"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information coming October 2020. The ramp definitions created by this order request."},"children":[]}]}]}],"items":{"properties":{"rampNumber":{"description":"The number of the ramp definition.","maxLength":50,"type":"string"},"subscriptionNumber":{"description":"The number of the subscription that this ramp deal definition is applied to.","maxLength":150,"type":"string"}},"type":"object"},"type":"array"},"refunds":{"items":{"properties":{"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refund number. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"R-00009564"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":32,"type":"string"},"refundInvoiceNumbers":{"description":"An array of the refunded invoice numbers generated in this order request.","items":{"type":"string","maxLength":255},"type":"array"},"status":{"description":"The status of the refund.","enum":["Success","Error"],"type":"string"}},"type":"object"},"type":"array"},"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 order. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only applicable for an order that contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action."},"children":[]}]}]}],"enum":["Draft","Pending","Completed","Scheduled"],"type":"string"},"subscriptionIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the subscription IDs of the subscriptions in an order. This field is returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","maxLength":32},"type":"array"},"subscriptionOwnerId":{"description":"Subscription owner account ID of the subscription.","type":"string"},"subscriptionOwnerNumber":{"description":"Subscription owner account number of the subscription.","type":"string"},"subscriptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you are on the latest Zuora API minor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"223.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"later available version."},"children":[]}]}]}],"items":{"properties":{"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. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are only applicable for an order that contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action."},"children":[]}]}]}],"enum":["Active","Pending Activation","Pending Acceptance","Cancelled","Suspended"],"type":"string"},"subscriptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription ID of the subscription included in this order. This field is returned instead of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":32,"type":"string"},"subscriptionNumber":{"description":"Subscription number of the subscription included in this order.","maxLength":150,"type":"string"}},"type":"object"},"type":"array"},"writeOff":{"items":{"properties":{"amount":{"description":"The amount written off from the invoice balance.","maximum":22,"minimum":9,"type":"number"},"failedReason":{"description":"The reason of write-off failure.","type":"string"},"invoiceNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice that is written off. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV00051208"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"status":{"description":"The status of the write-off.","enum":["Success","Failed"],"type":"string"},"writeOffCreditMemoNumber":{"description":"The number of the credit memo that is written off.","maxLength":255,"type":"string"}},"type":"object"},"type":"array"},"commitments":{"$ref":"#/components/schemas/CommitmentOutput"}},"type":"object"}]}},"components/schemas/DeleteOrderAsyncResponse":{"id":"components/schemas/DeleteOrderAsyncResponse","kind":"json-schema","title":"DeleteOrderAsyncResponse","data":{"properties":{"jobId":{"description":"The ID of an asynchronous job that will be returned for tracking the status and result of the job.","type":"string"},"success":{"description":"Indicates whether the call succeeded.","type":"boolean"}},"type":"object"}},"components/schemas/GetAsyncCreateOrderJobResponse":{"id":"components/schemas/GetAsyncCreateOrderJobResponse","kind":"json-schema","title":"GetAsyncCreateOrderJobResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"$ref":"#/components/schemas/CreateOrderResult"},{"type":"object","properties":{"jobType":{"description":"The type of job.","type":"string","enum":["AsyncCreateOrder"],"default":"AsyncCreateOrder"}}}]}},"components/schemas/GetAsyncPreviewOrderJobResponse":{"id":"components/schemas/GetAsyncPreviewOrderJobResponse","kind":"json-schema","title":"GetAsyncPreviewOrderJobResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"$ref":"#/components/schemas/PreviewOrderResult"},{"type":"object","properties":{"jobType":{"description":"The type of job.","type":"string","enum":["AsyncPreviewOrder"],"default":"AsyncPreviewOrder"}}}]}},"components/schemas/GetAsyncOrderJobResponseResult":{"id":"components/schemas/GetAsyncOrderJobResponseResult","kind":"json-schema","title":"GetAsyncOrderJobResponseResult","data":{"oneOf":[{"$ref":"#/components/schemas/GetAsyncCreateOrderJobResponse"},{"$ref":"#/components/schemas/GetAsyncPreviewOrderJobResponse"}],"discriminator":{"propertyName":"jobType","mapping":{"AsyncCreateOrder":"#/components/schemas/GetAsyncCreateOrderJobResponse","AsyncPreviewOrder":"#/components/schemas/GetAsyncPreviewOrderJobResponse"}}}},"components/schemas/GetAsyncOrderJobResponse":{"id":"components/schemas/GetAsyncOrderJobResponse","kind":"json-schema","title":"GetAsyncOrderJobResponse","data":{"properties":{"errors":{"description":"Error messages returned if the job failed.","type":"string","nullable":true},"result":{"$ref":"#/components/schemas/GetAsyncOrderJobResponseResult"},"status":{"description":"Type of job status.","enum":["Processing","Failed","Completed"],"type":"string"},"success":{"description":"Indicates whether the operation call succeeded.","type":"boolean"}},"type":"object"}},"components/schemas/GetOrdersResponse":{"id":"components/schemas/GetOrdersResponse","kind":"json-schema","title":"GetOrdersResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"orders":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"}},"type":"object"}]}},"components/schemas/PUTOrderPatchRequestType":{"id":"components/schemas/PUTOrderPatchRequestType","kind":"json-schema","title":"PUTOrderPatchRequestType","data":{"example":{"customFields":{"CustomTag__c":"internal"}},"properties":{"customFields":{"$ref":"#/components/schemas/OrderObjectCustomFields"},"subscriptions":{"items":{"properties":{"orderActions":{"items":{"properties":{"customFields":{"$ref":"#/components/schemas/OrderActionObjectCustomFields"},"orderActionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Id of the order action in the order. You can provide either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderActionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify which order action to update. You cannot use then both at the same time."},"children":[]}]}]}],"type":"string"},"sequence":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sequence number of the order action in the order. You can provide either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderActionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify which order action to update. You cannot use then both at the same time."},"children":[]}]}]}],"type":"integer"}},"type":"object"},"type":"array"},"subscriptionNumber":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/PUTSubscriptionPatchRequestType":{"id":"components/schemas/PUTSubscriptionPatchRequestType","kind":"json-schema","title":"PUTSubscriptionPatchRequestType","data":{"example":{"customFields":{"CustomTag__c":"internal"}},"properties":{"customFields":{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"},"ratePlans":{"items":{"properties":{"charges":{"items":{"properties":{"chargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the charge for which you will be updating the custom fields. By using this field you actually specify a specific charge segment of a charge. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-soap-api-object-rateplancharge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segmented rate plan charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about charge segments."},"children":[]}]}]}],"type":"string"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the charge for which you will be updating the custom fields. By using this field you actually specify the last charge segment of a charge. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-soap-api-object-rateplancharge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segmented rate plan charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about charge segments."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"}},"type":"object"},"type":"array"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"ratePlanId":{"description":"The rate plan id in any version of the subscription. This will be linked to the only one rate plan in the current version.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/PUTOrderActionTriggerDatesRequestType":{"id":"components/schemas/PUTOrderActionTriggerDatesRequestType","kind":"json-schema","title":"PUTOrderActionTriggerDatesRequestType","data":{"example":{"subscriptions":[{"subscriptionNumber":"A-S00000143","orderActions":[{"sequence":0,"triggerDates":[{"name":"CustomerAcceptance","triggerDate":"2024-07-22"}]}]}]},"properties":{"subscriptions":{"items":{"properties":{"orderActions":{"items":{"properties":{"charges":{"items":{"properties":{"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge number of the charge which needs the triggering date to be provided. The charge's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must have been set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"specificTriggerDate":{"description":"Date in YYYY-MM-DD format. The specific trigger date you are to set for the charge.","format":"date","type":"string"}},"type":"object"},"type":"array"},"sequence":{"description":"Identifies which order action will have its triggering dates updated. \n","type":"integer"},"triggerDates":{"description":"Container for the service activation and customer acceptance dates of the order action.","items":{"properties":{"name":{"description":"Name of the trigger date of the order action.","enum":["ServiceActivation","CustomerAcceptance"],"type":"string"},"triggerDate":{"description":"Trigger date in YYYY-MM-DD format. The date you are to set as the service activation date or the customer acceptance date.\n","format":"date","type":"string"}},"type":"object"},"type":"array"}},"required":["sequence"],"type":"object"},"type":"array"},"subscriptionNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription number of a subscription in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order for which you are to update the triggering dates. For example, A-S00000001."},"children":[]}]}]}],"maxLength":100,"type":"string"}},"required":["subscriptionNumber"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/PUTOrderTriggerDatesResponseType":{"id":"components/schemas/PUTOrderTriggerDatesResponseType","kind":"json-schema","title":"PUTOrderTriggerDatesResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"accountNumber":{"description":"The account number for the order.","type":"string"},"orderNumber":{"description":"The order number of the order updated.","type":"string"},"status":{"description":"Status of the order.","enum":["Completed","Pending"],"type":"string"},"subscriptions":{"description":"The subscriptions updated.","items":{"properties":{"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. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are only applicable for an order that contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action."},"children":[]}]}]}],"enum":["Active","Pending Activation","Pending Acceptance"],"type":"string"},"subscriptionNumber":{"description":"Subscription number of the subscription updated.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}]}},"components/schemas/PutOrderCancelResponse":{"id":"components/schemas/PutOrderCancelResponse","kind":"json-schema","title":"PutOrderCancelResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"accountNumber":{"description":"The account number for the order.","type":"string"},"cancelReason":{"description":"The reason for cancelling the order.","type":"string"},"orderNumber":{"description":"The order number of the order created.","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 order. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only valid value."},"children":[]}]}]}],"enum":["Cancelled"],"type":"string"}},"type":"object"}]}},"components/schemas/CommitmentAccountRescanResponse":{"id":"components/schemas/CommitmentAccountRescanResponse","kind":"json-schema","title":"CommitmentAccountRescanResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"commitmentNumber":{"description":"The commitment number that was rescanned.","type":"string"},"accountsActivated":{"description":"The number of accounts newly activated (inserted or reactivated) by this rescan.","type":"integer"},"accountsUnchanged":{"description":"The number of accounts that were already active and eligible, left untouched.","type":"integer"},"activatedAccountNumbers":{"description":"Account numbers activated by this rescan.","items":{"type":"string"},"type":"array"}},"type":"object"}]}},"components/schemas/OrderDeltaQty":{"id":"components/schemas/OrderDeltaQty","kind":"json-schema","title":"OrderDeltaQty","data":{"properties":{"chargeNumber":{"description":"The charge number for the associated Rate Plan Charge. This field can be\nnull if the metric is generated for an Order Line Item.","type":"string"},"endDate":{"description":"The end date for the order delta metric.\n","format":"date","type":"string"},"quantity":{"description":"The gross amount for the metric. The is the amount excluding applied\ndiscount.","type":"number"},"orderActionId":{"description":"The Id for the related Order Action. This field can be null if the metric\nis generated for an Order Line Item.","type":"string"},"orderActionSequence":{"description":"The sequence for the related Order Action. This field can be null if the\nmetric is generated for an Order Line Item.","type":"string"},"orderActionType":{"description":"The type for the related Order Action. This field can be null if the\nmetric is generated for an Order Line Item.","type":"string"},"orderLineItemNumber":{"description":"A sequential number auto-assigned for each of order line items in a order,\nused as an index, for example, \"1\".","type":"string"},"productRatePlanChargeId":{"description":"The Id for the associated Product Rate Plan Charge. This field can be null\nif the Order Line Item is not associated with a Product Rate Plan Charge.","type":"string"},"ratePlanChargeId":{"description":"The id for the associated Rate Plan Charge. This field can be null if the\nmetric is generated for an Order Line Item.","type":"string"},"startDate":{"description":"The start date for the order delta metric.\n","format":"date","type":"string"},"subscriptionNumber":{"description":"The number of the subscription. This field can be null if the metric is\ngenerated for an Order Line Item.","type":"string"},"orderLineItemId":{"description":"The system generated Id for the Order Line Item. This field can be null\nif the metric is generated for a Rate Plan Charge.","type":"string"}},"type":"object","description":"Order Delta Qty. This is a metric that reflects the change to the QTY on Rate\nPlan Charge object, or the Quantity for an Order Line Item as\nthe result of the order"}},"components/schemas/OrderDeltaMetrics":{"id":"components/schemas/OrderDeltaMetrics","kind":"json-schema","title":"OrderDeltaMetrics","data":{"description":[{"$$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":" As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The new methodologies are reflected in the following Order Delta Metrics objects:"},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics/order-delta-mrr"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Mrr"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics/order-delta-tcv"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Tcv"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics/order-delta-tcb"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Tcb"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics/order-delta-quantity"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Qty"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is recommended that all customers use the new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics/overview-of-order-delta-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Delta Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you are an existing "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer and want to migrate to Order Delta Metrics, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"orderDeltaMrr":{"items":{"$ref":"#/components/schemas/OrderDeltaMrr"},"type":"array"},"orderDeltaTcb":{"items":{"$ref":"#/components/schemas/OrderDeltaTcb"},"type":"array"},"orderDeltaTcv":{"items":{"$ref":"#/components/schemas/OrderDeltaTcv"},"type":"array"},"orderDeltaQty":{"items":{"$ref":"#/components/schemas/OrderDeltaQty"},"type":"array"}},"type":"object"}},"components/schemas/GetOrderDeltaMetricsResponse":{"id":"components/schemas/GetOrderDeltaMetricsResponse","kind":"json-schema","title":"GetOrderDeltaMetricsResponse","data":{"allOf":[{"properties":{"generationStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the Order Delta Metrics generation for the order."},"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":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The metrics are not available yet, either because the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order is not completed, or because the asynchronous generation is still"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in progress. Retry the request later."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For orders whose status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generationStatus"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because Order Delta Metrics are not generated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"until the order is completed."},"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":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The metrics have been generated. Note that the metrics"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"arrays can still be empty if the order does not produce any metric."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The metrics could not be retrieved. Retry the request later,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error persists."},"children":[]}]}]}]}]}],"enum":["PROCESSING","COMPLETED","ERROR"],"type":"string"},"orderDeltaMetrics":{"$ref":"#/components/schemas/OrderDeltaMetrics"}},"type":"object"},{"$ref":"#/components/schemas/CommonResponse"}]}},"components/schemas/OrderActionCustomFields":{"id":"components/schemas/OrderActionCustomFields","kind":"json-schema","title":"OrderActionCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order Action object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Order Action object.\n","title":"OrderActionCustomFields","type":"object"}},"components/schemas/OrderActionCommon":{"id":"components/schemas/OrderActionCommon","kind":"json-schema","title":"OrderAction","data":{"properties":{"changeReason":{"description":"The change reason set for an order action when the order action is updated.\n","type":"string"},"customFields":{"$ref":"#/components/schemas/OrderActionCustomFields"}},"title":"OrderAction","type":"object"}},"components/schemas/PUTOrderActionsRequestType":{"id":"components/schemas/PUTOrderActionsRequestType","kind":"json-schema","title":"PUTOrderActionsRequestType","data":{"example":{"changeReason":"string","customFields":{"PICKLIST_CF__c":"option_1"}},"type":"object","allOf":[{"$ref":"#/components/schemas/OrderActionCommon"}]}},"components/schemas/OrderLineItemCustomFieldsRetrieveOrderLineItem":{"id":"components/schemas/OrderLineItemCustomFieldsRetrieveOrderLineItem","kind":"json-schema","title":"OrderLineItemCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order Line Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Order Line Item object.\n","title":"OrderLineItemCustomFields","type":"object"}},"components/schemas/OrderLineItemCommonRetrieveOrderLineItem":{"id":"components/schemas/OrderLineItemCommonRetrieveOrderLineItem","kind":"json-schema","title":"OrderLineItem","data":{"properties":{"UOM":{"description":"Specifies the units to measure usage.\n","type":"string"},"accountingCode":{"description":"The accountingCode for the Order Line Item.\n","type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available in the request body schema only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available in the request body schema only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}],"type":"string"},"amendedByOrderOn":{"description":"The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue.\n","format":"date","type":"string"},"amountPerUnit":{"description":"The actual charged amount per unit for the Order Line Item.\n","type":"number"},"billTargetDate":{"description":"The target date for the Order Line Item to be picked up by bill run for billing.\n","format":"date","type":"string"},"billTo":{"description":"The ID of the bill-to contact of an order line item. An existing contact under the billing account is specified as the bill-to contact of the order line item. The billing account is the order account.\n","type":"string"},"billToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the bill-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"billingRule":{"description":"The billing rule for the Order Line Item.\n","enum":["TriggerWithoutFulfillment","TriggerAsFulfillmentOccurs"],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available in the request body schema only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available in the request body schema only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available in the request body schema only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}],"type":"string"},"currency":{"description":"The currency for the order line item. You can specify a currency when creating an order line item through the \"Create an order\" operation.\n","type":"string"},"customFields":{"$ref":"#/components/schemas/OrderLineItemCustomFieldsRetrieveOrderLineItem"},"deferredRevenueAccountingCode":{"description":"The deferred revenue accounting code for the Order Line Item.\n","type":"string"},"description":{"description":"The description of the Order Line Item.\n","type":"string"},"discount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field shows the total discount amount that is applied to an order line item after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The inline discount is applied to the list price of an order line item (see the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field)."},"children":[]}]}]}],"type":"number"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a credit memo is generated by a bill run from a returned or fulfillment-related  order line item, Zuora carries this value from the source order line item to the  credit memo item."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude Order Line Item from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"inlineDiscountPerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used in accordance with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, in the following manner:"},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount percentage is 5%."},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount amount on each unit of the order line item is 10."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"type":"number"},"inlineDiscountType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to specify the inline discount type, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"None"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"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 field is used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"enum":["Percentage","FixedAmount","None"],"type":"string"},"invoiceOwnerAccountId":{"description":"The account ID of the invoice owner of the order line item.\n","type":"string"},"invoiceOwnerAccountName":{"description":"The account name of the invoice owner of the order line item.\n","type":"string"},"invoiceOwnerAccountNumber":{"description":"The account number of the invoice owner of the order line item.\n","type":"string"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"itemCategory":{"default":"Sales","description":"The category for the Order Line Item, to indicate a product sales or return.\n","enum":["Sales","Return"],"type":"string"},"itemName":{"description":"The name of the Order Line Item.\n","type":"string"},"itemNumber":{"description":"The number for the Order Line Item.\n","type":"string"},"itemState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the Order Line Item. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State transitions for an order, order line item, and fulfillment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["Draft","Executing","Booked","SentToBilling","Complete","Cancelled"],"type":"string"},"itemType":{"description":"The type of the Order Line Item.\n","enum":["Product","Fee","Services"],"type":"string"},"listPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity"},"children":[]}]}]}],"type":"number"},"listPricePerUnit":{"description":"The list price per unit for the Order Line Item.\n","type":"number"},"originalOrderDate":{"description":"The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue.\n","format":"date","type":"string"},"originalOrderId":{"description":"The ID of the original sales order for a return order line item.\n","type":"string"},"originalOrderLineItemId":{"description":"The ID of the original sales order line item for a return order line item.\n","type":"string"},"originalOrderLineItemNumber":{"description":"The number of the original sales order line item for a return order line item.\n","type":"string"},"originalOrderNumber":{"description":"The number of the original sales order for a return order line item.\n","type":"string"},"ownerAccountId":{"description":"The account ID of the owner of the order line item.\n","type":"string"},"ownerAccountName":{"description":"The account name of the owner of the order line item.\n","type":"string"},"ownerAccountNumber":{"description":"The account number of the owner of the order line item.\n","type":"string"},"productCode":{"description":"The product code for the Order Line Item.\n","type":"string"},"productRatePlanChargeId":{"description":"Id of a Product Rate Plan Charge. Only one-time charges are supported.\n","type":"string"},"purchaseOrderNumber":{"description":"Used by customers to specify the Purchase Order Number provided by the buyer.\n","type":"string"},"quantity":{"description":"The quantity of units, such as the number of authors in a hosted wiki service.\n","type":"number"},"quantityAvailableForReturn":{"description":"The quantity that can be returned for an order line item. \n","type":"number"},"quantityFulfilled":{"description":"The fulfilled quantity for an order line item. \n","type":"number"},"quantityPendingFulfillment":{"description":"The quantity to fulfill for an order line item. \n","type":"number"},"recognizedRevenueAccountingCode":{"description":"The recognized revenue accounting code for the Order Line Item.\n","type":"string"},"relatedSubscriptionNumber":{"description":"Use this field to relate an order line item to an subscription. Specify this field to the subscription number of the subscription to relate.\n","type":"string"},"requiresFulfillment":{"description":"The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.\n","type":"boolean"},"revenueRecognitionRule":{"description":"The Revenue Recognition rule for the Order Line Item.\n","type":"string"},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"sequenceSetId":{"description":"The ID of the sequence set associated with the OrderLineItem.\n","type":"string","nullable":true},"communicationProfileId":{"description":"The ID of the communication profile associated with the subscription.\n","type":"string","nullable":true},"shipTo":{"description":"The ID of a contact that belongs to the owner account or billing account of the order line item. Use this field to assign an existing account as the ship-to contact of an order line item.\n","type":"string"},"shipToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the ship-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"soldTo":{"description":"The ID of a contact that belongs to the owner account or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item.\n","type":"string"},"soldToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"taxCode":{"description":"The tax code for the Order Line Item.\n","type":"string"},"taxMode":{"description":"The tax mode for the Order Line Item.\n","enum":["TaxInclusive","TaxExclusive"],"type":"string"},"transactionEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"format":"date","type":"string"},"transactionStartDate":{"description":"The date a transaction starts. The default value of this field is the order date.\n","format":"date","type":"string"},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available in the request body schema only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}],"type":"string"}},"title":"OrderLineItem","type":"object"}},"components/schemas/FulfillmentCustomFields":{"id":"components/schemas/FulfillmentCustomFields","kind":"json-schema","title":"FulfillmentCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Fulfillment object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Fulfillment object.\n","title":"FulfillmentCustomFields","type":"object"}},"components/schemas/FulfillmentCommon":{"id":"components/schemas/FulfillmentCommon","kind":"json-schema","title":"Fulfillment","data":{"properties":{"billTargetDate":{"description":"The target date for the Fulfillment to be picked up by bill run for billing.\n","format":"date","type":"string"},"carrier":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The carrier of the Fulfillment. The available values can be configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fulfillment Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through Zuora UI."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/FulfillmentCustomFields"},"description":{"description":"The description of the Fulfillment.\n","type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude Fulfillment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude Fulfillment from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"externalId":{"description":"The external id of the Fulfillment.\n","type":"string"},"fulfillmentDate":{"description":"The date of the Fulfillment.\n","format":"date","type":"string"},"fulfillmentLocation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fulfillment location of the Fulfillment. The available values can be configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fulfillment Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through Zuora UI."},"children":[]}]}]}],"type":"string"},"fulfillmentSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fulfillment system of the Fulfillment. The available values can be configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fulfillment Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through Zuora UI."},"children":[]}]}]}],"type":"string"},"fulfillmentType":{"description":"The type of the Fulfillment. \n","enum":["Delivery","Return"],"type":"string"},"orderLineItemId":{"description":"The reference id of the related Order Line Item.\n","format":"UUID","type":"string"},"quantity":{"description":"The quantity of the Fulfillment.\n","type":"number"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the Fulfillment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State transitions for an order, order line item, and fulfillment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["Executing","Booked","SentToBilling","Complete","Cancelled"],"type":"string"},"trackingNumber":{"description":"The tracking number of the Fulfillment.\n","type":"string"}},"title":"Fulfillment","type":"object"}},"components/schemas/FulfillmentGet":{"id":"components/schemas/FulfillmentGet","kind":"json-schema","title":"FulfillmentGet","data":{"allOf":[{"properties":{"fulfillmentNumber":{"description":"The sytem generated number for the Fulfillment.\n","type":"string"},"id":{"description":"The sytem generated Id.\n","format":"UUID","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/FulfillmentCommon"}]}},"components/schemas/OrderLineItem":{"id":"components/schemas/OrderLineItem","kind":"json-schema","title":"OrderLineItem","data":{"allOf":[{"properties":{"amount":{"description":"The calculated gross amount for the Order Line Item.\n","type":"number"},"amountWithoutTax":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The calculated gross amount for an order line item excluding tax. If the tax mode is tax exclusive, the value of this field equals that of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"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 tax mode of an order line item is not set, the system treats it as tax exclusive by default. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountWithoutTax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field equals that of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"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 you create an order line item from the product catalog, the tax mode and tax code of the product rate plan charge are used for the order line item by default. You can still overwrite this default set-up by setting the tax mode and tax code of the order line item."},"children":[]}]}]}],"type":"number"},"id":{"description":"The sytem generated Id for the Order Line Item.\n","format":"UUID","type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-grouping"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Grouping"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","maxLength":255,"nullable":true},"quantityFulfilled":{"description":"The quantity that has been fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state.\n","type":"number"},"quantityPendingFulfillment":{"description":"The quantity that needs to be fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state.\n","type":"number"}},"type":"object"},{"$ref":"#/components/schemas/OrderLineItemCommonRetrieveOrderLineItem"},{"properties":{"fulfillments":{"description":"Container for the fulfillments attached to an order line item.\n","items":{"$ref":"#/components/schemas/FulfillmentGet"},"type":"array"}},"type":"object"}]}},"components/schemas/GetOrderLineItemResponseType":{"id":"components/schemas/GetOrderLineItemResponseType","kind":"json-schema","title":"GetOrderLineItemResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"orderLineItem":{"$ref":"#/components/schemas/OrderLineItem"}},"type":"object"}],"example":{"success":true,"orderLineItems":[{"id":"8a90e4a7932049480193247166783bfe","itemState":"Executing"}]}}},"components/schemas/OrderLineItemCommon":{"id":"components/schemas/OrderLineItemCommon","kind":"json-schema","title":"OrderLineItem","data":{"properties":{"UOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units to measure usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"accountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accountingCode for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"amountPerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual charged amount per unit for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"number"},"billTargetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the Order Line Item (OLI) to be picked up by bill run for generating billing documents."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate billing documents for an OLI, you must set this field and set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"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":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"format":"date","type":"string"},"billTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact of an order line item. Specify an existing contact under the billing account as the bill-to contact of the order line item. The billing account is the order account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"billingRule":{"default":"TriggerWithoutFulfillment","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rule for billing of the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when it is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["TriggerWithoutFulfillment","TriggerAsFulfillmentOccurs"],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object.  This field is available only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/OrderLineItemCustomFields"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deferred revenue accounting code for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related rate plan charges and order line items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"inlineDiscountPerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"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 field in accordance with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, in the following manner:"},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount percentage is 5%."},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount amount on each unit of the order line item is 10."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"type":"number"},"inlineDiscountType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"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 field to specify the inline discount type, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"None"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"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 field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"enum":["Percentage","FixedAmount","None"],"type":"string"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"itemName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"itemState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the Order Line Item (OLI). See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State transitions for an order, order line item, and fulfillment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate invoice for an OLI, you must set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billTargetDate"},"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":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or 'Booked' or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["Draft","Executing","Booked","SentToBilling","Complete","Canceled"],"type":"string"},"itemType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["Product","Fee","Services"],"type":"string"},"listPricePerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price per unit for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"number"},"ownerAccountNumber":{"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 assign an existing account as the owner of an order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"productCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product code for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"purchaseOrderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used by customers to specify the Purchase Order Number provided by the buyer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quantity of units, such as the number of authors in a hosted wiki service."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"number"},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recognized revenue accounting code for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"relatedSubscriptionNumber":{"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 relate an order line item to an subscription. Specify this field to the subscription number of the subscription to relate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"revenueRecognitionRule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Revenue Recognition rule for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"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":"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"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":"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-grouping"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Grouping"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify this field on a sales order line item when its state (that is, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string","maxLength":255,"nullable":true},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID or number of the sequence set associated with the order line item."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify this field on a sales order line item when its state (that is, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment term name associated with the order line item."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify this field on a sales order line item when its state (that is, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string"},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the order line item."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify this field on a sales order line item when its state (that is, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string"},"shipTo":{"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 assign an existing account as the ship-to contact of an order line item, by the following rules:"},"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":"ownerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item."},"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":"ownerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item. The billing account is the order account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"soldTo":{"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 assign an existing account as the sold-to contact of an order line item, by the following rules:"},"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":"ownerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item."},"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":"ownerAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item. The billing account is the order account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["TaxInclusive","TaxExclusive"],"type":"string"},"transactionEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionStartDate"},"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":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","type":"string"},"transactionStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date a transaction starts. The default value of this field is the order date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","type":"string"},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object. This field is available only if you have enabled "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"}},"title":"OrderLineItem","type":"object"}},"components/schemas/PUTOrderLineItemRequestType":{"id":"components/schemas/PUTOrderLineItemRequestType","kind":"json-schema","title":"PUTOrderLineItemRequestType","data":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemCommon"}],"example":{"description\"":"Details of the order line item"}}},"components/schemas/PutOrderLineItemResponseType":{"id":"components/schemas/PutOrderLineItemResponseType","kind":"json-schema","title":"PutOrderLineItemResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"}]}},"components/schemas/PostOrderLineItemUpdateType":{"id":"components/schemas/PostOrderLineItemUpdateType","kind":"json-schema","title":"PostOrderLineItemUpdateType","data":{"allOf":[{"properties":{"id":{"description":"The sytem generated Id for the Order Line Item(OLI). Use this field to specify which OLI to update.\n","format":"UUID","type":"string"}},"required":["id"],"type":"object"},{"$ref":"#/components/schemas/OrderLineItemCommon"}]}},"components/schemas/BillingOptions":{"id":"components/schemas/BillingOptions","kind":"json-schema","title":"BillingOptions","data":{"properties":{"documentDate":{"description":"The invoice date displayed on the billing document.","format":"date","type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges for order line items if a billing document is generated. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-bill-runs-creation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is a Target Date?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"}},"components/schemas/ProcessingOptions":{"id":"components/schemas/ProcessingOptions","kind":"json-schema","title":"ProcessingOptions","data":{"description":"Processing options for generating billing documents.","properties":{"billingOptions":{"$ref":"#/components/schemas/BillingOptions"},"runBilling":{"description":"Indicates if the current request needs to generate a billing document. The billing document will be generated against all Order Line Items included in this order.","type":"boolean"}},"type":"object"}},"components/schemas/PostOrderLineItemsRequestType":{"id":"components/schemas/PostOrderLineItemsRequestType","kind":"json-schema","title":"PostOrderLineItemsRequestType","data":{"example":{"orderLineItems":[{"id":"8a90e4a7932049480193247166783bfe","description":"Details of the order line item"}]},"properties":{"orderLineItems":{"items":{"$ref":"#/components/schemas/PostOrderLineItemUpdateType"},"type":"array"},"processingOptions":{"$ref":"#/components/schemas/ProcessingOptions"}},"type":"object"}},"components/schemas/FulfillmentItemCustomFields":{"id":"components/schemas/FulfillmentItemCustomFields","kind":"json-schema","title":"FulfillmentItemCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Fulfillment Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Fulfillment Item object.\n","title":"FulfillmentItemCustomFields","type":"object"}},"components/schemas/FulfillmentItemCommon":{"id":"components/schemas/FulfillmentItemCommon","kind":"json-schema","title":"FulfillmentItem","data":{"properties":{"customFields":{"$ref":"#/components/schemas/FulfillmentItemCustomFields"},"description":{"description":"The description of the Fulfillment Item.\n","type":"string"},"itemIdentifier":{"description":"The external identifier of the Fulfillment Item.\n","type":"string"}},"title":"FulfillmentItem","type":"object"}},"components/schemas/FulfillmentItemPostFromFulfillmentPost":{"id":"components/schemas/FulfillmentItemPostFromFulfillmentPost","kind":"json-schema","title":"FulfillmentItemPostFromFulfillmentPost","data":{"allOf":[{"$ref":"#/components/schemas/FulfillmentItemCommon"}]}},"components/schemas/FulfillmentPost":{"id":"components/schemas/FulfillmentPost","kind":"json-schema","title":"FulfillmentPost","data":{"allOf":[{"properties":{"orderLineItemId":{"description":"The reference id of the related Order Line Item.\n","format":"UUID","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/FulfillmentCommon"},{"properties":{"fulfillmentItems":{"items":{"$ref":"#/components/schemas/FulfillmentItemPostFromFulfillmentPost"},"type":"array"}},"type":"object"}]}},"components/schemas/PostFulfillmentsRequestType":{"id":"components/schemas/PostFulfillmentsRequestType","kind":"json-schema","title":"PostFulfillmentsRequestType","data":{"example":{"fulfillments":[{"billTargetDate":"2022-01-01","fulfillmentDate":"2022-01-01","fulfillmentType":"Delivery","orderLineItemId":"4028828c82819b740182821bb23e15c4","quantity":5,"state":"SentToBilling"},{"billTargetDate":"2022-01-01","fulfillmentDate":"2022-01-01","fulfillmentType":"Delivery","orderLineItemId":"4028828c82819b740182821bb23e15c4","quantity":5,"state":"SentToBilling"}],"processingOptions":{"billingOptions":{"documentDate":"2022-01-01","targetDate":"2022-01-01"},"collectPayment":true,"runBilling":true}},"properties":{"fulfillments":{"items":{"$ref":"#/components/schemas/FulfillmentPost"},"type":"array"},"processingOptions":{"$ref":"#/components/schemas/ProcessingOptions"}},"type":"object"}},"components/schemas/PostFulfillmentsResponseType":{"id":"components/schemas/PostFulfillmentsResponseType","kind":"json-schema","title":"PostFulfillmentsResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"creditMemoNumbers":{"description":"An array of the credit memo numbers generated in this request. The credit memo is only available if you have the Invoice Settlement feature enabled.\n","items":{"type":"string"},"type":"array","nullable":true},"fulfillments":{"items":{"properties":{"fulfillmentItems":{"items":{"properties":{"id":{"description":"The sytem generated Id.\n","format":"UUID","type":"string"}},"type":"object"},"type":"array"},"fulfillmentNumber":{"description":"The sytem generated number for the Fulfillment.\n","type":"string"},"id":{"description":"The sytem generated Id.\n","format":"UUID","type":"string"}},"type":"object"},"type":"array"},"invoiceNumbers":{"description":"An array of the invoice numbers generated in this request. Normally it includes one invoice number only.\n","items":{"type":"string"},"type":"array"},"paidAmount":{"description":"The total amount collected in this request.\n","type":"number"},"paymentNumber":{"description":"The payment number collected in this request.\n","type":"string"}},"type":"object"}]}},"components/schemas/GetFulfillmentResponseType":{"id":"components/schemas/GetFulfillmentResponseType","kind":"json-schema","title":"GetFulfillmentResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"fulfillment":{"$ref":"#/components/schemas/FulfillmentGet"}},"type":"object"}]}},"components/schemas/PutFulfillmentRequestType":{"id":"components/schemas/PutFulfillmentRequestType","kind":"json-schema","title":"PutFulfillmentRequestType","data":{"example":{"billTargetDate":"2022-01-01","fulfillmentDate":"2022-01-01","fulfillmentType":"Delivery","quantity":5,"state":"SentToBilling"},"properties":{"billTargetDate":{"description":"The target date for the Fulfillment to be picked up by bill run for billing.\n","format":"date","type":"string"},"carrier":{"description":"The carrier of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.\n","type":"string"},"customFields":{"$ref":"#/components/schemas/FulfillmentCustomFields"},"description":{"description":"The description of the Fulfillment.\n","type":"string"},"externalId":{"description":"The external id of the Fulfillment.\n","type":"string"},"fulfillmentDate":{"description":"The date of the Fulfillment.\n","format":"date","type":"string"},"fulfillmentLocation":{"description":"The fulfillment location of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.\n","type":"string"},"fulfillmentSystem":{"description":"The fulfillment system of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.\n","type":"string"},"quantity":{"description":"The quantity of the Fulfillment.\n","type":"number"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the Fulfillment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Item states, Order states, and state transitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["Executing","Booked","SentToBilling","Complete","Cancelled"],"type":"string"},"trackingNumber":{"description":"The tracking number of the Fulfillment.\n","type":"string"}},"type":"object"}},"components/schemas/FulfillmentItemPost":{"id":"components/schemas/FulfillmentItemPost","kind":"json-schema","title":"FulfillmentItemPost","data":{"allOf":[{"properties":{"fulfillmentNumber":{"description":"The reference of the related Fulfillment.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/FulfillmentItemCommon"}]}},"components/schemas/PostFulfillmentItemsRequestType":{"id":"components/schemas/PostFulfillmentItemsRequestType","kind":"json-schema","title":"PostFulfillmentItemsRequestType","data":{"example":{"fulfillmentItems":[{"customFields":{"PICKLIST_CF__c":"option_1"},"description":"description1","fulfillmentNumber":"F-00000001","itemIdentifier":"0c27b769-5bba-46a5-80aa-cdd95f931216"},{"customFields":{"PICKLIST_CF__c":"option_2"},"description":"description2","fulfillmentNumber":"F-00000001","itemIdentifier":"456d3812-33d2-454c-b272-4c5a9a3e2742"}]},"properties":{"fulfillmentItems":{"items":{"$ref":"#/components/schemas/FulfillmentItemPost"},"type":"array"}},"type":"object"}},"components/schemas/PostFulfillmentItemsResponseType":{"id":"components/schemas/PostFulfillmentItemsResponseType","kind":"json-schema","title":"PostFulfillmentItemsResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"fulfillmentItems":{"items":{"properties":{"id":{"description":"The sytem generated Id.\n","format":"UUID","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}]}},"components/schemas/FulfillmentItemGet":{"id":"components/schemas/FulfillmentItemGet","kind":"json-schema","title":"FulfillmentItemGet","data":{"allOf":[{"properties":{"fulfillmentId":{"description":"The reference id of the related Fulfillment.\n","format":"UUID","type":"string"},"id":{"description":"The sytem generated Id.\n","format":"UUID","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/FulfillmentItemCommon"}]}},"components/schemas/GetFulfillmentItemResponseType":{"id":"components/schemas/GetFulfillmentItemResponseType","kind":"json-schema","title":"GetFulfillmentItemResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"fulfillmentItem":{"$ref":"#/components/schemas/FulfillmentItemGet"}},"type":"object"}]}},"components/schemas/PutFulfillmentItemRequestType":{"id":"components/schemas/PutFulfillmentItemRequestType","kind":"json-schema","title":"PutFulfillmentItemRequestType","data":{"example":{"customFields":{"PICKLIST_CF__c":"option_1"},"description":"description1","itemIdentifier":"0c27b769-5bba-46a5-80aa-cdd95f931216"},"properties":{"customFields":{"$ref":"#/components/schemas/FulfillmentItemCustomFields"},"description":{"description":"The description of the Fulfillment Item.\n","type":"string"},"itemIdentifier":{"description":"The external identifier of the Fulfillment Item.\n","type":"string"}},"type":"object"}},"components/schemas/GETRampByRampNumberResponseType":{"id":"components/schemas/GETRampByRampNumberResponseType","kind":"json-schema","title":"GETRampByRampNumberResponseType","data":{"allOf":[{"properties":{"ramp":{"$ref":"#/components/schemas/RampResponse"}},"type":"object"},{"$ref":"#/components/schemas/CommonResponse"}]}},"components/schemas/RampIntervalMetrics":{"id":"components/schemas/RampIntervalMetrics","kind":"json-schema","title":"RampIntervalMetrics","data":{"properties":{"description":{"description":"The short description of the interval.","type":"string"},"discountTcb":{"description":"The discount amount for the TCB.","type":"number"},"discountTcv":{"description":"The discount amount for the TCV.","type":"number"},"endDate":{"description":"The end date of the interval.","format":"date","type":"string"},"grossTcb":{"description":"The gross TCB value before discount charges are applied.","type":"number"},"grossTcv":{"description":"The gross TCV value before discount charges are applied.","type":"number"},"intervalMetrics":{"description":"Container for the detailed metrics for each rate plan charge in each ramp interval.","items":{"$ref":"#/components/schemas/RampIntervalChargeMetrics"},"type":"array"},"name":{"description":"The name of the interval.","type":"string"},"netTcb":{"description":"The net TCB value after discount charges are applied.","type":"number"},"netTcv":{"description":"The net TCV value after discount charges are applied.","type":"number"},"startDate":{"description":"The start date of the interval.","format":"date","type":"string"}},"type":"object"}},"components/schemas/RampMetrics":{"id":"components/schemas/RampMetrics","kind":"json-schema","title":"RampMetrics","data":{"properties":{"description":{"description":"The short description of the ramp.","type":"string"},"discountTcb":{"description":"The discount amount for the TCB.","type":"number"},"discountTcv":{"description":"The discount amount for the TCV.","type":"number"},"grossTcb":{"description":"The gross TCB value before discount charges are applied.","type":"number"},"grossTcv":{"description":"The gross TCV value before discount charges are applied.","type":"number"},"intervals":{"description":"Container for the intervals that the ramp is split into in its timeline.","items":{"$ref":"#/components/schemas/RampIntervalMetrics"},"type":"array"},"name":{"description":"The name of the ramp.","type":"string"},"netTcb":{"description":"The net TCB value after discount charges are applied.","type":"number"},"netTcv":{"description":"The net TCV value after discount charges are applied.","type":"number"},"number":{"description":"The number of the ramp. It is automaticcally generated by the billing system.","type":"string"}},"type":"object"}},"components/schemas/GETRampMetricsByRampNumberResponseType":{"id":"components/schemas/GETRampMetricsByRampNumberResponseType","kind":"json-schema","title":"GETRampMetricsByRampNumberResponseType","data":{"allOf":[{"properties":{"rampMetrics":{"$ref":"#/components/schemas/RampMetrics"}},"type":"object"},{"$ref":"#/components/schemas/CommonResponse"}]}},"components/schemas/GETRampsBySubscriptionKeyResponseType":{"id":"components/schemas/GETRampsBySubscriptionKeyResponseType","kind":"json-schema","title":"GETRampsBySubscriptionKeyResponseType","data":{"allOf":[{"properties":{"ramps":{"items":{"$ref":"#/components/schemas/RampResponse"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/CommonResponse"}]}},"components/schemas/GETRampMetricsBySubscriptionKeyResponseType":{"id":"components/schemas/GETRampMetricsBySubscriptionKeyResponseType","kind":"json-schema","title":"GETRampMetricsBySubscriptionKeyResponseType","data":{"allOf":[{"properties":{"rampMetrics":{"$ref":"#/components/schemas/RampMetrics"}},"type":"object"},{"$ref":"#/components/schemas/CommonResponse"}]}},"components/schemas/GETRampMetricsByOrderNumberResponseType":{"id":"components/schemas/GETRampMetricsByOrderNumberResponseType","kind":"json-schema","title":"GETRampMetricsByOrderNumberResponseType","data":{"allOf":[{"properties":{"rampMetrics":{"items":{"$ref":"#/components/schemas/OrderRampMetrics"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/CommonResponse"}]}},"components/schemas/POSTSubscriptionPreviewTypePreviewAccountInfo":{"id":"components/schemas/POSTSubscriptionPreviewTypePreviewAccountInfo","kind":"json-schema","title":"previewAccountInfo","data":{"allOf":[{"properties":{"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = end-of-month), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for auto-set."},"children":[]}]}]}],"format":"int64","type":"integer"},"billToContact":{"description":"Container for bill-to contact information of this account.\n","properties":{"city":{"description":"The city of the bill-to address. The value should be 40 characters or less.\n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country of the bill-to address. The value must be a valid country name or abbreviation."},"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":" You must specify this field if you are using Zuora Tax for this account."},"children":[]}]}]}],"type":"string"},"county":{"description":"The county of the bill-to address. The value should be 32 characters or less.\n","type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the bill-to address. The value must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You must specify this field if you are using Zuora Tax for this account and the country is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canada"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax rules.\n","type":"string","nullable":true},"zipCode":{"description":"The zip code of the bill-to address. The value should be 20 characters or less.\n","type":"string"}},"type":"object"},"currency":{"description":"A currency as defined in Billing Settings.\n","type":"string"}},"required":["billCycleDay","billToContact","currency"],"type":"object"},{"$ref":"#/components/schemas/AccountObjectNSFields"},{"$ref":"#/components/schemas/AccountObjectCustomFields"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A container for providing a customer account information if you do not have an existing customer account. This customer account information is only used for subscription preview."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify the account information either in this field or in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with the following conditions:"},"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 you already have a customer account, specify the account number or ID in the accountKey field."},"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 have a customer account, provide account information in this field."},"children":[]}]}]}]}],"title":"previewAccountInfo"}},"components/schemas/POSTSubscriptionPreviewType":{"id":"components/schemas/POSTSubscriptionPreviewType","kind":"json-schema","title":"POSTSubscriptionPreviewType","data":{"allOf":[{"properties":{"accountKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer account number or ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify the account information either in this field or in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewAccountInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with the following conditions:"},"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 you already have a customer account, specify the account number or ID in this field."},"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 have a customer account, provide account information in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewAccountInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}],"type":"string"},"contractEffectiveDate":{"description":"Effective contract date for this subscription, as yyyy-mm-dd.\n","format":"date","type":"string"},"customerAcceptanceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default value is dependent on the value of other fields. See "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more details."},"children":[]}]}]}],"format":"date","type":"string"},"documentDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the billing document, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos."},"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 field is specified, the specified date is used as the billing document date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, the date specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used as the billing document date."},"children":[]}]}]}]}],"format":"date","type":"string"},"includeExistingDraftDocItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include draft invoice items in subscription previews."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Includes draft invoice items in the preview result."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Excludes draft invoice items in the preview result."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"boolean"},"initialTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the first term of the subscription, in whole months. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then this field is required, and the value must be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is ignored."},"children":[]}]}]}],"format":"int64","type":"integer"},"initialTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type of the initial term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values 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":"Month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default period type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"invoiceOwnerAccountKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice owner account number or ID."},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"notes":{"description":"The notes for the subscription.","maxLength":1000,"type":"string"},"previewAccountInfo":{"$ref":"#/components/schemas/POSTSubscriptionPreviewTypePreviewAccountInfo"},"previewType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of preview you will receive."},"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":": If your API minor version is earlier than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"206.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for this request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"206.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or earlier, the following values are supported for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field:"},"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":"InvoiceItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeMetrics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceItemChargeMetrics"},"children":[]}]}]}]}],"enum":["LegalDoc","ChargeMetrics","LegalDocChargeMetrics"],"type":"string","default":"LegalDoc"},"serviceActivationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default value is dependent on the value of other fields. See "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more details."},"children":[]}]}]}],"format":"date","type":"string"},"skipTax":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will bypass the tax calculation during subscription preview."},"children":[]}]}]}],"default":false,"type":"boolean"},"subscribeToRatePlans":{"description":"Container for one or more rate plans for this subscription.\n","items":{"$ref":"#/components/schemas/POSTSrpCreateType"},"type":"array"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date."},"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 only available if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"termStartDate":{"description":"The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.\n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"required":["termType","contractEffectiveDate","subscribeToRatePlans"],"type":"object"},{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"}],"example":{"accountKey":"8ad09be48db5aba7018db604776d4854","contractEffectiveDate":"2024-07-01","termType":"TERMED","initialTerm":12,"subscribeToRatePlans":[{"productRatePlanId":"8ad081dd9096ef9501909b40bb4e74a4"}]}}},"components/schemas/POSTSubscriptionPreviewTaxationItemsType":{"id":"components/schemas/POSTSubscriptionPreviewTaxationItemsType","kind":"json-schema","title":"taxationItems","data":{"properties":{"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","type":"number"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":"The identifier for the location based on the value of the taxCode field.\n","type":"string"},"name":{"description":"The name of the taxation item.\n","type":"string"},"taxAmount":{"description":"The tax amount of the invoice item.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific invoice.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":"The date when the tax is applied to the invoice.\n","type":"string"},"taxRate":{"description":"The tax rate applied to the invoice. ","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"Enum:\"Percentage\" \"FlatFee\". The type of the tax rate applied to the invoice.\n","enum":["Percentage","FlatFee"],"type":"string"}},"title":"taxationItems","type":"object"}},"components/schemas/POSTSubscriptionPreviewCreditMemoItemsType":{"id":"components/schemas/POSTSubscriptionPreviewCreditMemoItemsType","kind":"json-schema","title":"creditMemoItems","data":{"properties":{"amountWithoutTax":{"description":"The credit memo item amount excluding tax.\n","format":"double","type":"number"},"chargeAmount":{"description":"The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax\n","format":"double","type":"number"},"chargeDescription":{"description":"Description of this credit memo item.\n","type":"string"},"chargeName":{"description":"Name of this credit memo item.\n","type":"string"},"productName":{"description":"Name of the product associated with this credit memo item.\n","type":"string"},"productRatePlanChargeId":{"description":"ID of the product rate plan charge associated with this credit memo item.\n","type":"string"},"quantity":{"description":"Quantity of the charge associated with this credit memo item.\n","type":"integer"},"serviceEndDate":{"description":"End date of the service period for this credit memo item, as yyyy-mm-dd.\n","format":"date","type":"string"},"serviceStartDate":{"description":"Service start date of this credit memo item, as yyyy-mm-dd.\n","format":"date","type":"string"},"taxAmount":{"description":"The tax amount of the credit memo item.\n","format":"double","type":"number"},"taxationItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of taxation items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"315.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/POSTSubscriptionPreviewTaxationItemsType"},"type":"array"},"unitOfMeasure":{"description":"Unit used to measure consumption.","type":"string"}},"title":"creditMemoItems","type":"object"}},"components/schemas/POSTSubscriptionPreviewInvoiceItemsType":{"id":"components/schemas/POSTSubscriptionPreviewInvoiceItemsType","kind":"json-schema","title":"invoiceItems","data":{"properties":{"chargeAmount":{"description":"The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive.\n","type":"number"},"chargeDescription":{"description":"Description of the charge.\n","type":"string"},"chargeName":{"description":"Name of the charge.\n","type":"string"},"productName":{"description":"Name of the product associated with this item.\n","type":"string"},"productRatePlanChargeId":{"description":"ID of the product rate plan charge.\n","type":"string"},"quantity":{"description":"Quantity of this item.\n","type":"number"},"serviceEndDate":{"description":"End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd.\n","format":"date","type":"string"},"serviceStartDate":{"description":"Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge.\n","format":"date","type":"string"},"taxAmount":{"description":"The tax amount of the invoice item.\n","format":"double","type":"number"},"taxationItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of taxation items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"315.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/POSTSubscriptionPreviewTaxationItemsType"},"type":"array"},"unitOfMeasure":{"description":"","type":"string"}},"title":"invoiceItems","type":"object"}},"components/schemas/POSTSubscriptionPreviewResponseType":{"id":"components/schemas/POSTSubscriptionPreviewResponseType","kind":"json-schema","title":"POSTSubscriptionPreviewResponseType","data":{"properties":{"chargeMetrics":{"description":"Container for charge metrics.\n","properties":{"dmrr":{"description":"Change in monthly recurring revenue.\n","type":"string"},"dtcv":{"description":"Change in total contract value.\n","type":"string"},"mrr":{"description":"Monthly recurring revenue.\n","type":"string"},"number":{"description":"The charge number of the subscription. Only available for update subscription.\n","type":"string"},"originRatePlanId":{"description":"The origin rate plan ID. Only available for update subscription.\n","type":"string"},"originalId":{"description":"The original rate plan charge ID. Only available for update subscription.\n","type":"string"},"productRatePlanChargeId":{"description":"The product rate plan charge ID.\n","type":"string"},"productRatePlanId":{"description":"The product rate plan ID.\n","type":"string"},"tcv":{"description":"Total contract value.\n","type":"string"}},"type":"object"},"contractedMrr":{"description":"Monthly recurring revenue of the subscription.\n","type":"number"},"creditMemo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for credit memos."},"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 container is only available if you are on the latest Zuora API version or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":",  and you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"properties":{"amount":{"description":"Credit memo amount.","format":"double","type":"number"},"amountWithoutTax":{"description":"Credit memo amount minus tax.","format":"double","type":"number"},"creditMemoItems":{"description":"","items":{"$ref":"#/components/schemas/POSTSubscriptionPreviewCreditMemoItemsType"},"type":"array"},"taxAmount":{"description":"Tax amount on the credit memo.","format":"double","type":"number"}},"type":"object"},"documentDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the billing document, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos."},"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 field is specified, the specified date is used as the billing document date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, the date specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used as the billing document date."},"children":[]}]}]}]}],"format":"date","type":"string"},"invoice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for invoices."},"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 only available if you set the Zuora REST API minor version to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header. Also, the response structure is changed and the following invoice related response fields are moved to this "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" container:"},"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":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amountWithoutTax"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceItems"},"children":[]}]}]}]}],"properties":{"amount":{"description":"Invoice amount.","type":"number"},"amountWithoutTax":{"description":"Invoice amount minus tax.\n","type":"number"},"invoiceItems":{"description":"Container for invoice items.\n","items":{"$ref":"#/components/schemas/POSTSubscriptionPreviewInvoiceItemsType"},"type":"array"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date."},"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 only available if you set the Zuora REST API minor version to 207.0 or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header."},"children":[]}]}]}],"type":"string"},"taxAmount":{"description":"The tax amount of the invoice.\n","type":"number"}},"type":"object"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date."},"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 only available if you set the Zuora REST API minor version to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header."},"children":[]}]}]}],"format":"date","type":"string"},"taxAmount":{"description":"Tax amount on the invoice.\n","type":"number"},"totalContractedValue":{"description":"Total contracted value of the subscription.\n","type":"number"}},"type":"object"}},"components/schemas/PreviewStartDatePolicy":{"id":"components/schemas/PreviewStartDatePolicy","kind":"json-schema","title":"PreviewStartDatePolicy","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The options on how the preview start date is calculated."},"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 you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startOfTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the preview start date is the start date of the subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the preview start date is today."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify a specific date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. The date must be in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["startOfTerm","today","specificDate"],"type":"string"}},"components/schemas/PreviewStartDate":{"id":"components/schemas/PreviewStartDate","kind":"json-schema","title":"PreviewStartDate","data":{"description":"The start date of the preview.\n","properties":{"previewStartDatePolicy":{"$ref":"#/components/schemas/PreviewStartDatePolicy"},"specificDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date for the preview start date. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewStartDatePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/PreviewThruDatePolicy":{"id":"components/schemas/PreviewThruDatePolicy","kind":"json-schema","title":"PreviewThruDatePolicy","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The options on how the preview through date is calculated."},"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 you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextBillingPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the number of billing periods to preview in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextBillingPeriods"},"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":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endOfTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the preview through date is the end date of the subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify a specific date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. The date must be in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["nextBillingPeriods","endOfTerm","specificDate"],"type":"string"}},"components/schemas/PreviewThroughDate":{"id":"components/schemas/PreviewThroughDate","kind":"json-schema","title":"PreviewThroughDate","data":{"description":"The preview through date.\n","properties":{"previewThruDatePolicy":{"$ref":"#/components/schemas/PreviewThruDatePolicy"},"nextBillingPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of billing periods to preview. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewThruDatePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextBillingPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"specificDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date for the preview start date. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewThruDatePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/QuantityForUsageCharges":{"id":"components/schemas/QuantityForUsageCharges","kind":"json-schema","title":"QuantityForUsageCharges","data":{"allOf":[{"properties":{"chargeId":{"description":"The ID of the subscription charge.\n","type":"string"},"quantity":{"description":"The quantity of the subscription charge.\n","type":"number"}},"type":"object"}]}},"components/schemas/PreviewExistingSubscriptionRequest":{"id":"components/schemas/PreviewExistingSubscriptionRequest","kind":"json-schema","title":"PreviewExistingSubscriptionRequest","data":{"description":"Preview the existing subscription by subscription ID or number.\n","properties":{"previewStartDate":{"$ref":"#/components/schemas/PreviewStartDate"},"previewThroughDate":{"$ref":"#/components/schemas/PreviewThroughDate"},"quantityForUsageCharges":{"items":{"$ref":"#/components/schemas/QuantityForUsageCharges"},"type":"array","description":"Container for usage charges.\n"},"skipTax":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system will bypass the tax calculation during subscription preview."},"children":[]}]}]}],"type":"boolean"}},"type":"object","example":{"previewStartDate":{"previewStartDatePolicy":"specificDate","specificDate":"2024-01-01"},"previewThroughDate":{"previewThruDatePolicy":"nextBillingPeriods","nextBillingPeriods":"2"},"quantityForUsageCharges":[{"chargeId":"402880e78ccd1743018cce026efb002d","quantity":20}]}}},"components/schemas/PreviewExistingSubscriptionDiscountDetails":{"id":"components/schemas/PreviewExistingSubscriptionDiscountDetails","kind":"json-schema","title":"PreviewExistingSubscriptionDiscountDetails","data":{"properties":{"discountChargeName":{"type":"string","description":"The charge name of the discount."},"discountChargeNumber":{"type":"string","description":"The charge number of the discount."},"discountRate":{"type":"number","description":"The discount rate."},"serviceStartDate":{"format":"date","type":"string","description":"Start date of the service period for this discount charge."},"serviceEndDate":{"format":"date","type":"string","description":"End date of the service period for this discount charge."}},"type":"object"}},"components/schemas/PreviewExistingSubscriptionInvoiceItemResult":{"id":"components/schemas/PreviewExistingSubscriptionInvoiceItemResult","kind":"json-schema","title":"PreviewExistingSubscriptionInvoiceItemResult","data":{"properties":{"serviceStartDate":{"format":"date","type":"string","description":"Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge."},"serviceEndDate":{"format":"date","type":"string","description":"End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd."},"amountWithoutTax":{"type":"number","description":"Invoice amount minus tax.","format":"double"},"taxAmount":{"type":"number","description":"The tax amount of the invoice item.","format":"double"},"chargeDescription":{"type":"string","description":"Description of the charge."},"chargeName":{"type":"string","description":"Name of the charge."},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field was specified in the request or when the order is amending an existing subscription."},"children":[]}]}]}],"type":"string"},"productName":{"type":"string","description":"Name of the product."},"productRatePlanChargeId":{"type":"string","description":"The ID of the product rate plan charge."},"processingType":{"type":"string","description":"The processing type of the invoice item.","enum":["Charge","Discount","Tax"]},"unitPrice":{"type":"number","description":"The unit price of the charge.","format":"double"},"quantity":{"type":"number","description":"The quantity of the charge."},"unitOfMeasure":{"type":"string","description":"The unit of measure of the charge.","nullable":true},"discountDetails":{"items":{"$ref":"#/components/schemas/PreviewExistingSubscriptionDiscountDetails"},"type":"array","description":"Container for discount details."}},"type":"object"}},"components/schemas/PreviewExistingSubscriptionResultInvoices":{"id":"components/schemas/PreviewExistingSubscriptionResultInvoices","kind":"json-schema","title":"PreviewExistingSubscriptionResultInvoices","data":{"properties":{"invoiceNumber":{"type":"string","description":"The invoice number.\n"},"amount":{"type":"number","description":"Invoice amount.\n","format":"double"},"amountWithoutTax":{"type":"number","description":"Invoice amount minus tax.\n","format":"double"},"taxAmount":{"type":"number","description":"The tax amount of the invoice.\n","format":"double"},"targetDate":{"format":"date","type":"string","description":"Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd.\n"},"invoiceItems":{"items":{"$ref":"#/components/schemas/PreviewExistingSubscriptionInvoiceItemResult"},"type":"array","description":"The container for invoice items.\n"},"status":{"type":"string","description":"The status of the invoice.\n","enum":["Draft","Posted",null],"nullable":true},"isFromExistingInvoice":{"type":"boolean","description":"Indicates whether the invoice information is from an existing invoice.\n"}},"type":"object"}},"components/schemas/PreviewExistingSubscriptionCreditMemoItemResult":{"id":"components/schemas/PreviewExistingSubscriptionCreditMemoItemResult","kind":"json-schema","title":"PreviewExistingSubscriptionCreditMemoItemResult","data":{"properties":{"serviceStartDate":{"format":"date","type":"string","description":"Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge."},"serviceEndDate":{"format":"date","type":"string","description":"End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd."},"amountWithoutTax":{"type":"number","description":"Credit memo amount minus tax.","format":"double"},"taxAmount":{"type":"number","description":"The tax amount of the credit memo item.","format":"double"},"chargeDescription":{"type":"string","description":"Description of the charge."},"chargeName":{"type":"string","description":"Name of the charge."},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field was specified in the request or when the order is amending an existing subscription."},"children":[]}]}]}],"type":"string"},"productName":{"type":"string","description":"Name of the product."},"productRatePlanChargeId":{"type":"string","description":"The ID of the product rate plan charge."},"processingType":{"type":"string","description":"The processing type of the credit memo item.","enum":["Charge","Discount","Tax"]},"unitPrice":{"type":"number","description":"The unit price of the charge.","format":"double"},"quantity":{"type":"number","description":"The quantity of the charge."},"unitOfMeasure":{"type":"string","description":"The unit of measure of the charge.","nullable":true},"discountDetails":{"items":{"$ref":"#/components/schemas/PreviewExistingSubscriptionDiscountDetails"},"type":"array","description":"Container for discount details."}},"type":"object"}},"components/schemas/PreviewExistingSubscriptionResultCreditMemos":{"id":"components/schemas/PreviewExistingSubscriptionResultCreditMemos","kind":"json-schema","title":"PreviewExistingSubscriptionResultCreditMemos","data":{"properties":{"creditMemoNumber":{"type":"string","description":"The credit memo number."},"amount":{"type":"number","description":"Credit memo amount.","format":"double"},"amountWithoutTax":{"type":"number","description":"Credit memo amount minus tax.","format":"double"},"taxAmount":{"type":"number","description":"The tax amount of the credit memo.","format":"double"},"targetDate":{"format":"date","type":"string","description":"Date through which to calculate charges if a credit memo is generated, as yyyy-mm-dd."},"creditMemoItems":{"items":{"$ref":"#/components/schemas/PreviewExistingSubscriptionCreditMemoItemResult"},"type":"array","description":"Container for credit memo items."},"status":{"type":"string","description":"The status of the credit memo.","nullable":true},"isFromExistingCreditMemo":{"type":"boolean","description":"Indicates whether the credit memo information is from an existing credit memo."}},"type":"object"}},"components/schemas/PreviewExistingSubscriptionResponse":{"id":"components/schemas/PreviewExistingSubscriptionResponse","kind":"json-schema","title":"PreviewExistingSubscriptionResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"invoices":{"description":"Container for invoices.","items":{"$ref":"#/components/schemas/PreviewExistingSubscriptionResultInvoices"},"type":"array"},"creditMemos":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for credit memos."},"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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PreviewExistingSubscriptionResultCreditMemos"},"type":"array"}},"type":"object"}]}},"components/schemas/POSTSubscriptionType":{"id":"components/schemas/POSTSubscriptionType","kind":"json-schema","title":"POSTSubscriptionType","data":{"allOf":[{"properties":{"accountKey":{"description":"Customer account number or ID\n","type":"string"},"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply to invoices."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"applyCreditBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply a credit balance to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit balance is applied to the invoice. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 you are using the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"This field is deprecated if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"autoRenew":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, this subscription automatically renews at the end of the subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"collect":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the automatic payment is collected. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"196.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"contractEffectiveDate":{"description":"Effective contract date for this subscription, as yyyy-mm-dd\n","format":"date","type":"string"},"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"customerAcceptanceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default value is dependent on the value of other fields. See "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more details."},"children":[]}]}]}],"format":"date","type":"string"},"documentDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the billing document, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos."},"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 field is specified, the specified date is used as the billing document date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, the date specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used as the billing document date."},"children":[]}]}]}]}],"format":"date","type":"string"},"externallyManagedBy":{"description":"An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n","enum":["Amazon","Apple","Google","Roku"],"type":"string"},"gatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment gateway instance. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c92c0f86078c4d5016091674bcc3e92"},"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 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-gateway-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Gateway Routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled:"},"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 field is not specified, gateway routing rules will be invoked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Payment Gateway Routing is disabled:"},"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 field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"children":[]}]}]}]}],"type":"string"},"initialTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the period for the first subscription term. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then this field is required, and the value must be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is ignored."},"children":[]}]}]}],"format":"int64","type":"integer"},"initialTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the first subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InitialTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the initial subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"invoiceOwnerAccountKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice owner account number or ID."},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"invoiceSeparately":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Separates a single subscription from other subscriptions and invoices the charge independently."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is billed separately from other subscriptions. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is included with other subscriptions in the account invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Prerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes."},"children":[]}]}]}],"type":"boolean"},"lastBookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set per the user's timezone. The value of this field 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":"For a new subscription created by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-apis-subscribe-and-amend"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend APIs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field has the value of the subscription creation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a subscription changed by an amendment, this field has the value of the amendment booking date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a subscription created or changed by an order, this field has the value of the order date."},"children":[]}]}]}]}],"format":"date","type":"string"},"notes":{"description":"The notes for the subscription.\n","maxLength":1000,"type":"string"},"paymentMethodId":{"description":"The ID of the payment method used for the payment.\n","type":"string"},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the subscription will consume the reserved payment amount of the customer account. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"renewalSetting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_TO_EVERGREEN"},"children":[]}]}]}]}],"type":"string"},"renewalTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the period for the subscription renewal term. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer"},"renewalTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the subscription renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the subscription renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"runBilling":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-and-credit-memo-generation-rule"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice and credit memo generation rule"},"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 billing documents generated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this operation is only for this subscription, not for the entire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"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":"Possible values:"},"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":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No invoice is created."},"children":[]}]}]}]}]}],"type":"boolean"},"serviceActivationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default value is dependent on the value of other fields. See "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for more details."},"children":[]}]}]}],"format":"date","type":"string"},"subscribeToRatePlans":{"description":"Container for one or more rate plans for this subscription.\n","items":{"$ref":"#/components/schemas/POSTSrpCreateType"},"type":"array"},"subscriptionNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Number. The value can be up to 1000 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not specify a subscription number when creating a subscription, Zuora will generate a subscription number automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the account is created successfully, the subscription number is returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response field."},"children":[]}]}]}],"type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice or a credit memo is generated, as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd. Default is current date."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"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":"The credit memo is only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]}],"format":"date","type":"string"},"termStartDate":{"description":"The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.\n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"required":["accountKey","contractEffectiveDate","subscribeToRatePlans","termType","renewalTerm"],"type":"object"},{"$ref":"#/components/schemas/SubscriptionObjectQTFields"},{"$ref":"#/components/schemas/SubscriptionObjectNSFields"},{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"}],"example":{"accountKey":"8ad09be48db5aba7018db604776d4854","contractEffectiveDate":"2024-07-16","termType":"TERMED","initialTerm":12,"renewalTerm":12,"autoRenew":true,"subscribeToRatePlans":[{"productRatePlanId":"8ad081dd9096ef9501909b40bb4e74a4"}]}}},"components/schemas/POSTSubscriptionResponseType":{"id":"components/schemas/POSTSubscriptionResponseType","kind":"json-schema","title":"POSTSubscriptionResponseType","data":{"properties":{"contractedMrr":{"description":"Monthly recurring revenue of the subscription.\n","type":"number"},"creditMemoId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memo ID, if a credit memo is generated during the subscription process."},"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 container is only available if you set the Zuora REST API minor version to 207.0 or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header, and you have  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"invoiceId":{"description":"Invoice ID, if an invoice is generated during the subscription process.\n","type":"string"},"paidAmount":{"description":"Payment amount, if a payment is collected.\n","type":"number"},"paymentId":{"description":"Payment ID, if a payment is collected.\n","type":"string"},"subscriptionId":{"description":"","type":"string"},"subscriptionNumber":{"description":"","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"totalContractedValue":{"description":"Total contracted value of the subscription.\n","type":"number"}},"type":"object"}},"components/schemas/Currency":{"id":"components/schemas/Currency","kind":"json-schema","title":"Currency","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency used by the account. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/GETDeliveryScheduleType":{"id":"components/schemas/GETDeliveryScheduleType","kind":"json-schema","title":"deliverySchedule","data":{"description":[{"$$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":"deliverySchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for the Delivery Pricing charge model only."},"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 Delivery Pricing charge model is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable billing features by yourself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center. You can check "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable Charge Types / Models"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"frequency":{"description":"Specifies delivery frequency for the delivery schedule.\n","enum":["Weekly"],"type":"string"},"friday":{"description":"Indicates whether delivery occurs on Friday.\n","type":"boolean"},"monday":{"description":"Indicates whether delivery occurs on Monday.\n","type":"boolean"},"saturday":{"description":"Indicates whether delivery occurs on Saturday.\n","type":"boolean"},"sunday":{"description":"Indicates whether delivery occurs on Sunday.\n","type":"boolean"},"thursday":{"description":"Indicates whether delivery occurs on Thursday.\n","type":"boolean"},"tuesday":{"description":"Indicates whether delivery occurs on Tuesday.\n","type":"boolean"},"wednesday":{"description":"Indicates whether delivery occurs on Wednesday.\n","type":"boolean"}},"title":"deliverySchedule","type":"object"}},"components/schemas/DiscountApplyDetails":{"id":"components/schemas/DiscountApplyDetails","kind":"json-schema","title":"discountApplyDetails","data":{"properties":{"appliedProductName":{"description":"The name of the product that the discount rate plan charge applies to.\n","type":"string"},"appliedProductRatePlanChargeId":{"description":"The ID of the product rate plan charge that the discount rate plan charge applies to.\n","type":"string"},"appliedProductRatePlanChargeName":{"description":"The name of the product rate plan charge that the discount rate plan charge applies to.\n","type":"string"},"appliedProductRatePlanId":{"description":"The ID of the product rate plan that the discount rate plan charge applies to.\n","type":"string"},"appliedProductRatePlanName":{"description":"The name of the product rate plan that the discount rate plan charge applies to.\n","type":"string"}},"title":"discountApplyDetails","type":"object"}},"components/schemas/DiscountLevel":{"id":"components/schemas/DiscountLevel","kind":"json-schema","title":"DiscountLevel","data":{"type":"string","enum":["rateplan","subscription","account"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The level of the discount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}]}},"components/schemas/Uom":{"id":"components/schemas/Uom","kind":"json-schema","title":"Uom","data":{"description":"Specifies the units to measure usage.","type":"string"}},"components/schemas/EndDateCondition":{"id":"components/schemas/EndDateCondition","kind":"json-schema","title":"EndDateCondition","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become inactive."},"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":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge is active for a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"Specific_End_Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when then charge becomes inactive."},"children":[]}]}]}],"type":"string","enum":["Subscription_End","Fixed_Period","Specific_End_Date","One_Time"]}},"components/schemas/PriceChangeOption":{"id":"components/schemas/PriceChangeOption","kind":"json-schema","title":"PriceChangeOption","data":{"type":"string","description":"Applies an automatic price change when a termed subscription is renewed.\n","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing",null],"default":"NoChange","nullable":true}},"components/schemas/GETIntervalPriceTierType":{"id":"components/schemas/GETIntervalPriceTierType","kind":"json-schema","title":"IntervalPricing","data":{"properties":{"endingUnit":{"description":"Decimal defining end of tier range.\n","type":"number"},"isOveragePrice":{"description":"True if the price is overage price for the tier.\n","type":"boolean"},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field directly under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies."},"children":[]}]}]}],"type":"number"},"priceFormat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tier price format. Allowed values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flat fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"startingUnit":{"description":"Decimal defining start of tier range.\n","type":"number"},"tier":{"description":"Unique number of the tier.\n","format":"int64","type":"integer"}},"title":"IntervalPricing","type":"object"}},"components/schemas/GETIntervalPriceType":{"id":"components/schemas/GETIntervalPriceType","kind":"json-schema","title":"IntervalPricing","data":{"properties":{"duration":{"description":"Duration period of this interval.\n","type":"integer","nullable":true},"price":{"description":"Price of this interval.\n","type":"number"},"sequence":{"description":"A system-generated number that indicates the sequence in which each interval price is billed.\n","type":"integer"},"subscriptionChargeIntervalPriceTiers":{"items":{"$ref":"#/components/schemas/GETIntervalPriceTierType"},"type":"array"},"type":{"description":"Interval type of this pricing.\n","enum":["Day","Month","Infinity"],"type":"string"}},"title":"IntervalPricing","type":"object"}},"components/schemas/RatePlanChargeTier":{"id":"components/schemas/RatePlanChargeTier","kind":"json-schema","title":"chargeTier","data":{"type":"object","title":"chargeTier","properties":{"tier":{"description":"Unique number of the tier.\n","format":"int64","type":"integer","minimum":1},"startingUnit":{"description":"Decimal defining start of tier range.\n","type":"number","format":"double"},"endingUnit":{"description":"Decimal defining end of tier range.\n","type":"number","format":"double"},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field directly under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies."},"children":[]}]}]}],"type":"number"},"priceFormat":{"description":"Tier price format. \n","type":"string","enum":["FlatFee","PerUnit"]},"originalListPrice":{"type":"number","format":"double","description":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"}}}},"components/schemas/BillingPeriodAlignment":{"id":"components/schemas/BillingPeriodAlignment","kind":"json-schema","title":"BillingPeriodAlignment","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines when to start new billing periods. You"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can use this field to align the billing periods of different charges."},"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":"code","inline":true,"attributes":{"content":"AlignToCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"falls on or after the date when the charge becomes active."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day that falls on or after the start date of the subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - For each term of the subscription, Zuora starts a new billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period on the first billing day that falls on or after the start date of the term."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for information about how Zuora determines the billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day."},"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":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available for prepayment charges by default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To enable this value for non-prepaid recurring charges, contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart","AlignToTermEnd"],"type":"string"}},"components/schemas/TriggerEvent":{"id":"components/schemas/TriggerEvent","kind":"json-schema","title":"TriggerEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become active. If this field is not specified,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the value of the field will be defaulted to the trigger event value defined in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product catalog."},"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":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to specify the date when the charge becomes active."},"children":[]}]}]}],"type":"string","enum":["ContractEffective","ServiceActivation","CustomerAcceptance","SpecificDate"]}},"components/schemas/UpToPeriodsType":{"id":"components/schemas/UpToPeriodsType","kind":"json-schema","title":"UpToPeriodsType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time that the charge duration is measured in. Only applicable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["Days","Weeks","Months","Years","Billing_Periods",null],"nullable":true}},"components/schemas/ValidityPeriodType":{"id":"components/schemas/ValidityPeriodType","kind":"json-schema","title":"ValidityPeriodType","data":{"description":[{"$$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 only available if you have the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period in which the prepayment units are valid to use as defined in a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH",null],"nullable":true}},"components/schemas/RatePlanChargeSegment":{"id":"components/schemas/RatePlanChargeSegment","kind":"json-schema","title":"ratePlanChargeSegment","data":{"type":"object","title":"ratePlanChargeSegment","properties":{"id":{"type":"string","description":"ID of the charge.\n"},"amendedByOrderOn":{"description":"The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n","format":"date","type":"string"},"applyDiscountTo":{"type":"string","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE",null],"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 charges a specific discount applies to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only used when applied to a discount charge model. If you are not using a discount charge model, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"chargeFunction":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define what type of charge it is in Advanced consumption billing: * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Normal charge with no Prepayment or Commitment or Drawdown. * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prepayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For recurring charges. Unit or currency based prepaid charge. * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CommitmentTrueUp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For recurring charges. Currency based minimum commitment charge. * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Drawdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For usage charges. Drawdown from prepaid funds. * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DrawdownAndCreditCommitment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds. * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditCommitment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}],"enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"],"type":"string"},"chargeModelConfiguration":{"$ref":"#/components/schemas/ChargeModelConfigurationType"},"chargedThroughDate":{"description":"The date through which a customer has been billed for the charge.\n","format":"date","type":"string"},"commitmentType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of commitment. A prepaid charge can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". And a min commitment(in-arrears) charge can only be CURRENCY type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For topup(recurring/one-time) charges, this field indicates what type of funds are created."},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it will create a fund with given prepaidUom."},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it will create a fund with the currency amount calculated in list price."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"],"type":"string"},"prepaidCommittedAmount":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the prepaid committed amount."},"children":[]}]}]}],"nullable":true},"creditOption":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled. \\nTo use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack",null],"type":"string","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"deliverySchedule":{"$ref":"#/components/schemas/GETDeliveryScheduleType"},"numberOfDeliveries":{"type":"number","description":"The number of the deliveries.\n","nullable":true},"description":{"description":"Description of the rate plan charge segment.","type":"string"},"discountAmount":{"description":"The amount of the discount.","type":"number","nullable":true},"discountApplyDetails":{"description":"Container for the application details about a discount rate plan charge. \n\nOnly discount rate plan charges have values in this field.\n","items":{"$ref":"#/components/schemas/DiscountApplyDetails"},"type":"array","nullable":true},"discountClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The class that the discount belongs to. The discount class defines"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the order in which discount rate plan charges are applied."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-manage-discount-classes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Discount Classes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"discountLevel":{"$ref":"#/components/schemas/DiscountLevel"},"discountPercentage":{"description":"The amount of the discount as a percentage.\n","type":"number","nullable":true},"applyToBillingPeriodPartially":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that the charge segment is applied to a billing period"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partially. The value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]}],"default":false},"dmrc":{"description":"The change (delta) of monthly recurring charge exists when the change\nin monthly recurring revenue caused by an amendment or a new subscription.\n","type":"number","format":"double"},"done":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that an invoice for a charge segment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has been completed. A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that an invoice has not been"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed for the charge segment."},"children":[]}]}]}],"type":"boolean"},"drawdownRate":{"type":"number","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"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":"Must be a positive number (>0)."},"children":[]}]}]}]},"drawdownUom":{"$ref":"#/components/schemas/Uom"},"dtcv":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After an amendment or an AutomatedPriceChange event, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dtcv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" displays the change (delta) for the total contract value (TCV) amount for this charge, compared with its previous value with recurring charge types."},"children":[]}]}]}],"type":"number","format":"double"},"effectiveEndDate":{"format":"date","type":"string","description":"The effective end date of the charge.\n"},"effectiveStartDate":{"format":"date","type":"string","description":"The effective start date of the charge.\n"},"endDateCondition":{"$ref":"#/components/schemas/EndDateCondition"},"includedUnits":{"type":"number","description":"The number of units included in this charge segment.\n"},"inputArgumentId":{"type":"string","description":"The ID of the input argument for the charge segment.\n"},"isCommitted":{"type":"boolean","description":"Indicates if the charge segment is committed.\n"},"isPrepaid":{"type":"boolean","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this charge is a prepayment (topup) charge or a drawdown charge."},"children":[]}]}]}]},"isRollover":{"type":"boolean","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It determines whether the rollover fields are needed."},"children":[]}]}]}]},"mrr":{"type":"number","format":"double","description":"Monthly recurring revenue (MRR) is the amount of recurring\ncharges in a given month. The MRR calculation doesn't include one-time\ncharges nor usage charges. \n"},"originalOrderDate":{"format":"date","type":"string","description":"The date when the rate plan charge is created through an order or\namendment. This field is to standardize the booking date information\nto increase audit ability and traceability of data between Zuora\nBilling and Zuora Revenue. It is mapped as the booking date for a\nsales order line in Zuora Revenue.\n"},"overagePrice":{"type":"number","description":"Price for units over the allowed amount. \n\nAvailable for the usage-based charge type for the Overage and Tiered with Overage charge models.\n"},"prepaidOperationType":{"enum":["topup","drawdown"],"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this charge. It is either a prepayment (topup) charge or a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge."},"children":[]}]}]}]},"prepaidQuantity":{"type":"number","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"prepaidTotalQuantity":{"type":"number","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of units that end customers can use during a validity period when they subscribe to a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"prepaidUOM":{"$ref":"#/components/schemas/Uom"},"quantity":{"type":"number","description":"Number of units purchased. \n"},"price":{"type":"number","description":"The price of the charge segment.\n"},"priceChangeOption":{"$ref":"#/components/schemas/PriceChangeOption"},"priceIncreasePercentage":{"type":"number","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription's renewal. Use this field if you set the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PriceChangeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"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":"AutomatedPriceChange setting is on"},"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":"Charge type is not one-time"},"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":"Charge model is not discount fixed amount"},"children":[]}]}]}]}]}],"minimum":-100,"maximum":100},"pricingSummary":{"type":"string","description":"A concise description of the charge model and pricing that is suitable to\nshow to your customers. \n"},"originalListPrice":{"type":"number","nullable":true,"description":"The original list price is the price of a product or service at which it\nis listed for sale by a manufacturer or retailer.\n"},"processedThroughDate":{"format":"date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargedThroughDate"},"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":"This date is the earliest date when a charge can be amended."},"children":[]}]}]}]},"rolloverApply":{"enum":["ApplyFirst","ApplyLast"],"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}]},"rolloverPeriodLength":{"type":"integer","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period."},"children":[]}]}]}]},"rolloverPeriods":{"format":"int64","type":"integer","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}]},"prorationOption":{"type":"string","description":[{"$$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 only available if you have the Charge Level Proration feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charge-level proration option for the product rate plan charge."},"children":[]}]}]}]},"segment":{"format":"int64","type":"integer","description":"Segment number of the charge.\n"},"specificEndDate":{"format":"date","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends after the charge trigger date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_End_Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"subscriptionChargeIntervalPricing":{"items":{"$ref":"#/components/schemas/GETIntervalPriceType"},"type":"array"},"tcv":{"type":"number","format":"double","description":"Total contract value (TCV) is the sum of one-time charges, recurring\ncharges, and usage charges. The TCV calculation includes one-time\ncharges, recurring charges, and usage charges.\n"},"tiers":{"items":{"$ref":"#/components/schemas/RatePlanChargeTier"},"type":"array","nullable":true},"triggerDate":{"format":"date","type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the charge becomes effective and billing begins, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"billingPeriodAlignment":{"$ref":"#/components/schemas/BillingPeriodAlignment"},"triggerEvent":{"$ref":"#/components/schemas/TriggerEvent"},"upToPeriods":{"format":"int64","type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"upToPeriodsType":{"$ref":"#/components/schemas/UpToPeriodsType"},"validityPeriodType":{"$ref":"#/components/schemas/ValidityPeriodType"},"salesPrice":{"type":"number","format":"double","description":"The sales price of the charge segment.\n"},"accountingCode":{"type":"string","nullable":true,"description":"The accounting code of the charge segment.\n"},"revenueRecognitionCode":{"type":"string","nullable":true,"description":"The revenue recognition code of the charge segment.\n"},"revRecTriggerCondition":{"type":"string","nullable":true,"description":"Specifies when revenue recognition begins.\n"},"estimatedEndDate":{"format":"date","type":"string","description":"The estimated end date of the charge segment.\n"},"estimatedStartDate":{"format":"date","type":"string","description":"The estimated start date of the charge segment.\n"},"taxable":{"type":"boolean","nullable":true,"description":"Indicates whether the charge is taxable. \n"},"taxCode":{"type":"string","nullable":true,"description":"The tax code of a charge.\n"},"taxMode":{"type":"string","nullable":true,"description":"Determines how to define taxation for the charge.\n\nIt affects the tax calculation of the charge.\n","enum":["TaxExclusive","TaxInclusive",null]}}}},"components/schemas/GETTierType":{"id":"components/schemas/GETTierType","kind":"json-schema","title":"tiers","data":{"properties":{"endingUnit":{"description":"Decimal defining end of tier range.\n","type":"number","nullable":true},"originalListPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer."},"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 applies to the following charges in a subscription created through an order:"},"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":"oneTimeTiered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oneTimeVolume"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringTiered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringVolume"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageTiered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageVolume"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageTieredWithOverage"},"children":[]}]}]}]}],"type":"number"},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field directly under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies."},"children":[]}]}]}],"type":"number"},"priceFormat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tier price format. Allowed values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flat fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"startingUnit":{"description":"Decimal defining start of tier range.\n","type":"number"},"tier":{"description":"Unique number of the tier.\n","format":"int64","type":"integer"}},"title":"tiers","type":"object"}},"components/schemas/GETSubscriptionRatePlanChargesType":{"id":"components/schemas/GETSubscriptionRatePlanChargesType","kind":"json-schema","title":"ratePlanCharges","data":{"allOf":[{"properties":{"amendedByOrderOn":{"description":"The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n","type":"string","nullable":true},"applyDiscountTo":{"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 charges a specific discount applies to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only used when applied to a discount charge model. If you are not using a discount charge model, the value is null."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"RECURRING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONETIMERECURRING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONETIMEUSAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRINGUSAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONETIMERECURRINGUSAGE"},"children":[]}]}]}]}],"type":"string","nullable":true},"applyToBillingPeriodPartially":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow the discount duration to be aligned with the billing period partially."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"billingDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing cycle day (BCD), which is when bill runs generate invoices"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for charges associated with the product rate plan charge or the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"DefaultFromCustomer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth(# of the month)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionStartDay"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeTriggerDay"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek/dayofweek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": in which dayofweek is the day in the week you define your billing periods to start."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response data, a day-of-the-month ordinal value ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31st"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") appears in place of the hash sign above (\"#\"). If this value exceeds the number of days in a particular month, the last day of the month is used as the BCD."},"children":[]}]}]}],"type":"string","nullable":true},"billingPeriod":{"description":"Allows billing period to be overridden on the rate plan charge.\n","type":"string","nullable":true},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"AlignToCharge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]}]}]}]}],"type":"string","nullable":true},"billingTiming":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing timing for the charge. This field is only used if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanChargeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"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":"Possible values 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":"In Advance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"In Arrears"},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"chargeFunction":{"description":[{"$$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 only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"141"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"Standard: Normal charge with no Prepayment or Commitment or Drawdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepayment: For recurring charges. Unit or currency based prepaid charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown: For usage charges. Drawdown from prepaid funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"],"type":"string"},"commitmentType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the type of commitment. A prepaid charge can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A minimum commitment(in-arrears) charge can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. For topup(recurring or one-time) charges, this field indicates what type of funds are created."},"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 UNIT, it will create a fund with given prepaidUom."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If CURRENCY, it will create a fund with the currency amount calculated in list price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"],"type":"string"},"chargeModelConfiguration":{"$ref":"#/components/schemas/ChargeModelConfigurationType"},"chargeSegments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is returned only if you have set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"charge-detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all-segments"},"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":"Container for the charge information for all the charge segments."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/RatePlanChargeSegment"}},"chargedThroughDate":{"description":"The date through which a customer has been billed for the charge.\n","format":"date","type":"string","nullable":true},"creditOption":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 114 or higher. Otherwise, an error occurs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"],"type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency used by the account. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"description":{"description":"Description of the rate plan charge.\n","type":"string"},"discountAmount":{"description":"The amount of the discount.\n","type":"number","nullable":true},"discountApplyDetails":{"description":"Container for the application details about a discount rate plan charge. \n\nOnly discount rate plan charges have values in this field.\n","items":{"$ref":"#/components/schemas/DiscountApplyDetails"},"type":"array","nullable":true},"discountClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The class that the discount belongs to. The discount class defines the order in which discount rate plan charges are applied."},"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://docs.zuora.com?resourceId=billing-manage-discount-classes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Discount Classes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The level of the discount. Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"discountPercentage":{"description":"The amount of the discount as a percentage.\n","type":"number","nullable":true},"dmrc":{"description":"The change (delta) of monthly recurring charge exists when the change in monthly recurring revenue caused by an amendment or a new subscription.\n","type":"number","nullable":true},"done":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that an invoice for a charge segment has been completed. A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that an invoice has not been completed for the charge segment."},"children":[]}]}]}],"type":"boolean"},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"drawdownScope":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prepayment"},"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":"code","inline":true,"attributes":{"content":"SUBSCRIPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges of the same subscription can be drawn down."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - only usage charges in the same account (subscription owner) can be drawn down."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["SUBSCRIPTION","ACCOUNT"]},"drawdownPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown priority for consumption ordering. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"integer"},"drawdownUom":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"dtcv":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After an amendment or an AutomatedPriceChange event, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dtcv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" displays the change (delta) for the total contract value (TCV) amount for this charge, compared with its previous value with recurring charge types."},"children":[]}]}]}],"type":"number"},"effectiveEndDate":{"description":"The effective end date of the rate plan charge.\n","format":"date","type":"string"},"effectiveStartDate":{"description":"The effective start date of the rate plan charge.\n","format":"date","type":"string"},"eligibleAccountConditions":{"additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A filter expression (single condition or nested condition groups with logical relations) that defines which accounts’ charges are considered in the calculation. If omitted, the system defaults to the calculated charge’s subscription account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"object"},"eligibleChargeConditions":{"additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A filter expression (single condition or nested condition groups with logical relations) that defines which rate plan charges contribute to the calculation; if omitted, the scope defaults to “All charges” (i.e., all charges under the selected accounts are eligible)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"object"},"endDateCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends after the charge trigger date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Subscription_End"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_End_Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"One_Time"},"children":[]}]}]}]}],"type":"string"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"estimatedEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated end date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system automatically calculates the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"fundSupportAccountHierarchy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to enable sub-account's usage to drawdown from the parent's funds."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"id":{"description":"Rate plan charge ID.\n","type":"string"},"includedUnits":{"description":"Specifies the number of units in the base set of units.\n","type":"number","nullable":true},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the rate plan charge on the subscription."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isDimensionalPrice":{"description":[{"$$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 only available when the Dynamic Pricing feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the charge uses dimensional pricing. When set to true, this charge enables dynamic pricing."},"children":[]}]}]}],"type":"boolean"},"isPrepaid":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: "},"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":"."},"children":[]}]}]}],"type":"boolean"},"isPriceNegotiated":{"description":[{"$$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 only available when the Negotiated Price Table feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the charge uses negotiated pricing. When set to true, this charge defines a negotiated price table."},"children":[]}]}]}],"type":"boolean"},"isRollover":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is either \"True\" or \"False\". It determines whether the rollover fields are needed."},"children":[]}]}]}],"type":"boolean"},"isStackedDiscount":{"description":[{"$$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 only applicable to the Discount - Percentage charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to 130 or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates whether the discount is to be calculated as stacked discount. Possible values are 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":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is a stacked discount, which should be calculated by stacking with other discounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is not a stacked discount, which should be calculated in sequence with other discounts."},"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://docs.zuora.com?resourceId=billing-discount-charge-models"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stacked discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List price base; possible values 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":"Per_Billing_Period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Week"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]}]}]}]}],"type":"string","nullable":true},"maximumAmount":{"description":"Non-negative currency amount that establishes the upper bound for the calculated charge in a billing period; if the computed amount exceeds this value, the invoice amount will be capped at the maximum.\n","type":"number"},"minimumAmount":{"description":"Non-negative currency amount that establishes the lower bound for the calculated charge in a billing period; if the computed amount is less than this value, the invoice amount will be set to the minimum.\n","type":"number"},"model":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge model; possible values 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":"FlatFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PerUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Overage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Volume"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TieredWithOverage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountFixedAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DiscountPercentage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MultiAttributePricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PreratedPerUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PreratedPricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HighWatermarkVolumePricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HighWatermarkTieredPricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivery"},"children":[]}]}]}]}],"type":"string"},"mrr":{"description":"Monthly recurring revenue of the rate plan charge.\n","type":"number","nullable":true},"name":{"description":"Charge name.\n","type":"string"},"number":{"description":"Charge number.\n","type":"string"},"numberOfDeliveries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of deliveries in the billing period for the charge segment."},"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":"numberOfDeliveries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for the Delivery Pricing charge model only."},"children":[]}]}]}],"type":"number"},"numberOfPeriods":{"description":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model.\n","format":"int64","type":"integer","nullable":true},"optional":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether a charge is optional. The possible values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Charge is optional, this is only available for charges within a hard bundle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Charge is non-optional and the charge is created after the hard bundle feature is released."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Charge is non-optional and the charge is created before the hard bundle feature is released."},"children":[]}]}]}]}],"type":"boolean","nullable":true},"originalChargeId":{"description":"The original ID of the rate plan charge.\n","type":"string"},"originalListDiscountAmount":{"description":"The original discount amount listed for sale by a manufacturer or retailer.\n","type":"number"},"originalListDiscountPercentage":{"description":"The original discount percentage listed for sale by a manufacturer or retailer.\n","type":"number"},"originalListPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer."},"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 applies to the following charges in a subscription created through an order:"},"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":"oneTimeFlatFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oneTimePerUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringFlatFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringPerUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageFlatFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usagePerUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageOverage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageTieredWithOverage"},"children":[]}]}]}]}],"type":"number"},"originalOrderDate":{"description":"The date when the rate plan charge is created through an order or amendment.\n\nThis field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n","format":"date","type":"string"},"overageCalculationOption":{"description":"Determines when to calculate overage charges.\n","type":"string","nullable":true},"overagePrice":{"description":"The price for units over the allowed amount.\n","type":"number","nullable":true},"overageUnusedUnitsCreditOption":{"description":"Determines whether to credit the customer with unused units of usage.\n","type":"string","nullable":true},"percentage":{"description":"The specific rate applied to the total eligible spend to determine the base invoice amount before any minimum or maximum amount is applied.\n","type":"number"},"prepaidOperationType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this charge. It is either a prepayment (topup) charge or a drawdown charge."},"children":[]}]}]}],"enum":["topup","drawdown"],"type":"string"},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"prepaidTotalQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of units that end customers can use during a validity period when they subscribe to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"prepaidUom":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"prepaymentUnitType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit type of the prepayment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string","enum":["UNIT"]},"price":{"description":"The price associated with the rate plan charge expressed as a decimal.\n","type":"number","nullable":true},"pricingAttributes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for pricing attributes that provide additional context for dynamic pricing. This field includes all the dynamic pricing attributes and values associated with this charge, except for the pricing attributes mapped to Zuora Usage object fields."},"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":" To enable Dynamic Pricing, submit a request to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","additionalProperties":true},"salesPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sales price associated with the rate plan charge expressed as a decimal."},"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":"Notes"},"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":"This field is only available to subscriptions that are created through orders and exist after 2023-01-10."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies to the following charge models, and the values vary with the charge models:"},"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":"Flat fee: the value equals the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"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":"text","inline":true,"attributes":{"content":"Per unit: the value equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"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":"Fixed amount discount: the value equals the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"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":"text","inline":true,"attributes":{"content":"Volume: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit."},"children":[]}]}]}]}]}]}],"type":"number"},"priceChangeOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the following is true:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"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":"AutomatedPriceChange setting is on"},"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":"Charge type is not one-time"},"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":"Charge model is not discount percentage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Then an automatic price change can have a value for when a termed subscription is renewed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values (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":"code","inline":true,"attributes":{"content":"NoChange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UseLatestProductCatalogPricing"},"children":[]}]}]}]}],"type":"string","nullable":true},"priceIncreasePercentage":{"description":"A planned future price increase amount as a percentage.\n","type":"number","nullable":true},"pricingSummary":{"description":"Concise description of rate plan charge model.\n","type":"string"},"processedThroughDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargedThroughDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. This date is the earliest date when a charge can be amended."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"productCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is used to maintain the product category."},"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 only available if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}],"type":"string"},"productClass":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is used to maintain the product class."},"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 only available if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}],"type":"string"},"productFamily":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is used to maintain the product family."},"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 only available if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}],"type":"string"},"productLine":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is used to maintain the product line."},"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 only available if you have the Additional Revenue Fields property enabled."},"children":[]}]}]}],"type":"string"},"productRatePlanChargeId":{"description":"","type":"string"},"quantity":{"description":"The quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing.\n","type":"number","nullable":true},"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for per unit, volume pricing, and tiered pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-Time Charges and Recurring Charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string","nullable":true},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set both the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"rolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicit cutoff date when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverEndDateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"rolloverEndDateType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollover cutoff strategy determining when the rollover eligibility will end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"ChargeEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at the subscription term end."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Rollover stops at an explicit date specified in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RolloverEndDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeEndDate","SubscriptionTerm","SpecificDate"]},"rolloverFundPriority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority for rolled-over funds. Lower value means that it will be consumed first."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"rolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Enhanced Unit-Based Prepaid with Drawdown feature is enabled, you can customize a single rollover period length together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"rolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"number"},"rolloverPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit for rollover period length."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"Day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Day-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Month-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quarter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Quarter-based rollover periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Annual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Annual rollover periods."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["Day","Month","Quarter","Annual"]},"segment":{"description":"The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1.\n","format":"int64","type":"integer"},"smoothingModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when revenue recognition begins. When charge model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Overage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TieredWithOverage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smoothingModel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be 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":"ContractEffectiveDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivationDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptanceDate"},"children":[]}]}]}]}],"type":"string","nullable":true},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizes the number of month or week for the charges billing period. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer","nullable":true},"specificEndDate":{"description":"The specific date on which the charge ends. If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.\n","format":"date","type":"string","nullable":true},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge."},"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":":"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"specificValidityPeriodLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of days, weeks, or months for the validity period when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidityPeriodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_DAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_WEEKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPECIFIC_MONTHS"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status to indicate a charge is active or has been removed. The possible values 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":"removedDirectly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The charge has been removed directly through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action. This is only applicable to optional charges within a hard bundle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"removedWithRatePlan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - charge has been removed when the parent rate plan is removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - charge is active, or the charge has been removed before the hard bundle feature is released."},"children":[]}]}]}]}],"enum":["removedDirectly","removedWithRatePlan"],"type":"string","nullable":true},"subscriptionChargeDeliverySchedule":{"$ref":"#/components/schemas/GETDeliveryScheduleType"},"subscriptionChargeIntervalPricing":{"description":"Interval Pricing information. This field is available if the Offers feature is enabled.\n","items":{"$ref":"#/components/schemas/GETIntervalPriceType"},"type":"array"},"tcv":{"description":"The total contract value.\n","type":"number"},"tiers":{"description":"One or many defined ranges with distinct pricing.\n","items":{"$ref":"#/components/schemas/GETTierType"},"type":"array","nullable":true},"triggerDate":{"description":"The date that the rate plan charge will be triggered.\n","format":"date","type":"string","nullable":true},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event that will cause the rate plan charge to be triggered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ContractEffective"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]}]}]}]}],"type":"string"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge type. Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"unusedUnitsCreditRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the rate to credit a customer for unused units of usage. This field is applicable only for overage charge models when the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OverageUnusedUnitsCreditOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditBySpecificRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","nullable":true},"upsellOriginChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the original upselling charge associated with the current charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a termed subscription, you can now use the \"Create an order\" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:"},"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":"Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell."},"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":"In the preceding charge to add, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upsellOriginChargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the existing rate plan charge for which you want to make the quantity upsell."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription."},"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 Quantity Upsell feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"uom":{"description":"Specifies the units to measure usage. \n","type":"string","nullable":true},"upToPeriods":{"description":"Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.\n\nIf the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.\n","type":"string","nullable":true},"upToPeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the charge ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Billing_Periods"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Weeks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Years"},"children":[]}]}]}]}],"type":"string","nullable":true},"usageRecordRatingOption":{"description":"Determines how Zuora processes usage records for per-unit usage charges. \n","type":"string","nullable":true},"validityPeriodType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period in which the prepayment units are valid to use as defined in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"type":"string"},"validityPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the anchor date for validity period (VP) boundaries. The anchor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date defines the recurring grid — VP boundaries fall at every VP-length step"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the anchor. The charge's start and end dates then determine which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"portion of this grid is covered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ChargeStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - Anchor date is the charge start date. Simplest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"option with no partial first VP."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is the subscription term start date. Aligns all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges on the same subscription to a common grid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TermEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is derived by walking backward from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription term end date. Last VP always ends cleanly at term end;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partial VP (if any) is at the start."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Anchor date is an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAnchorDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom alignment for special billing arrangements."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ChargeStart","TermStart","TermEnd","SpecificDate"]},"validityPeriodAnchorDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The anchor date for validity period alignment. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validityPeriodAlignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"validityPeriodProrationOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls what happens to units when a validity period (VP) is partial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are:"},"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":"code","inline":true,"attributes":{"content":"ProrateUnits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant partial units, the number is prorated based on the overlap ratio."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NoProrate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant full units."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/prepaid-with-drawdown/prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Unit-Based Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}],"type":"string","enum":["ProrateUnits","NoProrate"]},"version":{"description":"Rate plan charge revision number.\n","format":"int64","type":"integer"}},"type":"object"},{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"}],"title":"ratePlanCharges"}},"components/schemas/GETSubscriptionProductFeatureType":{"id":"components/schemas/GETSubscriptionProductFeatureType","kind":"json-schema","title":"subscriptionProductFeatures","data":{"properties":{"description":{"description":"Feature description.\n","type":"string"},"featureCode":{"description":"Feature code, up to 255 characters long.\n","type":"string"},"id":{"description":"SubscriptionProductFeature ID.\n","type":"string"},"name":{"description":"Feature name, up to 255 characters long.\n","type":"string"}},"title":"subscriptionProductFeatures","type":"object"}},"components/schemas/GETSubscriptionRatePlanType":{"id":"components/schemas/GETSubscriptionRatePlanType","kind":"json-schema","title":"ratePlans","data":{"allOf":[{"properties":{"externallyManagedPlanId":{"description":"Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"id":{"description":"Rate plan ID.\n","type":"string"},"lastChangeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last amendment on the rate plan."},"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":" If a subscription is created through an order, this field is only available if multiple orders are created on the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"Add"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Remove"},"children":[]}]}]}]}],"type":"string"},"productId":{"description":"","type":"string"},"productName":{"description":"","type":"string"},"productRatePlanId":{"description":"","type":"string"},"productSku":{"description":"The unique SKU for the product.\n","type":"string"},"productRatePlanType":{"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 rate plan. The possible values 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":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Normal rate plan created after the hard bundle feature is released."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanHardBundle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Hard Bundle rate plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Normal rate plan created before the hard bundle feature is released."},"children":[]}]}]}]}],"enum":["Standalone","RatePlanHardBundle"],"type":"string","nullable":true},"contractedMrr":{"description":"Monthly recurring revenue of the subscription rate plan exclusive of all the discounts applicable.\n","type":"number"},"contractedNetMrr":{"description":"Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.\n","type":"number"},"asOfDayGrossMrr":{"description":"Monthly recurring revenue of the subscription rate plan exclusive of any discounts applicable as of specified day.\n","type":"number"},"asOfDayNetMrr":{"description":"Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day.\n","type":"number"},"ratePlanCharges":{"description":"Container for one or more charges.\n","items":{"$ref":"#/components/schemas/GETSubscriptionRatePlanChargesType"},"type":"array"},"ratePlanName":{"description":"Name of the rate plan.\n","type":"string"},"subscriptionProductFeatures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for one or more features."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only available when the following settings are enabled:"},"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":"The Entitlements feature in your tenant."},"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":"The Enable Feature Specification in Product and Subscriptions setting in Zuora Billing Settings"},"children":[]}]}]}]}]}],"items":{"$ref":"#/components/schemas/GETSubscriptionProductFeatureType"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/RatePlanObjectCustomFields"}],"title":"ratePlans"}},"components/schemas/SubscriptionRampIntervalResponse":{"id":"components/schemas/SubscriptionRampIntervalResponse","kind":"json-schema","title":"RampInterval","data":{"properties":{"description":{"description":"The short description of the interval.","type":"string"},"endDate":{"description":"The end date of the interval.","format":"date","type":"string"},"name":{"description":"The name of the interval.","type":"string"},"startDate":{"description":"The start date of the interval.","format":"date","type":"string"}},"title":"RampInterval","type":"object"}},"components/schemas/SubscriptionRampChargeResponse":{"id":"components/schemas/SubscriptionRampChargeResponse","kind":"json-schema","title":"RampCharge","data":{"properties":{"chargeNumber":{"description":"The number of the rate plan charge.","type":"string"}},"title":"RampCharge","type":"object"}},"components/schemas/SubscriptionRampResponse":{"id":"components/schemas/SubscriptionRampResponse","kind":"json-schema","title":"SubscriptionRamp","data":{"description":"Ramp information associated with the subscription including the ramp intervals and the charges.","properties":{"id":{"description":"The ID of the ramp.","type":"string"},"name":{"description":"The name of the ramp.","type":"string"},"number":{"description":"The number of the ramp. It is automatically generated by the billing\nsystem.","type":"string"},"description":{"description":"The short description of the ramp.","type":"string"},"intervals":{"description":"Container for the intervals that the ramp is split into in its timeline.","items":{"$ref":"#/components/schemas/SubscriptionRampIntervalResponse"},"type":"array"},"charges":{"description":"Container for the rate plan charges that are considered as part of the\nramp deal.","items":{"$ref":"#/components/schemas/SubscriptionRampChargeResponse"},"type":"array"}},"title":"SubscriptionRamp","type":"object"}},"components/schemas/GETSubscriptionStatusHistoryType":{"id":"components/schemas/GETSubscriptionStatusHistoryType","kind":"json-schema","title":"statusHistory","data":{"allOf":[{"properties":{"endDate":{"description":"The effective end date of the status history.","format":"date","type":"string"},"startDate":{"description":"The effective start date of the status history.","format":"date","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Pending Activation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Suspended"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OutOfTerm"},"children":[]}]}]}]}],"type":"string"}},"type":"object"}],"title":"statusHistory"}},"components/schemas/GETSubscriptionType":{"id":"components/schemas/GETSubscriptionType","kind":"json-schema","title":"subscriptions","data":{"allOf":[{"properties":{"accountId":{"description":"","type":"string"},"accountName":{"description":"","type":"string"},"accountNumber":{"description":"","type":"string"},"autoRenew":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription automatically renews at the end of the term. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","nullable":true},"billToContact":{"$ref":"#/components/schemas/GETAccountSummaryTypeBillToContact"},"cancelReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for a subscription cancellation copied from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of a Cancel Subscription order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"contractEffectiveDate":{"description":"Effective contract date for this subscription, as yyyy-mm-dd.\n","format":"date","type":"string"},"contractedMrr":{"description":"Monthly recurring revenue of the subscription.\n","type":"number"},"contractedNetMrr":{"description":"Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.\n","type":"number"},"asOfDayGrossMrr":{"description":"Monthly recurring revenue of the subscription exclusive of any discounts applicable as of specified day.\n","type":"number"},"asOfDayNetMrr":{"description":"Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day.\n","type":"number"},"netTotalContractedValue":{"description":"Total contracted value of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.\n","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"currentTerm":{"description":"The length of the period for the current subscription term.\n","format":"int64","type":"integer"},"currentTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the current subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"customerAcceptanceDate":{"description":"The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n","format":"date","type":"string"},"externallyManagedBy":{"description":"An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n","enum":["Amazon","Apple","Google","Roku"],"type":"string","nullable":true},"id":{"description":"Subscription ID.\n","type":"string"},"initialTerm":{"description":"The length of the period for the first subscription term.\n","format":"int64","type":"integer"},"initialTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the first subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"invoiceOwnerAccountId":{"description":"","type":"string"},"invoiceOwnerAccountName":{"description":"","type":"string"},"invoiceOwnerAccountNumber":{"description":"","type":"string"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"invoiceSeparately":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Separates a single subscription from other subscriptions and creates an invoice for the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is billed separately from other subscriptions. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is included with other subscriptions in the account invoice."},"children":[]}]}]}],"type":"boolean","nullable":true},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"invoiceTemplateName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field during subscription creation, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"isLatestVersion":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current subscription object is the latest version."},"children":[]}]}]}],"type":"boolean"},"lastBookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set per the user's timezone. The value of this field 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":"For a new subscription created by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-apis-subscribe-and-amend"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend APIs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field has the value of the subscription creation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a subscription changed by an amendment, this field has the value of the amendment booking date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a subscription created or changed by an order, this field has the value of the order date."},"children":[]}]}]}]}],"format":"date","type":"string"},"notes":{"description":"A string of up to 65,535 characters.\n","type":"string","nullable":true},"orderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number of the order in which the changes on the subscription are made."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". We will investigate your use cases and data before enabling this feature for you."},"children":[]}]}]}],"type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"ratePlans":{"description":"Container for rate plans.\n","items":{"$ref":"#/components/schemas/GETSubscriptionRatePlanType"},"type":"array"},"renewalSetting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether a termed subscription will remain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or change to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it is renewed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_TO_EVERGREEN"},"children":[]}]}]}]}],"type":"string","nullable":true},"renewalTerm":{"description":"The length of the period for the subscription renewal term.\n","format":"int64","type":"integer"},"renewalTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the subscription renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"revision":{"description":"An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions.\n","type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the subscription."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string","nullable":true},"ramp":{"$ref":"#/components/schemas/SubscriptionRampResponse"},"sequenceSetName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field during subscription creation, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"serviceActivationDate":{"description":"The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd\n","format":"date","type":"string"},"shipToContact":{"$ref":"#/components/schemas/GetAccountSummaryTypeShipToContact"},"soldToContact":{"$ref":"#/components/schemas/GETAccountSummaryTypeSoldToContact"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription status; possible values 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":"Draft"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Suspended"},"children":[]}]}]}]}],"type":"string"},"statusHistory":{"description":"Container for status history.\n","items":{"$ref":"#/components/schemas/GETSubscriptionStatusHistoryType"},"type":"array"},"subscriptionEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription term ends, where the subscription ends at midnight the day before."},"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":"subscriptionEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This date is the same as the term end date or the cancelation date, as appropriate."},"children":[]}]}]}],"format":"date","type":"string"},"subscriptionNumber":{"description":"","type":"string"},"subscriptionStartDate":{"description":"Date the subscription becomes effective.\n","format":"date","type":"string"},"termEndDate":{"description":"Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set).\n","format":"date","type":"string","nullable":true},"termStartDate":{"description":"Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date.\n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"scheduledCancelDate":{"description":"The date when the subscription is scheduled to be canceled.","format":"date","type":"string","nullable":true},"scheduledSuspendDate":{"description":"The date when the subscription is scheduled to be suspended.","format":"date","type":"string","nullable":true},"scheduledResumeDate":{"description":"The date when the subscription is scheduled to be resumed.","format":"date","type":"string","nullable":true},"totalContractedValue":{"description":"Total contracted value of the subscription.\n","type":"number"},"totalNumberOfChargeSegments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of charge segments in this subscription, including segments from removed charges. This value is the sum of the segments for all charges under the subscription."},"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 default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there are no charge segments."},"children":[]}]}]}],"type":"integer"},"uniqueToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique string to represent the subscription in the order. Use this token to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference the subscription in other actions within the same order, such as in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commitment eligibility conditions. Must be unique across all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createSubscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order actions within the same order."},"children":[]}]}]}],"maxLength":50,"type":"string","nullable":true},"version":{"description":"This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment.","format":"int64","type":"integer"}},"type":"object"},{"$ref":"#/components/schemas/SubscriptionObjectQTFields"},{"$ref":"#/components/schemas/SubscriptionObjectNSFields"},{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"}],"title":"subscriptions"}},"components/schemas/GETSubscriptionWrapper":{"id":"components/schemas/GETSubscriptionWrapper","kind":"json-schema","title":"GETSubscriptionWrapper","data":{"properties":{"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"subscriptions":{"description":"Array of subscriptions.\n","items":{"$ref":"#/components/schemas/GETSubscriptionType"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETSubscriptionByKeyWithSuccess":{"id":"components/schemas/GETSubscriptionByKeyWithSuccess","kind":"json-schema","title":"GETSubscriptionByKeyWithSuccess","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the account associated with this subscription.","type":"string"},"accountName":{"description":"The name of the account associated with this subscription.","type":"string"},"accountNumber":{"description":"The number of the account associated with this subscription.","type":"string"},"autoRenew":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription automatically renews at the end of the term. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"billToContact":{"$ref":"#/components/schemas/GETAccountSummaryTypeBillToContact"},"cancelReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for a subscription cancellation copied from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of a Cancel Subscription order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"contractEffectiveDate":{"description":"Effective contract date for this subscription, as yyyy-mm-dd.\n","format":"date","type":"string"},"contractedMrr":{"description":"Monthly recurring revenue of the subscription.\n","type":"number"},"contractedNetMrr":{"description":"Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.\n","type":"number"},"asOfDayGrossMrr":{"description":"Monthly recurring revenue of the subscription exclusive of any discounts applicable as of specified day.\n","type":"number"},"asOfDayNetMrr":{"description":"Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day.\n","type":"number"},"netTotalContractedValue":{"description":"Total contracted value of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.\n","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"currentTerm":{"description":"The length of the period for the current subscription term.\n","format":"int64","type":"integer"},"currentTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the current subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"customerAcceptanceDate":{"description":"The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n","format":"date","type":"string"},"externallyManagedBy":{"description":"An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n","enum":["Amazon","Apple","Google","Roku"],"type":"string"},"id":{"description":"Subscription ID.\n","type":"string"},"initialTerm":{"description":"The length of the period for the first subscription term.\n","format":"int64","type":"integer"},"initialTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the first subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"invoiceOwnerAccountId":{"description":"","type":"string"},"invoiceOwnerAccountName":{"description":"","type":"string"},"invoiceOwnerAccountNumber":{"description":"","type":"string"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"invoiceSeparately":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Separates a single subscription from other subscriptions and creates an invoice for the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is billed separately from other subscriptions. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is included with other subscriptions in the account invoice."},"children":[]}]}]}],"type":"boolean"},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"invoiceTemplateName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field during subscription creation, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"isLatestVersion":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current subscription object is the latest version."},"children":[]}]}]}],"type":"boolean"},"lastBookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set per the user's timezone. The value of this field 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":"For a new subscription created by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-apis-subscribe-and-amend"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend APIs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field has the value of the subscription creation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a subscription changed by an amendment, this field has the value of the amendment booking date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a subscription created or changed by an order, this field has the value of the order date."},"children":[]}]}]}]}],"format":"date","type":"string"},"notes":{"description":"A string of up to 65,535 characters.\n","type":"string"},"orderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number of the order in which the changes on the subscription are made."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". We will investigate your use cases and data before enabling this feature for you."},"children":[]}]}]}],"type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"originalListPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer."},"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 applies to the following charges in a subscription created through an order:"},"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":"oneTimeFlatFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oneTimePerUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringFlatFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringPerUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageFlatFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usagePerUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageOverage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageTieredWithOverage"},"children":[]}]}]}]}],"type":"number"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"ramp":{"$ref":"#/components/schemas/SubscriptionRampResponse"},"ratePlans":{"description":"Container for rate plans.\n","items":{"$ref":"#/components/schemas/GETSubscriptionRatePlanType"},"type":"array"},"renewalSetting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether a termed subscription will remain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or change to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it is renewed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_TO_EVERGREEN"},"children":[]}]}]}]}],"type":"string"},"renewalTerm":{"description":"The length of the period for the subscription renewal term.\n","format":"int64","type":"integer"},"renewalTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the subscription renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"revision":{"description":"An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions.\n","type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the subscription."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string","nullable":true},"sequenceSetName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field during subscription creation, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"serviceActivationDate":{"description":"The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd\n","format":"date","type":"string"},"shipToContact":{"$ref":"#/components/schemas/GetAccountSummaryTypeShipToContact"},"soldToContact":{"$ref":"#/components/schemas/GETAccountSummaryTypeSoldToContact"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription status; possible values 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":"Draft"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Suspended"},"children":[]}]}]}]}],"type":"string"},"statusHistory":{"description":"Container for status history.\n","items":{"$ref":"#/components/schemas/GETSubscriptionStatusHistoryType"},"type":"array"},"subscriptionEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription term ends, where the subscription ends at midnight the day before."},"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":"subscriptionEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This date is the same as the term end date or the cancelation date, as appropriate."},"children":[]}]}]}],"format":"date","type":"string"},"subscriptionNumber":{"description":"Subscription number.","type":"string"},"subscriptionStartDate":{"description":"Date the subscription becomes effective.\n","format":"date","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"termEndDate":{"description":"Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set).\n","format":"date","type":"string"},"termStartDate":{"description":"Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date.\n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"scheduledCancelDate":{"description":"The date when the subscription is scheduled to be canceled.","format":"date","type":"string"},"scheduledSuspendDate":{"description":"The date when the subscription is scheduled to be suspended.","format":"date","type":"string"},"scheduledResumeDate":{"description":"The date when the subscription is scheduled to be resumed.","format":"date","type":"string"},"totalContractedValue":{"description":"Total contracted value of the subscription.\n","type":"number"},"totalNumberOfChargeSegments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of charge segments in this subscription, including segments from removed charges. This value is the sum of the segments for all charges under the subscription."},"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 default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there are no charge segments."},"children":[]}]}]}],"type":"integer"},"uniqueToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique string to represent the subscription in the order. Use this token to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference the subscription in other actions within the same order, such as in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commitment eligibility conditions. Must be unique across all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createSubscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order actions within the same order."},"children":[]}]}]}],"maxLength":50,"type":"string"},"version":{"description":"This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment.","format":"int64","type":"integer"},"accountOwnerDetails":{"$ref":"#/components/schemas/GETAccountTypeBasicInfo"},"invoiceOwnerAccountDetails":{"$ref":"#/components/schemas/GETAccountTypeBasicInfo"}},"type":"object"},{"$ref":"#/components/schemas/SubscriptionObjectQTFields"},{"$ref":"#/components/schemas/SubscriptionObjectNSFields"},{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"}]}},"components/schemas/PUTScAddType":{"id":"components/schemas/PUTScAddType","kind":"json-schema","title":"chargeOverrides","data":{"allOf":[{"properties":{"amendedByOrderOn":{"description":"The date when the rate plan charge is amended through an order or amendment. This field is not updatable.\n\nThis field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n","type":"string"},"applyDiscountTo":{"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 charges that you want a specific discount to apply to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"ONETIME"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONETIMERECURRING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONETIMEUSAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRINGUSAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONETIMERECURRINGUSAGE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models:"},"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":"Recurring"},"children":[]}]}]}]}],"type":"string"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge 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":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]}],"type":"string"},"billCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to determine the billing day for the charge. When this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. When this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeklyBillCycleDay"},"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":"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":"DefaultFromCustomer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionStartDay"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeTriggerDay"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge 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":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]}],"type":"string"},"billingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). When you renew a subscription, the current subscription term is extended by creating a new term. If any charge in your subscription has the billing period set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"， a new charge segment is generated for the new term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quarter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Semi_Annual"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Annual"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Eighteen_Months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Two_Years"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Three_Years"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Five_Years"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription_Term"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge 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":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]}],"type":"string"},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aligns charges within the same subscription if multiple charges begin on different dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"AlignToCharge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge 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":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]}],"type":"string"},"billingTiming":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing timing for the charge for recurring charge types. Not avaliable for one time, usage and discount charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"IN_ADVANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_ARREARS"},"children":[]}]}]}]}],"type":"string"},"chargeModelConfiguration":{"$ref":"#/components/schemas/ChargeModelConfigurationType"},"description":{"description":"Description of the charge.\n","type":"string"},"discountAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the amount of fixed-amount discount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge type for the Discount-Fixed Amount charge model:"},"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":"Recurring"},"children":[]}]}]}]}],"type":"number"},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the discount applies to the product rate plan only , the entire subscription, or to any activity in the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"rateplan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models:"},"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":"Recurring"},"children":[]}]}]}]}],"type":"string"},"discountPercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage of a percentage discount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge type for the Discount-Percentage charge model:"},"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":"Recurring"},"children":[]}]}]}]}],"type":"number"},"endDateCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Subscription_End"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_End_Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"One_Time"},"children":[]}]}]}]}],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"includedUnits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of units in the base set of units for this charge. Must be >="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"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 for the following charge type for the Overage charge model:"},"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":"Usage-based"},"children":[]}]}]}]}],"type":"number"},"isAllocationEligible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the charge segment is allocation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eligible in revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"isUnbilled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition."},"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 field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price base for the product rate plan charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Per_Billing_Period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Week"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge type for the Flat Fee, Per Unit, Volume Pricing, and Tiered Pricing charge models:"},"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":"Recurring"},"children":[]}]}]}]}],"type":"string"},"number":{"description":"Unique number that identifies the charge. System-generated if not provided.\n","type":"string"},"numberOfPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge type for the Overage and Tiered with Overage charge models:"},"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":"Usage-based"},"children":[]}]}]}]}],"format":"int64","type":"integer"},"originalOrderDate":{"description":"The date when the rate plan charge is created through an order or amendment. This field is not updatable.\n\nThis field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n","format":"date","type":"string"},"overagePrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price for units over the allowed amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge type for the Overage and Tiered with Overage charge models:"},"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":"Usage-based"},"children":[]}]}]}]}],"type":"number"},"overageUnusedUnitsCreditOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to credit the customer with unused units of usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"NoCredit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditBySpecificRate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge type for the Overage and Tiered with Overage charge models:"},"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":"Usage-based"},"children":[]}]}]}]}],"type":"string"},"price":{"description":"Price for units in the subscription rate plan.\n\nSupports all charge types for the Flat Fee and Per Unit charge models\n","type":"number"},"priceChangeOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies an automatic price change when a termed subscription is renewed. The Zuora Billing Admin setting Enable Automatic Price Change When Subscriptions are Renewed?  must be set to Yes to use this field.  See Define Default Subscription Settings for more information on setting this option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"NoChange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UseLatestProductCatalogPricing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge 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":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not available for the Fixed-Amount Discount charge model."},"children":[]}]}]}]}],"type":"string"},"priceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PriceChangeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"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":"Decimal between -100 and 100."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge 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":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not available for the Fixed-Amount Discount charge model."},"children":[]}]}]}],"type":"number"},"productRatePlanChargeId":{"description":"","type":"string"},"productRatePlanChargeNumber":{"description":"Number of a product rate-plan charge for this subscription.                     ","type":"string"},"quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of units. Must be >="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"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 for the following charge types for the Per Unit, Volume Pricing, and Tiered Pricing charge models:"},"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":"One-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]}]}],"type":"number"},"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for per unit, volume pricing, and tiered pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-Time Charges and Recurring Charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string"},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of month or week for the charges billing period. Required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"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 for the following charge 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":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]}],"format":"int64","type":"integer"},"specificEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines when the charge ends after the charge trigger date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_End_Date"},"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 subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date."},"children":[]}]}]}],"format":"date","type":"string"},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer"},"tiers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge 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":"One-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/POSTTierType"},"type":"array"},"triggerDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge. Required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"UCE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UCA"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]}],"type":"string"},"unusedUnitsCreditRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the rate to credit a customer for unused units of usage. This field applies only for overage charge models when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OverageUnusedUnitsCreditOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditBySpecificRate"},"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 for the following charge type for the Overage and Tiered with Overage charge models:"},"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":"Usage-based"},"children":[]}]}]}]}],"type":"number"},"upToPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the charge ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Billing_Periods"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Weeks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Years"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer"},"upToPeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the charge ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Billing_Periods"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Weeks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Years"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"required":["productRatePlanChargeId"],"type":"object"},{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"}],"title":"chargeOverrides"}},"components/schemas/PUTSrpAddType":{"id":"components/schemas/PUTSrpAddType","kind":"json-schema","title":"add","data":{"allOf":[{"properties":{"bookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The default value is the current date when you make the API call."},"children":[]}]}]}],"format":"date","type":"string"},"chargeOverrides":{"description":"This optional container is used to override the quantity of one or more product rate plan charges for this subscription.\n","items":{"$ref":"#/components/schemas/PUTScAddType"},"type":"array"},"contractEffectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the amendment changes take effect. The format of the date is yyyy-mm-dd."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there is already a future-dated Update Product amendment on the subscription, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificUpdateDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be used instead of this field to specify when the Update Product amendment takes effect."},"children":[]}]}]}],"format":"date","type":"string"},"customerAcceptanceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the customer accepts the contract in yyyy-mm-dd format."},"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 not set:"},"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":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set, the value of this field is set to be the contract effective date."},"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":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set, the value of this field is set to be the service activation date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate"},"children":[]}]}]}],"format":"date","type":"string"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"externalIdSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the external source system. You can use this field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a product rate plan that is imported from an external system."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalIdSourceSystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"externallyManagedPlanId":{"description":"Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"productRatePlanId":{"description":"ID of a product rate plan for this subscription\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription\n","type":"string"},"serviceActivationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the new product in the subscription is activated in yyyy-mm-dd format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field defaults to be the Contract Effective Date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate"},"children":[]}]}]}],"format":"date","type":"string"}},"required":["contractEffectiveDate"],"type":"object"},{"$ref":"#/components/schemas/RatePlanObjectCustomFields"}],"title":"add"}},"components/schemas/PUTSrpChangeType":{"id":"components/schemas/PUTSrpChangeType","kind":"json-schema","title":"change","data":{"allOf":[{"properties":{"bookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The default value is the current date when you make the API call."},"children":[]}]}]}],"format":"date","type":"string"},"chargeOverrides":{"description":"This optional container is used to override one or more product rate plan charges for this subscription.","items":{"$ref":"#/components/schemas/PUTScAddType"},"type":"array"},"contractEffectiveDate":{"description":"Effective date of the new subscription, as yyyy-mm-dd.","format":"date","type":"string"},"customerAcceptanceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the customer accepts the contract in yyyy-mm-dd format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this field is not set:"},"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":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set, the value of this field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is set to be the contract effective date."},"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":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set, the value of this field is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set to be the service activation date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate"},"children":[]}]}]}],"format":"date","type":"string"},"effectivePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectivePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field 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":"If the rate plan change (from old to new) is an upgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveImmediately"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the rate plan change (from old to new) is a downgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"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":"Notes"},"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":"When setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you cannot set the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-trigger-dates-updation-for-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing trigger dates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the subscription as the system will automatically set the trigger dates to the end of billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contractEffectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}],"enum":["EffectiveImmediately","EffectiveEndOfBillingPeriod","SpecificDate"],"type":"string"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan. However, if there are multiple rate plans with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value existing in the subscription, you must use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to remove the rate plan. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be used to distinguish multiple rate plans in this case."},"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":" Provide only one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If more than one field is provided then the request would fail."},"children":[]}]}]}],"type":"string"},"externalIdSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the external source system. You can use this field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a product rate plan that is imported from an external system."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalIdSourceSystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"newExternalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan."},"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":" Provide only one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newExternalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newProductRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If both fields are provided then the request would fail."},"children":[]}]}]}],"type":"string"},"newExternalIdSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the external source system. You can use this field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newExternalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a product rate plan that is imported from an external system."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newExternalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newExternalIdSourceSystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newProductRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"newProductRatePlanId":{"description":"ID of a product rate plan for this subscription.","type":"string"},"newProductRatePlanNumber":{"description":"Number of a product rate plan for this subscription.","type":"string"},"productRatePlanId":{"description":"ID of the product rate plan that the removed rate plan is based on.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.    ","type":"string"},"ratePlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of a rate plan to remove. Note that the removal of a rate plan through the Change Plan amendment supports the function of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-rate-plans-removal-from-subscriptions-before-future-dated-removals","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removal before future-dated removals"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as in a Remove Product amendment."},"children":[]}]}]}],"type":"string"},"resetBcd":{"default":false,"description":"If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD.\n","type":"boolean"},"serviceActivationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the change in the subscription is activated in yyyy-mm-dd format. You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field defaults to be the Contract Effective Date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate"},"children":[]}]}]}],"format":"date","type":"string"},"subType":{"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 choose the sub type for your change plan amendment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, if you do not set this field, the field will be automatically generated by the system according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are within the same Grading catalog group:"},"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 grade of new plan is greater than that of the old plan, this is an \"Upgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan is less than that of the old plan, this is a \"Downgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan equals that of the old plan, this is a \"Crossgrade\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\"."},"children":[]}]}]}],"enum":["Upgrade","Downgrade","Crossgrade","PlanChanged"],"type":"string"},"subscriptionRatePlanNumber":{"description":"Number of a rate plan for this subscription.  ","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/RatePlanObjectCustomFields"}],"title":"change"}},"components/schemas/PUTSrpRemoveType":{"id":"components/schemas/PUTSrpRemoveType","kind":"json-schema","title":"remove","data":{"properties":{"bookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The default value is the current date when you make the API call."},"children":[]}]}]}],"format":"date","type":"string"},"contractEffectiveDate":{"description":"Effective date of the new subscription, as yyyy-mm-dd.\n","format":"date","type":"string"},"customerAcceptanceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the customer accepts the contract in yyyy-mm-dd format."},"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 not set:"},"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":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set, the value of this field is set to be the contract effective date."},"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":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set, the value of this field is set to be the service activation date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate"},"children":[]}]}]}],"format":"date","type":"string"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan. However, if there are multiple rate plans with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value existing in the subscription, you must use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to remove the rate plan. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be used to distinguish multiple rate plans in this case."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"externalIdSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the external source system. You can use this field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a product rate plan that is imported from an external system."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalIdSourceSystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanId":{"description":"ID of a rate plan for this subscription. This can be the latest version or any history version of ID.\n","type":"string"},"serviceActivationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the remove amendment is activated in yyyy-mm-dd format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field defaults to be the Contract Effective Date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate"},"children":[]}]}]}],"format":"date","type":"string"},"subscriptionRatePlanNumber":{"description":"Number of a rate plan for this subscription.\n","type":"string"}},"required":["contractEffectiveDate"],"title":"remove","type":"object"}},"components/schemas/PUTScUpdateType":{"id":"components/schemas/PUTScUpdateType","kind":"json-schema","title":"chargeUpdateDetails","data":{"allOf":[{"properties":{"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aligns charges within the same subscription if multiple charges begin on different dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"AlignToCharge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge 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":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]}],"type":"string"},"chargeModelConfiguration":{"$ref":"#/components/schemas/ChargeModelConfigurationType"},"description":{"description":"Description of the charge.\n","type":"string"},"includedUnits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of units in the base set of units for this charge. Must be >=0."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge type for the Overage charge model:"},"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":"Usage-based"},"children":[]}]}]}]}],"type":"number"},"overagePrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price for units over the allowed amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge type for the Overage and Tiered with Overage charge models:"},"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":"Usage-based"},"children":[]}]}]}]}],"type":"number"},"price":{"description":"Price for units in the subscription rate plan.\n\nSupports all charge types for the Flat Fee and Per Unit charge models\n","type":"number"},"priceChangeOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies an automatic price change when a termed subscription is renewed. The Billing Admin setting "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable Automatic Price Change When Subscriptions are Renewed?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to Yes to use this field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"NoChange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UseLatestProductCatalogPricing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available for the following charge 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":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not available for the Fixed-Amount Discount charge model."},"children":[]}]}]}],"type":"string"},"priceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PriceChangeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"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":"Decimal between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"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 for the following charge 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":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not available for the Fixed-Amount Discount charge model."},"children":[]}]}]}],"type":"number"},"quantity":{"description":"Quantity of units; must be greater than zero.\n","type":"number"},"ratePlanChargeId":{"description":"ID of a rate-plan charge for this subscription. It can be the latest version or any history version of ID.\n","type":"string"},"tiers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge 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":"One-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-based"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/POSTTierType"},"type":"array"},"triggerDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge. Required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to USD."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated for the following using the REST update subscription call:"},"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":"One-time charge type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount-Fixed Amount charge model"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount-Percentage charge model"},"children":[]}]}]}]}],"format":"date","type":"string"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"UCE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UCA"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the date when charge changes in the REST request become effective."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated for the following using the REST update subscription call:"},"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":"One-time charge type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount-Fixed Amount charge model"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount-Percentage charge model"},"children":[]}]}]}]}],"type":"string"}},"required":["ratePlanChargeId"],"type":"object"},{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"}],"title":"chargeUpdateDetails"}},"components/schemas/PUTSrpUpdateType":{"id":"components/schemas/PUTSrpUpdateType","kind":"json-schema","title":"update","data":{"allOf":[{"properties":{"bookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The default value is the current date when you make the API call."},"children":[]}]}]}],"format":"date","type":"string"},"chargeUpdateDetails":{"description":"Container for one or more product rate plan charges. \n","items":{"$ref":"#/components/schemas/PUTScUpdateType"},"type":"array"},"contractEffectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the amendment changes take effect. The format of the date is yyyy-mm-dd."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there is already a future-dated Update Product amendment on the subscription, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificUpdateDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be used instead of this field to specify when the Update Product amendment takes effect."},"children":[]}]}]}],"format":"date","type":"string"},"customerAcceptanceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the customer accepts the contract in yyyy-mm-dd format."},"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 not set:"},"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":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set, the value of this field is set to be the contract effective date."},"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":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set, the value of this field is set to be the service activation date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate"},"children":[]}]}]}],"format":"date","type":"string"},"externalCatalogPlanId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must match one of the values that are predefined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externallyManagedPlanIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on a product rate plan. However, if there are multiple rate plans with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value existing in the subscription, you must use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to update the rate plan. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be used to distinguish multiple rate plans in this case."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"externalIdSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the external source system. You can use this field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a product rate plan that is imported from an external system."},"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":" If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCatalogPlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalIdSourceSystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided. They must point to the same product rate plan. Otherwise, the request would fail."},"children":[]}]}]}],"type":"string"},"externallyManagedPlanId":{"description":"Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"productRatePlanNumber":{"description":"Number of a product rate plan for this subscription.\n","type":"string"},"ratePlanId":{"description":"ID of a rate plan for this subscription. This can be the latest version or any history version of ID.\n","type":"string"},"serviceActivationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the update amendment is activated in yyyy-mm-dd format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field defaults to be the Contract Effective Date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate"},"children":[]}]}]}],"format":"date","type":"string"},"specificUpdateDate":{"description":"The date when the Update Product amendment takes effect. This field is only applicable if there is already a future-dated Update Product amendment on the subscription. The format of the date is yyyy-mm-dd.\n\nRequired only for Update Product amendments if there is already a future-dated Update Product amendment on the subscription.\n","format":"date","type":"string"},"subscriptionRatePlanNumber":{"description":"Number of a rate plan for this subscription.\n","type":"string"}},"required":["contractEffectiveDate"],"type":"object"},{"$ref":"#/components/schemas/RatePlanObjectCustomFields"}],"title":"update"}},"components/schemas/PUTSubscriptionType":{"id":"components/schemas/PUTSubscriptionType","kind":"json-schema","title":"PUTSubscriptionType","data":{"allOf":[{"properties":{"add":{"description":"Container for adding one or more rate plans.\n","items":{"$ref":"#/components/schemas/PUTSrpAddType"},"type":"array"},"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply to invoices."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply credit memos or unapplied payments, or both to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"applyCreditBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply a credit balance to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit balance is applied to the invoice. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 you are using the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"This field is deprecated if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"autoRenew":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this subscription automatically renews at the end of the subscription term. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"bookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The booking date that you want to set for the contract when you change the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the subscription and as a result get a new version of subscription created. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The default value is the current date when you make the API call."},"children":[]}]}]}],"format":"date","type":"string"},"change":{"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 change one or more rate plans - to replace the existing rate plans in a subscription with other rate plans."},"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":": Changing rate plans is currently not supported for the  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PUTSrpChangeType"},"type":"array"},"collect":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the automatic payment is collected. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"196.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later available version."},"children":[]}]}]}],"type":"boolean"},"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"currentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the period for the current subscription term. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is required and must be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"termType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this value is ignored."},"children":[]}]}]}],"format":"int64","type":"integer"},"currentTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the current subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CurrentTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the current subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"documentDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the billing document, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos."},"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 field is specified, the specified date is used as the billing document date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, the date specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used as the billing document date."},"children":[]}]}]}]}],"format":"date","type":"string"},"externallyManagedBy":{"description":"An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n","enum":["Amazon","Apple","Google","Roku"],"type":"string"},"includeExistingDraftDocItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to include draft invoice items in subscription previews."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default). Includes draft invoice items in the preview result."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Excludes draft invoice items in the preview result."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later available version."},"children":[]}]}]}],"type":"boolean"},"invoiceSeparately":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Separates a single subscription from other subscriptions and invoices the charge independently."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is billed separately from other subscriptions. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is included with other subscriptions in the account invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Prerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes."},"children":[]}]}]}],"type":"boolean"},"notes":{"description":"The notes for the subscription.\n","maxLength":1000,"type":"string"},"preview":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the update is made in preview mode. The default setting is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"previewType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of preview you will receive."},"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":": If your API minor version is earlier than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"206.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for this request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"206.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or earlier, the following values are supported for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field:"},"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":"InvoiceItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeMetrics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceItemChargeMetrics"},"children":[]}]}]}]}],"enum":["LegalDoc","ChargeMetrics","LegalDocChargeMetrics"],"default":"LegalDoc","type":"string"},"remove":{"description":"Container for removing one or more rate plans.\n","items":{"$ref":"#/components/schemas/PUTSrpRemoveType"},"type":"array"},"renewalSetting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether a termed subscription will remain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or change to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it is renewed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_TO_EVERGREEN"},"children":[]}]}]}]}],"type":"string"},"renewalTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the period for the subscription renewal term. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","type":"integer"},"renewalTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the subscription renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the subscription renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"runBilling":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-and-credit-memo-generation-rule"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice and credit memo generation rule"},"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 billing documents generated in this operation is only for this subscription, not for the entire customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later available version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"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":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No invoice is created."},"children":[]}]}]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice or a credit memo is generated, as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd. Default is current date."},"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 credit memo is only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a  later available version."},"children":[]}]}]}],"format":"date","type":"string"},"termStartDate":{"description":"Date the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date. \n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"update":{"description":"Container for updating one or more rate plans.\n","items":{"$ref":"#/components/schemas/PUTSrpUpdateType"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/SubscriptionObjectQTFields"},{"$ref":"#/components/schemas/SubscriptionObjectNSFields"},{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"}],"example":{"autoRenew":true}}},"components/schemas/PUTSubscriptionPreviewInvoiceItemsType":{"id":"components/schemas/PUTSubscriptionPreviewInvoiceItemsType","kind":"json-schema","title":"invoiceItems","data":{"properties":{"chargeAmount":{"description":"The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive.\n","type":"number"},"chargeDescription":{"description":"Description of the charge.\n","type":"string"},"chargeName":{"description":"Name of the charge\n","type":"string"},"productName":{"description":"Name of the product associated with this item.\n","type":"string"},"productRatePlanChargeId":{"description":"","type":"string"},"quantity":{"description":"Quantity of this item.\n","type":"number"},"serviceEndDate":{"description":"End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd.\n","format":"date","type":"string"},"serviceStartDate":{"description":"Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge.\n","format":"date","type":"string"},"taxationItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of taxation items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"315.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later available version."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/POSTSubscriptionPreviewTaxationItemsType"},"type":"array"},"unitOfMeasure":{"description":"","type":"string"}},"title":"invoiceItems","type":"object"}},"components/schemas/PUTSubscriptionResponseType":{"id":"components/schemas/PUTSubscriptionResponseType","kind":"json-schema","title":"PUTSubscriptionResponseType","data":{"properties":{"chargeMetrics":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for charge metrics. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"dmrr":{"description":"Change in total contract value.\n","type":"string"},"dtcv":{"description":"Change in monthly recurring revenue.\n","type":"string"},"mrr":{"description":"Monthly recurring revenue.\n","type":"string"},"number":{"description":"The charge number of the subscription. Only available for update subscription.\n","type":"string"},"originRatePlanId":{"description":"The origin rate plan ID. Only available for update subscription.\n","type":"string"},"originalId":{"description":"The original rate plan charge ID. Only available for update subscription.\n","type":"string"},"productRatePlanChargeId":{"description":"","type":"string"},"productRatePlanId":{"description":"","type":"string"},"tcv":{"description":"Total contract value.\n","type":"string"}},"type":"object"},"creditMemo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for credit memos. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 container is only available if you set the Zuora REST API minor version to 207.0 or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header, and you have  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"properties":{"amount":{"description":"Credit memo amount.","format":"double","type":"number"},"amountWithoutTax":{"description":"Credit memo amount minus tax.","format":"double","type":"number"},"creditMemoItems":{"description":"","items":{"$ref":"#/components/schemas/POSTSubscriptionPreviewCreditMemoItemsType"},"type":"array"},"taxAmount":{"description":"Tax amount on the credit memo.","format":"double","type":"number"}},"type":"object"},"creditMemoId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memo ID. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a credit memo is generated during the update."},"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 container is only available if you set the Zuora REST API minor version to 207.0 or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header, and you have  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"invoice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for invoices. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Also, the response structure is changed and the following invoice related response fields are moved to this "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" container:"},"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":"amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amountWithoutTax"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoiceItems"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"targetDate"},"children":[]}]}]}]}],"properties":{"amount":{"description":"Invoice amount.","format":"double","type":"number"},"amountWithoutTax":{"description":"Invoice amount minus tax.\n","format":"double","type":"number"},"invoiceItems":{"description":"Container for invoice items.\n","items":{"$ref":"#/components/schemas/PUTSubscriptionPreviewInvoiceItemsType"},"type":"array"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"taxAmount":{"description":"The tax amount of the invoice.\n","format":"double","type":"number"}},"type":"object"},"invoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the generated invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an invoice is generated during the update."},"children":[]}]}]}],"type":"string"},"invoiceItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for invoice items. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PUTSubscriptionPreviewInvoiceItemsType"},"type":"array"},"paidAmount":{"description":"Payment amount, if a payment is collected\n","type":"number"},"paymentId":{"description":"Payment ID, if a payment is collected.\n","type":"string"},"subscriptionId":{"description":"The ID of the resulting new subscription.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 only available if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"207.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"taxAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax amount on the invoice. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"totalDeltaMrr":{"description":"Change in the subscription monthly recurring revenue as a result of the update.\n","type":"number"},"totalDeltaTcv":{"description":"Change in the total contracted value of the subscription as a result of the update.\n","type":"number"}},"type":"object"}},"components/schemas/GETSubscriptionTypeWithSuccess":{"id":"components/schemas/GETSubscriptionTypeWithSuccess","kind":"json-schema","title":"GETSubscriptionTypeWithSuccess","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the account associated with this subscription.","type":"string"},"accountName":{"description":"The name of the account associated with this subscription.","type":"string"},"accountNumber":{"description":"The number of the account associated with this subscription.","type":"string"},"autoRenew":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription automatically renews at the end of the term. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"billToContact":{"$ref":"#/components/schemas/GETAccountSummaryTypeBillToContact"},"cancelReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for a subscription cancellation copied from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of a Cancel Subscription order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"contractEffectiveDate":{"description":"Effective contract date for this subscription, as yyyy-mm-dd.\n","format":"date","type":"string"},"contractedMrr":{"description":"Monthly recurring revenue of the subscription, does not count in the discounts.\n","type":"number"},"contractedNetMrr":{"description":"Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.\n","type":"number"},"asOfDayGrossMrr":{"description":"Monthly recurring revenue of the subscription exclusive of any discounts applicable as of specified day.\n","type":"number"},"asOfDayNetMrr":{"description":"Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day.\n","type":"number"},"netTotalContractedValue":{"description":"Total contracted value of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.\n","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"currentTerm":{"description":"The length of the period for the current subscription term.\n","format":"int64","type":"integer"},"currentTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the current subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"customerAcceptanceDate":{"description":"The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n","format":"date","type":"string"},"externallyManagedBy":{"description":"An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n","enum":["Amazon","Apple","Google","Roku"],"type":"string"},"id":{"description":"Subscription ID.\n","type":"string"},"initialTerm":{"description":"The length of the period for the first subscription term.\n","format":"int64","type":"integer"},"initialTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the first subscription term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"invoiceOwnerAccountId":{"description":"","type":"string"},"invoiceOwnerAccountName":{"description":"","type":"string"},"invoiceOwnerAccountNumber":{"description":"","type":"string"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"integer"},"invoiceSeparately":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Separates a single subscription from other subscriptions and creates an invoice for the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is billed separately from other subscriptions. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription is included with other subscriptions in the account invoice."},"children":[]}]}]}],"type":"boolean"},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"invoiceTemplateName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field during subscription creation, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"isLatestVersion":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current subscription object is the latest version."},"children":[]}]}]}],"type":"boolean"},"lastBookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set per the user's timezone. The value of this field 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":"For a new subscription created by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-apis-subscribe-and-amend"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend APIs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field has the value of the subscription creation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a subscription changed by an amendment, this field has the value of the amendment booking date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a subscription created or changed by an order, this field has the value of the order date."},"children":[]}]}]}]}],"format":"date","type":"string"},"notes":{"description":"A string of up to 65,535 characters.\n","type":"string"},"orderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order number of the order in which the changes on the subscription are made."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-order-metrics"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Metrics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". We will investigate your use cases and data before enabling this feature for you."},"children":[]}]}]}],"type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"scheduledCancelDate":{"description":"The date when the subscription is scheduled to be canceled.","format":"date","type":"string"},"scheduledSuspendDate":{"description":"The date when the subscription is scheduled to be suspended.","format":"date","type":"string"},"scheduledResumeDate":{"description":"The date when the subscription is scheduled to be resumed.","format":"date","type":"string"},"ramp":{"$ref":"#/components/schemas/SubscriptionRampResponse"},"ratePlans":{"description":"Container for rate plans.\n","items":{"$ref":"#/components/schemas/GETSubscriptionRatePlanType"},"type":"array"},"renewalSetting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether a termed subscription will remain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or change to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it is renewed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"RENEW_WITH_SPECIFIC_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RENEW_TO_EVERGREEN"},"children":[]}]}]}]}],"type":"string"},"renewalTerm":{"description":"The length of the period for the subscription renewal term.\n","format":"int64","type":"integer"},"renewalTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the subscription renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values 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":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]}],"type":"string"},"revision":{"description":"An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions.\n","type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the subscription."},"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":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature disabled, this field is unavailable in the request body and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}],"type":"string"},"sequenceSetName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field during subscription creation, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"serviceActivationDate":{"description":"The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd\n","format":"date","type":"string"},"shipToContact":{"$ref":"#/components/schemas/GetAccountSummaryTypeShipToContact"},"soldToContact":{"$ref":"#/components/schemas/GETAccountSummaryTypeSoldToContact"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription status; possible values 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":"Draft"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Suspended"},"children":[]}]}]}]}],"type":"string"},"statusHistory":{"description":"Container for status history.\n","items":{"$ref":"#/components/schemas/GETSubscriptionStatusHistoryType"},"type":"array"},"subscriptionEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription term ends, where the subscription ends at midnight the day before."},"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":"subscriptionEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This date is the same as the term end date or the cancelation date, as appropriate."},"children":[]}]}]}],"format":"date","type":"string"},"subscriptionNumber":{"description":"Subscription number.","type":"string"},"subscriptionStartDate":{"description":"Date the subscription becomes effective.\n","format":"date","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"termEndDate":{"description":"Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set).\n","format":"date","type":"string"},"termStartDate":{"description":"Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date.\n","format":"date","type":"string"},"termType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"totalContractedValue":{"description":"Total contracted value of the subscription.\n","type":"number"},"totalNumberOfChargeSegments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of charge segments in this subscription, including segments from removed charges. This value is the sum of the segments for all charges under the subscription."},"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 default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there are no charge segments."},"children":[]}]}]}],"type":"integer"},"uniqueToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique string to represent the subscription in the order. Use this token to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference the subscription in other actions within the same order, such as in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commitment eligibility conditions. Must be unique across all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createSubscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order actions within the same order."},"children":[]}]}]}],"maxLength":50,"type":"string"},"version":{"description":"This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment.","format":"int64","type":"integer"}},"type":"object"},{"$ref":"#/components/schemas/SubscriptionObjectQTFields"},{"$ref":"#/components/schemas/SubscriptionObjectNSFields"},{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"}]}},"components/schemas/PUTRenewSubscriptionType":{"id":"components/schemas/PUTRenewSubscriptionType","kind":"json-schema","title":"PUTRenewSubscriptionType","data":{"example":{"runBilling":true},"properties":{"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply to invoices."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"applyCreditBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply a credit balance to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit balance is applied to the invoice. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 you are using the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"This field is deprecated if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"collect":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the automatic payment is collected. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"196.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"documentDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the billing document, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos."},"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 field is specified, the specified date is used as the billing document date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, the date specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used as the billing document date."},"children":[]}]}]}]}],"format":"date","type":"string"},"orderDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"This field is required for Orders customers only, not applicable to Orders Harmonization customers."},"children":[]}]}]}],"format":"date","type":"string"},"runBilling":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-and-credit-memo-generation-rule"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice and credit memo generation rule"},"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 billing documents generated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this operation is only for this subscription, not for the entire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"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":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No invoice is created."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date."},"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":":"},"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":"This field is available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"The credit memo is only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]}]}],"format":"date","type":"string"}},"type":"object"}},"components/schemas/PUTRenewSubscriptionResponseType":{"id":"components/schemas/PUTRenewSubscriptionResponseType","kind":"json-schema","title":"PUTRenewSubscriptionResponseType","data":{"properties":{"creditMemoId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memo ID, if a credit memo is generated during the subscription process."},"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 container is only available if you set the Zuora REST API minor version to 207.0 or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header, and you have  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"invoiceId":{"description":"Invoice ID, if one is generated.\n","type":"string"},"paidAmount":{"description":"Payment amount, if payment is collected.\n","type":"number"},"paymentId":{"description":"Payment ID, if payment is collected.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"termEndDate":{"description":"Date the new subscription term ends, as yyyy-mm-dd.\n","format":"date","type":"string"},"termStartDate":{"description":"Date the new subscription term begins, as yyyy-mm-dd.\n","format":"date","type":"string"},"totalDeltaMrr":{"description":"Change in the subscription monthly recurring revenue as a result of the update. For a renewal, this is the MRR of the subscription in the new term.\n","type":"number"},"totalDeltaTcv":{"description":"Change in the total contracted value of the subscription as a result of the update. For a renewal, this is the TCV of the subscription in the new term.\n","type":"number"}},"type":"object"}},"components/schemas/POSTSubscriptionCancellationType":{"id":"components/schemas/POSTSubscriptionCancellationType","kind":"json-schema","title":"POSTSubscriptionCancellationType","data":{"example":{"cancellationPolicy":"EndOfCurrentTerm"},"properties":{"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply to invoices."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"applyCreditBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply a credit balance to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit balance is applied to the invoice. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 you are using the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"This field is deprecated if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"bookingDate":{"description":"The booking date that you want to set for the amendment contract when you cancel the subscription. The default value is the current date when you make the API call.\n","format":"date","type":"string"},"cancellationEffectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the cancellation takes effect, in the format yyyy-mm-dd.  Use only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancellationPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced."},"children":[]}]}]}],"format":"date","type":"string"},"cancellationPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancellation method. Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndOfCurrentTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndOfLastInvoicePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancellationEffectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]}],"type":"string"},"collect":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the automatic payment is collected. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"196.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"contractEffectiveDate":{"description":"The date when the customer notifies you that they want to cancel their subscription.\n","format":"date","type":"string"},"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"documentDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the billing document, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos."},"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 field is specified, the specified date is used as the billing document date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, the date specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used as the billing document date."},"children":[]}]}]}]}],"format":"date","type":"string"},"orderDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"This field is required for Orders customers only, not applicable to Orders Harmonization customers."},"children":[]}]}]}],"format":"date","type":"string"},"runBilling":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-and-credit-memo-generation-rule"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice and credit memo generation rule"},"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 billing documents generated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this operation is only for this subscription, not for the entire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"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":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No invoice is created."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice or a credit memo is generated, as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd. Default is current date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":":"},"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":"This field is available only if you are on the latest Zuora"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"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":"The credit memo is only available if you have the Invoice"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement feature enabled."},"children":[]}]}]}]}],"format":"date","type":"string"}},"required":["cancellationPolicy"],"type":"object"}},"components/schemas/POSTSubscriptionCancellationResponseType":{"id":"components/schemas/POSTSubscriptionCancellationResponseType","kind":"json-schema","title":"POSTSubscriptionCancellationResponseType","data":{"properties":{"cancelledDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the subscription was canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available in the Orders Harmonization tenants and the Subscribe and Amend tenants. This field is not available in the Orders tenants. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-tenant-type-identification-for-managing-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify your tenant type for managing subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"creditMemoId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memo ID, if a credit memo is generated during the subscription process."},"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 container is only available if you set the Zuora REST API minor version to 207.0 or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header, and you have  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"invoiceId":{"description":"ID of the invoice, if one is generated.\n","type":"string"},"paidAmount":{"description":"Amount paid.\n","type":"number"},"paymentId":{"description":"ID of the payment, if a payment is collected.\n","type":"string"},"subscriptionId":{"description":"The subscription ID.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"totalDeltaMrr":{"description":"Change in the subscription monthly recurring revenue as a result of the update.\n","type":"number"},"totalDeltaTcv":{"description":"Change in the total contracted value of the subscription as a result of the update.\n","type":"number"}},"type":"object"}},"components/schemas/PUTSubscriptionResumeType":{"id":"components/schemas/PUTSubscriptionResumeType","kind":"json-schema","title":"PUTSubscriptionResumeType","data":{"example":{"resumePolicy":"Today"},"properties":{"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply to invoices."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"applyCreditBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply a credit balance to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit balance is applied to the invoice. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 if you have the Invoice Settlement feature enabled."},"children":[]}]}]}],"type":"boolean"},"bookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The booking date that you want to set for the amendment contract when you resume the subscription. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extendsTerm"},"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":", which means you also extend the term, then this field is also the booking date for the Terms and Conditions amendment contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The default value of this field is the current date when you make the API call."},"children":[]}]}]}],"format":"date","type":"string"},"collect":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the automatic payment is collected. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"196.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later available version."},"children":[]}]}]}],"type":"boolean"},"contractEffectiveDate":{"description":"The date when the customer notifies you that they want to resume their subscription.\n","format":"date","type":"string"},"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"documentDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the billing document, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos."},"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 field is specified, the specified date is used as the billing document date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, the date specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used as the billing document date."},"children":[]}]}]}]}],"format":"date","type":"string"},"extendsTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to extend the subscription term by the length of time the suspension is in effect."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"orderDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"This field is required for Orders customers only, not applicable to Orders Harmonization customers."},"children":[]}]}]}],"format":"date","type":"string"},"resumePeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the period."},"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 only applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"resumePeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"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 only applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"resumePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resume methods. Specify a way to resume a subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values:"},"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":"code","inline":true,"attributes":{"content":"Today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription resumption takes effect on today's date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription resumption takes effect after a specified period based on the suspend date. You must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to define the period."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription resumption takes effect on a specific date. You must define the specific date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumeSpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription resumption takes effect after a specified period based on the today's date. You must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to define the period."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription resumption takes effect on the date of suspension of the subscription."},"children":[]}]}]}]}]}],"type":"string"},"resumeSpecificDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd."},"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 only applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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 value should not be earlier than the subscription suspension date."},"children":[]}]}]}],"format":"date","type":"string"},"runBilling":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-and-credit-memo-generation-rule"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice and credit memo generation rule"},"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 billing documents generated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this operation is only for this subscription, not for the entire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"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":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No invoice is created."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later available version."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice or a credit memo is generated, as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd. Default is current date."},"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":"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":"This field is available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a  later available version."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memo is only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]}],"format":"date","type":"string"}},"required":["resumePolicy"],"type":"object"}},"components/schemas/PUTSubscriptionResumeResponseType":{"id":"components/schemas/PUTSubscriptionResumeResponseType","kind":"json-schema","title":"PUTSubscriptionResumeResponseType","data":{"properties":{"creditMemoId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memo ID, if a credit memo is generated during the subscription process."},"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 container is only available if you set the Zuora REST API minor version to 207.0 or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header, and you have  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"invoiceId":{"description":"Invoice ID, if an invoice is generated during the subscription process.\n","type":"string"},"paidAmount":{"description":"Payment amount, if a payment is collected.\n","type":"number"},"paymentId":{"description":"Payment ID, if a payment is collected.\n","type":"string"},"resumeDate":{"description":"The date when subscription resumption takes effect, as yyyy-mm-dd.\n","format":"date","type":"string"},"subscriptionId":{"description":"The subscription ID.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"termEndDate":{"description":"The date when the new subscription term ends, as yyyy-mm-dd.\n","format":"date","type":"string"},"totalDeltaTcv":{"description":"Change in the total contracted value of the subscription as a result of the update.\n","type":"number"}},"type":"object"}},"components/schemas/PUTSubscriptionSuspendType":{"id":"components/schemas/PUTSubscriptionSuspendType","kind":"json-schema","title":"PUTSubscriptionSuspendType","data":{"example":{"suspendPolicy":"Today"},"properties":{"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply to invoices."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"applyCreditBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply a credit balance to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit balance is applied to the invoice. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 you are using the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceCollect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"This field is deprecated if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]}],"type":"boolean"},"bookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The booking date that you want to set for the amendment contract when you suspend the subscription. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resume"},"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":", which means you also choose to resume the subscription at some point, then this field is also the booking date for the Resume amendment contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The default value of this field is the current date when you make the API call."},"children":[]}]}]}],"format":"date","type":"string"},"collect":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the automatic payment is collected. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisite: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"196.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later available version."},"children":[]}]}]}],"type":"boolean"},"contractEffectiveDate":{"description":"The date when the customer notifies you that they want to amend their subscription.\n","format":"date","type":"string"},"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"documentDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the billing document, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos."},"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 field is specified, the specified date is used as the billing document date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, the date specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used as the billing document date."},"children":[]}]}]}]}],"format":"date","type":"string"},"extendsTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to extend the subscription term by the length of time the suspension is in effect. Values: "},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"orderDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"This field is required for Orders customers only, not applicable to Orders Harmonization customers."},"children":[]}]}]}],"format":"date","type":"string"},"resume":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to set when to resume a subscription when creating a suspend amendment. Values: "},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"resumePeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the period."},"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 only applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"resumePeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the resumePeriods field to specify the period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"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 only applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"resumePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resume methods. Specify a way to resume a subscription. Values:"},"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":"code","inline":true,"attributes":{"content":"Today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription resumption takes effect on today's date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromSuspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription resumption takes effect after a specified period based on the suspend date. You must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to define the period."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription resumption takes effect on a specific date. You must define the specific date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumeSpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription resumption takes effect after a specified period based on the today's date. You must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to define the period."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription resumption takes effect on the date of suspension of the subscription."},"children":[]}]}]}]}]}],"type":"string"},"resumeSpecificDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd."},"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 only applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resumePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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 value should not be earlier than the subscription suspension date."},"children":[]}]}]}],"format":"date","type":"string"},"runBilling":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-and-credit-memo-generation-rule"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice and credit memo generation rule"},"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 billing documents generated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this operation is only for this subscription, not for the entire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"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":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No invoice is created."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a  later available version."},"children":[]}]}]}],"type":"boolean"},"suspendPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the period used to specify when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the period."},"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 only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday."},"children":[]}]}]}],"type":"string"},"suspendPeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the suspendPeriods field to specify the period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type: string (enum)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Year"},"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 only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday."},"children":[]}]}]}],"type":"string"},"suspendPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suspend methods. Specify a way to suspend a subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value:"},"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":"Today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription suspension takes effect on today's date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndOfLastInvoicePeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription suspension takes effect at the end of the last invoice period. The suspend date defaults to a date that is one day after the last invoiced period. You can choose this option to avoid any negative invoices (credits) issued back to the customer after the subscription suspension."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription suspension takes effect on a specific date. You must define the specific date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendSpecificDate"},"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":"code","inline":true,"attributes":{"content":"FixedPeriodsFromToday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subscription suspension takes effect after a specified period based on today's date. You must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspendPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to define the period."},"children":[]}]}]}]}],"type":"string"},"suspendSpecificDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A specific date when the subscription suspension takes effect, in the format yyyy-mm-dd."},"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 only applicable only when the suspendPolicy field is set to SpecificDate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value should not be earlier than the subscription contract effective date, later than the subscription term end date, or within a period for which the customer has been invoiced."},"children":[]}]}]}],"format":"date","type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date through which to calculate charges if an invoice or a credit memo is generated, as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd. Default is current date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"211.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later available version."},"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 credit memo is only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["suspendPolicy"],"type":"object"}},"components/schemas/PUTSubscriptionSuspendResponseType":{"id":"components/schemas/PUTSubscriptionSuspendResponseType","kind":"json-schema","title":"PUTSubscriptionSuspendResponseType","data":{"properties":{"creditMemoId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit memo ID, if a credit memo is generated during the subscription process."},"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 container is only available if you set the Zuora REST API minor version to 207.0 or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request header, and you have  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"invoiceId":{"description":"Invoice ID, if an invoice is generated during the subscription process.\n","type":"string"},"paidAmount":{"description":"Payment amount, if a payment is collected.\n","type":"number"},"paymentId":{"description":"Payment ID, if a payment is collected.\n","type":"string"},"resumeDate":{"description":"The date when subscription resumption takes effect, in the format yyyy-mm-dd.\n","format":"date","type":"string","nullable":true},"subscriptionId":{"description":"The subscription ID.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"suspendDate":{"description":"The date when subscription suspension takes effect, in the format yyyy-mm-dd.\n","format":"date","type":"string"},"termEndDate":{"description":"The date when the new subscription term ends, in the format yyyy-mm-dd.\n","format":"date","type":"string"},"totalDeltaTcv":{"description":"Change in the total contracted value of the subscription as a result of the update.\n","type":"number"}},"type":"object"}},"components/schemas/PUTDeleteSubscriptionResponseType":{"id":"components/schemas/PUTDeleteSubscriptionResponseType","kind":"json-schema","title":"PUTDeleteSubscriptionResponseType","data":{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request is processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PUTSubscriptionPatchSpecificVersionRequestType":{"id":"components/schemas/PUTSubscriptionPatchSpecificVersionRequestType","kind":"json-schema","title":"PUTSubscriptionPatchSpecificVersionRequestType","data":{"example":{"customFields":{"CustomTag__c":"internal"}},"properties":{"customFields":{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"},"ratePlans":{"items":{"properties":{"charges":{"items":{"properties":{"chargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the charge for which you will be updating the custom fields. By using this field you actually specify a specific charge segment of a charge. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-soap-api-object-rateplancharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segmented rate plan charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about charge segments."},"children":[]}]}]}],"type":"string"},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the charge for which you will be updating the custom fields. By using this field you actually specify the last charge segment of a charge. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-soap-api-object-rateplancharge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segmented rate plan charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about charge segments."},"children":[]}]}]}],"type":"string"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"}},"type":"object"},"type":"array"},"customFields":{"$ref":"#/components/schemas/RatePlanObjectCustomFields"},"ratePlanId":{"description":"The rate plan id in any version of the subscription. This will be linked to the only one rate plan in the current version.","type":"string"}},"required":["ratePlanId"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/GETMetricsBySubscriptionNumbersResponse":{"id":"components/schemas/GETMetricsBySubscriptionNumbersResponse","kind":"json-schema","title":"GETMetricsBySubscriptionNumbersResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"subscriptionMetrics":{"items":{"properties":{"subscriptionNumber":{"description":"The number for the subscription.\n","type":"string"},"contractedMrr":{"description":"Monthly recurring revenue of the subscription.\n","type":"number"},"contractedNetMrr":{"description":"Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.\n","type":"number"},"asOfDayGrossMrr":{"description":"Monthly recurring revenue of the subscription rate plan exclusive of any discounts applicable as of specified day.\n","type":"number"},"asOfDayNetMrr":{"description":"Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day.\n","type":"number"},"netTotalContractedValue":{"description":"Total contracted value of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.\n","type":"number"},"totalContractedValue":{"description":"Total contracted value of the subscription.\n","type":"number"}},"type":"object"},"type":"array"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanAmendment":{"id":"components/schemas/OrderActionRatePlanAmendment","kind":"json-schema","title":"OrderActionRatePlanAmendment","data":{"description":"The amendment that is related to the subscription rate plan.\n","properties":{"code":{"description":"The amendment code.\n","type":"string"},"contractEffectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the amendment becomes effective for billing purposes, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"createdBy":{"description":"The ID of the user who created this amendment.\n","type":"string"},"createdDate":{"description":"The time that the amendment gets created in the system.","type":"string"},"customerAcceptanceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the customer accepts the amendment changes to the subscription, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"description":{"description":"Description of the amendment.\n","type":"string","nullable":true},"effectiveDate":{"description":"The date when the amendment changes take effective. \n","format":"date","type":"string"},"id":{"description":"The amendment ID.\n","type":"string"},"name":{"description":"The name of the amendment.\n","type":"string"},"serviceActivationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when service is activated, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"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 amendment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"text","inline":true,"attributes":{"content":"NewProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]}]}],"type":"string"},"updatedBy":{"description":"The ID of the user who updated this amendment.","type":"string"},"updatedDate":{"description":"The time that the amendment gets updated in the system.","type":"string"},"customFields":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Amendment object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Amendment object.\n","type":"object"}}}},"components/schemas/OrderActionRatePlanRatePlanChargeObjectCustomFields":{"id":"components/schemas/OrderActionRatePlanRatePlanChargeObjectCustomFields","kind":"json-schema","title":"ratePlanChargeFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan Charge object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Rate Plan Charge object.\n","title":"ratePlanChargeFieldsCustom","type":"object"}},"components/schemas/OrderActionRatePlanEndConditions":{"id":"components/schemas/OrderActionRatePlanEndConditions","kind":"json-schema","title":"endDate","data":{"description":"Specifies when a charge becomes inactive.\n","properties":{"endDateCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become inactive."},"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":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge is active for a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"Specific_End_Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when then charge becomes inactive."},"children":[]}]}]}],"enum":["Subscription_End","Fixed_Period","Specific_End_Date"],"type":"string"},"specificEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date in YYYY-MM-DD format. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_End_Date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"upToPeriods":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the charge in billing periods, days, weeks, months, or years, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"upToPeriodsType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of time that the charge duration is measured in. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed_Period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Billing_Periods","Days","Weeks","Months","Years"],"type":"string"}},"title":"endDate","type":"object"}},"components/schemas/OrderActionRatePlanChargeTier":{"id":"components/schemas/OrderActionRatePlanChargeTier","kind":"json-schema","title":"chargeTier","data":{"properties":{"endingUnit":{"description":"Limit on the number of units for which the tier is effective.\n","type":"number"},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price or per-unit price of the tier, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceFormat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"number"},"priceFormat":{"description":"Specifies whether the tier has a fixed price or a per-unit price.\n","enum":["FlatFee","PerUnit"],"type":"string"},"startingUnit":{"description":"Number of units at which the tier becomes effective.\n","type":"number"},"tier":{"description":"Index of the tier in the charge.\n","minimum":1,"type":"integer"}},"required":["tier","startingUnit","price","priceFormat"],"title":"chargeTier","type":"object"}},"components/schemas/OrderActionRatePlanChargeModelDataOverride":{"id":"components/schemas/OrderActionRatePlanChargeModelDataOverride","kind":"json-schema","title":"chargeModelData","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for charge model configuration data."},"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 only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"properties":{"chargeModelConfiguration":{"properties":{"customFieldPerUnitRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field that carries the per-unit rate for each usage record. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"perUnitAmount__c"},"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 field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"type":"string"},"customFieldTotalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field that carries the total amount to charge for a usage record. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount__c"},"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 field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"type":"string"},"formula":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pricing formula to calculate actual rating amount for each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"type":"string"}},"type":"object"},"tiers":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of cumulative pricing tiers in the charge."},"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":": When you override tiers of the charge with a High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Editions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pricing information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"title":"chargeModelData","type":"object"}},"components/schemas/OrderActionRatePlanDiscountPricingOverride":{"id":"components/schemas/OrderActionRatePlanDiscountPricingOverride","kind":"json-schema","title":"discount","data":{"description":"Pricing information about a discount charge.\n","properties":{"applyDiscountTo":{"description":"Specifies which type of charge the discount charge applies to.\n","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"],"type":"string"},"discountAmount":{"description":"Only applicable if the discount charge is a fixed-amount discount.\n","type":"number"},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account"],"type":"string"},"discountPercentage":{"description":"Only applicable if the discount charge is a percentage discount.\n","type":"number"},"priceChangeOption":{"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n","enum":["NoChange","UseLatestProductCatalogPricing"],"type":"string"}},"title":"discount","type":"object"}},"components/schemas/OrderActionRatePlanOneTimeFlatFeePricingOverride":{"id":"components/schemas/OrderActionRatePlanOneTimeFlatFeePricingOverride","kind":"json-schema","title":"oneTimeFlatFee","data":{"description":"Pricing information about a one-time charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n","properties":{"listPrice":{"description":"Price of the charge.\n","type":"number"}},"required":["listPrice"],"title":"oneTimeFlatFee","type":"object"}},"components/schemas/OrderActionRatePlanOneTimePerUnitPricingOverride":{"id":"components/schemas/OrderActionRatePlanOneTimePerUnitPricingOverride","kind":"json-schema","title":"oneTimePerUnit","data":{"description":"Pricing information about a one-time charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n","properties":{"listPrice":{"description":"Per-unit price of the charge.\n","type":"number"},"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"}},"title":"oneTimePerUnit","type":"object"}},"components/schemas/OrderActionRatePlanOneTimeTieredPricingOverride":{"id":"components/schemas/OrderActionRatePlanOneTimeTieredPricingOverride","kind":"json-schema","title":"oneTimeTiered","data":{"description":"Pricing information about a one-time charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n","properties":{"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"tiers":{"description":"List of cumulative pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"title":"oneTimeTiered","type":"object"}},"components/schemas/OrderActionRatePlanOneTimeVolumePricingOverride":{"id":"components/schemas/OrderActionRatePlanOneTimeVolumePricingOverride","kind":"json-schema","title":"oneTimeVolume","data":{"description":"Pricing information about a one-time charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n","properties":{"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"tiers":{"description":"List of variable pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"title":"oneTimeVolume","type":"object"}},"components/schemas/OrderActionRatePlanPriceChangeParams":{"id":"components/schemas/OrderActionRatePlanPriceChangeParams","kind":"json-schema","title":"OrderActionRatePlanPriceChangeParams","data":{"properties":{"priceChangeOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora changes the price of the charge each time the subscription renews."},"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":"SpecificPercentageValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceIncreasePercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify how much the price of the charge should change."},"children":[]}]}]}],"enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"type":"string"},"priceIncreasePercentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceChangeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minimum":-100,"type":"number"}},"type":"object"}},"components/schemas/OrderActionRatePlanRecurringDeliveryPricingOverride":{"id":"components/schemas/OrderActionRatePlanRecurringDeliveryPricingOverride","kind":"json-schema","title":"recurringDelivery","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"deliverySchedule":{"$ref":"#/components/schemas/DeliveryScheduleParams"},"listPrice":{"description":"Price of the charge in each recurring period.\n","type":"number"}},"type":"object"}],"description":"Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled.\n","title":"recurringDelivery"}},"components/schemas/OrderActionRatePlanRecurringFlatFeePricingOverride":{"id":"components/schemas/OrderActionRatePlanRecurringFlatFeePricingOverride","kind":"json-schema","title":"recurringFlatFee","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"listPrice":{"description":"Price of the charge in each recurring period.\n","type":"number"},"listPriceBase":{"description":"Specifies the duration of each recurring period.\n","enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months"],"type":"string"},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. 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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer"}},"type":"object"}],"description":"Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n","title":"recurringFlatFee"}},"components/schemas/OrderActionRatePlanRecurringPerUnitPricingOverride":{"id":"components/schemas/OrderActionRatePlanRecurringPerUnitPricingOverride","kind":"json-schema","title":"recurringPerUnit","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"listPrice":{"description":"Per-unit price of the charge in each recurring period.\n","type":"number"},"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the duration of each recurring period."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum values are available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months"],"type":"string"},"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer"}},"type":"object"}],"description":"Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n","title":"recurringPerUnit"}},"components/schemas/OrderActionRatePlanRecurringTieredPricingOverride":{"id":"components/schemas/OrderActionRatePlanRecurringTieredPricingOverride","kind":"json-schema","title":"recurringTiered","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"listPriceBase":{"description":"Specifies the duration of each recurring period.\n","enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months"],"type":"string"},"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer"},"tiers":{"description":"List of cumulative pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"type":"object"}],"description":"Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n","title":"recurringTiered"}},"components/schemas/OrderActionRatePlanRecurringVolumePricingOverride":{"id":"components/schemas/OrderActionRatePlanRecurringVolumePricingOverride","kind":"json-schema","title":"recurringVolume","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"listPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the duration of each recurring period."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum values are available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"enum":["Per_Billing_Period","Per_Month","Per_Week","Per_Year","Per_Specific_Months"],"type":"string"},"quantity":{"description":"Number of units purchased.\n","minimum":0,"type":"number"},"specificListPriceBase":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32","maximum":200,"minimum":1,"type":"integer"},"tiers":{"description":"List of variable pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"type":"object"}],"description":"Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n","title":"recurringVolume"}},"components/schemas/OrderActionRatePlanUsageFlatFeePricingOverride":{"id":"components/schemas/OrderActionRatePlanUsageFlatFeePricingOverride","kind":"json-schema","title":"usageFlatFee","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"listPrice":{"description":"Price of the charge.\n","type":"number"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n","title":"usageFlatFee"}},"components/schemas/OrderActionRatePlanUsageOveragePricingOverride":{"id":"components/schemas/OrderActionRatePlanUsageOveragePricingOverride","kind":"json-schema","title":"usageOverage","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"includedUnits":{"description":"Number of free units that may be consumed.\n","minimum":0,"type":"number"},"numberOfPeriods":{"description":"Number of periods that Zuora considers when calculating overage charges with overage smoothing.\n","minimum":1,"type":"integer"},"overagePrice":{"description":"Price per overage unit consumed.\n","type":"number"},"overageUnusedUnitsCreditOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to credit the customer for unused units."},"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":"CreditBySpecificRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unusedUnitsCreditRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the rate at which to credit the customer for unused units."},"children":[]}]}]}],"enum":["NoCredit","CreditBySpecificRate"],"type":"string"},"unusedUnitsCreditRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageUnusedUnitsCreditOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditBySpecificRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n","title":"usageOverage"}},"components/schemas/OrderActionRatePlanUsagePerUnitPricingOverride":{"id":"components/schemas/OrderActionRatePlanUsagePerUnitPricingOverride","kind":"json-schema","title":"usagePerUnit","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"listPrice":{"description":"Per-unit price of the charge.\n","type":"number"},"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora groups usage records when rating usage. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-usage-rating-by-group"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage Rating by Group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"ByBillingPeriod (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageStartDate: The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageRecord: The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file."},"children":[]}]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload"],"type":"string"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n","title":"usagePerUnit"}},"components/schemas/OrderActionRatePlanUsageTieredPricingOverride":{"id":"components/schemas/OrderActionRatePlanUsageTieredPricingOverride","kind":"json-schema","title":"usageTiered","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora groups usage records when rating usage. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-usage-rating-by-group"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage Rating by Group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"ByBillingPeriod (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageStartDate: The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageRecord: The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file."},"children":[]}]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload"],"type":"string"},"tiers":{"description":"List of cumulative pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n","title":"usageTiered"}},"components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingOverride":{"id":"components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingOverride","kind":"json-schema","title":"usageTieredWithOverage","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"numberOfPeriods":{"description":"Number of periods that Zuora considers when calculating overage charges with overage smoothing.\n","minimum":1,"type":"integer"},"overagePrice":{"description":"Price per overage unit consumed.\n","type":"number"},"overageUnusedUnitsCreditOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to credit the customer for unused units."},"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":"CreditBySpecificRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unusedUnitsCreditRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the rate at which to credit the customer for unused units."},"children":[]}]}]}],"enum":["NoCredit","CreditBySpecificRate"],"type":"string"},"tiers":{"description":"List of cumulative pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"},"unusedUnitsCreditRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageUnusedUnitsCreditOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditBySpecificRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n","title":"usageTieredWithOverage"}},"components/schemas/OrderActionRatePlanUsageVolumePricingOverride":{"id":"components/schemas/OrderActionRatePlanUsageVolumePricingOverride","kind":"json-schema","title":"usageVolume","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora groups usage records when rating usage. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-usage-rating-by-group"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage Rating by Group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"ByBillingPeriod (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageStartDate: The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageRecord: The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file."},"children":[]}]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload"],"type":"string"},"tiers":{"description":"List of variable pricing tiers in the charge.\n","items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"type":"object"}],"description":"Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n","title":"usageVolume"}},"components/schemas/OrderActionRatePlanTriggerParams":{"id":"components/schemas/OrderActionRatePlanTriggerParams","kind":"json-schema","title":"startDate","data":{"description":"Specifies when a charge becomes active.\n","properties":{"specificTriggerDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date in YYYY-MM-DD format. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"While this field is applicable, if this field is not set, your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order action creates a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription. If at the same time the service activation date is required and not set, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While this field is applicable, if this field is not set, the following order actions create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order but do not impact the subscription status. "},"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you want to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"AddProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RenewSubscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TermsAndConditions"},"children":[]}]}]}]}],"format":"date","type":"string"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become active."},"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":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificTriggerDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes active."},"children":[]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance"],"type":"string"}},"title":"startDate","type":"object"}},"components/schemas/OrderActionRatePlanChargeOverride":{"id":"components/schemas/OrderActionRatePlanChargeOverride","kind":"json-schema","title":"charge","data":{"description":"Charge associated with a rate plan.\n","properties":{"billing":{"description":"Billing information about the charge.\n","properties":{"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the month that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maximum":31,"minimum":0,"type":"integer"},"billCycleType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines the day that each billing period begins on."},"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":"DefaultFromCustomer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the bill cycle day of the account that owns the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the month that each billing period begins on."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionStartDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeTriggerDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each billing period begins on the same day of the month as the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeklyBillCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the day of the week that each billing period begins on."},"children":[]}]}]}]}],"enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek"],"type":"string"},"billingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing frequency of the charge. The value of this field controls the duration of each billing period."},"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":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the duration of each billing period."},"children":[]}]}]}],"enum":["Month","Quarter","Semi_Annual","Annual","Eighteen_Months","Two_Years","Three_Years","Five_Years","Specific_Months","Subscription_Term","Week","Specific_Weeks"],"type":"string"},"billingPeriodAlignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges."},"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":"AlignToCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToSubscriptionStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AlignToTermStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for information about how Zuora determines the billing day."},"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 not supported in one time charges."},"children":[]}]}]}],"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart"],"type":"string"},"billingTiming":{"description":"Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n","enum":["IN_ADVANCE","IN_ARREARS"],"type":"string"},"specificBillingPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of each billing period in months or weeks, depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific_Weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"weeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the week that each billing period begins on. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDayofWeek"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"type":"object"},"chargeNumber":{"description":"Charge number of the charge. For example, C-00000307.\n\nIf you do not set this field, Zuora will generate the charge number.\n","maxLength":50,"type":"string"},"customFields":{"$ref":"#/components/schemas/OrderActionRatePlanRatePlanChargeObjectCustomFields"},"description":{"description":"Description of the charge.\n","maxLength":500,"type":"string"},"endDate":{"$ref":"#/components/schemas/OrderActionRatePlanEndConditions"},"pricing":{"description":"Pricing information about the charge.\n","properties":{"chargeModelData":{"$ref":"#/components/schemas/OrderActionRatePlanChargeModelDataOverride"},"discount":{"$ref":"#/components/schemas/OrderActionRatePlanDiscountPricingOverride"},"oneTimeFlatFee":{"$ref":"#/components/schemas/OrderActionRatePlanOneTimeFlatFeePricingOverride"},"oneTimePerUnit":{"$ref":"#/components/schemas/OrderActionRatePlanOneTimePerUnitPricingOverride"},"oneTimeTiered":{"$ref":"#/components/schemas/OrderActionRatePlanOneTimeTieredPricingOverride"},"oneTimeVolume":{"$ref":"#/components/schemas/OrderActionRatePlanOneTimeVolumePricingOverride"},"recurringDelivery":{"$ref":"#/components/schemas/OrderActionRatePlanRecurringDeliveryPricingOverride"},"recurringFlatFee":{"$ref":"#/components/schemas/OrderActionRatePlanRecurringFlatFeePricingOverride"},"recurringPerUnit":{"$ref":"#/components/schemas/OrderActionRatePlanRecurringPerUnitPricingOverride"},"recurringTiered":{"$ref":"#/components/schemas/OrderActionRatePlanRecurringTieredPricingOverride"},"recurringVolume":{"$ref":"#/components/schemas/OrderActionRatePlanRecurringVolumePricingOverride"},"usageFlatFee":{"$ref":"#/components/schemas/OrderActionRatePlanUsageFlatFeePricingOverride"},"usageOverage":{"$ref":"#/components/schemas/OrderActionRatePlanUsageOveragePricingOverride"},"usagePerUnit":{"$ref":"#/components/schemas/OrderActionRatePlanUsagePerUnitPricingOverride"},"usageTiered":{"$ref":"#/components/schemas/OrderActionRatePlanUsageTieredPricingOverride"},"usageTieredWithOverage":{"$ref":"#/components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingOverride"},"usageVolume":{"$ref":"#/components/schemas/OrderActionRatePlanUsageVolumePricingOverride"}},"type":"object"},"productRatePlanChargeId":{"description":"Internal identifier of the product rate plan charge that the charge is based on.\n","type":"string"},"revRecCode":{"description":"Revenue Recognition Code\n","maxLength":70,"type":"string"},"revRecTriggerCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition trigger condition."},"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":"Contract Effective Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Service Activation Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Customer Acceptance Date"},"children":[]}]}]}]}],"enum":["Contract Effective Date","Service Activation Date","Customer Acceptance Date"],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the revenue recognition rule."},"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":"Recognize upon invoicing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recognize daily over time"},"children":[]}]}]}]}],"enum":["Recognize upon invoicing","Recognize daily over time"],"type":"string"},"startDate":{"$ref":"#/components/schemas/OrderActionRatePlanTriggerParams"},"uniqueToken":{"description":"Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n","maxLength":50,"type":"string"}},"required":["productRatePlanChargeId"],"title":"charge","type":"object"}},"components/schemas/OrderActionRatePlanRatePlanObjectCustomFields":{"id":"components/schemas/OrderActionRatePlanRatePlanObjectCustomFields","kind":"json-schema","title":"RatePlanCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Rate Plan object.\n","title":"RatePlanCustomFields","type":"object"}},"components/schemas/OrderActionRatePlanRatePlanOverride":{"id":"components/schemas/OrderActionRatePlanRatePlanOverride","kind":"json-schema","title":"ratePlan","data":{"description":"Rate plan associated with a subscription.\n","properties":{"chargeOverrides":{"description":"List of charges associated with the rate plan.\n","items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeOverride"},"type":"array"},"customFields":{"$ref":"#/components/schemas/OrderActionRatePlanRatePlanObjectCustomFields"},"newRatePlanId":{"description":"Internal identifier of the rate plan.\n","type":"string"},"productRatePlanId":{"description":"Internal identifier of the product rate plan that the rate plan is based on.\n","type":"string"},"uniqueToken":{"description":"Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n","maxLength":50,"type":"string"}},"required":["productRatePlanId"],"title":"ratePlan","type":"object"}},"components/schemas/OrderActionRatePlanRemoveProduct":{"id":"components/schemas/OrderActionRatePlanRemoveProduct","kind":"json-schema","title":"removeProduct","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RemoveProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"ratePlanId":{"description":"Internal identifier of the rate plan to remove.\n","type":"string"},"uniqueToken":{"description":"A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.A unique string in the order to represent the rate plan.","type":"string"}},"title":"removeProduct","type":"object"}},"components/schemas/OrderActionRatePlanBillingUpdate":{"id":"components/schemas/OrderActionRatePlanBillingUpdate","kind":"json-schema","title":"OrderActionRatePlanBillingUpdate","data":{"properties":{"billingPeriodAlignment":{"enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart"],"type":"string"}},"type":"object"}},"components/schemas/OrderActionRatePlanDiscountPricingUpdate":{"id":"components/schemas/OrderActionRatePlanDiscountPricingUpdate","kind":"json-schema","title":"OrderActionRatePlanDiscountPricingUpdate","data":{"properties":{"applyDiscountTo":{"description":"Specifies which type of charge the discount charge applies to.\n","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"],"type":"string"},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account"],"type":"string"},"discountPercentage":{"description":"The amount of the discount as a percentage. This field is only used for percentage discounts.\n","type":"number"},"priceChangeOption":{"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n","enum":["NoChange","UseLatestProductCatalogPricing"],"type":"string"}},"type":"object"}},"components/schemas/OrderActionRatePlanRecurringDeliveryPricingUpdate":{"id":"components/schemas/OrderActionRatePlanRecurringDeliveryPricingUpdate","kind":"json-schema","title":"OrderActionRatePlanRecurringDeliveryPricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"deliverySchedule":{"$ref":"#/components/schemas/DeliveryScheduleParams"},"listPrice":{"type":"number"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanRecurringFlatFeePricingUpdate":{"id":"components/schemas/OrderActionRatePlanRecurringFlatFeePricingUpdate","kind":"json-schema","title":"OrderActionRatePlanRecurringFlatFeePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"listPrice":{"type":"number"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanRecurringPerUnitPricingUpdate":{"id":"components/schemas/OrderActionRatePlanRecurringPerUnitPricingUpdate","kind":"json-schema","title":"OrderActionRatePlanRecurringPerUnitPricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"listPrice":{"type":"number"},"quantity":{"minimum":0,"type":"number"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanRecurringTieredPricingUpdate":{"id":"components/schemas/OrderActionRatePlanRecurringTieredPricingUpdate","kind":"json-schema","title":"OrderActionRatePlanRecurringTieredPricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"quantity":{"minimum":0,"type":"number"},"tiers":{"items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanRecurringVolumePricingUpdate":{"id":"components/schemas/OrderActionRatePlanRecurringVolumePricingUpdate","kind":"json-schema","title":"OrderActionRatePlanRecurringVolumePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"quantity":{"minimum":0,"type":"number"},"tiers":{"items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanUsageFlatFeePricingUpdate":{"id":"components/schemas/OrderActionRatePlanUsageFlatFeePricingUpdate","kind":"json-schema","title":"OrderActionRatePlanUsageFlatFeePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"listPrice":{"type":"number"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanUsageOveragePricingUpdate":{"id":"components/schemas/OrderActionRatePlanUsageOveragePricingUpdate","kind":"json-schema","title":"OrderActionRatePlanUsageOveragePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"includedUnits":{"description":"A certain quantity of units for free in the overage charge model. It cannot be negative. It must be 0 and above. Decimals are allowed.\n","type":"number"},"overagePrice":{"type":"number"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanUsagePerUnitPricingUpdate":{"id":"components/schemas/OrderActionRatePlanUsagePerUnitPricingUpdate","kind":"json-schema","title":"OrderActionRatePlanUsagePerUnitPricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"listPrice":{"type":"number"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanUsageTieredPricingUpdate":{"id":"components/schemas/OrderActionRatePlanUsageTieredPricingUpdate","kind":"json-schema","title":"OrderActionRatePlanUsageTieredPricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"tiers":{"items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingUpdate":{"id":"components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingUpdate","kind":"json-schema","title":"OrderActionRatePlanUsageTieredWithOveragePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"overagePrice":{"type":"number"},"tiers":{"items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanUsageVolumePricingUpdate":{"id":"components/schemas/OrderActionRatePlanUsageVolumePricingUpdate","kind":"json-schema","title":"OrderActionRatePlanUsageVolumePricingUpdate","data":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPriceChangeParams"},{"properties":{"tiers":{"items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeTier"},"type":"array"}},"type":"object"}]}},"components/schemas/OrderActionRatePlanPricingUpdate":{"id":"components/schemas/OrderActionRatePlanPricingUpdate","kind":"json-schema","title":"OrderActionRatePlanPricingUpdate","data":{"properties":{"chargeModelData":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanChargeModelDataOverride"}],"description":"Container for charge model configuration data.\n"},"discount":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanDiscountPricingUpdate"}],"description":"Pricing information about a discount charge.\n"},"recurringDelivery":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanRecurringDeliveryPricingUpdate"}],"description":"Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled.\n"},"recurringFlatFee":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanRecurringFlatFeePricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"},"recurringPerUnit":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanRecurringPerUnitPricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"},"recurringTiered":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanRecurringTieredPricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"},"recurringVolume":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanRecurringVolumePricingUpdate"}],"description":"Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"},"usageFlatFee":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanUsageFlatFeePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"},"usageOverage":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanUsageOveragePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n"},"usagePerUnit":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanUsagePerUnitPricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n"},"usageTiered":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanUsageTieredPricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n"},"usageTieredWithOverage":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n"},"usageVolume":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanUsageVolumePricingUpdate"}],"description":"Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n"}},"type":"object"}},"components/schemas/OrderActionRatePlanChargeUpdate":{"id":"components/schemas/OrderActionRatePlanChargeUpdate","kind":"json-schema","title":"OrderActionRatePlanChargeUpdate","data":{"description":"The JSON object containing the information for a charge update in the 'UpdateProduct' type order action.","properties":{"billing":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanBillingUpdate"}],"description":"Billing information about the charge.\n"},"chargeNumber":{"description":"Read only. Identifies the charge to be updated.\n","type":"string"},"customFields":{"$ref":"#/components/schemas/OrderActionRatePlanRatePlanChargeObjectCustomFields"},"description":{"description":"Description of the charge.\n","type":"string"},"effectiveDate":{"$ref":"#/components/schemas/OrderActionRatePlanTriggerParams"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderActionRatePlanPricingUpdate"}],"description":"Pricing information about the charge.\n"},"uniqueToken":{"description":"A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.\n","type":"string"}},"type":"object"}},"components/schemas/OrderActionRatePlanRatePlanUpdate":{"id":"components/schemas/OrderActionRatePlanRatePlanUpdate","kind":"json-schema","title":"updateProduct","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about an order action of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateProduct"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"chargeUpdates":{"items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeUpdate"},"type":"array"},"customFields":{"$ref":"#/components/schemas/OrderActionRatePlanRatePlanObjectCustomFields"},"newRatePlanId":{"description":"Internal identifier of the updated rate plan in the new subscription version.\n","type":"string"},"ratePlanId":{"description":"Internal identifier of the rate plan that was updated.\n","type":"string"},"specificUpdateDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date when the Update Product order action takes effect.  This field allows you to update a charge before a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd."},"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":": After you use this option, the charge's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TriggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field value will be changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-update-products-on-subscriptions-future-dated-updates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Product on Subscription with Future-dated Updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about this feature."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"uniqueToken":{"description":"A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.\n","type":"string","nullable":true}},"title":"updateProduct","type":"object"}},"components/schemas/OrderActionRatePlanOrderActionObjectCustomFields":{"id":"components/schemas/OrderActionRatePlanOrderActionObjectCustomFields","kind":"json-schema","title":"orderActionFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order Action object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Order Action object.\n","title":"orderActionFieldsCustom","type":"object"}},"components/schemas/OrderActionRatePlanOrderAction":{"id":"components/schemas/OrderActionRatePlanOrderAction","kind":"json-schema","title":"OrderActionRatePlanOrderAction","data":{"description":"Represents the processed order action.","properties":{"addProduct":{"$ref":"#/components/schemas/OrderActionRatePlanRatePlanOverride"},"id":{"description":"The Id of the order action processed in the order.","type":"string"},"removeProduct":{"$ref":"#/components/schemas/OrderActionRatePlanRemoveProduct"},"type":{"description":"Type of the order action.","enum":["AddProduct","UpdateProduct","RemoveProduct"],"type":"string"},"updateProduct":{"$ref":"#/components/schemas/OrderActionRatePlanRatePlanUpdate"},"customFields":{"$ref":"#/components/schemas/OrderActionRatePlanOrderActionObjectCustomFields"}},"type":"object"}},"components/schemas/OrderActionRatePlanOrder":{"id":"components/schemas/OrderActionRatePlanOrder","kind":"json-schema","title":"OrderActionRatePlanOrder","data":{"description":"The order that is related to the subscription rate plan.\n","properties":{"id":{"description":"The order ID.","type":"string"},"orderActions":{"items":{"$ref":"#/components/schemas/OrderActionRatePlanOrderAction"},"type":"array"},"orderNumber":{"description":"The order number of the order.","type":"string"}},"type":"object"}},"components/schemas/GetOrderActionRatePlanResponse":{"id":"components/schemas/GetOrderActionRatePlanResponse","kind":"json-schema","title":"GetOrderActionRatePlanResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"amendment":{"$ref":"#/components/schemas/OrderActionRatePlanAmendment"},"externallyManagedPlanId":{"description":"The unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n","type":"string"},"id":{"description":"Unique subscription rate-plan ID.","type":"string"},"lastChangeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Latest change type. Possible values 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":"text","inline":true,"attributes":{"content":"New"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove"},"children":[]}]}]}]}],"type":"string"},"order":{"$ref":"#/components/schemas/OrderActionRatePlanOrder"},"productId":{"description":"Product ID\n","type":"string"},"productName":{"description":"The name of the product.\n","type":"string"},"productRatePlanId":{"description":"Product rate plan ID\n","type":"string"},"productSku":{"description":"The unique SKU for the product.\n","type":"string"},"ratePlanName":{"description":"The name of the rate plan.\n","type":"string"},"subscriptionId":{"description":"Subscription ID.\n","type":"string"},"subscriptionVersion":{"description":"The version of the subscription.\n"}},"type":"object"}]}},"components/schemas/OmniChannelAccountData":{"id":"components/schemas/OmniChannelAccountData","kind":"json-schema","title":"OmniChannelAccountData","data":{"description":"The information of the account that you want to create while creating an omnichannel subscription.\n","properties":{"accountNumber":{"maxLength":70,"type":"string","description":"The number of the account."},"name":{"maxLength":255,"type":"string","description":"The name of the account."},"currency":{"description":"Three uppercase character currency code.\n","type":"string"},"notes":{"maxLength":65535,"type":"string","description":"The note for the account."},"billToContact":{"$ref":"#/components/schemas/ContactInfo"},"soldToContact":{"$ref":"#/components/schemas/ContactInfo"},"customFields":{"additionalProperties":true,"description":"Container for custom fields.\n","title":"CustomFields","type":"object"}},"required":["billToContact","currency","name"],"type":"object"}},"components/schemas/CreateOmniChannelSubscriptionRequest":{"id":"components/schemas/CreateOmniChannelSubscriptionRequest","kind":"json-schema","title":"CreateOmniChannelSubscriptionRequest","data":{"example":{"externalSubscriptionId":"original-transaction-id1","accountId":"8a90b4488e602d56018e6062ff5700a3","externalSourceSystem":"Apple","externalTransactionReason":"Purchase","externalState":"Active","state":"Active","externalProductId":"external-product-id-1","externalInAppOwnershipType":"Purchased","externalQuantity":1,"currency":"USD","autoRenew":true,"externalPurchaseDate":"2024-02-01 00:01:15","externalActivationDate":"2024-02-01 00:01:15","externalExpirationDate":"2024-05-01 00:01:15","externalApplicationId":"004d58fca978fec3697fec4af1d10065","externalBundleId":"43dcdc4562784ed8a59ece4ef7d98e57","externalSubscriberId":"2466082b6d1149c184a09b15bd5be694","externalPurchaseType":"Purchased","externalPrice":100,"externalLastRenewalDate":"2024-10-01 00:00:00","externalNextRenewalDate":"2025-01-01 00:00:00"},"allOf":[{"properties":{"accountId":{"description":"The ID of the account associated with this subscription.\n","type":"string"},"externalSubscriptionId":{"description":"The original transaction ID of the notification. This must be unique in the tenant.\n","type":"string"},"externalTransactionReason":{"description":"The latest transaction reason.\n","type":"string"},"externalSourceSystem":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source app store from which the channel subscription originated. For example, Apple, Google, Roku, Amazon."},"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":" When creating a new Omnichannel subscription, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalSourceSystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a required field. When updating an existing Omnichannel subscription, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalSourceSystem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an optional field."},"children":[]}]}]}],"type":"string"},"externalState":{"description":"The original status from client, such as active, canceled, expired, pastDue.\n","type":"string"},"state":{"description":"The common external subscription state.\n","type":"string"},"externalProductId":{"description":"The product ID in the external system.\n","type":"string"},"externalReplaceByProductId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product ID is going to replace the existing product ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field during the subscription renewal."},"children":[]}]}]}],"type":"string","nullable":true},"externalInAppOwnershipType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Such as purchased, family_shared."},"children":[]}]}]}],"type":"string"},"externalQuantity":{"description":"The quantity of the product, must be greather than 0. \n","default":1,"type":"integer"},"currency":{"description":"The currency code of the transaction. If not specified, get value from the Account.\n","type":"string"},"autoRenew":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription automatically renews at the end of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"term."},"children":[]}]}]}],"default":false,"type":"boolean"},"externalPurchaseDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the App Store charged the user’s account for a purchase, restored product, subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or subscription renewal after a lapse."},"children":[]}]}]}],"type":"string"},"externalActivationDate":{"description":"When the external subscription was activated on the external platform.\n","type":"string"},"externalExpirationDate":{"description":"This expiration date is a static value that applies for each transaction.\n","type":"string"},"externalApplicationId":{"description":"The external application ID.\n","type":"string"},"externalBundleId":{"description":"The external bundler ID.\n","type":"string"},"externalSubscriberId":{"description":"The external subscriber ID.\n","type":"string"},"externalPrice":{"description":"The price in external system.\n","type":"number"},"externalPurchaseType":{"description":"The external purchase type.","type":"string"},"externalLastRenewalDate":{"description":"This last renewal date is a static value that applies for each transaction.\n","type":"string"},"externalNextRenewalDate":{"description":"This next renewal date is a static value that applies for each transaction.\n","type":"string"},"accountIdentifierField":{"description":"The account field used to identify the account in acountData. It could be a custom field.","type":"string"},"accountData":{"$ref":"#/components/schemas/OmniChannelAccountData"}},"required":["externalSubscriptionId"],"type":"object"},{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"}]}},"components/schemas/CreateOmniChannelSubscriptionResponse":{"id":"components/schemas/CreateOmniChannelSubscriptionResponse","kind":"json-schema","title":"CreateOmniChannelSubscriptionResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"subscriptionId":{"description":"The system generated ID in Billing.\n","type":"string"},"subscriptionNumber":{"description":"The system generated subscription number.\n","type":"string"},"accountId":{"description":"The ID of the account associated with this subscription.\n","type":"string"},"accountNumber":{"description":"The number of the account associated with this subscription.\n","type":"string"}}}]}},"components/schemas/GetOmniChannelSubscriptionResponse":{"id":"components/schemas/GetOmniChannelSubscriptionResponse","kind":"json-schema","title":"OmniChannelSubscription","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"id":{"description":"The system generated ID in Billing.\n","type":"string"},"subscriptionNumber":{"description":"The system generated subscription number.\n","type":"string"},"accountId":{"description":"The ID of the account associated with this subscription.\n","type":"string"},"externalSubscriptionId":{"description":"The original transaction ID of the notification.\n","type":"string"},"externalTransactionReason":{"description":"The latest transaction reason.\n","type":"string"},"externalSourceSystem":{"description":"The source app store from which the channel subscription originated. For example, Apple, Google, Roku, Amazon.\n","type":"string"},"externalState":{"description":"The original status from client, such as active, canceled, expired, pastDue.\n","type":"string"},"state":{"description":"The common external subscription state.\n","type":"string"},"externalProductId":{"description":"The product ID in the external system.\n","type":"string"},"externalReplaceByProductId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product ID is going to replace the existing product ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field during the subscription renewal."},"children":[]}]}]}],"type":"string","nullable":true},"externalInAppOwnershipType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Such as purchased, family_shared."},"children":[]}]}]}],"type":"string"},"externalQuantity":{"description":"The quantity of the product, must be greater than 0. \n","default":1,"type":"integer"},"currency":{"description":"The currency code of the transaction. If not specified, get value from the Account.\n","type":"string"},"autoRenew":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription automatically renews at the end of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"term."},"children":[]}]}]}],"default":false,"type":"boolean"},"originalPurchaseDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalPurchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when this external subscription firstly created."},"children":[]}]}]}],"type":"string"},"externalPurchaseDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the App Store charged the user’s account for a purchase, restored product, subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or subscription renewal after a lapse."},"children":[]}]}]}],"type":"string"},"externalActivationDate":{"description":"When the external subscription was activated on the external platform.\n","type":"string"},"externalExpirationDate":{"description":"This expiration date is a static value that applies for each transaction.\n","type":"string"},"externalApplicationId":{"description":"The external application ID.\n","type":"string"},"externalBundleId":{"description":"The external bundler ID.\n","type":"string"},"externalSubscriberId":{"description":"The external subscriber ID.\n","type":"string"},"externalPrice":{"description":"The price in external system.\n","type":"number"},"externalPurchaseType":{"description":"The external purchase type.","type":"string"},"externalLastRenewalDate":{"description":"This last renewal date is a static value that applies for each transaction.\n","type":"string"},"externalNextRenewalDate":{"description":"This next renewal date is a static value that applies for each transaction.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"}],"title":"OmniChannelSubscription"}},"components/schemas/DestinationValidityPeriodInfo":{"id":"components/schemas/DestinationValidityPeriodInfo","kind":"json-schema","title":"destinationValidityPeriod","data":{"description":"Date range of the destination validity period to which the funds are transferred. It should be close to the source validity period.","properties":{"endDate":{"description":"End date of the destination validity period.","format":"date","type":"string"},"startDate":{"description":"Start date of the destination validity period.","format":"date","type":"string"}},"required":["startDate","endDate"],"title":"destinationValidityPeriod","type":"object"}},"components/schemas/SourceValidityPeriodInfo":{"id":"components/schemas/SourceValidityPeriodInfo","kind":"json-schema","title":"sourceValidityPeriod","data":{"description":"Date range of the source validity period from which the funds are transferred. It should be close to the destination validity period.","properties":{"endDate":{"description":"End date of the source validity period.","format":"date","type":"string"},"startDate":{"description":"Start date of the source validity period.","format":"date","type":"string"}},"required":["startDate","endDate"],"title":"sourceValidityPeriod","type":"object"}},"components/schemas/POSTReverseRolloverRequestType":{"id":"components/schemas/POSTReverseRolloverRequestType","kind":"json-schema","title":"POSTReverseRolloverRequestType","data":{"allOf":[{"properties":{"destinationValidityPeriod":{"$ref":"#/components/schemas/DestinationValidityPeriodInfo"},"prepaymentUom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units of measure for prepayment charge. Units of measure are configured in the web-based UI. Your values depend on your configuration in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid unit of measure"},"children":[]}]}]}],"type":"string"},"sourceValidityPeriod":{"$ref":"#/components/schemas/SourceValidityPeriodInfo"},"subscriptionNumber":{"description":"The unique identifier number of the subscription.","maxLength":100,"type":"string"}},"required":["subscriptionNumber","prepaymentUom","sourceValidityPeriod","destinationValidityPeriod"],"type":"object"}],"example":{"destinationValidityPeriod":{"endDate":"2024-01-01","startDate":"2023-01-01"},"prepaymentUom":"Each","sourceValidityPeriod":{"endDate":"2025-01-01","startDate":"2024-01-01"},"subscriptionNumber":"A-S00000009"}}},"components/schemas/POSTReverseRolloverResponseType":{"id":"components/schemas/POSTReverseRolloverResponseType","kind":"json-schema","title":"POSTReverseRolloverResponseType","data":{"properties":{"message":{"description":"Indicates the result.","type":"string"},"reverseRolloverFundCount":{"description":"Indicates the number of funds which have been rolled back.","format":"int64","type":"integer"},"success":{"description":"Indicates whether the call succeeded.","type":"boolean"}},"type":"object"}},"components/schemas/POSTTriggerRolloverRequestType":{"id":"components/schemas/POSTTriggerRolloverRequestType","kind":"json-schema","title":"POSTTriggerRolloverRequestType","data":{"allOf":[{"properties":{"destinationValidityPeriod":{"$ref":"#/components/schemas/DestinationValidityPeriodInfo"},"prepaymentUom":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units of measure for prepayment charge. Units of measure are configured in the web-based UI. Your values depend on your configuration in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid unit of measure"},"children":[]}]}]}],"type":"string"},"priority":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the priority of rolled over fund in case of drawdown."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ApplyLast / ApplyFirst"},"children":[]}]}]}],"type":"string"},"sourceValidityPeriod":{"$ref":"#/components/schemas/SourceValidityPeriodInfo"},"subscriptionNumber":{"description":"The unique identifier number of the subscription.","maxLength":100,"type":"string"}},"required":["subscriptionNumber","prepaymentUom","sourceValidityPeriod","destinationValidityPeriod","priority"],"type":"object"}],"example":{"destinationValidityPeriod":{"endDate":"2025-01-01","startDate":"2024-01-01"},"prepaymentUom":"Each","priority":"ApplyFirst","sourceValidityPeriod":{"endDate":"2024-01-01","startDate":"2023-01-01"},"subscriptionNumber":"A-S00000009"}}},"components/schemas/POSTTriggerRolloverResponseType":{"id":"components/schemas/POSTTriggerRolloverResponseType","kind":"json-schema","title":"POSTTriggerRolloverResponseType","data":{"properties":{"message":{"description":"Indicates the result.","type":"string"},"rolloverFundCount":{"description":"Indicates the number of funds which have been rolled over.","format":"int64","type":"integer"},"success":{"description":"Indicates whether the call succeeded.","type":"boolean"}},"type":"object"}},"components/schemas/POSTDepleteFundRequestType":{"id":"components/schemas/POSTDepleteFundRequestType","kind":"json-schema","title":"POSTDepleteFundRequestType","data":{"properties":{"fundIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of the funds to deplete in full."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteOptions"},"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":"Each fund is recorded with the default accounting date of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus one day."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate ids in this array are not rejected by request validation."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"depleteOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-fund deplete instructions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundIds"},"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 supplied, this array alone determines which funds are depleted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not appear more than once."},"children":[]}]}]}],"type":"array","items":{"title":"DepleteOption","type":"object","properties":{"fundId":{"description":"The ID of the fund to deplete.","type":"string","maxLength":32},"depleteDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting date recorded on the deplete transaction and the daily consumption record."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be on or after the later of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the fund's most recent drawdown"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or deplete date, and on or before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus one day."},"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":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus one day."},"children":[]}]}]}],"type":"string","format":"date"},"depleteAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to deplete from a currency fund."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be greater than zero and must not exceed the fund's balance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteQuantity"},"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":"Not applicable to quantity-based funds."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the fund is depleted in full."},"children":[]}]}]}],"type":"number","format":"decimal"},"depleteQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity to deplete from a quantity-based fund."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be greater than zero and must not exceed the fund's balance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depleteAmount"},"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":"Not applicable to amount-based funds (for example upfront currency)."},"children":[]}]}]}],"type":"number","format":"decimal"}},"required":["fundId"]}}},"example":{"depleteOptions":[{"fundId":"4028818c8d0c9db5018d0cbbdecd72c1","depleteDate":"2022-06-15","depleteAmount":302}]}}},"components/schemas/POSTDepleteFundResponseType":{"id":"components/schemas/POSTDepleteFundResponseType","kind":"json-schema","title":"POSTDepleteFundResponseType","data":{"properties":{"processId":{"description":"The ID of the process that handles the operation.","type":"string"},"reasons":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container of the error code and message."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"title":"Reason","properties":{"code":{"description":"The error code of the response.","type":"string"},"message":{"description":"Detailed information about the error response.","type":"string"}},"type":"object"},"type":"array"},"requestId":{"description":"Unique identifier of the request.","type":"string","format":"uuid","minLength":36,"maxLength":36},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the request was structurally valid and processing completed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can include per-fund failures."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the entire request was rejected (validation, permission,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or depletion transaction failure), with details in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"fundIds":{"description":"One entry per fund in the request, covering both depleted funds and funds that were \nrejected on their own. Absent when the request was rejected as a whole.\n","items":{"title":"FundDepletionResult","properties":{"fundId":{"description":"The unique ID of the fund.\n","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the fund depletion:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the fund was depleted, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this fund alone was rejected."},"children":[]}]}]}],"type":"string","enum":["success","failed"]},"message":{"description":"Localized description of the outcome for this fund.\n","type":"string"},"depleteDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting date on which the depletion was recorded."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only 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":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; omitted for failed funds."},"children":[]}]}]}],"type":"string","format":"date"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/POSTUsageResponseType":{"id":"components/schemas/POSTUsageResponseType","kind":"json-schema","title":"POSTUsageResponseType","data":{"properties":{"checkImportStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path for checking the status of the import."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The possible status values at this path are "},"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":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"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":"Canceled"},"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":". Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that the file contents were imported successfully."},"children":[]}]}]}],"type":"string"},"size":{"description":"The size of the uploaded file in bytes.\n","format":"int64","type":"integer"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/GETUsageRateDetailWrapper":{"id":"components/schemas/GETUsageRateDetailWrapper","kind":"json-schema","title":"GETUsageRateDetailWrapper","data":{"properties":{"data":{"description":"Contains usage rate details for the invoice item as specified in the request.\n","properties":{"amountWithoutTax":{"description":"The amount of the invoice item without tax.\n","format":"double","type":"number"},"chargeNumber":{"description":"The unique number of the product rate plan charge associated with the invoice item.\n","type":"string"},"invoiceId":{"description":"The unique ID of the invoice.\n","type":"string"},"invoiceItemId":{"description":"The unique ID of the invoice item.\n","type":"string"},"invoiceNumber":{"description":"The unique number of the invoice.\n","type":"string"},"listPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price of the product rate plan charge associated with the invoice item. For example, if the product rate plan charge uses the tiered charge model, its list price could be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tier / From / To / List Price / Price Format\\n1 / 0 / 9 / 0.00 / Per Unit\\n2 / 10 / 20 / 1.00 / Per Unit\\n3 / 21 / 30 / 2.00 / Flat Fee\\n4 / 31 /   / 3.00 / Per Unit\\n"},"children":[]}]}]}],"type":"string"},"quantity":{"description":"The quantity of the invoice item.\n","format":"double","type":"number"},"rateDetail":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate detail of the invoice item. It shows how the total amount is calculated. For example, if the product rate plan charge uses the tiered charge model, the rate detail for the associated invoice item could be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00\\nTier 2: 10-20, 11 Each(s) x $1.00/Each = $11.00\\nTier 3: 21-30, $2.00 Flat Fee\\nTier 4: >=31, 15 Each(s) x $3.00/Each = $45.00\\nTotal = $58.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate detail retrieved from this REST API operation is the same as the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-display-usage-charge-breakdown"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Detail presented on PDF invoices"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"servicePeriod":{"description":"The service period of the invoice item.\n","type":"string"},"uom":{"description":"The unit of measurement of the invoice item.\n","type":"string"}},"type":"object"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was not processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/UsageObjectCustomFields":{"id":"components/schemas/UsageObjectCustomFields","kind":"json-schema","title":"usageFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Usage object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Usage object.\n","title":"usageFieldsCustom","type":"object"}},"components/schemas/ProxyCreateUsage":{"id":"components/schemas/ProxyCreateUsage","kind":"json-schema","title":"ProxyCreateUsage","data":{"allOf":[{"properties":{"AccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the account associated with the usage data. This field is only required if no value is specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid account ID."},"children":[]}]}]}],"type":"string"},"AccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the account associated with the usage data. This field is only required if no value is specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 50 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid account number."},"children":[]}]}]}],"type":"string"},"ChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The OrginalId of the rate plan charge related to the usage record, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c9081a03c63c94c013c6873357a0117"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid rate plan charge OriginalID."},"children":[]}]}]}],"type":"string"},"ChargeNumber":{"description":"A unique number for the rate plan charge related to the usage record. For example, C-00000007.\n","maxLength":50,"type":"string"},"Description":{"description":"A description of the usage record.\n","maxLength":200,"type":"string"},"EndDateTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid date and time value."},"children":[]}]}]}],"format":"date-time","type":"string"},"ProductRatePlanChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a product rate plan charge number so that you can charge your customer with a dynamic usage charge for the corresponding uploaded usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"146"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/dynamic-usage-charges","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic Usage Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"Quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of units used."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid decimal amount."},"children":[]}]}]}],"format":"double","type":"number"},"StartDateTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StartDateTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field does affect usage calculation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid date and time value"},"children":[]}]}]}],"format":"date-time","type":"string"},"SubscriptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original ID of the subscription that contains the fees related to the usage data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a subscription might change when you create amendments to the subscription. It is good practice to use the unique subscription number that you can specify in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":32,"type":"string"},"SubscriptionNumber":{"description":"The unique identifier number of the subscription that contains the fees related to the usage data.\n\nIt is good practice to use this field when creating usage records.\n","maxLength":100,"type":"string"},"UOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid unit of measure"},"children":[]}]}]}],"type":"string"},"UniqueKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique external reference of the usage record. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload usage record with unique key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for information on how to use this field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"114"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later. This field is only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature or the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload usage record with unique key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"}},"required":["Quantity","StartDateTime","UOM"],"type":"object"},{"$ref":"#/components/schemas/UsageObjectCustomFields"}],"example":{"AccountId":"8ad09378905a5af201907ca1edb524c2","UOM":"Minutes","Quantity":200,"StartDateTime":"2024-06-01T02:00:00.000+01:00"}}},"components/schemas/ProxyGetUsage":{"id":"components/schemas/ProxyGetUsage","kind":"json-schema","title":"ProxyGetUsage","data":{"allOf":[{"properties":{"AccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the account associated with the usage data. This field is required if no value is specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid account ID"},"children":[]}]}]}],"type":"string"},"AccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the account associated with the usage data. This field is required if no value is specified for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 50 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid account number"},"children":[]}]}]}],"type":"string"},"ChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The OrginalId of the rate plan charge related to the usage record, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c9081a03c63c94c013c6873357a0117"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid rate plan charge OriginalID"},"children":[]}]}]}],"type":"string"},"CreatedById":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user ID of the person who uploaded the usage records."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"type":"string"},"CreatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the usage was generated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"format":"date-time","type":"string"},"Description":{"description":"A description of the usage record.\n","type":"string"},"EndDateTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid date and time value"},"children":[]}]}]}],"format":"date-time","type":"string"},"Id":{"description":"Object identifier.","type":"string"},"ProductRatePlanChargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a product rate plan charge number so that you can charge your customer with a dynamic usage charge for the corresponding uploaded usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"146"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-dynamic-usage-charges","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic Usage Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"Quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of units used."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid decimal amount."},"children":[]}]}]}],"format":"double","type":"number"},"RbeStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the rating and billing engine (RBE) processed usage data for an invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 9 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated to be one of the following values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Importing"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]}]}]}],"type":"string"},"SourceType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the usage records were imported from the web-based UI or the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 6 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated to be one of the following values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Import"},"children":[]}]}]}],"type":"string"},"StartDateTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StartDateTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field does affect usage calculation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid date and time value"},"children":[]}]}]}],"format":"date-time","type":"string"},"SubscriptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original ID of the subscription that contains the fees related to the usage data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid subscription ID"},"children":[]}]}]}],"type":"string"},"SubscriptionNumber":{"description":"The unique identifier number of the subscription that contains the fees related to the usage data.\n","type":"string"},"UOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid unit of measure"},"children":[]}]}]}],"type":"string"},"UpdatedById":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the user who last updated the usage upload."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"type":"string"},"UpdatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the usage upload was last updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"format":"date-time","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/UsageObjectCustomFields"}]}},"components/schemas/ProxyModifyUsage":{"id":"components/schemas/ProxyModifyUsage","kind":"json-schema","title":"ProxyModifyUsage","data":{"allOf":[{"properties":{"EndDateTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid date and time value"},"children":[]}]}]}],"format":"date-time","type":"string"},"Quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of units used."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A valid decimal amount."},"children":[]}]}]}],"format":"double","type":"number"},"RbeStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the rating and billing engine (RBE) processed usage data for an invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 9 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated to be one of the following values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Importing"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]}]}]}],"type":"string"},"StartDateTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StartDateTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field does affect usage calculation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid date and time value"},"children":[]}]}]}],"format":"date-time","type":"string"},"UOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid unit of measure"},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/UsageObjectCustomFields"}],"example":{"EndDateTime":"2024-06-30T02:00:00.000+01:00"}}},"components/schemas/LocalFsOptions":{"id":"components/schemas/LocalFsOptions","kind":"json-schema","title":"LocalFsOptions","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration options for LOCAL_FS sources (previously uploaded files)."},"children":[]}]}]}],"required":["fileId"],"properties":{"fileId":{"type":"integer","format":"int64","description":"The ID of the file uploaded through the \"Upload a file\" operation, to be used as the source."}}}},"components/schemas/S3Options":{"id":"components/schemas/S3Options","kind":"json-schema","title":"S3Options","data":{"type":"object","description":"Configuration options for S3 sources (paths, connection).","required":["paths","fileFormat"],"properties":{"connectionName":{"type":"string","description":"Name of the S3 connection to use."},"connectionVersion":{"type":"integer","format":"int32","description":"Version of the S3 connection."},"paths":{"type":"array","description":"List of S3 paths to read from.","items":{"type":"string"}},"fileFormat":{"type":"string","description":"Format of the input files.","enum":["CSV","EXCEL","PARQUET","JSON","XML","AVRO"]},"incremental":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables incremental mode to continuously monitor for new files. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", files are processed only once."},"children":[]}]}]}]},"monitorInterval":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interval in milliseconds for checking for new files when incremental mode is enabled. This field is applicable only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incremental"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"retentionTime":{"type":"integer","format":"int64","description":"Retention time in milliseconds for processed files."},"batchSize":{"type":"integer","format":"int32","description":"Batch size for reading files."}}}},"components/schemas/SnowflakeOptions":{"id":"components/schemas/SnowflakeOptions","kind":"json-schema","title":"SnowflakeOptions","data":{"type":"object","description":"Configuration options for Snowflake sources.","properties":{"database":{"type":"string","description":"Snowflake database name."},"schema":{"type":"string","description":"Snowflake schema name."},"table":{"type":"string","description":"Snowflake table name."},"query":{"type":"string","description":"Custom SQL query to execute (SELECT only)."},"warehouse":{"type":"string","description":"Snowflake warehouse to use."},"role":{"type":"string","description":"Snowflake role to use."},"unloadFileFormat":{"type":"string","description":"File format for UNLOAD operation.","enum":["CSV","EXCEL","PARQUET","JSON","XML","AVRO"]},"queryParameters":{"type":"object","description":"Parameter values for parameterized queries (:paramName syntax).","additionalProperties":{"type":"object","description":"Parameter values for parameterized queries (:paramName syntax)."}}}}},"components/schemas/EventStoreOptions":{"id":"components/schemas/EventStoreOptions","kind":"json-schema","title":"EventStoreOptions","data":{"type":"object","description":"Configuration options for EventStore sources (date range).","required":["storeId"],"properties":{"storeId":{"type":"string","description":"Event store ID to read from."},"startDate":{"type":"string","description":"Start date for partition pruning (YYYY-MM-DD).","example":"2025-01-01"},"endDate":{"type":"string","description":"End date for partition pruning (YYYY-MM-DD).","example":"2025-01-31"},"query":{"type":"string","description":"Ad-hoc SQL query for Event Store (SELECT only, mutually exclusive with date range)."}}}},"components/schemas/RuntimeSourceConfig":{"id":"components/schemas/RuntimeSourceConfig","kind":"json-schema","title":"RuntimeSourceConfig","data":{"type":"object","required":["sourceType"],"properties":{"processorId":{"type":"string","description":"ID of the source processor in the meter definition to apply this configuration to. Required when the meter has multiple sources of the same type."},"sourceType":{"type":"string","description":"Type of the source. Must match the actual source type in the meter definition.","enum":["LOCAL_FS","S3","SNOWFLAKE","EVENT_STORE"]},"localFs":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration options for LOCAL_FS sources (previously uploaded files)."},"children":[]}]}]}],"$ref":"#/components/schemas/LocalFsOptions"},"s3":{"description":"Configuration options for S3 sources (paths, connection).","$ref":"#/components/schemas/S3Options"},"snowflake":{"description":"Configuration options for Snowflake sources.","$ref":"#/components/schemas/SnowflakeOptions"},"eventStore":{"description":"Configuration options for EventStore sources (date range).","$ref":"#/components/schemas/EventStoreOptions"}}}},"components/schemas/RunMeterVersionRequest":{"id":"components/schemas/RunMeterVersionRequest","kind":"json-schema","title":"RunMeterVersionRequest","data":{"type":"object","description":"The request payload to run a specific version of a meter.","properties":{"sourceOptions":{"type":"array","description":"Settings for meter to run with local file.","items":{"type":"object","properties":{"processorId":{"type":"string","description":"Source operator ID. Optional if there's only one local file source in the meter."},"localFileId":{"type":"string","description":"Internal ID of uploaded file."}}}},"eventStoreSourceOptions":{"type":"array","description":"Settings for meter to run with event store.","items":{"type":"object","required":["processorId"],"properties":{"processorId":{"type":"string","description":"Source operator ID."},"startDate":{"type":"string","format":"date","description":"Start date of event store to query from (e.g., 2025-01-01)."},"endDate":{"type":"string","format":"date","description":"End date of event store to query to (e.g., 2025-02-01)."}}}},"runtimeSourceConfigs":{"type":"array","description":"Runtime source configurations to override source settings at execution time. Applies to both NORMAL and DEBUG runs.","items":{"$ref":"#/components/schemas/RuntimeSourceConfig"}},"uniqueKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional idempotency key for this meter run. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is scoped to the meter (not tenant-wide)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you trigger a meter run and the operation times out, you can safely retry the same request using the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueKey"},"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 original request already created a run, Zuora Mediation returns a 400 error indicating a duplicate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and does not start a new run."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This behavior ensures idempotency and prevents duplicate meter executions."},"children":[]}]}]}],"example":"lms_meter2_2026-03-31T22:00:00Z"}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code identifying the failure type."},"message":{"type":"string","description":"Human-readable description of the error that provides more context about what went wrong."},"detail":{"type":"object","description":"Additional structured details about the error, such as validation issues or parameter-specific information."}}}},"components/schemas/RunMeterVersionResponse":{"id":"components/schemas/RunMeterVersionResponse","kind":"json-schema","title":"RunMeterVersionResponse","data":{"type":"object","description":"Response payload after triggering a meter run.","properties":{"success":{"type":"boolean","description":"Whether the API request has succeeded."},"data":{"type":"object","properties":{"id":{"type":"string","description":"Internal run history ID, unique within tenant."},"sessionId":{"type":"string","description":"Corresponding session ID of this run."},"jobId":{"type":"string","description":"Corresponding job ID of this run."},"meterId":{"type":"integer","description":"Internal meter ID."},"version":{"type":"string","description":"Version of the meter."},"revision":{"type":"integer","description":"Revision number of this version run."},"runType":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The run type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NORMAL"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":2,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEBUG"},"children":[]}]}]}]}]}]}],"minimum":1,"maximum":2},"runTypeDescription":{"type":"string","description":"Description of the run type."},"startTime":{"type":"string","format":"date-time","description":"Start time of this run."},"endTime":{"type":"string","format":"date-time","nullable":true,"description":"End time of this run."},"status":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The run status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEVER_RUN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":2,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TESTING"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":3,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TESTING_FAILED"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":4,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TESTING_PASSED"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":5,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RUNNING"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":6,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAUSED"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":7,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":8,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":9,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELED"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":10,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INITIALIZING"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":11,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USAGE_PUSHING"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":12,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUSH_COMPLETED"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":13,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONSUME_COMPLETED"},"children":[]}]}]}]}]}]}],"minimum":1,"maximum":13},"statusDescription":{"type":"string","description":"Description of the run status."},"canExportSummary":{"type":"boolean","description":"Whether the summary is ready to export."},"hasLineageEnabled":{"type":"boolean","description":"Whether lineage feature is enabled on this run."}}},"previousPage":{"type":"string","description":"Cursor or URL for the previous page of audit records, if available. Used for backward pagination."},"nextPage":{"type":"string","description":"Cursor or URL for the next page of audit records, if available. Used for forward pagination."},"error":{"$ref":"#/components/schemas/Error","description":"Container for error information returned by the API when the request fails."}}}},"components/schemas/MediationStopMeterResponse":{"id":"components/schemas/MediationStopMeterResponse","kind":"json-schema","title":"MediationStopMeterResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"error":{"type":"object","description":"Error details returned when the request fails.","properties":{"code":{"type":"string","description":"Machine-readable error code identifying the failure."},"message":{"type":"string","description":"Human-readable description of the error."}}}}}},"components/schemas/SourceOption":{"id":"components/schemas/SourceOption","kind":"json-schema","title":"SourceOption","data":{"type":"object","properties":{"processorId":{"type":"string","description":"The source operator ID. Optional if there is only one local file source."},"sampleFileId":{"type":"integer","description":"Test meter with event definition sample file, specified by the ID."},"localFileId":{"type":"integer","description":"Test meter with uploaded file, specified by the ID."},"testData":{"type":"array","description":"Test meter with manually input data.","items":{"type":"object","properties":{"Amount":{"type":"number","description":"Amount"},"Quantity":{"type":"number","description":"Quantity"},"UsageDate":{"type":"string","format":"date","description":"UsageDate"},"CostCenter":{"type":"string","description":"CostCenter"},"CustomerId":{"type":"string","description":"CustomerId"},"UsageIdentifier":{"type":"string","description":"UsageIdentifier"}}}},"saveTestData":{"type":"boolean","description":"Whether to save the test data."},"testDataName":{"type":"string","description":"The name of the test data."},"testDataId":{"type":"integer","description":"Test meter with previously saved test data, specified by the ID."}}}},"components/schemas/EventStoreSourceOption":{"id":"components/schemas/EventStoreSourceOption","kind":"json-schema","title":"EventStoreSourceOption","data":{"type":"object","properties":{"processorId":{"type":"string","description":"The source operator ID for event store."},"startDate":{"type":"string","format":"date","description":"The start date of the event store to query from, e.g., 2025-01-01."},"endDate":{"type":"string","format":"date","description":"The end date of the event store to query to, e.g., 2025-02-01."}}}},"components/schemas/TestSpecificMeterRequest":{"id":"components/schemas/TestSpecificMeterRequest","kind":"json-schema","title":"TestSpecificMeterRequest","data":{"type":"object","properties":{"sourceOptions":{"type":"array","items":{"$ref":"#/components/schemas/SourceOption"}},"eventStoreSourceOptions":{"type":"array","items":{"$ref":"#/components/schemas/EventStoreSourceOption"}}}}},"components/schemas/TestSpecificMeterResponse":{"id":"components/schemas/TestSpecificMeterResponse","kind":"json-schema","title":"TestSpecificMeterResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Internal run history ID, unique within tenant."},"sessionId":{"type":"string","description":"The corresponding session ID of this run."},"jobId":{"type":"string","description":"The corresponding job ID of this run."},"meterId":{"type":"integer","description":"The meter ID."},"version":{"type":"string","description":"The version of the meter."},"revision":{"type":"integer","description":"The revision of the meter version when it runs."},"runType":{"type":"integer","description":"The run type of the meter (1 for NORMAL, 2 for DEBUG).","minimum":1,"maximum":2},"runTypeDescription":{"type":"string","description":"Description of the run type."},"startTime":{"type":"string","description":"The start time of the run in ISO 8601 format."},"endTime":{"type":"string","description":"The end time of the run in ISO 8601 format."},"runStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the run (e.g., NEVER_RUN, TESTING, FAILED)."},"children":[]}]}]}]},"runStatusDescription":{"type":"string","description":"Description of the run status."},"canExportSummary":{"type":"boolean","description":"Whether the summary is ready to export."},"hasLineageEnabled":{"type":"boolean","description":"Whether lineage is enabled for this run."}}}},"components/schemas/MediationErrorResponse":{"id":"components/schemas/MediationErrorResponse","kind":"json-schema","title":"MediationErrorResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the API request has succeeded or not."},"data":{"type":"object","description":"Detailed response information for successful requests (e.g., instance info, job details).","properties":{"id":{"type":"string","description":"The instance ID."},"sessionId":{"type":"string","description":"The session ID of the meter instance."},"jobId":{"type":"string","description":"The job ID of the meter instance."},"meterId":{"type":"integer","description":"The ID of the meter."},"version":{"type":"string","description":"The meter version."},"revision":{"type":"string","description":"The meter revision."},"runType":{"type":"integer","description":"The run type of the instance."},"runTypeDescription":{"type":"string","description":"The description of the run type."},"startTime":{"type":"string","description":"The start time of the instance."},"status":{"type":"integer","description":"The job status of the instance."},"statusDescription":{"type":"string","description":"The status description of the instance."},"canExportSummary":{"type":"boolean","description":"Whether the instance can export summary information (internal usage)."},"hasLineageEnabled":{"type":"boolean","description":"Whether lineage is enabled for the meter (internal usage)."}}},"error":{"type":"object","description":"Contains error details when the request fails.","properties":{"code":{"type":"string","description":"The error reason code (e.g., \"70002006\" for authorization errors)."},"message":{"type":"string","description":"A human-readable description of the error."}}}}}},"components/schemas/CreateSpecificMeterSummaryRequest":{"id":"components/schemas/CreateSpecificMeterSummaryRequest","kind":"json-schema","title":"CreateSpecificMeterSummaryRequest","data":{"type":"object","properties":{"runType":{"type":"string","description":"Specifies the type of run."},"sessionIds":{"type":"array","description":"A list of specific run IDs to export.","items":{"type":"string"}},"operatorIds":{"type":"array","description":"A list of operator IDs to filter by.","items":{"type":"string"}},"groupBy":{"type":"array","description":"Specifies the fields used to group the summary results.","items":{"type":"string"}},"queryFromTime":{"type":"string","description":"The minimum timestamp for the data to be exported."},"queryToTime":{"type":"string","description":"The maximum timestamp for the data to be exported."}},"example":{"runType":"NORMAL","queryFromTime":"2025-10-01T0000+0000","queryToTime":"2025-11-17T23:59:59+0000","operatorIds":["4610a876-61ee-4e5e-a634-152e7a635f75"],"sessionIds":["R-00002247","R-00002293"],"groupBy":["errorCode","processorId","sessionId"]}}},"components/schemas/SummaryFilters":{"id":"components/schemas/SummaryFilters","kind":"json-schema","title":"SummaryFilters","data":{"type":"object","properties":{"runType":{"type":"string","description":"Specifies the type of run."},"sessionIds":{"type":"array","nullable":true,"description":"A list of specific run IDs to export.","items":{"type":"string"}},"operatorIds":{"type":"array","nullable":true,"description":"A list of operator IDs to filter by.","items":{"type":"string"}},"groupBy":{"type":"array","description":"Specifies the fields used to group the summary results.","items":{"type":"string"}},"queryFromTime":{"type":"string","nullable":true,"description":"The minimum timestamp for the data to be exported."},"queryToTime":{"type":"string","nullable":true,"description":"The maximum timestamp for the data to be exported."}}}},"components/schemas/SummaryGroupByResult":{"id":"components/schemas/SummaryGroupByResult","kind":"json-schema","title":"SummaryGroupByResult","data":{"type":"object","properties":{"dimensions":{"description":"Stores dimension details or attributes used in grouping or filtering.","type":"object","additionalProperties":{"type":"object","description":"Stores extra or custom fields not defined in the main schema."}},"output":{"type":"integer","format":"int64","description":"Represents the total number of output records or items."},"totalErrorCount":{"type":"integer","format":"int64","description":"Indicates the total count of errors in the response."}}}},"components/schemas/SummaryResponse":{"id":"components/schemas/SummaryResponse","kind":"json-schema","title":"SummaryResponse","data":{"type":"object","properties":{"requestId":{"type":"string","description":"Unique identifier for the API request."},"requestTime":{"type":"string","description":"Timestamp indicating when the request was made."},"query":{"$ref":"#/components/schemas/SummaryFilters","description":"Defines the filters or parameters applied to the summary query."},"output":{"type":"array","description":"Lists grouped summary results based on the specified fields.\n","items":{"$ref":"#/components/schemas/SummaryGroupByResult"}}}}},"components/schemas/CreateSpecificMeterSummaryResponse":{"id":"components/schemas/CreateSpecificMeterSummaryResponse","kind":"json-schema","title":"CreateSpecificMeterSummaryResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"$ref":"#/components/schemas/SummaryResponse","description":"List of audit trail entries for the specified meter. Each object represents a recorded event or operation associated with the meter.\n"},"previousPage":{"type":"string","nullable":true,"description":"Cursor or URL for the previous page of audit records, if available. Used for backward pagination."},"nextPage":{"type":"string","nullable":true,"description":"Cursor or URL for the next page of audit records, if available. Used for forward pagination."},"error":{"$ref":"#/components/schemas/Error","description":"Container for error information returned by the API when the request fails."}}}},"components/schemas/RunStatusResponse":{"id":"components/schemas/RunStatusResponse","kind":"json-schema","title":"RunStatusResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"runStatus":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The run status of the current version. Possible 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":"text","inline":true,"attributes":{"content":"1: NEVER_RUN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2: TESTING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3: TESTING_FAILED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4: TESTING_PASSED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5: RUNNING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6: PAUSED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7: COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8: FAILED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9: CANCELED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10: INITIALIZING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11: USAGE_PUSHING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12: PUSH_COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13: CONSUME_COMPLETED"},"children":[]}]}]}]}],"minimum":1,"maximum":13},"runStatusDescription":{"type":"string","description":"Description of the run status."}}}}}},"components/schemas/MeterAuditRecord":{"id":"components/schemas/MeterAuditRecord","kind":"json-schema","title":"MeterAuditRecord","data":{"type":"object","properties":{"errorTime":{"type":"string","description":"Timestamp when an error occurred during the meter operation or event processing, if applicable."},"timestamp":{"type":"string","description":"Timestamp when the audit entry was created, representing the exact time the event or operation was recorded."},"errorCode":{"type":"string","description":"Unique identifier for the specific error type, used to categorize and troubleshoot issues. Present only when an error has occurred."},"errorMessage":{"type":"string","description":"Descriptive message explaining the cause or nature of the error. Useful for debugging or logging."},"payload":{"description":"Raw event data or metadata associated with the audited action, including event content, request body, or contextual details.","type":"object","additionalProperties":{"type":"object"}},"eventId":{"type":"string","description":"Unique identifier assigned to the audited event. Enables correlation of events across systems for traceability."},"traceId":{"type":"string","description":"Unique identifier used to trace the end-to-end flow of an event through the system. Useful for debugging distributed processes."},"operatorType":{"type":"string","description":"Type of processor used. Examples: MAP, ENRICHMENT","enum":["ACCUMULATOR","AGGREGATOR","BILLING_RATING","CLICKHOUSE_SINK","CLICKHOUSE_SOURCE","DEDUPLICATE","EVENT_STORE_SINK","EVENT_STORE_SOURCE","FILTER","HTTP","KAFKA_SINK","KAFKA_SOURCE","LOCAL_FS_SOURCE","MAP","NATS_SINK","NATS_SOURCE","PARTITION","RATING","S3_SINK","S3_SOURCE","SAMPLE_COMMITTABLE_SINK","SCRIPT_ACCUMULATOR","SCRIPT_AGGREGATOR","SCRIPT_FILTER","SCRIPT_MAP","SNOWFLAKE_ERROR","SNOWFLAKE_SINK","SNOWFLAKE_SOURCE","STREAMING_API_SOURCE","SUBSCRIPTION_LOOKUP","TSTORE_SINK","USAGE_RECORD_SINK","USER_INPUT_SOURCE"]},"operatorName":{"type":"string","description":"Name of the processor used in ther meter configuration."},"operatorId":{"type":"string","description":"ID of the processor used in the meter configuration."}}}},"components/schemas/GetAuditTrailResponse":{"id":"components/schemas/GetAuditTrailResponse","kind":"json-schema","title":"GetAuditTrailResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"array","description":"List of audit trail entries for the specified meter. Each object represents a recorded event or operation associated with the meter.\n","items":{"$ref":"#/components/schemas/MeterAuditRecord"}},"previousPage":{"type":"string","nullable":true,"description":"Cursor for the previous page of audit records, if available. Used for backward pagination."},"nextPage":{"type":"string","description":"Cursor for the next page of audit records, if available. Used for forward pagination."},"error":{"$ref":"#/components/schemas/Error","description":"Container for error information returned by the API when the request fails."}}}},"components/schemas/GetAuditTrailExportResponse":{"id":"components/schemas/GetAuditTrailExportResponse","kind":"json-schema","title":"GetAuditTrailExportResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"description":"Container for pagination metadata and the list of audit trail export jobs\nfor the specified meter.\n","type":"object","properties":{"page":{"type":"integer","format":"int32","description":"Current page number."},"pageSize":{"type":"integer","format":"int32","description":"Number of jobs returned on this page."},"jobs":{"type":"array","description":"List of export jobs for the specified meter.","items":{"type":"object","description":"Audit trail export job."}}}},"previousPage":{"type":"string","nullable":true,"description":"Cursor for the previous page of export jobs, if available. Used for backward pagination."},"nextPage":{"type":"string","nullable":true,"description":"Cursor for the next page of export jobs, if available. Used for forward pagination."},"error":{"$ref":"#/components/schemas/Error","description":"Container for error information returned by the API when the request fails."}}}},"components/schemas/ExportAuditTrailResponse":{"id":"components/schemas/ExportAuditTrailResponse","kind":"json-schema","title":"ExportAuditTrailResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"description":"List of audit trail entries for the specified meter. Each object represents a recorded event or operation associated with the meter.\n","type":"object","additionalProperties":{"type":"object","description":"Stores extra or custom fields that are not defined in the main schema."}},"previousPage":{"type":"string","nullable":true,"description":"Cursor for the previous page of audit records, if available. Used for backward pagination."},"nextPage":{"type":"string","nullable":true,"description":"Cursor for the next page of audit records, if available. Used for forward pagination."},"error":{"$ref":"#/components/schemas/Error","description":"Container for error information returned by the API when the request fails."}}}},"components/schemas/GetPresignedURLResponse":{"id":"components/schemas/GetPresignedURLResponse","kind":"json-schema","title":"GetPresignedURLResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"string","description":"The pre-signed URL to download a specific export file.\n"},"previousPage":{"type":"string","description":"Cursor for the previous page, if available. Used for backward pagination."},"nextPage":{"type":"string","description":"Cursor for the next page, if available. Used for forward pagination."},"error":{"$ref":"#/components/schemas/Error","description":"Container for error information returned by the API when the request fails."}}}},"components/schemas/UsageFieldMapping":{"id":"components/schemas/UsageFieldMapping","kind":"json-schema","title":"UsageFieldMapping","data":{"type":"object","properties":{"name":{"type":"string","description":"Field name"},"field":{"type":"string","description":"Mapped field name"},"required":{"type":"boolean","description":"Indicates if the field is required"},"dateFormat":{"type":"string","description":"Date format if applicable"}}}},"components/schemas/MeterTypeDefinition":{"id":"components/schemas/MeterTypeDefinition","kind":"json-schema","title":"MeterTypeDefinition","data":{"type":"object","properties":{"sourceType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source type, e.g., ZUORA_BULK_API or LOCAL_FILE"},"children":[]}]}]}]},"schemaId":{"type":"string","description":"Event definition ID"},"fieldMappings":{"type":"array","items":{"$ref":"#/components/schemas/UsageFieldMapping"},"description":"Field mappings from event definition to Zuora usage"},"configs":{"type":"object","additionalProperties":true,"description":"Configurations for accumulated meters (e.g., SUM)"}}}},"components/schemas/TransitionNode":{"id":"components/schemas/TransitionNode","kind":"json-schema","title":"TransitionNode","data":{"type":"object","properties":{"id":{"type":"string","description":"Operator ID"}}}},"components/schemas/MeterTask":{"id":"components/schemas/MeterTask","kind":"json-schema","title":"MeterTask","data":{"type":"object","properties":{"id":{"type":"string","description":"Operator ID"},"name":{"type":"string","description":"Operator name"},"nodeType":{"type":"string","description":"Operator node type (e.g., SOURCE, PROCESSOR, SINK)"},"operatorType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operator type (e.g., KAFKA, S3, LOCAL_FILE)"},"children":[]}]}]}]},"metadata":{"type":"object","additionalProperties":true,"description":"Operator metadata"},"predecessors":{"type":"array","items":{"$ref":"#/components/schemas/TransitionNode"},"description":"Predecessor operators"},"extraConfig":{"type":"object","additionalProperties":true,"description":"Extra configurations for the operator"},"setting":{"type":"object","additionalProperties":true,"description":"Runtime settings for the operator"}}}},"components/schemas/MeterVersionExportResult":{"id":"components/schemas/MeterVersionExportResult","kind":"json-schema","title":"MeterVersionExportResult","data":{"type":"object","properties":{"version":{"type":"string","description":"The initial version of meter, default is 0.0.1"},"versionDetail":{"type":"string","description":"Detail description of this version"},"metadata":{"type":"string","description":"Version metadata, UI stores meter position data into this field"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/MeterTask"},"description":"List of tasks for this version"}}}},"components/schemas/EventSchemaExportResult":{"id":"components/schemas/EventSchemaExportResult","kind":"json-schema","title":"EventSchemaExportResult","data":{"type":"object","description":"Schema details of an event associated with a meter","properties":{"name":{"type":"string","description":"Event definition name"},"type":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema type (1 = simple, 2 = advanced)"},"children":[]}]}]}],"minimum":1,"maximum":2},"schema":{"type":"object","description":"JSON schema","properties":{"description":{"type":"string","description":"Schema description"},"type":{"type":"string","enum":["object"],"description":"Schema base type"},"title":{"type":"string","description":"Schema title"},"required":{"type":"array","description":"Required fields in the event","items":{"type":"string"}},"properties":{"type":"object","description":"Field definitions in the schema","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"Data type of the field"},"description":{"type":"string","description":"Description of the field"}}}}}}},"example":{"name":"source(97)","type":1,"schema":{"description":"A description","type":"object","title":"source","required":["CustomerId","UsageIdentifier","UsageDate"],"properties":{"Amount":{"type":"number","description":"Amount"},"Quantity":{"type":"number","description":"Quantity"},"UsageDate":{"type":"string","description":"UsageDate"},"CostCenter":{"type":"string","description":"CostCenter"},"CustomerId":{"type":"string","description":"CustomerId"},"UsageIdentifier":{"type":"string","description":"UsageIdentifier"}}}}}},"components/schemas/ExportMeterResponse":{"id":"components/schemas/ExportMeterResponse","kind":"json-schema","title":"ExportMeterResponse","data":{"type":"object","properties":{"name":{"type":"string","description":"Meter name"},"description":{"type":"string","description":"Meter description"},"type":{"type":"string","description":"Meter type (e.g., CUSTOM, STANDARD)"},"typeDefinition":{"$ref":"#/components/schemas/MeterTypeDefinition","description":"The meter definition for non-CUSTOM meters"},"latestVersion":{"type":"string","description":"The latest version of the meter"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/MeterVersionExportResult"},"description":"List of all versions for the meter"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/EventSchemaExportResult"},"description":"List of event schemas used by this meter"}}}},"components/schemas/ImportMeterRequest":{"id":"components/schemas/ImportMeterRequest","kind":"json-schema","title":"ImportMeterRequest","data":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"Meter definition file, should match format from Export Meter API"},"globalId":{"type":"string","description":"If present and matches an existing meter, updates it. Else, creates a new meter with this globalId."}}}},"components/schemas/ImportMeterResponse":{"id":"components/schemas/ImportMeterResponse","kind":"json-schema","title":"ImportMeterResponse","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"id":{"type":"string","description":"Internal meter ID, unique within tenant"},"name":{"type":"string","description":"Meter name"},"description":{"type":"string","description":"Meter description"},"type":{"type":"string","description":"Meter type"},"typeDefinition":{"$ref":"#/components/schemas/MeterTypeDefinition","description":"The meter definition for non-CUSTOM meters"},"latestVersion":{"type":"string","description":"The latest version of the meter"},"globalId":{"type":"string","description":"Meter global ID used for ingestion via Streaming API"},"uniqueUploadUrl":{"type":"string","description":"The upload URL for usage ingestion"},"activeVersionRunStatus":{"type":"integer","description":"Run status of the active version"},"activeVersionRunStatusDescription":{"type":"string","description":"Description of active version run status"},"latestVersionRunStatus":{"type":"integer","description":"Run status of the latest version"},"latestVersionRunStatusDescription":{"type":"string","description":"Description of latest version run status"},"createdAt":{"type":"string","description":"Timestamp of meter creation"},"updatedAt":{"type":"string","description":"Timestamp of meter update"}}}}}},"components/schemas/CreateFileResponse":{"id":"components/schemas/CreateFileResponse","kind":"json-schema","title":"CreateFileResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Internal file ID"},"name":{"type":"string","description":"File name"},"resourceId":{"type":"string","description":"Resource ID of the file"},"format":{"type":"string","description":"File format (CSV, Excel, JSON)"},"hasHeader":{"type":"boolean","description":"Indicates if the file has a header"},"firstRow":{"type":"integer","description":"The first row number in the CSV file"},"delimiter":{"type":"string","description":"Delimiter used in the CSV file"},"sheet":{"type":"string","description":"The sheet name in the Excel file"},"dataRange":{"type":"string","description":"Data range in the Excel file"},"lines":{"type":"integer","description":"Number of lines in the file"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"}}}},"components/schemas/StreamingEvent":{"id":"components/schemas/StreamingEvent","kind":"json-schema","title":"StreamingEvent","data":{"type":"object","description":"A usage event to be ingested into Zuora Mediation.","properties":{"CustomerId":{"type":"string","description":"Unique identifier for the customer."},"UsageIdentifier":{"type":"string","description":"Identifier for the usage type."},"UsageDate":{"type":"string","format":"date-time","description":"Date and time when the usage occurred."},"Quantity":{"type":"number","description":"Quantity of usage."}},"required":["CustomerId","UsageIdentifier","UsageDate","Quantity"]}},"components/schemas/StreamingIngestionSuccessResponse":{"id":"components/schemas/StreamingIngestionSuccessResponse","kind":"json-schema","title":"StreamingIngestionSuccessResponse","data":{"type":"object","description":"Successful ingestion response.","properties":{"success":{"type":"boolean","description":"Whether the ingestion was successful."},"message":{"type":"string","description":"Response message with details."}}}},"components/schemas/StreamingIngestionAuthError":{"id":"components/schemas/StreamingIngestionAuthError","kind":"json-schema","title":"StreamingIngestionAuthError","data":{"type":"object","description":"Response for authentication, authorization, or other system-level errors.","properties":{"message":{"type":"string","description":"Error message describing the problem."}},"required":["message"]}},"components/schemas/BulkDeleteEventRequest":{"id":"components/schemas/BulkDeleteEventRequest","kind":"json-schema","title":"BulkDeleteEventRequest","data":{"type":"object","required":["file","storeId"],"properties":{"file":{"type":"string","format":"binary","description":"The file that contains the event IDs to delete."},"storeId":{"type":"integer","description":"ID of the event store to delete events from."}}}},"components/schemas/BulkDeleteEventResponse":{"id":"components/schemas/BulkDeleteEventResponse","kind":"json-schema","title":"BulkDeleteEventResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the bulk delete request was successful."},"data":{"type":"object","properties":{"queryId":{"type":"string","description":"Query ID to track the bulk delete operation."}}}}}},"components/schemas/LatestEventStoreJobResponse":{"id":"components/schemas/LatestEventStoreJobResponse","kind":"json-schema","title":"LatestEventStoreJobResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"object","properties":{"id":{"type":"string","description":"Internal event store query history ID."},"eventStoreId":{"type":"string","description":"Related event store ID."},"queryId":{"type":"string","description":"Query ID."},"status":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run status of the job. Possible 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":"text","inline":true,"attributes":{"content":"5: RUNNING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6: PAUSED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7: COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8: FAILED"},"children":[]}]}]}]}],"minimum":5,"maximum":8},"operationType":{"type":"string","description":"Operation type."},"inputRecordCount":{"type":"integer","description":"Input record count of this query."},"uniqueRecordCount":{"type":"integer","description":"Unique record count of this query."},"modifiedRecordCount":{"type":"integer","description":"Modified record count of this query."},"createdAt":{"type":"string","description":"Created timestamp of the query history."},"updatedAt":{"type":"string","description":"Updated timestamp of the query history."}}}}}},"components/schemas/TruncateEventStoreResponse":{"id":"components/schemas/TruncateEventStoreResponse","kind":"json-schema","title":"TruncateEventStoreResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"description":"Truncation job metadata.","type":"object","properties":{"queryId":{"type":"string","description":"ID of the submitted truncation job. Use this to poll job status."}}},"previousPage":{"type":"string","nullable":true,"description":"Cursor for the previous page, if available. Used for backward pagination."},"nextPage":{"type":"string","nullable":true,"description":"Cursor for the next page, if available. Used for forward pagination."}}}},"components/schemas/MediationTruncateErrorResponse":{"id":"components/schemas/MediationTruncateErrorResponse","kind":"json-schema","title":"MediationTruncateErrorResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful.","example":false},"previousPage":{"type":"string","nullable":true,"description":"Cursor or URL for the previous page of results, if available.\nUsed for backward pagination.\n"},"nextPage":{"type":"string","nullable":true,"description":"Cursor or URL for the next page of results, if available.\nUsed for forward pagination.\n"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Application-specific error code."},"message":{"type":"string","description":"Human-readable error message."}}}}}},"components/schemas/SubmitEventStoreQueryRequest":{"id":"components/schemas/SubmitEventStoreQueryRequest","kind":"json-schema","title":"SubmitEventStoreQueryRequest","data":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"The query clause."}},"example":{"query":"select * from usage_event"}}},"components/schemas/SubmitEventStoreQueryResponse":{"id":"components/schemas/SubmitEventStoreQueryResponse","kind":"json-schema","title":"SubmitEventStoreQueryResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"description":"Contains metadata and result details for the submitted event store query.","type":"object","properties":{"queryId":{"type":"string","description":"Unique identifier of the submitted event store query. Use this ID to poll for status and fetch results."}},"additionalProperties":{"type":"object","description":"Stores extra or custom fields that are not defined in the main schema."}},"previousPage":{"type":"string","description":"Cursor or URL for the previous page of audit records, if available. Used for backward pagination."},"nextPage":{"type":"string","description":"Cursor or URL for the next page of audit records, if available. Used for forward pagination."},"error":{"$ref":"#/components/schemas/Error","description":"Container for error information returned by the API when the request fails."}}}},"components/schemas/QueryResult":{"id":"components/schemas/QueryResult","kind":"json-schema","title":"QueryResult","data":{"type":"object","properties":{"isFailed":{"type":"boolean","description":"A boolean flag indicating whether the query execution has failed."},"totalCount":{"type":"integer","format":"int32","description":"The total number of rows that match the conditions defined in the executed query."},"columns":{"type":"array","description":"A list containing details of each column in the store.","items":{"type":"object","properties":{"name":{"type":"string","description":"The column name."},"logicalType":{"type":"object","description":"Logical type information for the column.","properties":{"type":{"type":"string","description":"The data type of the column (for example, VARCHAR, BIGINT, DECIMAL)."},"nullable":{"type":"boolean","description":"Indicates whether the column can contain null values."},"length":{"type":"integer","format":"int32","description":"For string types, the maximum length."},"precision":{"type":"integer","description":"For DECIMAL types, the total number of digits."},"scale":{"type":"integer","description":"For DECIMAL types, the number of digits to the right of the decimal point."}},"additionalProperties":false},"comment":{"type":"string","nullable":true,"description":"Optional comment or description for the column."}},"additionalProperties":false}},"rows":{"type":"array","description":"The list of rows returned by the query.","items":{"type":"object","properties":{"kind":{"type":"string","description":"The kind of change for the row (for example, INSERT)."},"fields":{"type":"array","description":"The ordered list of field values for this row. Each position corresponds to a column in the columns array.","items":{}}},"additionalProperties":false}},"message":{"type":"string","description":"Error message displayed for a failed query execution."},"ready":{"type":"boolean","description":"A boolean flag indicating whether the query execution has completed."}}}},"components/schemas/GetQueryResultsResponse":{"id":"components/schemas/GetQueryResultsResponse","kind":"json-schema","title":"GetQueryResultsResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"description":"Contains the query result object, including the query ID, execution status flags, total row count, column metadata, and the list of rows returned by the query.","$ref":"#/components/schemas/QueryResult"}}}},"components/schemas/PrefetchAuditRecord":{"id":"components/schemas/PrefetchAuditRecord","kind":"json-schema","title":"PrefetchAuditRecord","data":{"type":"object","description":"A single prefetch job audit record.","properties":{"jobId":{"type":"integer","format":"int64","description":"Prefetch job ID."},"operatorId":{"type":"string","description":"Processor (operator) ID."},"definitionId":{"type":"integer","format":"int64","description":"Prefetch definition ID."},"duration":{"type":"integer","format":"int64","description":"Job duration in milliseconds."},"completedTime":{"type":"string","format":"date-time","description":"Timestamp when the job completed."},"startTime":{"type":"string","format":"date-time","description":"Timestamp when the job started."},"dataFreshness":{"type":"string","format":"date-time","nullable":true,"description":"Data freshness timestamp, if available."},"status":{"type":"string","description":"Job status.","enum":["RUNNING","CANCELED","FINISHED","FAILED"]},"triggerType":{"type":"string","description":"Trigger type for the job.","enum":["MANUAL","AUTOMATIC"]},"error":{"type":"string","nullable":true,"description":"Error message if the job failed; otherwise null."}}}},"components/schemas/GetPrefetchAuditResponse":{"id":"components/schemas/GetPrefetchAuditResponse","kind":"json-schema","title":"GetPrefetchAuditResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"data":{"type":"array","description":"List of prefetch audit records for the specified processor.","items":{"$ref":"#/components/schemas/PrefetchAuditRecord"}},"previousPage":{"type":"string","description":"Cursor or URL for the previous page of audit records, if available. Used for backward pagination."},"nextPage":{"type":"string","description":"Cursor or URL for the next page of audit records, if available. Used for forward pagination."},"error":{"$ref":"#/components/schemas/Error","description":"Container for error information returned by the API when the request fails."}}}},"components/schemas/CommitmentStatus":{"id":"components/schemas/CommitmentStatus","kind":"json-schema","title":"CommitmentStatus","data":{"type":"string","enum":["Active","Cancelled","Evaluated","CancelledPendingEvaluation"],"description":"Status of the commitment.\n"}},"components/schemas/PrepaymentTypeEnum":{"id":"components/schemas/PrepaymentTypeEnum","kind":"json-schema","title":"PrepaymentTypeEnum","data":{"type":"string","enum":["FullyPrepaid","NotPrepaid"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The prepayment type of the commitment."},"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":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FullyPrepaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" commitments will not be considered for true-up during invoice generation."},"children":[]}]}]}]}},"components/schemas/CommitmentCustomFields":{"id":"components/schemas/CommitmentCustomFields","kind":"json-schema","title":"CommitmentCustomFields","data":{"type":"object","description":"Container for custom fields of a Commitment object.","additionalProperties":{"description":"A custom field on the Commitment object.","type":"string"}}},"components/schemas/SettlementType":{"id":"components/schemas/SettlementType","kind":"json-schema","title":"SettlementType","data":{"type":"string","description":"Settlement type for commitment cancellation.","enum":["NoSettlement","FullMinimum","PeriodMinimum"],"default":"NoSettlement"}},"components/schemas/CancellationPolicy":{"id":"components/schemas/CancellationPolicy","kind":"json-schema","title":"CancellationPolicy","data":{"type":"object","description":"Cancellation policy configuration for a commitment. Defines how settlements are handled when a commitment is cancelled.\n","properties":{"settlementType":{"$ref":"#/components/schemas/SettlementType"}}}},"components/schemas/GetCommitmentResponse":{"id":"components/schemas/GetCommitmentResponse","kind":"json-schema","title":"GetCommitmentResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the commitment.\n"},"status":{"$ref":"#/components/schemas/CommitmentStatus"},"version":{"type":"integer","description":"Version of the commitment.\n"},"startDate":{"type":"string","format":"date","description":"The start date of the commitment."},"endDate":{"type":"string","format":"date","description":"The end date of the commitment."},"totalAmount":{"type":"number","format":"double","description":"The commitment amount."},"currency":{"type":"string","description":"Currency of the commitment.\n"},"orderNumber":{"type":"string","maxLength":32,"description":"The number of the order."},"orderId":{"type":"string","maxLength":32,"description":"The ID of the order."},"accountId":{"type":"string","maxLength":32,"description":"The ID of the commitment owner account.\n"},"accountNumber":{"type":"string","maxLength":100,"description":"Use this field to assign an existing account as the owner of an Commitment."},"commitmentNumber":{"type":"string","maxLength":100,"description":"The number of the commitment.\n"},"name":{"type":"string","maxLength":255,"description":"The name of the commitment.\n"},"type":{"type":"string","description":"The type of the commitment.\n","enum":["MinCommitment","MaxCommitment"]},"prepaymentType":{"$ref":"#/components/schemas/PrepaymentTypeEnum"},"description":{"type":"string","maxLength":500,"description":"The description about this commitment.\n"},"priority":{"type":"integer","description":"The priority of the commitment.\nIt defines the evaluation order of the commitment. The lower the number, the higher the priority.\nWhen two commitments have the same priority, the one with the earlier created time will be evaluated first.\n"},"customFields":{"$ref":"#/components/schemas/CommitmentCustomFields"},"aceId":{"type":"integer","format":"int64","description":"The account code entity ID."},"accountReceivableAccountingCode":{"description":"The accounting code on the Commitment object for customers","type":"string","maxLength":200},"adjustmentLiabilityAccountingCode":{"type":"string","maxLength":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"adjustmentRevenueAccountingCode":{"type":"string","maxLength":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"cancellationPolicy":{"$ref":"#/components/schemas/CancellationPolicy"},"cancellationEffectiveDate":{"type":"string","format":"date","description":"The effective date when the commitment cancellation takes effect."},"childCommitments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Child commitments nested under this parent. Never null."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeChildCommitments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted, this array is empty."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeChildCommitments"},"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":", this array contains full child commitment objects,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or an empty array when there are no children."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/GetCommitmentResponse"},"example":[{"id":"8ad08ca797ef6ca50197f3cce6267992","status":"Active","version":1,"currency":"USD","startDate":"2024-01-01","endDate":"2024-12-31","totalAmount":50000,"orderNumber":"O-0001","orderId":"00989e98483e00030a2733ee989e9815","accountId":"8a8aa0ac7f3b4c1d017f3b4c1d0a0001","accountNumber":"ACC-0001","commitmentNumber":"CMT-CHILD-001","name":"Child Commitment","type":"MinCommitment","prepaymentType":"NotPrepaid","description":"Child commitment created from parent","priority":1,"eligibleAccountConditions":{"field":"Account.AccountNumber","operator":"eq","value":"ACC-0001","conditions":[{}],"relation":"and"},"eligibleChargeConditions":{"field":"RatePlanCharge.ChargeNumber","operator":"in","value":"C-0001,C-0002","conditions":[{}],"relation":"and"},"periodAlignmentOption":"SpecificDate","specificPeriodAlignmentDate":"2020-01-15","customFields":{},"aceId":15837365486485894,"excludeItemBookingFromRevenueAccounting":true,"adjustmentLiabilityAccountingCode":"Accounts Receivable","adjustmentRevenueAccountingCode":"Accounts Receivable","contractAssetAccountingCode":"Accounts Receivable","contractLiabilityAccountingCode":"Accounts Receivable","contractRecognizedRevenueAccountingCode":"Accounts Receivable","deferredRevenueAccountingCode":"Accounts Receivable","excludeItemBillingFromRevenueAccounting":false,"isAllocationEligible":true,"isUnbilled":false,"recognizedRevenueAccountingCode":"Accounts Receivable","revenueRecognitionRule":"Recognize upon invoicing","unbilledReceivablesAccountingCode":"Accounts Receivable","revenueRecognitionTiming":"Upon Order Activation Date","revenueAmortizationMethod":"Immediate","accountReceivableAccountingCode":"Accounts Receivable","cancellationPolicy":{"settlementType":"NoSettlement"},"cancellationEffectiveDate":"2020-06-30","childCommitments":[],"taxable":true,"taxCode":"SalesTax_US","taxMode":"TaxInclusive"}]},"contractAssetAccountingCode":{"type":"string","maxLength":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"contractLiabilityAccountingCode":{"type":"string","maxLength":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"contractRecognizedRevenueAccountingCode":{"type":"string","maxLength":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"deferredRevenueAccountingCode":{"type":"string","maxLength":100,"description":"The deferred revenue accounting code for the commitment."},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","default":true,"description":"The flag to exclude commitment related booking items from revenue accounting.\n"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude commitment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"eligibleAccountConditions":{"$ref":"#/components/schemas/EligibleAccountCondition"},"eligibleChargeConditions":{"$ref":"#/components/schemas/EligibleChargeCondition"},"periodAlignmentOption":{"$ref":"#/components/schemas/PeriodAlignmentOptionEnum"},"specificPeriodAlignmentDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date for period alignment, required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodAlignmentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"isAllocationEligible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to identify if the commitment is allocation eligible in revenue recognition."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"isUnbilled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to dictate how to perform the accounting during revenue recognition."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"recognizedRevenueAccountingCode":{"type":"string","maxLength":100,"description":"The recognized revenue accounting code for the commitment."},"revenueAmortizationMethod":{"description":"This field is used to dictate the type of revenue amortization method.\n","type":"string","maxLength":200},"revenueRecognitionRule":{"type":"string","description":"The revenue recognition rule for the commitment."},"revenueRecognitionTiming":{"description":"This field is used to dictate the type of revenue recognition timing.\n","type":"string","maxLength":200},"unbilledReceivablesAccountingCode":{"type":"string","maxLength":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the commitment for customers."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"taxable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the true-up invoice of a commitment is taxable. If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the tax code and tax mode are required."},"children":[]}]}]}]},"taxCode":{"type":"string","description":"Identifies which tax rules and tax rates to apply to the corresponding billing document.\n"},"taxMode":{"type":"string","description":"The tax mode that determines whether tax is included or exclueded from the billing document.\n","enum":["TaxInclusive","TaxExclusive"]}}}},"components/schemas/EligibleAccountCondition":{"id":"components/schemas/EligibleAccountCondition","kind":"json-schema","title":"EligibleAccountCondition","data":{"type":"object","description":"The conditions for account level filters for the commitment.","properties":{"field":{"type":"string","description":"The field name of a single condition.\n"},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operator of a single condition."},"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":"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":"eq: equal, field = value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"neq: not equal, field != value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gt: greater than, field > value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lt: less than, field < value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gte: greater than or equal, field >= value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lte: less than or equal, field <= value - lk: like, field like value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in: in, field in value, multiple values are separated by commas"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nl: null, field is null"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nnl: not null, field is not null"},"children":[]}]}]}]}],"enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of a single condition, which can be a list of values separated by commas."},"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":"Notes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Account Condition only contains account related fields. Support is provided only for the indexed custom fields."},"children":[]}]}]}]},"conditions":{"type":"array","description":"The conditions will be combined by the relation.\n","items":{"$ref":"#/components/schemas/EligibleAccountCondition"}},"relation":{"type":"string","description":"The relation among the conditions.\n","enum":["and","or"]}}}},"components/schemas/EligibleChargeCondition":{"id":"components/schemas/EligibleChargeCondition","kind":"json-schema","title":"EligibleChargeCondition","data":{"type":"object","description":"The conditions for charge level filters for the commitment.","properties":{"field":{"type":"string","description":"The field name of a single condition.\n"},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operator of a single condition."},"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":"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":"eq: equal, field = value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"neq: not equal, field != value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gt: greater than, field > value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lt: less than, field < value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gte: greater than or equal, field >= value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lte: less than or equal, field <= value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lk: like, field like value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in: in, field in value, multiple values are separated by commas"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nl: null, field is null"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nnl: not null, field is not null"},"children":[]}]}]}]}],"enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of a single condition, which can be a list of values separated by commas."},"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":"Notes:"},"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":"PPDD (PrePaid DrawDown) charge will not be loaded during evaluation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge condition only contains charge related fields. Support is provided only for the indexed custom fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge types supports only the OneTime, Recurring and Usage values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge models supports only the FlatFee, PerUnit, Overage, Volume Tiered, TieredWithOverage, and Calculated values."},"children":[]}]}]}]}]},"conditions":{"type":"array","description":"The conditions will be combined by the relation.\n","items":{"$ref":"#/components/schemas/EligibleChargeCondition"}},"relation":{"type":"string","description":"The relation among the conditions.\n","enum":["and","or"]}}}},"components/schemas/GetCommitmentsResponse":{"id":"components/schemas/GetCommitmentsResponse","kind":"json-schema","title":"GetCommitmentsResponse","data":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of commitments returned.","example":1},"page":{"type":"integer","description":"Current page number.","example":1},"page_size":{"type":"integer","description":"Number of commitments per page.","example":1},"commitments":{"type":"array","description":"List of commitments.\n","items":{"$ref":"#/components/schemas/GetCommitmentResponse"}}}}},"components/schemas/PeriodStatusResponse":{"id":"components/schemas/PeriodStatusResponse","kind":"json-schema","title":"PeriodStatusResponse","data":{"type":"string","enum":["Active","Cancelled","Evaluated","ActiveWithDrawdown","CancelledPendingEvaluation"],"description":"Status of the commitment period.\n"}},"components/schemas/CommitmentPeriod":{"id":"components/schemas/CommitmentPeriod","kind":"json-schema","title":"CommitmentPeriod","data":{"type":"object","title":"CommitmentPeriod","properties":{"id":{"type":"string","description":"ID of the commitment period."},"commitmentId":{"type":"string","description":"ID of the commitment."},"commitmentNumber":{"type":"string","description":"The number of the commitment."},"version":{"type":"integer","description":"Version of the commitment period."},"type":{"$ref":"#/components/schemas/CommitmentTypeEnum"},"priority":{"type":"integer","description":"Priority of the commitment."},"currency":{"type":"string","description":"Currency of the commitment."},"isProrated":{"type":"boolean","description":"Indicates if the period is prorated."},"amount":{"description":"The total amount of the commitment within the current period.","type":"number","format":"double"},"balance":{"description":"The balance amount to be spent within the current period.","type":"number","format":"double"},"trueUpAmount":{"description":"Total true-up amount for this commitment period. It will be null if it is a prepaid commitment or if it is not evaluated yet. This will be a non-negative number.","type":"number","format":"double","nullable":true},"expiredAmount":{"description":"Total expired amount for this commitment period. It will be null if it is a postpaid commitment or if the period is not evaluated yet. This will be a non-negative number.","type":"number","format":"double","nullable":true},"billedTotalSpending":{"description":"Sum of charge contribution amount.","type":"number","format":"double"},"consumedAmount":{"type":"number","format":"double","example":1000,"description":"Sum of actual drawdown and reversal contributions for this commitment period."},"overage":{"type":"number","format":"double","example":200,"description":"Overage amount for this commitment period."},"status":{"$ref":"#/components/schemas/PeriodStatusResponse"},"startDate":{"description":"The start date of the commitment period.","type":"string","format":"date"},"endDate":{"description":"The end date of the commitment period.","type":"string","format":"date"}}}},"components/schemas/ListCommitmentPeriodsResponse":{"id":"components/schemas/ListCommitmentPeriodsResponse","kind":"json-schema","title":"ListCommitmentPeriodsResponse","data":{"title":"ListCommitmentPeriodsResponse","properties":{"total":{"type":"integer","description":"Total number of periods available for the given commitment/Total commitments for given account."},"page":{"type":"integer","description":"The current page number."},"pageSize":{"type":"integer","description":"The number of results returned per page."},"periods":{"description":"A list of commitment period objects.","type":"array","items":{"$ref":"#/components/schemas/CommitmentPeriod"}}}}},"components/schemas/PeriodBalanceStatus":{"id":"components/schemas/PeriodBalanceStatus","kind":"json-schema","title":"PeriodBalanceStatus","data":{"type":"string","enum":["ACTIVE","EVALUATED","ACTIVE_WITH_DRAWDOWN","CANCELLED_PENDING_EVALUATION"],"description":"A subset of the Period status. Periods in the 'Cancelled' status will not be included.\n"}},"components/schemas/PeriodBalance":{"id":"components/schemas/PeriodBalance","kind":"json-schema","title":"PeriodBalance","data":{"type":"object","title":"PeriodBalance","properties":{"id":{"type":"string","description":"ID of the commitment period."},"committedAmount":{"description":"The total amount of the commitment within the current period.","type":"number","format":"double"},"balance":{"description":"The balance amount to be spent within the current period.","type":"number","format":"double"},"totalSpend":{"description":"The total amount spent within the current period.","type":"number","format":"double"},"trueUpAmount":{"description":"Total true-up amount for this commitment period. It will be null if it is a prepaid commitment or if it is not evaluated yet. This will be a non-negative number.","type":"number","format":"double","nullable":true},"expiredAmount":{"description":"Total expired amount for this commitment period. It will be null if it is a postpaid commitment or if the period is not evaluated yet. This will be a non-negative number.","type":"number","format":"double","nullable":true},"billedTotalSpending":{"description":"Sum of charge contribution amount.","type":"number","format":"double"},"consumedAmount":{"type":"number","format":"double","example":850,"description":"Current consumed amount based on actual drawdown and reversal contributions."},"totalConsumedAmount":{"type":"number","format":"double","example":1200,"description":"Projected consumed amount including the preview drawdown contributions."},"status":{"$ref":"#/components/schemas/PeriodBalanceStatus"},"startDate":{"description":"Ths start date of the commitment period.","type":"string","format":"date"},"endDate":{"description":"The end date of the commitment period.","type":"string","format":"date"}}}},"components/schemas/GetCommitmentBalanceResponse":{"id":"components/schemas/GetCommitmentBalanceResponse","kind":"json-schema","title":"GetCommitmentBalancePreviewResponse","data":{"title":"GetCommitmentBalancePreviewResponse","properties":{"total":{"type":"integer","description":"Total commitments for the given account."},"page":{"type":"integer","description":"The current page number."},"pageSize":{"type":"integer","description":"The number of results returned per page."},"periods":{"description":"A list of commitment period objects.","type":"array","items":{"$ref":"#/components/schemas/PeriodBalance"}}}}},"components/schemas/CommitmentScheduleStatus":{"id":"components/schemas/CommitmentScheduleStatus","kind":"json-schema","title":"CommitmentScheduleStatus","data":{"type":"string","enum":["Active","Cancelled","Evaluated","CancelledPendingEvaluation"],"description":"Status of the commitment schedule.\n"}},"components/schemas/ListCommitmentScheduleOutput":{"id":"components/schemas/ListCommitmentScheduleOutput","kind":"json-schema","title":"ListCommitmentScheduleOutput","data":{"type":"object","title":"ListCommitmentScheduleOutput","properties":{"id":{"type":"string","description":"ID of the commitment schedule."},"commitmentId":{"type":"string","description":"ID of the commitment."},"commitmentNumber":{"type":"string","description":"The number of the commitment."},"version":{"description":"Version of the commitment schedule.","type":"integer"},"startDate":{"description":"Ths start date of the commitment schedule.","type":"string","format":"date"},"endDate":{"description":"The end date of the commitment schedule.","type":"string","format":"date"},"prepaymentDefinition":{"$ref":"#/components/schemas/PrepaymentDefinition"},"totalAmount":{"description":"The total amount of the commitment schedule.","type":"number","format":"double"},"amount":{"description":"The non-prorated actual amount of the commitment schedule.","type":"number","format":"double"},"amountBase":{"$ref":"#/components/schemas/AmountBaseEnum"},"periodType":{"$ref":"#/components/schemas/PeriodTypeEnum"},"specificPeriodLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific length of the period, required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificMonths"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"status":{"$ref":"#/components/schemas/CommitmentScheduleStatus"}}}},"components/schemas/GetCommitmentScheduleResponse":{"id":"components/schemas/GetCommitmentScheduleResponse","kind":"json-schema","title":"GetCommitmentScheduleResponse","data":{"title":"GetCommitmentScheduleResponse","properties":{"schedules":{"description":"A list of commitment schedule objects.","type":"array","items":{"$ref":"#/components/schemas/ListCommitmentScheduleOutput"}},"total":{"type":"integer","description":"Total number of schedules available for the given commitment."},"page":{"type":"integer","description":"The current page number."},"pageSize":{"type":"integer","description":"The number of results returned per page."}}}},"components/schemas/ExpirePrepaymentResponse":{"id":"components/schemas/ExpirePrepaymentResponse","kind":"json-schema","title":"ExpirePrepaymentResponse","data":{"title":"ExpirePrepaymentResponse","allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"id":{"type":"string","description":"The ID of the prepayment."},"prepaymentDefinitionId":{"type":"string","description":"The ID of the prepayment definition associated with the prepayment."},"commitmentId":{"type":"string","description":"The ID of the commitment associated with the prepayment."},"commitmentNumber":{"type":"string","description":"The number of the commitment associated with the prepayment."},"commitmentScheduleId":{"type":"string","description":"The ID of the commitment schedule associated with the prepayment."},"commitmentPeriodId":{"type":"string","description":"The ID of the commitment period associated with the prepayment."},"amount":{"type":"number","description":"The original amount of the prepayment."},"billedAmount":{"type":"number","description":"The total billed amount of the prepayment."},"spendAmount":{"type":"number","description":"The total spend amount of the prepayment."},"balance":{"type":"number","description":"The remaining balance of the prepayment."},"overageAmount":{"type":"number","description":"The overage amount of the prepayment."},"currency":{"type":"string","description":"The currency of the prepayment amounts."}}}]}},"components/schemas/Change":{"id":"components/schemas/Change","kind":"json-schema","title":"Change","data":{"title":"Change","type":"object","description":"The change of the value of the field.","additionalProperties":{"type":"object","description":"A changed field and its corresponding old and new values.","properties":{"oldValue":{"description":"The previous value of the field before the change."},"newValue":{"description":"The new value of the field after the change.","example":"New Value"}}}}},"components/schemas/CommitmentPeriodChanges":{"id":"components/schemas/CommitmentPeriodChanges","kind":"json-schema","title":"CommitmentPeriodChanges","data":{"title":"CommitmentPeriodChanges","type":"object","description":"The change of the value of the field.","properties":{"periodId":{"type":"string","description":"The ID of the commitment period.","example":"8ad08ca797ef6ca50197f3cce6267991"},"version":{"type":"integer","description":"The version number of the commitment period.","example":1},"changes":{"$ref":"#/components/schemas/Change"}}}},"components/schemas/CommitmentScheduleChanges":{"id":"components/schemas/CommitmentScheduleChanges","kind":"json-schema","title":"CommitmentScheduleChanges","data":{"title":"CommitmentScheduleChanges","type":"object","description":"The change of the value of the field.","properties":{"scheduleId":{"type":"string","description":"The ID of the commitment schedule.","example":"8ad08ca797ef6ca50197f3cce6267991"},"version":{"type":"integer","description":"The version number of the commitment schedule.","example":2},"changes":{"$ref":"#/components/schemas/Change"},"periodChanges":{"type":"array","description":"The changes in the period of the schedule in this order.","items":{"$ref":"#/components/schemas/CommitmentPeriodChanges"},"example":[{"periodId":"0df89cf12e650006ac13624398764f1b","version":1,"changes":{"status":{"oldValue":null,"newValue":"Active"}}}]}}}},"components/schemas/CommitmentAssociatedItemChanges":{"id":"components/schemas/CommitmentAssociatedItemChanges","kind":"json-schema","title":"CommitmentAssociatedItemChanges","data":{"title":"CommitmentAssociatedItemChanges","type":"object","properties":{"itemId":{"type":"string","description":"The ID of the associated item."},"version":{"type":"integer","description":"The version of the associated item at the time of this change."},"changes":{"$ref":"#/components/schemas/Change"}}}},"components/schemas/CommitmentAssociatedAccountChanges":{"id":"components/schemas/CommitmentAssociatedAccountChanges","kind":"json-schema","title":"CommitmentAssociatedAccountChanges","data":{"title":"CommitmentAssociatedAccountChanges","type":"object","properties":{"accountId":{"type":"string","description":"The ID of the associated account."},"version":{"type":"integer","description":"The version of the associated account at the time of this change."},"changes":{"$ref":"#/components/schemas/Change"}}}},"components/schemas/CommitmentAssociatedCommitmentChanges":{"id":"components/schemas/CommitmentAssociatedCommitmentChanges","kind":"json-schema","title":"CommitmentAssociatedCommitmentChanges","data":{"title":"CommitmentAssociatedCommitmentChanges","type":"object","description":"Child commitments added or removed in this order.","properties":{"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the listed children were linked under this commitment;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REMOVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if they were unlinked."},"children":[]}]}]}],"enum":["ADD","REMOVE"],"example":"ADD"},"commitmentNumbers":{"type":"array","description":"Commitment numbers of the child commitments added or removed.","items":{"type":"string"},"example":["CMT-0002"]}}}},"components/schemas/CommitmentOrderChangeOutput":{"id":"components/schemas/CommitmentOrderChangeOutput","kind":"json-schema","title":"CommitmentOrderChangeOutput","data":{"title":"CommitmentOrderChangeOutput","type":"object","properties":{"commitmentNumber":{"type":"string","description":"The unique identifier of the commitment.","example":"CMT-00083518"},"orderNumber":{"type":"string","description":"The number of the order that changed the commitment.","example":"O-00007435"},"version":{"type":"integer","description":"The commitment version by this order.","example":1},"changeDate":{"type":"string","format":"date-time","description":"The date and time when the change was made.","example":"2020-10-01T12:00:00Z"},"changes":{"allOf":[{"$ref":"#/components/schemas/Change"}],"description":"The changes in the commitment in this order.","example":{"name":{"oldValue":"Old Commitment Name","newValue":"New Commitment Name"},"description":{"oldValue":"Old description of the commitment.","newValue":"Updated description of the commitment."}}},"scheduleChanges":{"type":"array","description":"The changes in the schedules of the commitment in this order.","items":{"$ref":"#/components/schemas/CommitmentScheduleChanges"},"example":[{"scheduleId":"0df89cf12e650006ac13624398764f1b","version":2,"changes":{"amount":{"oldValue":100,"newValue":150}},"periodChanges":[{"periodId":"8ad08ca797ef6ca50197f3cce6267991","version":2,"changes":{"status":{"oldValue":"Active","newValue":"Closed"}}}]},{"scheduleId":"0df89cf12e650006ac13624398764f1b","version":1,"changes":{"startDate":{"oldValue":null,"newValue":"2021-01-01"},"endDate":{"oldValue":null,"newValue":"2021-06-30"},"amount":{"oldValue":null,"newValue":100},"status":{"oldValue":null,"newValue":"Active"}},"periodChanges":[{"periodId":"8ad08ca797ef6ca50197f3cce6267991","version":1,"changes":{"startDate":{"oldValue":null,"newValue":"2021-01-01"},"endDate":{"oldValue":null,"newValue":"2021-06-30"},"status":{"oldValue":null,"newValue":"Active"}}}]}]},"associatedItemChanges":{"type":"array","description":"Per-item field-level changes for the associated items of the commitment in this order.","items":{"$ref":"#/components/schemas/CommitmentAssociatedItemChanges"},"example":[{"itemId":"1873a10929b9f39b944f39e7ac640006","version":1,"changes":{"itemId":{"oldValue":null,"newValue":"1873a10929b9f39b944f39e7ac640006"},"status":{"oldValue":null,"newValue":"ACTIVE"},"itemType":{"oldValue":null,"newValue":"SUBSCRIPTION_CHARGE"},"itemNumber":{"oldValue":null,"newValue":"C-00000238"},"invoiceOwnerId":{"oldValue":null,"newValue":"8a90ff929f35bc19019f39ae5136225f"},"subscriptionNumber":{"oldValue":null,"newValue":"A-S00000162"},"subscriptionVersion":{"oldValue":null,"newValue":1}}}]},"associatedAccountChanges":{"type":"array","description":"Per-account field-level changes for the associated accounts of the commitment in this order.","items":{"$ref":"#/components/schemas/CommitmentAssociatedAccountChanges"},"example":[{"accountId":"8a90bbe7a007a30f01a00c48bcce0888","version":1,"changes":{"status":{"oldValue":null,"newValue":"ACTIVE"},"accountId":{"oldValue":null,"newValue":"8a90bbe7a007a30f01a00c48bcce0888"},"accountType":{"oldValue":null,"newValue":"SUBSCRIPTION_OWNER"},"accountNumber":{"oldValue":null,"newValue":"A00000118"}}}]},"associatedCommitmentChanges":{"type":"array","description":"Child commitments added or removed in this order.","items":{"$ref":"#/components/schemas/CommitmentAssociatedCommitmentChanges"},"example":[{"action":"ADD","commitmentNumbers":["CMT-0002"]},{"action":"REMOVE","commitmentNumbers":["CMT-0003"]}]}}}},"components/schemas/ListCommitmentHistoricalChangesResponse":{"id":"components/schemas/ListCommitmentHistoricalChangesResponse","kind":"json-schema","title":"ListCommitmentHistoricalChangesResponse","data":{"title":"ListCommitmentHistoricalChangesResponse","properties":{"commitmentChanges":{"description":"A list of commitment change objects.","type":"array","items":{"$ref":"#/components/schemas/CommitmentOrderChangeOutput"}},"total":{"type":"integer","description":"Total number of commitments in current page."},"page":{"type":"integer","description":"Current page number."},"pageSize":{"type":"integer","description":"Number of commitments per page."}}}},"components/schemas/GETAdjustmentByIdResponseType":{"id":"components/schemas/GETAdjustmentByIdResponseType","kind":"json-schema","title":"GETAdjustmentByIdResponseType","data":{"allOf":[{"properties":{"adjustmentId":{"description":"The system generated delivery adjustment ID.\n","format":"UUID","type":"string"},"adjustmentNumber":{"description":"The system generated delivery adjustment Number.\n","type":"string"},"amount":{"description":"The amount of the delivery adjustment.\n","type":"number"},"billingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing date is same as the delivery date of the delivery adjustment, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"chargeNumber":{"description":"The charge number in the subscription for which the delivery adjustment is created.\n","type":"string"},"creditMemoNumber":{"description":"The Credit Memo generated for the delivery adjustment.\n","type":"string"},"debitMemoNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Debit Memo generated to write off the Credit Memo for the delivery adjustment."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"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 only available when the delivery adjustment is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the deferred revenue, such as Monthly Recurring Liability."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"deliveryDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The delivery adjustment date, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"deliveryDay":{"description":"The delivery adjustment day of the week.\n","format":"string","type":"string"},"reason":{"description":"The reason for the delivery adjustment.\n","type":"string"},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the revenue recognition rule governing the revenue schedule."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the delivery adjustment will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Billed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"subscriptionNumber":{"description":"The subscription number for which the delivery adjustment is created.\n","type":"string"}},"type":"object"}]}},"components/schemas/GETAdjustmentsBySubscriptionNumberResponseType":{"id":"components/schemas/GETAdjustmentsBySubscriptionNumberResponseType","kind":"json-schema","title":"GETAdjustmentsBySubscriptionNumberResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"adjustments":{"description":"Container for all the delivery adjustments of a subscription.\n","items":{"$ref":"#/components/schemas/GETAdjustmentByIdResponseType"},"type":"array"}},"type":"object"}]}},"components/schemas/POSTCreateBillingAdjustmentRequestType":{"id":"components/schemas/POSTCreateBillingAdjustmentRequestType","kind":"json-schema","title":"POSTCreateBillingAdjustmentRequestType","data":{"example":{"chargeNumbers":["string","string"],"deferredRevenueAccountingCode":"string","endDate":"2023-02-27","exclusion":[{"chargeNumbers":["string","string"],"deliveryDate":"2023-02-26"},{"chargeNumbers":["string","string"],"deliveryDate":"2023-05-27"}],"reason":"string","recognizedRevenueAccountingCode":"string","revenueRecognitionRuleName":"string","startDate":"2023-02-26","subscriptionNumber":"string","type":"DeliveryCredit"},"properties":{"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number for which the delivery adjustment is created."},"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":":"},"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 account number should be of the subscription owner."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one of accountNumber or subscriptionNumber should be provided."},"children":[]}]}]}]}],"type":"string"},"chargeNumbers":{"description":"An optional container to specify charge numbers in the subscription for which the delivery adjustment needs to be created.\n","items":{"type":"string"},"type":"array"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the deferred revenue, such as Monthly Recurring Liability."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the delivery adjustment, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This is inclusive."},"children":[]}]}]}],"format":"date","type":"string"},"exclusion":{"description":"The charge numbers and the corresponding dates for exclusion of delivery adjustment.\n","items":{"properties":{"chargeNumbers":{"description":"The charge numbers to be excluded from delivery adjustment on the specified delivery date.\n","items":{"type":"string"},"type":"array"},"deliveryDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the delivery adjustment has to be excluded, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"},"type":"array"},"reason":{"description":"The reason for the delivery adjustment.\n","type":"string"},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the revenue recognition rule governing the revenue schedule."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the delivery adjustment, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This is inclusive."},"children":[]}]}]}],"format":"date","type":"string"},"subscriptionNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subscription number for which the delivery adjustment is created."},"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":": Only one of accountNumber or subscriptionNumber should be provided."},"children":[]}]}]}],"type":"string"},"type":{"description":"The type of delivery adjustment.\n","enum":["DeliveryCredit"],"type":"string"},"creditMemoCustomFields":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Credit Memo object.  The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"object"},"description":"Container for custom fields of the Credit Memo object. When creating a delivery adjustment, Zuora generates a credit memo automatically. You can use this field to specify the custom fields of the credit memo associated with this adjustment.\n","title":"creditMemoCustomFields","type":"object"}},"required":["startDate","endDate"],"type":"object"}},"components/schemas/POSTAdjustmentResponseType":{"id":"components/schemas/POSTAdjustmentResponseType","kind":"json-schema","title":"POSTAdjustmentResponseType","data":{"allOf":[{"properties":{"adjustmentId":{"description":"The system generated delivery adjustment ID.\n","format":"UUID","type":"string"},"adjustmentNumber":{"description":"The system generated delivery adjustment number.\n","format":"string","type":"string"},"amount":{"description":"The amount of the delivery adjustment.\n","type":"number"},"billingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing date is same as the delivery date of the delivery adjustment, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"chargeNumber":{"description":"The charge number in the subscription for which the delivery adjustment is created.\n","type":"string"},"creditMemoNumber":{"description":"The Credit Memo generated for the delivery adjustment.\n","type":"string","nullable":true},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the deferred revenue, such as Monthly Recurring Liability."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"deliveryDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The delivery adjustment date, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"deliveryDay":{"description":"The delivery adjustment day of the week.\n","type":"string"},"eligible":{"description":"The eligible flag is set as true for a successfully created delivery adjustment.\n","type":"boolean"},"reason":{"description":"The reason for the delivery adjustment.\n","type":"string"},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the revenue recognition rule governing the revenue schedule."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the delivery adjustment will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Billed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"subscriptionNumber":{"description":"The subscription number for which the delivery adjustment is created.\n","type":"string"}},"type":"object"}]}},"components/schemas/POSTIneligibleAdjustmentResponseType":{"id":"components/schemas/POSTIneligibleAdjustmentResponseType","kind":"json-schema","title":"POSTIneligibleAdjustmentResponseType","data":{"allOf":[{"properties":{"adjustmentId":{"description":"The system generated delivery adjustment ID.\n","format":"UUID","type":"string","nullable":true},"adjustmentNumber":{"description":"The system generated delivery adjustment number.\n","format":"string","type":"string","nullable":true},"amount":{"description":"The amount of the delivery adjustment.\n","type":"number","nullable":true},"billingDate":{"description":"The billing date of the delivery adjustment.\n","format":"date","type":"string","nullable":true},"chargeNumber":{"description":"The charge number in the subscription for which the delivery adjustment is created.\n","type":"string"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the deferred revenue, such as Monthly Recurring Liability."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"deliveryDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The delivery adjustment date, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"deliveryDay":{"description":"The delivery adjustment day of the week.\n","format":"string","type":"string"},"eligible":{"description":"The eligible flag is set as false for an unsuccessful delivery adjustment.\n","type":"boolean"},"errorMessage":{"description":"The reason due to which a delivery adjustment is not eligible on the given date. \n","type":"string"},"reason":{"description":"The reason for the delivery adjustment.\n","type":"string"},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the revenue recognition rule governing the revenue schedule."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"status":{"description":"The status of the delivery adjustment.\n","type":"string","nullable":true},"subscriptionNumber":{"description":"The subscription number for which the delivery adjustment is created.\n","type":"string"}},"type":"object"}]}},"components/schemas/GETAdjustmentsResponseType":{"id":"components/schemas/GETAdjustmentsResponseType","kind":"json-schema","title":"GETAdjustmentsResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"adjustments":{"description":"Container for delivery adjustments of a subscription.\n","items":{"$ref":"#/components/schemas/POSTAdjustmentResponseType"},"type":"array"},"ineligibleAdjustments":{"description":"Container for ineligible delivery adjustments of a subscription.\n","items":{"$ref":"#/components/schemas/POSTIneligibleAdjustmentResponseType"},"type":"array"},"totalAmount":{"description":"The total amount of all the delivery adjustments.\n","type":"number"},"totalNumberOfDeliveries":{"description":"The total number of all delivery adjustments.\n","type":"number"}},"type":"object"}]}},"components/schemas/POSTPreviewBillingAdjustmentRequestType":{"id":"components/schemas/POSTPreviewBillingAdjustmentRequestType","kind":"json-schema","title":"POSTPreviewBillingAdjustmentRequestType","data":{"example":{"chargeNumbers":["string","string"],"deferredRevenueAccountingCode":"string","endDate":"2023-02-27","exclusion":[{"chargeNumbers":["string","string"],"deliveryDate":"2023-02-26"},{"chargeNumbers":["string","string"],"deliveryDate":"2023-05-27"}],"reason":"string","recognizedRevenueAccountingCode":"string","revenueRecognitionRuleName":"string","startDate":"2023-02-26","subscriptionNumber":"string","type":"DeliveryCredit"},"properties":{"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number for which the delivery adjustment is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":":"},"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 account number should be of the subscription owner."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one of accountNumber or subscriptionNumber should be provided."},"children":[]}]}]}]}],"type":"string"},"chargeNumbers":{"description":"An optional container to specify charge numbers in the subscription for which the delivery adjustment needs to be created.\n","items":{"type":"string"},"type":"array"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the deferred revenue, such as Monthly Recurring Liability."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the delivery adjustment, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This is inclusive."},"children":[]}]}]}],"format":"date","type":"string"},"reason":{"description":"The reason for the delivery adjustment.\n","type":"string"},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the revenue recognition rule governing the revenue schedule."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the delivery adjustment, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This is inclusive."},"children":[]}]}]}],"format":"date","type":"string"},"subscriptionNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subscription number for which the delivery adjustment is created."},"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":": Only one of accountNumber or subscriptionNumber should be provided."},"children":[]}]}]}],"type":"string"},"type":{"description":"The type of delivery adjustment.\n","enum":["DeliveryCredit"],"type":"string"}},"required":["startDate","endDate"],"type":"object"}},"components/schemas/CancelBillingAdjustmentRequest":{"id":"components/schemas/CancelBillingAdjustmentRequest","kind":"json-schema","title":"CancelBillingAdjustmentRequest","data":{"example":{"debitMemoCustomFields":{"trackingNumber__c":"001"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CancelBillingAdjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"debitMemoCustomFields":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Debit Memo object.  The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"object"},"description":"Container for custom fields of the Debit Memo object. When cancelling a delivery adjustment, Zuora generates a debit memo automatically. You can use this field to specify the custom fields of the debit memo associated with the cancellation of adjustment.\n","title":"debitMemoCustomFields","type":"object"}}}},"components/schemas/GETCancelAdjustmentResponseType":{"id":"components/schemas/GETCancelAdjustmentResponseType","kind":"json-schema","title":"GETCancelAdjustmentResponseType","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"debitMemoNumber":{"description":"The Debit Memo generated to write off the Credit Memo for the delivery adjustment.       \n","type":"string"}},"type":"object"}]}},"components/schemas/GETBillingDocumentsResponseType":{"id":"components/schemas/GETBillingDocumentsResponseType","kind":"json-schema","title":"documents","data":{"properties":{"accountId":{"description":"The ID of the customer account associated with the billing document.","type":"string"},"amount":{"description":"The total amount of the billing document.\n","format":"double","type":"number"},"balance":{"description":"The balance of the billing document.\n","format":"double","type":"number"},"documentDate":{"description":"The date of the billing document. The date can be the invoice date for invoices, credit memo date for credit memos, or debit memo date for debit memos.\n","format":"date","type":"string"},"documentNumber":{"description":"The number of the billing document.\n","type":"string"},"documentType":{"description":"The type of the billing document.\n","enum":["Invoice","CreditMemo","DebitMemo"],"type":"string"},"id":{"description":"The ID of the billing document.\n","type":"string"},"status":{"description":"The current status of the billing document.\n","enum":["Draft","Posted","Canceled","Error"],"type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the billing document."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true}},"title":"documents","type":"object"}},"components/schemas/BillingDocumentQueryResponseElementType":{"id":"components/schemas/BillingDocumentQueryResponseElementType","kind":"json-schema","title":"BillingDocumentQueryResponseElementType","data":{"properties":{"documents":{"description":"Container for billing documents.\n","items":{"$ref":"#/components/schemas/GETBillingDocumentsResponseType"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/POSTBillingDocumentFilesDeletionJobRequest":{"id":"components/schemas/POSTBillingDocumentFilesDeletionJobRequest","kind":"json-schema","title":"POSTBillingDocumentFilesDeletionJobRequest","data":{"example":{"accountIds":["4028905558b483220158b48983dd0015","6028905558b483220158b68983dd0016"]},"properties":{"accountIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the IDs of the accounts that you want to create the billing document files deletion job for."},"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":": When creating jobs to delete billing document PDF files, you must specify either set of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountKeys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"accountKeys":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the IDs and/or numbers of the accounts that you want to create the billing document files deletion job for."},"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":": When creating jobs to delete billing document PDF files, you must specify either set of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountKeys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"}},"type":"object"}},"components/schemas/POSTBillingDocumentFilesDeletionJobResponse":{"id":"components/schemas/POSTBillingDocumentFilesDeletionJobResponse","kind":"json-schema","title":"POSTBillingDocumentFilesDeletionJobResponse","data":{"properties":{"id":{"description":"The unique ID of the billing document file deletion job.\n","type":"string"},"status":{"description":"The status of the billing document file deletion job.\n","enum":["Pending"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETBillingDocumentFilesDeletionJobResponse":{"id":"components/schemas/GETBillingDocumentFilesDeletionJobResponse","kind":"json-schema","title":"GETBillingDocumentFilesDeletionJobResponse","data":{"properties":{"id":{"description":"The unique ID of the billing document file deletion job.\n","type":"string"},"status":{"description":"The status of the billing document file deletion job.\n","enum":["Pending","Processing","Completed","Error"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PostGenerateBillingDocumentType":{"id":"components/schemas/PostGenerateBillingDocumentType","kind":"json-schema","title":"PostGenerateBillingDocumentType","data":{"example":{"effectiveDate":"2026-02-04","targetDate":"2026-02-04","autoPost":false,"subscriptionIds":["8ad09be490a1ec6a0190a56eb69d4cd3"],"commitmentKeys":["550e8400e29b41d4a716446655440000","6ba7b8109dad11d180b400c04fd430c8"]},"properties":{"autoPost":{"default":false,"description":"Whether to automatically post the billing documents after the draft billing documents are generated. \n\nIf an error occurs during posting billing documents, the draft billing documents are not generated too.\n","enum":[true,false],"type":"boolean"},"autoRenew":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically renew the subscriptions with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto Renew"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":[true,false],"type":"boolean"},"chargeTypeToExclude":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The types of the charges to be excluded from the generation of billing documents. The field values are case insensitive. Supported values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"commitmentKeys":{"description":"The IDs of the commitments to include in billing document generation.\n","items":{"type":"string"},"type":"array"},"creditMemoReasonCode":{"description":"A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.","type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which to generate the billing documents, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"includeSubscriptions":{"default":true,"description":"Indicates whether to bill subscriptions in the bill run.\n","type":"boolean"},"includeOrderLineItems":{"default":true,"description":"Indicates whether to bill order line items in the bill run.\n","type":"boolean"},"subscriptionIds":{"description":"The IDs of the subscriptions that you want to create the billing documents for. Each value must be the ID of the latest version of an active subscription.\n","items":{"type":"string"},"type":"array"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date used to determine which charges are to be billed, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object","required":["effectiveDate","targetDate"]}},"components/schemas/CreditMemoResponseType":{"id":"components/schemas/CreditMemoResponseType","kind":"json-schema","title":"creditMemos","data":{"properties":{"id":{"description":"The ID of the generated credit memo.\n","type":"string"}},"title":"creditMemos","type":"object"}},"components/schemas/InvoiceResponseType":{"id":"components/schemas/InvoiceResponseType","kind":"json-schema","title":"invoices","data":{"properties":{"id":{"description":"The ID of the generated invoice.\n","type":"string"}},"title":"invoices","type":"object"}},"components/schemas/GenerateBillingDocumentResponseType":{"id":"components/schemas/GenerateBillingDocumentResponseType","kind":"json-schema","title":"GenerateBillingDocumentResponseType","data":{"properties":{"creditMemos":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for generated credit memos."},"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 container is only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CreditMemoResponseType"},"type":"array"},"invoices":{"description":"Container for generated invoics.\n","items":{"$ref":"#/components/schemas/InvoiceResponseType"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/DiscountItemObjectNSFields":{"id":"components/schemas/DiscountItemObjectNSFields","kind":"json-schema","title":"discountItemFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for discount Item fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the invoice item's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the invoice item was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"discountItemFieldsNS","type":"object"}},"components/schemas/DiscountItemObjectCustomFields":{"id":"components/schemas/DiscountItemObjectCustomFields","kind":"json-schema","title":"discountItemFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Discount Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Discount Item object.\n","title":"discountItemFieldsCustom","type":"object"}},"components/schemas/PutDiscountItemType":{"id":"components/schemas/PutDiscountItemType","kind":"json-schema","title":"PutDiscountItemType","data":{"allOf":[{"properties":{"accountingCode":{"description":"The accounting code associated with the discount item.\n","type":"string"},"accountsReceivableAccountingCode":{"description":"The accounting code for accounts receivable.\n","maxLength":100,"type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment liability."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the discount item."},"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":"Should be a negative number. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-10"},"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":"Always a fixed amount no matter whether the discount charge associated with the discount item uses the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-fixed-amount-model-and-percentage-model"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fixed-amount model or percentage model"},"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":"For tax-exclusive discount items, this amount indicates the discount item amount excluding tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For tax-inclusive discount items, this amount indicates the discount item amount including tax."},"children":[]}]}]}]}],"format":"number","type":"string"},"bookingReference":{"description":"The booking reference of the discount item.\n","type":"string"},"chargeDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the discount item is charged, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"chargeName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the charge associated with the discount item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified in the request."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract asset."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the deferred revenue, such as Monthly Recurring Liability."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"description":{"description":"The description of the discount item.\n","type":"string"},"id":{"description":"The unique ID of the discount item.\n","type":"string"},"itemType":{"description":"The type of the discount item.\n","type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the discount item.\n","type":"string"},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"The revenue recognition code.\n","type":"string"},"revRecTriggerCondition":{"description":"The date when revenue recognition is triggered.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate"],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the revenue recognition rule governing the revenue schedule."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"sku":{"description":"The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product.\n","type":"string"},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"unitPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The per-unit price of the discount item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the discount charge associated with the discount item uses the percentage model, the unit price will display as a percentage amount in PDF. For example: if unit price is 5.00, it will display as 5.00% in PDF."},"children":[]}]}]}],"format":"number","type":"string"}},"required":["amount"],"title":"invoiceItems","type":"object"},{"$ref":"#/components/schemas/DiscountItemObjectNSFields"},{"$ref":"#/components/schemas/DiscountItemObjectCustomFields"}]}},"components/schemas/InvoiceItemObjectNSFields":{"id":"components/schemas/InvoiceItemObjectNSFields","kind":"json-schema","title":"invoiceItemFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Invoice Item fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the invoice item's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the invoice item was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"invoiceItemFieldsNS","type":"object"}},"components/schemas/InvoiceItemObjectCustomFields":{"id":"components/schemas/InvoiceItemObjectCustomFields","kind":"json-schema","title":"invoiceItemFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Invoice Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Invoice Item object.\n","title":"invoiceItemFieldsCustom","type":"object"}},"components/schemas/PutInvoiceItemType":{"id":"components/schemas/PutInvoiceItemType","kind":"json-schema","title":"PutInvoiceItemType","data":{"allOf":[{"properties":{"accountingCode":{"description":"The accounting code associated with the invoice item.\n","type":"string"},"accountsReceivableAccountingCode":{"description":"The accounting code for accounts receivable.\n","maxLength":100,"type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment liability."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the invoice item."},"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":"For tax-inclusive invoice items, the amount indicates the invoice item amount including tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For tax-exclusive invoice items, the amount indicates the invoice item amount excluding tax."},"children":[]}]}]}]}],"type":"number"},"bookingReference":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The booking reference of the invoice item."},"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 only available if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null."},"children":[]}]}]}],"type":"string"},"chargeDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the invoice item is charged, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"chargeName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the charge associated with the invoice item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified in the request."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract asset."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the deferred revenue, such as Monthly Recurring Liability."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"delete":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to delete the existing invoice item."},"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":": Set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and specify an item "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to delete an item."},"children":[]}]}]}],"type":"boolean"},"description":{"description":"The description of the invoice item.\n","type":"string"},"discountItems":{"description":"Container for discount items. The maximum number of discount items is 10.\n","items":{"$ref":"#/components/schemas/PutDiscountItemType"},"type":"array"},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the invoice item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the invoice item."},"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":"Specify this field when updating or deleting an existing memo item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not specify this field when creating a memo item."},"children":[]}]}]}]}],"type":"string"},"itemType":{"description":"The type of the invoice item.\n","type":"string"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the product rate plan charge that the invoice item is created from."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify the ID of a product rate plan charge in this field, no matter whether the following fields are specified with values, the following fields use the values from the corresponding product rate plan charge instead of the specified 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":"chargeName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uom"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountingCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferredRevenueAccountingCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recognizedRevenueAccountingCode"},"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":": Do not specify the invoice item "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when specifying this field."},"children":[]}]}]}],"type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated the invoice item.\n","type":"string"},"quantity":{"description":"The number of units for the invoice item.\n","format":"number","type":"string"},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"The revenue recognition code.\n","type":"string"},"revRecTriggerCondition":{"description":"The date when revenue recognition is triggered.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate"],"type":"string"},"revRecStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date for revenue recognition."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"example":"2026-01-15","format":"date","type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the revenue recognition rule governing the revenue schedule."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"serviceEndDate":{"description":"The service end date of the invoice item.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the invoice item.\n","format":"date","type":"string"},"sku":{"description":"The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product.\n","type":"string"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code identifies which tax rules and tax rates to apply to the invoice item."},"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":"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":"This field is only available if you have Taxation enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the values of both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when updating a standalone invoice, the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and its nested fields specified in the creation request will be removed."},"children":[]}]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax."},"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":"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":"This field is only available if you have Taxation enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the values of both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when updating a standalone invoice, the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and its nested fields specified in the creation request will be removed."},"children":[]}]}]}]}],"enum":["TaxInclusive","TaxExclusive"],"type":"string"},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"unitPrice":{"description":"The per-unit price of the invoice item.\n","format":"number","type":"string"},"uom":{"description":"The unit of measure.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceItemObjectNSFields"},{"$ref":"#/components/schemas/InvoiceItemObjectCustomFields"}]}},"components/schemas/InvoiceObjectNSFields":{"id":"components/schemas/InvoiceObjectNSFields","kind":"json-schema","title":"invoiceFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Invoice fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the invoice's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the invoice was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"invoiceFieldsNS","type":"object"}},"components/schemas/InvoiceObjectCustomFields":{"id":"components/schemas/InvoiceObjectCustomFields","kind":"json-schema","title":"invoiceFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Invoice object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Invoice object.\n","title":"invoiceFieldsCustom","type":"object"}},"components/schemas/BatchInvoiceType":{"id":"components/schemas/BatchInvoiceType","kind":"json-schema","title":"invoices","data":{"allOf":[{"properties":{"autoPay":{"description":"Whether invoices are automatically picked up for processing in the corresponding payment run.\n\nBy default, invoices are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"comments":{"description":"Additional information related to the invoice that a Zuora user added to the invoice.\n","maxLength":255,"type":"string"},"dueDate":{"description":"The date by which the payment for this invoice is due.\n","format":"date","type":"string"},"id":{"description":"The ID of the invoice to be updated.\n","type":"string"},"invoiceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new invoice date of the invoice. The new invoice date cannot fall in a closed accounting period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in one request. Otherwise, an error occurs."},"children":[]}]}]}],"format":"date","type":"string"},"invoiceItems":{"description":"Container for invoice items. The maximum number of items is 1,000.\n","items":{"$ref":"#/components/schemas/PutInvoiceItemType"},"type":"array"},"transferredToAccounting":{"description":"Whether the invoice was transferred to an external accounting system.\n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"templateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the invoice."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceObjectNSFields"},{"$ref":"#/components/schemas/InvoiceObjectCustomFields"}],"title":"invoices"}},"components/schemas/PutBatchInvoiceType":{"id":"components/schemas/PutBatchInvoiceType","kind":"json-schema","title":"PutBatchInvoiceType","data":{"example":{"invoices":[{"id":"2c93808457d787030157e031d86c4c57","invoiceDate":"2017-12-16"},{"id":"2c92c8955bd63cc1015bd7c151af02ab","invoiceDate":"2017-12-16"}]},"properties":{"invoices":{"description":"Container for invoice update details.\n","items":{"$ref":"#/components/schemas/BatchInvoiceType"},"type":"array"}},"type":"object"}},"components/schemas/ContactCustomFields":{"id":"components/schemas/ContactCustomFields","kind":"json-schema","title":"ContactCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Contact object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object"}},"components/schemas/PostCreateInvoiceContactType":{"id":"components/schemas/PostCreateInvoiceContactType","kind":"json-schema","title":"Contact","data":{"allOf":[{"properties":{"address1":{"description":"First address line, 255 characters or less.\n","maxLength":255,"type":"string"},"address2":{"description":"Second address line, 255 characters or less.\n","type":"string"},"city":{"description":"City, 40 characters or less.\n","maxLength":40,"type":"string"},"country":{"description":"Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the ship-to or sold-to contact to calculate tax. A bill-to contact may be used if no ship-to or sold-to contact is provided.\n","type":"string"},"county":{"description":"County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.\n","maxLength":32,"type":"string"},"fax":{"description":"Fax phone number, 40 characters or less.\n","maxLength":40,"type":"string"},"firstName":{"description":"First name, 100 characters or less.\n","maxLength":100,"type":"string"},"homePhone":{"description":"Home phone number, 40 characters or less.\n","maxLength":40,"type":"string"},"lastName":{"description":"Last name, 100 characters or less.\n","maxLength":100,"type":"string"},"mobilePhone":{"description":"Mobile phone number, 40 characters or less.\n","maxLength":40,"type":"string"},"nickname":{"description":"Nickname for this contact\n","type":"string"},"otherPhone":{"description":"Other phone number, 40 characters or less.\n","maxLength":40,"type":"string"},"otherPhoneType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"personalEmail":{"description":"Personal email address.\n","maxLength":80,"type":"string","format":"email"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State; must be a valid subregion (state or province) name or code."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"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 using Zuora Tax, be aware that Zuora Tax requires a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state (in the US) or province (in Canada) in this field for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ship-to or sold-to contact to calculate tax, and that a bill-to contact may be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used if no ship-to or sold-to contact is provided."},"children":[]}]}]}],"type":"string"},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n","type":"string"},"workEmail":{"description":"Work email address, 80 characters or less.\n","maxLength":80,"type":"string"},"workPhone":{"description":"Work phone number, 40 characters or less.\n","maxLength":40,"type":"string"},"zipCode":{"description":"Zip code, 20 characters or less.\n","maxLength":20,"type":"string"}},"required":["firstName","lastName"],"type":"object"},{"$ref":"#/components/schemas/ContactCustomFields"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for bill-to, sold-to, or ship-to contact information. A new Contact will be created under the invoice owner account."},"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":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body."},"children":[]}]}]}],"title":"Contact"}},"components/schemas/InvoiceWithCustomRatesType":{"id":"components/schemas/InvoiceWithCustomRatesType","kind":"json-schema","title":"customRates","data":{"allOf":[{"properties":{"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency code for either Reporting or Home currency."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]}],"type":"string"},"customFxRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Custom FX conversion rate between Home/Reporting and Transactional currency items."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]}],"format":"decimal","type":"number"},"rateDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which a particular currency rate is fixed or obtained on."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["currency","customFxRate"],"type":"object"}],"title":"customRates"}},"components/schemas/TaxationItemObjectCustomFields":{"id":"components/schemas/TaxationItemObjectCustomFields","kind":"json-schema","title":"taxationItemFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Taxation Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Taxation Item object.\n","title":"taxationItemFieldsCustom","type":"object"}},"components/schemas/PostTaxationItemType":{"id":"components/schemas/PostTaxationItemType","kind":"json-schema","title":"PostTaxationItemType","data":{"allOf":[{"properties":{"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"number","type":"string"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"name":{"description":"The name of taxation.\n","type":"string"},"taxAmount":{"description":"The amount of the taxation item in the invoice item.\n","format":"number","type":"string"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific invoice item.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the tax is applied to the invoice item, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"taxMode":{"description":"The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n","enum":["TaxInclusive","TaxExclusive"],"type":"string"},"taxRate":{"description":"The tax rate applied to the invoice item.\n","format":"number","type":"string"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate applied to the invoice item.\n","enum":["Percentage","FlatFee"],"type":"string"}},"required":["name","taxAmount","taxDate","taxMode","taxRate","taxRateType"],"title":"taxItems","type":"object"},{"$ref":"#/components/schemas/TaxationItemObjectCustomFields"}]}},"components/schemas/PostDiscountItemType":{"id":"components/schemas/PostDiscountItemType","kind":"json-schema","title":"PostDiscountItemType","data":{"allOf":[{"properties":{"accountingCode":{"description":"The accounting code associated with the discount item.\n","type":"string"},"accountsReceivableAccountingCode":{"description":"The accounting code for accounts receivable.\n","type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment liability."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the discount item."},"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":"Should be a negative number. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-10"},"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":"Always a fixed amount no matter whether the discount charge associated with the discount item uses the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-fixed-amount-model-and-percentage-model"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fixed-amount model or percentage model"},"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":"For tax-exclusive discount items, this amount indicates the discount item amount excluding tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For tax-inclusive discount items, this amount indicates the discount item amount including tax."},"children":[]}]}]}]}],"type":"number"},"bookingReference":{"description":"The booking reference of the discount item.\n","type":"string"},"chargeDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the discount item is charged, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"chargeName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the charge associated with the discount item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified in the request body."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract asset."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the deferred revenue, such as Monthly Recurring Liability."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"description":{"description":"The description of the discount item.\n","type":"string"},"itemType":{"description":"The type of the discount item.\n","type":"string"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the product rate plan charge that the discount item is created from."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify a value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body:"},"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":"chargeName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify a value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, Zuora directly copies the values of the following fields from the corresponding discount charge that "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-use-discount-specific-accounting-codes-rules-and-segments-to-manage-revenue"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uses discount specific accounting codes, rule and segment to manage revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", regardless of the values specified in the request body:"},"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":"accountingCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferredRevenueAccountingCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recognizedRevenueAccountingCode"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify a value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, Zuora directly copies the values of the following fields from the corresponding invoice item charge if the discount charge DOES NOT "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-use-discount-specific-accounting-codes-rules-and-segments-to-manage-revenue"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"use discount specific accounting codes, rule and segment to manage revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", regardless of the values specified in the request body:"},"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":"accountingCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferredRevenueAccountingCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recognizedRevenueAccountingCode"},"children":[]}]}]}]}],"type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the discount item.\n","type":"string"},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"The revenue recognition code.\n","type":"string"},"revRecTriggerCondition":{"description":"The date when revenue recognition is triggered.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate"],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the revenue recognition rule governing the revenue schedule."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"sku":{"description":"The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product.\n","type":"string"},"taxItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for taxation items. The maximum number of taxation items is 5."},"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 only available only if you have Taxation enabled."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PostTaxationItemType"},"type":"array"},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"unitPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The per-unit price of the discount item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the discount charge associated with the discount item uses the percentage model, the unit price will display as a percentage amount in PDF. For example: if unit price is 5.00, it will display as 5.00% in PDF."},"children":[]}]}]}],"type":"number"}},"required":["amount"],"title":"invoiceItems","type":"object"},{"$ref":"#/components/schemas/DiscountItemObjectNSFields"},{"$ref":"#/components/schemas/DiscountItemObjectCustomFields"}]}},"components/schemas/PostInvoiceItemType":{"id":"components/schemas/PostInvoiceItemType","kind":"json-schema","title":"PostInvoiceItemType","data":{"allOf":[{"properties":{"accountingCode":{"description":"The accounting code associated with the invoice item.\n","type":"string"},"accountsReceivableAccountingCode":{"description":"The accounting code for accounts receivable.\n","maxLength":100,"type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment liability."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the invoice item."},"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":"For tax-inclusive invoice items, the amount indicates the invoice item amount including tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For tax-exclusive invoice items, the amount indicates the invoice item amount excluding tax."},"children":[]}]}]}]}],"type":"number"},"bookingReference":{"description":"The booking reference of the invoice item.\n","type":"string"},"chargeDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the invoice item is charged, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"chargeName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the charge associated with the invoice item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified in the request."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract asset."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the deferred revenue, such as Monthly Recurring Liability."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"description":{"description":"The description of the invoice item.\n","type":"string"},"discountItems":{"description":"Container for discount items. The maximum number of discount items is 10.\n","items":{"$ref":"#/components/schemas/PostDiscountItemType"},"type":"array"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the invoice item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"itemType":{"description":"The type of the invoice item.\n","type":"string"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the product rate plan charge that the invoice item is created from."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Standalone Invoice With Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to create an invoice item from an existing charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify a value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body:"},"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":"chargeName"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uom"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountingCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferredRevenueAccountingCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recognizedRevenueAccountingCode"},"children":[]}]}]}]}],"type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the invoice item.\n","type":"string"},"quantity":{"default":1,"description":"The number of units for the invoice item.\n","type":"number"},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"The revenue recognition code.\n","type":"string"},"revRecTriggerCondition":{"description":"The date when revenue recognition is triggered.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate"],"type":"string"},"revRecStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date for revenue recognition."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"example":"2026-01-15","format":"date","type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the revenue recognition rule governing the revenue schedule."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"serviceEndDate":{"description":"The service end date of the invoice item.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the invoice item.\n","format":"date","type":"string"},"sku":{"description":"The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product.\n","type":"string"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code identifies which tax rules and tax rates to apply to the invoice item."},"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 only available only if you have Taxation enabled."},"children":[]}]}]}],"type":"string"},"taxItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for taxation items. The maximum number of taxation items is 5."},"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 only available only if you have Taxation enabled."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PostTaxationItemType"},"type":"array"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax."},"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 only available only if you have Taxation enabled."},"children":[]}]}]}],"enum":["TaxInclusive","TaxExclusive"],"type":"string"},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"unitPrice":{"description":"The per-unit price of the invoice item. To pass Level 3 data to the gateway, this field is required and must be greater than zero.\n","type":"number"},"uom":{"description":"The unit of measure.\n","type":"string"}},"required":["amount","serviceStartDate"],"title":"invoiceItems","type":"object"},{"$ref":"#/components/schemas/InvoiceItemObjectNSFields"},{"$ref":"#/components/schemas/InvoiceItemObjectCustomFields"}]}},"components/schemas/PostInvoiceType":{"id":"components/schemas/PostInvoiceType","kind":"json-schema","title":"PostInvoiceType","data":{"allOf":[{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the account associated with the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a customer account. If both of them are specified, they must refer to the same customer account."},"children":[]}]}]}],"type":"string"},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Number of the account associated with the invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a customer account. If both of them are specified, they must refer to the same customer account."},"children":[]}]}]}],"type":"string"},"autoPay":{"default":false,"description":"Whether invoices are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"billToContact":{"$ref":"#/components/schemas/PostCreateInvoiceContactType"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the invoice. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContact"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body."},"children":[]}]}]}],"type":"string"},"comments":{"description":"Comments about the invoice.\n","type":"string"},"communicationProfileId":{"description":"The ID of the communication profile associated with the invoice.\n","type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code of a currency as defined in Billing Settings through the Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not specify a currency during standalone invoice creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"customRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both)."},"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":":"},"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":"This field is available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"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":"You cannot set the custom rates, if both the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically include additional Currency Conversion information in data source exports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fx data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice, InvoiceItem, and TaxationItem will utilize the provided custom Fx rate to convert amounts from the transactional currency to the home currency."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/InvoiceWithCustomRatesType"},"maxItems":2,"type":"array"},"dueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for this invoice is due, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"invoiceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that appears on the invoice being created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The value cannot fall in a closed accounting period."},"children":[]}]}]}],"format":"date","type":"string"},"invoiceItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for invoice items. The maximum number of invoice items is 1,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must have corresponding billing permissions to create invoice items from existing product rate plan charges or new charges. For more information about billing permissions, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-billing-roles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Roles"},"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":"To create an invoice item from an existing charge, you must have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Standalone Invoice With Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and specify the charge ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"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":"text","inline":true,"attributes":{"content":"To create an invoice item from a new charge, you must have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Standalone Invoice Without Product Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission without specifying the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productRatePlanChargeId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For the \"Create a standalone invoice\" and \"Create standalone invoices\" operations, note 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":"If tax has been calculated by an external tax engine, you need to create a standalone invoice with both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponds to the tax information processed by this external tax engine. In this case, you should not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Instead, you need to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested fields of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You need to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxExclusive"},"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 tax has not been calculated by an external tax engine, you can create a standalone invoice only with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and decide whether Zuora includes the tax in the quoted charge price and invoice item by specifying the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nested field of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field as either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxExclusive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxInclusive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Meanwhile, you need to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, indicating the charge price and invoice item are taxable."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/PostInvoiceItemType"},"type":"array"},"invoiceNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customized invoice number with the following format requirements:"},"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":"Max length: 32 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acceptable characters: a-z,A-Z,0-9,-,_,"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purely numerical prefixes or prefixes ending with a number are supported for standalone invoices. For example, you can use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202310000300"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2003"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV202310000300"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2023-09-100009785"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as invoice numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be unique in the system, otherwise it may cause issues with bill runs and subscribe/amend. Check out "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-number-customization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"things to note and troubleshooting steps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID or name of the payment term associated with the invoice. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body."},"children":[]}]}]}],"type":"string"},"sequenceSet":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID or name of the sequence set associated with the invoice."},"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":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body."},"children":[]}]}]}],"type":"string"},"shipToContact":{"$ref":"#/components/schemas/PostCreateInvoiceContactType"},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the invoice. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body."},"children":[]}]}]}],"type":"string"},"shipToSameAsBillTo":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the ship-to contact and bill-to contact are the same entity. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The created invoice has the same bill-to contact and ship-to contact entity only when all the following conditions are met in the request body:"},"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":"This field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"A bill-to contact or bill-to contact ID is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Neither ship-to contact nor ship-to contact ID is specified."},"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":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body."},"children":[]}]}]}],"type":"boolean"},"soldToContact":{"$ref":"#/components/schemas/PostCreateInvoiceContactType"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the invoice. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContact"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body."},"children":[]}]}]}],"type":"string"},"soldToSameAsBillTo":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the sold-to contact and bill-to contact are the same entity. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The created invoice has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:"},"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":"This field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"A bill-to contact or bill-to contact ID is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Neither sold-to contact nor sold-to contact ID is specified."},"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":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body."},"children":[]}]}]}],"type":"boolean"},"status":{"default":"Draft","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of invoice. By default, the invoice status is Draft."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating an invoice, if you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Posted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the invoice is created and posted directly."},"children":[]}]}]}],"enum":["Draft","Posted"],"type":"string"},"templateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the invoice."},"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":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body."},"children":[]}]}]}],"type":"string"},"transferredToAccounting":{"enum":["Processing","Error","Ignore","Yes","No"],"type":"string","nullable":true}},"required":["invoiceDate"],"title":"invoices","type":"object"},{"$ref":"#/components/schemas/InvoiceObjectNSFields"},{"$ref":"#/components/schemas/InvoiceObjectCustomFields"}],"example":{"accountId":"8ad09be48db5aba7018db604776d4854","invoiceDate":"2024-07-30","invoiceItems":[{"amount":100,"serviceStartDate":"2024-07-11","productRatePlanChargeId":"8ad097b4909708e001909b41bb085d38"}]}}},"components/schemas/PostInvoiceResponse":{"id":"components/schemas/PostInvoiceResponse","kind":"json-schema","title":"PostInvoiceResponse","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account associated with the invoice.\n","type":"string"},"adjustmentAmount":{"description":"The amount of the invoice adjustments associated with the invoice.\n","type":"number"},"amount":{"description":"The total amount of the invoice.\n","type":"number"},"amountWithoutTax":{"description":"The invoice amount excluding tax.\n","type":"number"},"autoPay":{"description":"Whether invoices are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"balance":{"description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n","type":"number"},"billRunId":{"description":"The id of bill run if the invoice is generated by a bill run.\n","type":"string","nullable":true},"billToContactId":{"description":"The ID of the bill-to contact associated with the invoice.\n","type":"string","nullable":true},"billToContactSnapshotId":{"description":"The ID of the bill-to contact snapshot associated with the invoice.\n","type":"string","nullable":true},"comments":{"description":"Comments about the invoice.\n","type":"string","nullable":true},"createdById":{"description":"The user ID of the person who created the invoice. If a bill run generated the invoice, then the value is the user ID of person who created the bill run.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the invoice was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditBalanceAdjustmentAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency amount of the adjustment applied to the customer's credit balance."},"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 only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled."},"children":[]}]}]}],"type":"number"},"creditMemoAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency amount of all credit memos applied to this invoice."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the invoice."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"discount":{"description":"the invoice discount amount.\n","type":"number"},"dueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for this invoice is due, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"einvoiceErrorCode":{"description":"The error code when status is \"Failed\". This code can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n","type":"string"},"einvoiceErrorMessage":{"description":"The error message when status is \"Failed\". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n","type":"string"},"einvoiceFileId":{"description":"The ID of the e-invoice file.\n","type":"string"},"einvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the e-invoice file generation for the invoice."},"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 e-invoicing file generation succeeds, this field is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both the error code and message are empty, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eInvoiceField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fieldstores the ID of the generated e-inoice file."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically.  You can view these updates in System Health telemetry."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a failure occurs during e-invoice file generation, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If e-invoice file generation conditionally succeeds, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConditionalSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the e-invoice file has been approved by the tax authority, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The next status will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"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 e-invoice file has been rejected by the government, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot resend this e-invoice; you must create a new invoice instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]}],"enum":["Processing","RetrieveTimeOut","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string"},"id":{"description":"The unique ID of the invoice.\n","type":"string"},"includesOneTime":{"description":"Specifies whether the invoice includes one-time charges.\n","type":"boolean"},"includesRecurring":{"description":"Specifies whether the invoice includes recurring charges.\n","type":"boolean"},"includesUsage":{"description":"Specifies whether the invoice includes usage charges.\n","type":"boolean"},"invoiceDate":{"description":"The date that appears on the invoice being created.\n","format":"date","type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"invoiceNumber":{"description":"The unique identification number of the invoice.\n","type":"string"},"lastEmailSentDate":{"description":"The date when the invoice was last emailed.\n","type":"string","nullable":true},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentAmount":{"description":"The amount of payments applied to the invoice.\n","type":"number"},"paymentTerm":{"description":"The name of payment term associated with the invoice.\n","type":"string","nullable":true},"postedBy":{"description":"The user ID of the person who moved the invoice to Posted status.\n","type":"string","nullable":true},"postedDate":{"description":"The date when the invoice was posted.\n","format":"date","type":"string","nullable":true},"refundAmount":{"description":"Specifies the amount of a refund that was applied against an earlier payment on the invoice.\n","type":"number"},"sequenceSetId":{"description":"The ID of the sequence set associated with the invoice.\n","type":"string","nullable":true},"communicationProfileId":{"description":"The ID of the communication profile associated with the invoice.\n","type":"string","nullable":true},"shipToContactId":{"description":"The ID of the ship-to contact associated with the invoice.\n","type":"string","nullable":true},"shipToContactSnapshotId":{"description":"The ID of the ship-to contact snapshot associated with the invoice.\n","type":"string"},"soldToContactId":{"description":"The ID of the sold-to contact associated with the invoice.\n","type":"string","nullable":true},"soldToContactSnapshotId":{"description":"The ID of the sold-to contact snapshot associated with the invoice.\n","type":"string","nullable":true},"source":{"description":"The source of the invoice.\n","enum":["BillRun","API","ApiSubscribe","ApiAmend"],"type":"string"},"sourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice source."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an invoice is generated from a bill run, the value is the number of the corresponding bill run.Otherwise, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"sourceType":{"description":"The type of the invoice source.\n","enum":["Subscription","Standalone","Order","Consolidation"],"type":"string"},"status":{"description":"The status of the invoice.\n","enum":["Draft","Posted"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":"This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.\n","format":"date","type":"string","nullable":true},"taxAmount":{"description":"The amount of taxation.\n","type":"number"},"taxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","type":"number"},"taxMessage":{"description":"The message that the tax engine return if it calculates the taxes of this invoice fails.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status that the tax engine return after it calculates the taxes of this invoice."},"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 only applicable to tax calculation by third-party tax engines. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string"},"templateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template."},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled, the value of this field depends on the configuration of the invoice template."},"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 you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription."},"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 specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]}],"type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the invoice was transferred to an external accounting system.\n","enum":["Processing","Error","Ignore","Yes","No"],"type":"string","nullable":true},"updatedById":{"description":"The ID of the Zuora user who last updated the invoice.\n","type":"string"},"updatedDate":{"description":"The date when the invoice was last updated.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceObjectNSFields"},{"$ref":"#/components/schemas/InvoiceObjectCustomFields"}]}},"components/schemas/PostBatchInvoicesType":{"id":"components/schemas/PostBatchInvoicesType","kind":"json-schema","title":"PostBatchInvoicesType","data":{"example":{"invoices":[{"accountId":"ff8080817cda56fa017cda87aaa2071e","autoPay":false,"comments":"comments","currency":"EUR","invoiceDate":"2020-02-01","invoiceItems":[{"amount":100,"bookingReference":"bookingReference","chargeDate":"2020-02-01 00:00:00","description":"description","discountItems":[{"amount":-10,"bookingReference":"discountBookingReference","chargeDate":"2020-02-01 11:00:00","chargeName":"discount","description":"description","sku":"SKU-0002","taxItems":[{"exemptAmount":0,"jurisdiction":"jurisdiction","locationCode":"locationCode","name":"country tax","taxAmount":-1,"taxCode":"country tax code","taxCodeDescription":"country tax code, tax rate 10%","taxDate":"2021-02-08","taxMode":"TaxExclusive","taxRate":0.1,"taxRateDescription":"country tax","taxRateType":"Percentage"}]}],"productRatePlanChargeId":"ff8080817cda56fa017cda87999d071b","purchaseOrderNumber":"PO-000303","quantity":1,"serviceEndDate":"2020-02-10","serviceStartDate":"2020-02-01","taxItems":[{"exemptAmount":0,"jurisdiction":"juristiction","locationCode":"locationCode","name":"country tax","taxAmount":10,"taxCode":"tax code","taxCodeDescription":"tax code description","taxDate":"2020-02-01","taxMode":"TaxExclusive","taxRate":0.01,"taxRateDescription":"tax rate description","taxRateType":"Percentage"}]},{"amount":100,"bookingReference":"bookingReference","chargeDate":"2020-02-01 00:00:00","chargeName":"charge name","description":"description","purchaseOrderNumber":"PO-000303","quantity":1,"serviceEndDate":"2020-02-10","serviceStartDate":"2020-02-01","sku":"sku-001","uom":"each"}]},{"accountId":"ff8080817cda56fa017cda87aaa2071e","autoPay":false,"comments":"comments","currency":"EUR","invoiceDate":"2020-02-01","invoiceItems":[{"amount":100,"bookingReference":"bookingReference","chargeDate":"2020-02-01 00:00:00","description":"description","productRatePlanChargeId":"ff8080817cda56fa017cda87999d071b","purchaseOrderNumber":"PO-000303","quantity":1,"serviceEndDate":"2020-02-10","serviceStartDate":"2020-02-01","taxItems":[{"exemptAmount":0,"jurisdiction":"juristiction","locationCode":"locationCode","name":"country tax","taxAmount":10,"taxCode":"tax code","taxCodeDescription":"tax code description","taxDate":"2020-02-01","taxMode":"TaxExclusive","taxRate":0.01,"taxRateDescription":"tax rate description","taxRateType":"Percentage"}]},{"amount":100,"bookingReference":"bookingReference","chargeDate":"2020-02-01 00:00:00","chargeName":"charge name","description":"description","purchaseOrderNumber":"PO-000303","quantity":1,"serviceEndDate":"2020-02-10","serviceStartDate":"2020-02-01","sku":"sku-001","uom":"each"}]}],"useSingleTransaction":false},"properties":{"invoices":{"description":"Container for standalone invoices.\n","items":{"$ref":"#/components/schemas/PostInvoiceType"},"type":"array"},"useSingleTransaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether a batch request is handled with a single transaction."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that a batch request will be handled with a single transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  indicates that the standalone invoices to be created in a batch request will be handled with separated transactions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a failure in the batch request will not cause the whole request to fail, so you have to retry the whole batch request."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PostBatchInvoiceItemResponse":{"id":"components/schemas/PostBatchInvoiceItemResponse","kind":"json-schema","title":"PostBatchInvoiceItemResponse","data":{"allOf":[{"properties":{"success":{"description":"Indicates whether the invoice is created successfully.\n","type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/PostInvoiceResponse"}]}},"components/schemas/PostBatchInvoiceResponse":{"id":"components/schemas/PostBatchInvoiceResponse","kind":"json-schema","title":"PostBatchInvoiceResponse","data":{"properties":{"invoices":{"items":{"$ref":"#/components/schemas/PostBatchInvoiceItemResponse"},"type":"array"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/InvoicePostType":{"id":"components/schemas/InvoicePostType","kind":"json-schema","title":"InvoicePostType","data":{"allOf":[{"properties":{"id":{"description":"The ID of the invoice to be posted.\n","type":"string"},"invoiceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that appears on the invoice being created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The value cannot fall in a closed accounting period."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceObjectCustomFields"}]}},"components/schemas/POSTInvoicesBatchPostType":{"id":"components/schemas/POSTInvoicesBatchPostType","kind":"json-schema","title":"POSTInvoicesBatchPostType","data":{"allOf":[{"properties":{"invoices":{"description":"The container for invoices to be posted. The maximum number of invoices to be posted is 50 in one request.\n","items":{"$ref":"#/components/schemas/InvoicePostType"},"title":"invoices","type":"array"}},"type":"object"}],"example":{"invoices":[{"complexity__c":"Middle","description__c":"description","id":"402890555a7e9791015a7f15fe440123","invoiceDate":"2022-10-12"},{"complexity__c":"Middle","description__c":"description","id":"402890555a7e9791015a7f15fe44013a","invoiceDate":"2022-10-12"},{"complexity__c":"Middle","description__c":"description","id":"402890555a7e9791015a7f15fe44012b","invoiceDate":"2022-10-12"}]}}},"components/schemas/InvoicePostResponseType":{"id":"components/schemas/InvoicePostResponseType","kind":"json-schema","title":"InvoicePostResponseType","data":{"allOf":[{"properties":{"id":{"description":"The ID of the invoice that was posted.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the invoice was posted successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/InvoicesBatchPostResponseType":{"id":"components/schemas/InvoicesBatchPostResponseType","kind":"json-schema","title":"InvoicesBatchPostResponseType","data":{"allOf":[{"properties":{"invoices":{"description":"The container for a list of posted invoices.\n","items":{"$ref":"#/components/schemas/InvoicePostResponseType"},"title":"invoices","type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request has one of invoices was posted successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/GetInvoicePdfStatusResponse":{"id":"components/schemas/GetInvoicePdfStatusResponse","kind":"json-schema","title":"GetInvoicePdfStatusResponse","data":{"allOf":[{"properties":{"invoiceId":{"description":"The ID of the invoice whose pdf status is requested.\n","type":"string"},"invoiceNumber":{"description":"The invoice number of the invoice whose pdf status is requested.\n","type":"string"},"pdfGenerationStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The generation status of the invoice PDF."},"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":"Obsolete"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The status changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Obsolete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when additional updates are applied to the document, for example, payment applied or custom fields updated."},"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":"Archived"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The status changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the PDF file is archived. The file cannot be used directly until it is restored. For restoring, refer to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/PUT_Files/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restore a file"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}],"enum":["None","Pending","Processing","Generated","Error","Obsolete","Archived"],"type":"string"},"createdOn":{"description":"The time at which the request to generate the PDF was created.\n","type":"string"},"updatedOn":{"description":"The time at which the request to generate the PDF was updated.\n","type":"string"},"pdfFileURL":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file path or the URL of the PDF when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"errorCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error category when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"errorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}]}},"components/schemas/GetInvoicePdfStatusBatchResponse":{"id":"components/schemas/GetInvoicePdfStatusBatchResponse","kind":"json-schema","title":"invoiceFiles","data":{"description":"","example":{"invoiceFiles":[{"invoiceId":"402824aa8cc894d5018cc8a120576881","invoiceNumber":"INV00000003","pdfGenerationStatus":"Generated","createdOn":"2024-01-01 11:35:56","updatedOn":"2024-01-01 11:35:56","pdfFileUrl":"/v1/files/2c98901f62d7d83d0162d7facea6262d"},{"invoiceId":"2c98908a904dfc2601904e6e14090241","invoiceNumber":"INV00000004","pdfGenerationStatus":"Error","createdOn":"2024-01-02 10:14:13","updatedOn":"2024-01-02 10:14:13","errorCode":"INVALID_TEMPLATE","errorMessage":"Unknown merge filed chargeNumber__c"},{"invoiceId":"402824aa8cc894d5018cc8a120576881","invoiceNumber":"INV00000005","pdfGenerationStatus":"Pending","createdOn":"2024-01-01 11:35:56","updatedOn":"2024-01-01 11:35:56"}],"success":true},"properties":{"invoiceFiles":{"description":"Array of invoice PDF statuses requested.\n","items":{"$ref":"#/components/schemas/GetInvoicePdfStatusResponse"},"type":"array"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object","title":"invoiceFiles"}},"components/schemas/GetInvoiceResponse":{"id":"components/schemas/GetInvoiceResponse","kind":"json-schema","title":"GetInvoiceResponse","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account associated with the invoice.\n","type":"string"},"adjustmentAmount":{"description":"The amount of the invoice adjustments associated with the invoice.\n","type":"number"},"amount":{"description":"The total amount of the invoice.\n","type":"number"},"amountWithoutTax":{"description":"The invoice amount excluding tax.\n","type":"number"},"autoPay":{"description":"Whether invoices are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"balance":{"description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n","type":"number"},"billRunId":{"description":"The id of bill run if the invoice is generated by a bill run.\n","type":"string"},"billToContactId":{"description":"The ID of the bill-to contact associated with the invoice.\n","type":"string","nullable":true},"billToContactSnapshotId":{"description":"The ID of the bill-to contact snapshot associated with the invoice.\n","type":"string","nullable":true},"comments":{"description":"Comments about the invoice.\n","type":"string"},"createdById":{"description":"The user ID of the person who created the invoice. If a bill run generated the invoice, then the value is the user ID of person who created the bill run.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the invoice was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditBalanceAdjustmentAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency amount of the adjustment applied to the customer's credit balance."},"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 only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled."},"children":[]}]}]}],"type":"number"},"creditMemoAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency amount of all credit memos applied to this invoice."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the invoice."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"discount":{"description":"the invoice discount amount.\n","type":"number"},"dueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for this invoice is due, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"einvoiceErrorCode":{"description":"The error code when status is \"Failed\". This code can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n","type":"string"},"einvoiceErrorMessage":{"description":"The error message when status is \"Failed\". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n","type":"string"},"einvoiceFileId":{"description":"The ID of the e-invoice file.\n","type":"string"},"einvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the e-invoice file generation for the invoice."},"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 e-invoicing file generation succeeds, this field is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both the error code and message are empty, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eInvoiceField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fieldstores the ID of the generated e-inoice file."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically.  You can view these updates in System Health telemetry."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a failure occurs during e-invoice file generation, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If e-invoice file generation conditionally succeeds, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConditionalSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the e-invoice file has been approved by the tax authority, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The next status will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"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 e-invoice file has been rejected by the government, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot resend this e-invoice; you must create a new invoice instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]}],"enum":["Processing","RetrieveTimeOut","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string"},"id":{"description":"The unique ID of the invoice.\n","type":"string"},"includesOneTime":{"description":"Specifies whether the invoice includes one-time charges.\n","type":"boolean"},"includesRecurring":{"description":"Specifies whether the invoice includes recurring charges.\n","type":"boolean"},"includesUsage":{"description":"Specifies whether the invoice includes usage charges.\n","type":"boolean"},"invoiceDate":{"description":"The date that appears on the invoice being created.\n","format":"date","type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"invoiceNumber":{"description":"The unique identification number of the invoice.\n","type":"string"},"lastEmailSentDate":{"description":"The date when the invoice was last emailed.\n","type":"string","nullable":true},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentAmount":{"description":"The amount of payments applied to the invoice.\n","type":"number"},"paymentTerm":{"description":"The name of payment term associated with the invoice.\n","type":"string","nullable":true},"postedBy":{"description":"The user ID of the person who moved the invoice to Posted status.\n","type":"string","nullable":true},"postedDate":{"description":"The date when the invoice was posted.\n","format":"date","type":"string","nullable":true},"refundAmount":{"description":"Specifies the amount of a refund that was applied against an earlier payment on the invoice.\n","type":"number"},"sequenceSetId":{"description":"The ID of the sequence set associated with the invoice.\n","type":"string","nullable":true},"communicationProfileId":{"description":"The ID of the communication profile associated with the invoice.\n","type":"string","nullable":true},"shipToContactId":{"description":"The ID of the ship-to contact associated with the invoice.\n","type":"string","nullable":true},"shipToContactSnapshotId":{"description":"The ID of the ship-to contact snapshot associated with the invoice.\n","type":"string","nullable":true},"soldToContactId":{"description":"The ID of the sold-to contact associated with the invoice.\n","type":"string","nullable":true},"soldToContactSnapshotId":{"description":"The ID of the sold-to contact snapshot associated with the invoice.\n","type":"string","nullable":true},"source":{"description":"The source of the invoice.\n","enum":["BillRun","API","ApiSubscribe","ApiAmend"],"type":"string"},"sourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice source."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an invoice is generated from a bill run, the value is the number of the corresponding bill run.Otherwise, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"sourceType":{"description":"The type of the invoice source.\n","enum":["Subscription","Standalone","Order","Consolidation"],"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the invoice."},"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":"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status is applicable only when you use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/invoice-management/split-invoices/split-invoices-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Invoice feature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"When an invoice is split, its status changes from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the newly created invoices retain a reference to the original invoice."},"children":[]}]}]}]}]}],"enum":["Draft","Posted","Canceled","Error","Split"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":"This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.\n","format":"date","type":"string"},"taxAmount":{"description":"The amount of taxation.\n","type":"number"},"taxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","type":"number"},"taxMessage":{"description":"The message that the tax engine return if it calculates the taxes of this invoice fails.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status that the tax engine return after it calculates the taxes of this invoice."},"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 only applicable to tax calculation by third-party tax engines. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string"},"templateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template."},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled, the value of this field depends on the configuration of the invoice template."},"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 you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription."},"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 specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]}],"type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the invoice was transferred to an external accounting system.\n","enum":["Processing","Error","Ignore","Yes","No"],"type":"string","nullable":true},"updatedById":{"description":"The ID of the Zuora user who last updated the invoice.\n","type":"string"},"updatedDate":{"description":"The date when the invoice was last updated.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceObjectNSFields"},{"$ref":"#/components/schemas/InvoiceObjectCustomFields"}]}},"components/schemas/PutInvoiceType":{"id":"components/schemas/PutInvoiceType","kind":"json-schema","title":"PutInvoiceType","data":{"allOf":[{"properties":{"autoPay":{"description":"Whether invoices are automatically picked up for processing in the corresponding payment run.\nBy default, invoices are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"comments":{"description":"Additional information related to the invoice that a Zuora user added to the invoice.\n","maxLength":255,"type":"string"},"dueDate":{"description":"The date by which the payment for this invoice is due.\n","format":"date","type":"string"},"invoiceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new invoice date of the invoice. The new invoice date cannot fall in a closed accounting period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in one request. Otherwise, an error occurs."},"children":[]}]}]}],"format":"date","type":"string"},"invoiceItems":{"description":"Container for invoice items, The maximum number of items is 1,000.\n","items":{"$ref":"#/components/schemas/PutInvoiceItemType"},"type":"array"},"transferredToAccounting":{"description":"Whether the invoice was transferred to an external accounting system.\n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"templateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the invoice."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceObjectNSFields"},{"$ref":"#/components/schemas/InvoiceObjectCustomFields"}],"example":{"invoiceItems":[{"id":"8ad084db909fae930190a121c87f5800","amount":105}]}}},"components/schemas/PutInvoiceResponseType":{"id":"components/schemas/PutInvoiceResponseType","kind":"json-schema","title":"PutInvoiceResponseType","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account associated with the invoice.\n","type":"string"},"amount":{"description":"The total amount of the invoice.\n","format":"BigDecimal","type":"number"},"autoPay":{"description":"Whether invoices are automatically picked up for processing in the corresponding payment run. \n","type":"boolean"},"balance":{"description":"The balance of the invoice.\n","format":"BigDecimal","type":"number"},"cancelledById":{"description":"The ID of the Zuora user who cancelled the invoice.\n","type":"string","nullable":true},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the invoice was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the invoice. \n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the invoice.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the invoice was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditBalanceAdjustmentAmount":{"description":[{"$$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 filed is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency amount of the adjustment applied to the customer's credit balance."},"children":[]}]}]}],"format":"BigDecimal","type":"number"},"currency":{"description":"A currency defined in the web-based UI administrative settings.\n","type":"string"},"discount":{"description":"The discount of the invoice.\n","format":"BigDecimal","type":"number"},"dueDate":{"description":"The date by which the payment for this invoice is due. \n","format":"date","type":"string"},"id":{"description":"The unique ID of the invoice.\n","type":"string"},"invoiceDate":{"description":"The date on which to generate the invoice.\n","format":"date","type":"string"},"number":{"description":"The unique identification number of the invoice.\n","type":"string"},"postedById":{"description":"The ID of the Zuora user who posted the invoice.\n","type":"string","nullable":true},"postedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the invoice was posted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the invoice."},"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":"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status is applicable only when you use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/invoice-management/split-invoices/split-invoices-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Invoice feature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"When an invoice is split, its status changes from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the newly created invoices retain a reference to the original invoice."},"children":[]}]}]}]}]}],"enum":["Draft","Posted","Canceled","Error","Split"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the invoice, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-07-20."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"taxAmount":{"description":"The amount of taxation.\n","format":"BigDecimal","type":"number"},"templateId":{"description":"The ID of the invoice template associated with the invoice.\n","type":"string"},"totalTaxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"BigDecimal","type":"number"},"transferredToAccounting":{"description":"Whether the invoice was transferred to an external accounting system.\n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the invoice.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the invoice was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceObjectNSFields"},{"$ref":"#/components/schemas/InvoiceObjectCustomFields"}]}},"components/schemas/DeleteInvoiceResponseType":{"id":"components/schemas/DeleteInvoiceResponseType","kind":"json-schema","title":"DeleteInvoiceResponseType","data":{"properties":{"id":{"description":"The ID of the deleted invoice.\n","type":"string"},"jobId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the job that handles the invoice deletion operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify the value of this field as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_OperationJob/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an operation job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API operation to query job information."},"children":[]}]}]}],"type":"string"},"jobStatus":{"description":"The status of the invoice deletion operation. \n","enum":["Pending","Completed"],"type":"string"},"reasons":{"items":{"properties":{"code":{"description":"The error code of the response.\n","type":"string"},"message":{"description":"The detail information of the error response.\n","type":"string"}},"type":"object"},"type":"array"},"success":{"description":"Whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/CancelInvoiceResponseType":{"id":"components/schemas/CancelInvoiceResponseType","kind":"json-schema","title":"CancelInvoiceResponseType","data":{"properties":{"id":{"description":"The ID of the business object which is being operated.","type":"string"},"jobId":{"description":"The ID of the operation job.","type":"string"},"jobStatus":{"description":"The status of the job.","type":"string","enum":["Pending","Processing","Failed","Completed"]},"success":{"description":"Indicates whether the request was successful.","type":"boolean"}}}},"components/schemas/GetInvoiceApplicationPartType":{"id":"components/schemas/GetInvoiceApplicationPartType","kind":"json-schema","title":"applicationParts","data":{"properties":{"appliedAmount":{"description":"The amount that is applied to the invoice.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the payment or credit memo.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment or credit memo was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-12-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of credit memo that is applied to the specified invoice.\n","type":"string","nullable":true},"paymentId":{"description":"The ID of the payment that is applied to the specified invoice.\n","type":"string","nullable":true},"updatedById":{"description":"The ID of the Zuora user who last updated the payment or credit memo.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment or credit memo was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2018-01-02 11:42:16."},"children":[]}]}]}],"type":"string"}},"title":"applicationParts","type":"object"}},"components/schemas/GetInvoiceApplicationPartCollectionType":{"id":"components/schemas/GetInvoiceApplicationPartCollectionType","kind":"json-schema","title":"GetInvoiceApplicationPartCollectionType","data":{"properties":{"applicationParts":{"description":"Container for application parts.\n","items":{"$ref":"#/components/schemas/GetInvoiceApplicationPartType"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PostInvoiceEmailRequestType":{"id":"components/schemas/PostInvoiceEmailRequestType","kind":"json-schema","title":"PostInvoiceEmailRequestType","data":{"example":{"useEmailTemplateSetting":true},"properties":{"emailAddresses":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The valid email addresses you want to email an invoice to. Use commas to separate email addresses."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useEmailTemplateSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"includeAdditionalEmailAddresses":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to send an invoice to the additional email addresses of the invoice account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set the additional email addresses in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Email Addresses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on the account detail page from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-customer-account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Customer Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":[true,false],"type":"boolean"},"pdfFileId":{"description":"The ID of the PDF file that you want to send in the email.  If you do not specify any PDF file ID, the latest PDF file generated for the billing document is sent in the email.\n","pattern":"^[0-9a-fA-F]{32}$","type":"string"},"useEmailTemplateSetting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to email an invoice based on the email template setting."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the invoice is sent to the email addresses specified in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To Email"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the email template. The email template is the one you set in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" panel of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-email-template"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit Email Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about how to edit the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To Email"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the email template."},"children":[]}]}]}],"enum":[true,false],"type":"boolean"}},"type":"object"}},"components/schemas/InvoiceFile":{"id":"components/schemas/InvoiceFile","kind":"json-schema","title":"invoiceFiles","data":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice PDF file. This is the ID for the file object and different from the file handle ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdfFileUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. To open a file, you have to use the file handle ID."},"children":[]}]}]}],"type":"string"},"pdfFileUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relative URL of the invoice PDF file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can obtain the absolute URL for downloading the file by adding a prefix in the following format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{environment_base_url}/apps"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://apisandbox.zuora.com/apps/v1/files/2c98901f62d7d83d0162d7facea6262d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"versionNumber":{"description":"The version number of the invoice PDF file.\n","format":"int64","type":"integer"}},"title":"invoiceFiles","type":"object"}},"components/schemas/GETInvoiceFilesResponse":{"id":"components/schemas/GETInvoiceFilesResponse","kind":"json-schema","title":"GETInvoiceFilesResponse","data":{"properties":{"invoiceFiles":{"description":"Container for invoice PDF files.\n","items":{"$ref":"#/components/schemas/InvoiceFile"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/POSTUploadFileResponse":{"id":"components/schemas/POSTUploadFileResponse","kind":"json-schema","title":"POSTUploadFileResponse","data":{"properties":{"fileId":{"description":"The unique ID of the uploaded PDF file.\n","type":"string"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/GETInvoiceTaxItemType":{"id":"components/schemas/GETInvoiceTaxItemType","kind":"json-schema","title":"data","data":{"allOf":[{"$ref":"#/components/schemas/TaxationItemObjectCustomFields"},{"properties":{"availableToCreditAmount":{"description":"The amount of the invoice taxation item that is available to credit.\n","format":"decimal","type":"number"},"applicableTaxUnRounded":{"description":"The unrounded amount of the tax. \n","type":"number"},"country":{"description":"The field which contains country code.\n","type":"string"},"balance":{"description":"The balance of the taxation item.\n","format":"double","type":"number"},"creditAmount":{"description":"The amount of credit memos applied to the taxation item. \n","format":"double","type":"number"},"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"id":{"description":"The ID of the taxation item.\n","type":"string"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"name":{"description":"The name of the taxation item.\n","type":"string"},"paymentAmount":{"description":"The amount of payments applied to the taxation item. \n","format":"double","type":"number"},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific invoice.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string","nullable":true},"taxDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the tax is applied to the invoice, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"taxRate":{"description":"The tax rate applied to the invoice.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate.\n","enum":["Percentage","FlatFee"],"type":"string"}},"title":"data","type":"object"}],"title":"data"}},"components/schemas/InvoiceItem":{"id":"components/schemas/InvoiceItem","kind":"json-schema","title":"invoiceItems","data":{"allOf":[{"properties":{"accountingCode":{"description":"The accounting code associated with the invoice item.","type":"string"},"adjustmentLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment liability."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"appliedToItemId":{"description":"The unique ID of the invoice item that the discount charge is applied to.","type":"string","nullable":true},"availableToCreditAmount":{"description":"The amount of the invoice item that is available to credit.        \n","format":"decimal","type":"number"},"balance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The balance of the invoice item."},"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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]}],"format":"decimal","type":"string"},"bookingReference":{"description":"The booking reference of the invoice item.\n","type":"string"},"chargeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the charge."},"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 amount does not include taxes regardless if the charge's tax mode is inclusive or exclusive. This is the discount amount actually applied when the invoice item is a discount charge."},"children":[]}]}]}],"format":"decimal","type":"string"},"chargeDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the invoice item is charged, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"chargeDescription":{"description":"The description of the charge.","type":"string"},"chargeId":{"description":"The unique ID of the charge.","type":"string"},"chargeName":{"description":"The name of the charge.","type":"string"},"chargeType":{"description":"The type of the charge. \n","enum":["OneTime","Recurring","Usage"],"type":"string"},"commitmentId":{"description":"The ID of the commitment.\n","type":"string"},"commitmentPeriodId":{"description":"The ID of the commitment period.\n","type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract asset."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deferred revenue accounting code associated with the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"description":{"description":"The description of the invoice item.","type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the invoice item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"fulfillmentId":{"description":"The reference ID of the fulfillment associated with the invoice item.\n","type":"string"},"id":{"description":"Item ID.","type":"string"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule item by which Invoice Schedule Item the invoice item is generated by when the Invoice Schedule Item is executed."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"invoiceScheduleItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule item associated with the invoice item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"itemType":{"description":"The type of the invoice item.\n","type":"string"},"numberOfDeliveries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of deliveries dedicated to the Delivery Pricing charges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the Delivery Pricing feature enabled."},"children":[]}]}]}],"type":"number"},"orderLineItemId":{"description":"The reference ID of the oder line item associated with the invoice item.\n","type":"string"},"processingType":{"description":"The kind of the charge for the invoice item. \n","enum":["Charge","Discount","Prepayment","Tax","Rounding"],"type":"string"},"productName":{"description":"Name of the product associated with this item.","type":"string"},"productRatePlanChargeId":{"description":"The ID of the product rate plan charge that the invoice item is created from.\n","type":"string"},"purchaseOrderNumber":{"description":"The purchase order number associated with the invoice item.\n","type":"string"},"quantity":{"description":"The quantity of this item, in the configured unit of measure for the charge.","format":"decimal","type":"string"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set both the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExcludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"recognizedRevenueAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recognized revenue accounting code associated with the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"revRecCode":{"description":"The revenue recognition code.\n","type":"string"},"revRecTriggerCondition":{"description":"The date when revenue recognition is triggered.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate"],"type":"string"},"revRecStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date for revenue recognition."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"example":"2026-01-15","format":"date","type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue recognition rule of the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"serviceEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the service period for this item, i.e., the last day of the service period, as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"serviceStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the service period for this item, as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For a one-time fee item, the date of the charge."},"children":[]}]}]}],"format":"date","type":"string"},"sku":{"description":"The SKU of the invoice item.\n","type":"string"},"shipToContactId":{"description":"The ID of the ship-to contact associated with the invoice item.\n","type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the invoice item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"soldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the invoice item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"sourceItemType":{"description":"The type of the source item.\n","enum":["SubscriptionComponent","Rounding","ProductRatePlanCharge","None","OrderLineItem"],"type":"string"},"subscriptionId":{"description":"The ID of the subscription for this item.","type":"string"},"subscriptionName":{"description":"The name of the subscription for this item.","type":"string"},"taxAmount":{"description":"Tax applied to the charge.","format":"decimal","type":"string"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code of the invoice item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":" Only when taxation feature is enabled, this field can be presented."},"children":[]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode of the invoice item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":" Only when taxation feature is enabled, this field can be presented."},"children":[]}]}]}],"type":"string"},"taxationItems":{"description":"Container for the taxation items of the invoice item. \n","properties":{"data":{"description":"List of taxation items.\n","items":{"$ref":"#/components/schemas/GETInvoiceTaxItemType"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"}},"type":"object"},"unbilledReceivablesAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"unitOfMeasure":{"description":"Unit used to measure consumption.","type":"string"},"unitPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The per-unit price of the invoice item."},"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":": For discount charges, this represents the discount percentage (for percentage-based discounts)  or the discount amount (for fixed-amount discounts)."},"children":[]}]}]}],"format":"double","type":"number"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceItemObjectNSFields"},{"$ref":"#/components/schemas/InvoiceItemObjectCustomFields"}],"title":"invoiceItems"}},"components/schemas/GETInvoiceItemsResponse":{"id":"components/schemas/GETInvoiceItemsResponse","kind":"json-schema","title":"GETInvoiceItemsResponse","data":{"properties":{"invoiceItems":{"description":"Container for invoice items.\n","items":{"$ref":"#/components/schemas/InvoiceItem"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETInvoiceTaxationItemsResponse":{"id":"components/schemas/GETInvoiceTaxationItemsResponse","kind":"json-schema","title":"GETInvoiceTaxationItemsResponse","data":{"properties":{"data":{"description":"Container for the taxation items of the invoice item.\n","items":{"$ref":"#/components/schemas/GETInvoiceTaxItemType"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PutReverseInvoiceType":{"id":"components/schemas/PutReverseInvoiceType","kind":"json-schema","title":"PutReverseInvoiceType","data":{"example":{"applyEffectiveDate":"2017-02-20","memoDate":"2017-02-20"},"properties":{"applyEffectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the credit memo is applied to the invoice that will be reversed, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The effective date must be later than or equal to the memo date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is the date when you reverse the invoice and create the credit memo."},"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":" If the target invoice is a split invoice, this date must be equal to or later than all invoice dates in the split invoice group."},"children":[]}]}]}],"format":"date","type":"string"},"comment":{"description":"Comments about the reversal. The comment is used as the comment of the credit memo generated by reversing the specified invoice.\n","maxLength":255,"minLength":0,"type":"string"},"memoDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the credit memo was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The memo date must be later than or equal to the invoice date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is the date when you reverse the invoice and create the credit memo."},"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":" If the target invoice is a split invoice, this date must be equal to or later than all invoice dates in the split invoice group."},"children":[]}]}]}],"format":"date","type":"string"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the reason for the reversal. The value must be an existing reason code or empty. The code is used as the reason code of the credit memo generated by reversing the specified invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not specify a value, Zuora uses the default reason code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the credit memo."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/ReverseInvoiceResponseCreditMemo":{"id":"components/schemas/ReverseInvoiceResponseCreditMemo","kind":"json-schema","title":"ReverseInvoiceResponseCreditMemo","data":{"example":{"id":"402890555a40ca7f015a5b099b0e307a"},"properties":{"id":{"description":"The ID of the credit memo.","type":"string"}},"type":"object"}},"components/schemas/PutReverseInvoiceResponseType":{"id":"components/schemas/PutReverseInvoiceResponseType","kind":"json-schema","title":"PutReverseInvoiceResponseType","data":{"properties":{"creditMemo":{"description":"Container for the credit memo that is automatically generated during the invoice reversal.\n","properties":{"id":{"description":"The ID of the credit memo.","type":"string"}},"type":"object"},"creditMemos":{"description":"Array of credit memo objects generated by the reversal. This field can contain multiple items when the target invoice belongs to a split invoice group.\n","items":{"$ref":"#/components/schemas/ReverseInvoiceResponseCreditMemo"},"type":"array"},"debitMemo":{"description":"Container for the debit memo that is automatically generated during the reversal of the credit memo related to this invoice. If no related credit memo is reversed, this field is not returned in the response body.\n","properties":{"id":{"description":"The ID of the debit memo.","type":"string"}},"type":"object"},"id":{"type":"string","nullable":true,"description":"The ID of the invoice to be reversed.\n\nThis field is available only when the reversal operation is performed asynchronously.\n"},"jobId":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the job that handles the invoice reversal operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify the value of this field as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/GET_OperationJob/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an operation job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API operation to query job information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only when the reversal operation is performed asynchronously."},"children":[]}]}]}]},"jobStatus":{"type":"string","nullable":true,"enum":["Pending","Processing","Failed","Completed"],"description":"The status of the invoice reversal operation.\n\nThis field is available only when the reversal operation is performed asynchronously.\n"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/SplitInvoiceResponseSplitItems":{"id":"components/schemas/SplitInvoiceResponseSplitItems","kind":"json-schema","title":"SplitInvoiceResponseSplitItems","data":{"properties":{"splitAmount":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target invoice total amount (including tax) for this split invoice. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"splitType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The sum of all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"splitAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values must exactly equal the original invoice total. Each value must be at least the minimum currency unit (for example, 0.01 for USD, 1 for JPY)."},"children":[]}]}]}]},"splitPercentage":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of the original invoice total for this split invoice. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"splitType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The sum of all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"splitPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values must be exactly 100.000000000."},"children":[]}]}]}]},"invoiceDate":{"type":"string","format":"date","description":"Date for the new invoice in YYYY-MM-DD format. Defaults to the original invoice date if not specified.\n"},"paymentTerm":{"type":"string","description":"Payment term name for this split invoice (for example, Due Upon Receipt, Net 30). Must be a valid active payment term on the account.\n","additionalProperties":false}},"type":"object"}},"components/schemas/SplitInvoiceRequest":{"id":"components/schemas/SplitInvoiceRequest","kind":"json-schema","title":"SplitInvoiceRequest","data":{"example":{"splitType":"Amount","splits":[{"splitAmount":50,"invoiceDate":"2026-02-01","paymentTerm":"Due Upon Receipt"},{"splitAmount":80,"invoiceDate":"2026-02-15","paymentTerm":"Net 30"}]},"properties":{"splitType":{"description":"How the split is calculated. \n","enum":["Percentage","Amount"],"type":"string"},"splits":{"type":"array","description":"Array of split configurations.","minItems":2,"maxItems":50,"items":{"$ref":"#/components/schemas/SplitInvoiceResponseSplitItems"}}},"type":"object"}},"components/schemas/SplitInvoiceInvoiceItems":{"id":"components/schemas/SplitInvoiceInvoiceItems","kind":"json-schema","title":"SplitInvoiceInvoiceItems","data":{"properties":{"id":{"type":"string","description":"Invoice ID."},"invoiceNumber":{"type":"string","description":"Invoice number."},"invoiceDate":{"type":"string","format":"date","description":"Invoice date in YYYY-MM-DD format."},"amount":{"type":"number","format":"decimal","description":"Invoice amount."}},"type":"object"}},"components/schemas/SplitInvoiceResponse":{"id":"components/schemas/SplitInvoiceResponse","kind":"json-schema","title":"SplitInvoiceResponse","data":{"properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"id":{"type":"string","description":"Unique identifier for the request."},"jobId":{"type":"string","description":"Identifier of the async job."},"jobStatus":{"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 job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For invoices with a large number of invoice items, this operation might run asynchronously."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this case, the response includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies the operation job, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicates whether the operation is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Retrieve an operation job\" operation to check the job status until the operation is complete."},"children":[]}]}]}],"enum":["Pending","Processing","Failed","Completed"]},"invoices":{"type":"array","description":"List of generated invoices.","items":{"$ref":"#/components/schemas/SplitInvoiceInvoiceItems"}}}}},"components/schemas/POSTTaxationItemTypeForInvoice":{"id":"components/schemas/POSTTaxationItemTypeForInvoice","kind":"json-schema","title":"POSTTaxationItemTypeForInvoice","data":{"allOf":[{"properties":{"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"number","type":"string"},"financeInformation":{"description":"Container for the finance information related to the taxation item.\n","properties":{"accountsReceivableAccountingCode":{"description":"The accounting code for accounts receivable.\n","maxLength":100,"minLength":0,"type":"string"},"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"invoiceItemId":{"description":"The ID of the invoice associated with the taxation item.\n","type":"string"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"name":{"description":"The name of taxation.\n","type":"string"},"taxAmount":{"description":"The amount of the taxation item in the invoice item.\n","format":"number","type":"string"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific invoice item.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the tax is applied to the invoice item, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"taxMode":{"description":"The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n","enum":["TaxInclusive","TaxExclusive"],"type":"string"},"taxRate":{"description":"The tax rate applied to the invoice item.\n","format":"number","type":"string"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate applied to the invoice item.\n","enum":["Percentage","FlatFee"],"type":"string"}},"required":["invoiceItemId","jurisdiction","name","taxAmount","taxDate","taxRate","taxRateType"],"title":"taxItems","type":"object"},{"$ref":"#/components/schemas/TaxationItemObjectCustomFields"}]}},"components/schemas/POSTTaxationItemList":{"id":"components/schemas/POSTTaxationItemList","kind":"json-schema","title":"POSTTaxationItemList","data":{"example":{"taxationItems":[{"exemptAmount":0,"financeInformation":{"accountsReceivableAccountingCode":"Check","salesTaxPayableAccountingCode":"Check"},"invoiceItemId":"402890555a7e9791015a879f064d0055","jurisdiction":"CALIFORNIA","locationCode":"06","name":"STATE TAX","taxAmount":0.1,"taxCode":"ServiceTaxCode","taxCodeDescription":"This is tax code description!","taxDate":"2016-09-30","taxMode":"TaxExclusive","taxRate":0.0625,"taxRateDescription":"This is tax rate description!","taxRateType":"Percentage"}]},"properties":{"taxationItems":{"description":"Container for taxation items.\n","items":{"$ref":"#/components/schemas/POSTTaxationItemTypeForInvoice"},"type":"array"}},"type":"object"}},"components/schemas/GETTaxationItemTypewithSuccess":{"id":"components/schemas/GETTaxationItemTypewithSuccess","kind":"json-schema","title":"taxationItems","data":{"allOf":[{"properties":{"createdById":{"description":"The ID of the Zuora user who created the taxation item.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the taxation item was created in the Zuora system, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the taxation item.\n","properties":{"accountsReceivableAccountingCode":{"description":"The accounting code for accounts receivable.\n","type":"string"},"accountsReceivableAccountingCodeType":{"description":"The type of the accounting code for accounts receivable.\n","type":"string"},"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","type":"string"},"salesTaxPayableAccountingCodeType":{"description":"The type of the accounting code for the sales taxes payable.\n","type":"string"}},"type":"object"},"id":{"description":"The ID of the taxation item.\n","type":"string"},"invoiceItemId":{"description":"The ID of the invoice associated with the taxation item.\n","type":"string","nullable":true},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string","nullable":true},"name":{"description":"The name of the taxation item.\n","type":"string"},"taxAmount":{"description":"The amount of the tax applied to the invoice.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific invoice.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string","nullable":true},"taxDate":{"description":"The date when the tax is applied to the invoice.\n","format":"date","type":"string"},"taxMode":{"description":"The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n","enum":["TaxInclusive","TaxExclusive"],"type":"string"},"taxRate":{"description":"The tax rate applied to the invoice.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string","nullable":true},"taxRateType":{"description":"The type of the tax rate applied to the invoice.\n","enum":["Percentage","FlatFee"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the taxation item.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the taxation item was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TaxationItemObjectCustomFields"}],"title":"taxationItems"}},"components/schemas/GETTaxationItemListType":{"id":"components/schemas/GETTaxationItemListType","kind":"json-schema","title":"GETTaxationItemListType","data":{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"taxationItems":{"description":"Container for taxation items.\n","items":{"$ref":"#/components/schemas/GETTaxationItemTypewithSuccess"},"type":"array"}},"type":"object"}},"components/schemas/CreditMemoItemObjectCustomFields":{"id":"components/schemas/CreditMemoItemObjectCustomFields","kind":"json-schema","title":"creditMemoItemFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Credit Memo Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Credit Memo Item object.\n","title":"creditMemoItemFieldsCustom","type":"object"}},"components/schemas/CreditMemoItemFromWriteOffInvoice":{"id":"components/schemas/CreditMemoItemFromWriteOffInvoice","kind":"json-schema","title":"items","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the credit memo item.\n","type":"string"},"financeInformation":{"description":"Container for the finance information related to the credit memo item.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","maxLength":100,"minLength":0,"type":"string"},"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","maxLength":100,"minLength":0,"type":"string"},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"invoiceItemId":{"description":"The ID of the invoice item.\n","type":"string"},"serviceEndDate":{"description":"The service end date of the credit memo item. \n","format":"date","type":"string"},"amountWithoutTax":{"description":"The write off amount of the invoice item excluding tax.\n","type":"number"},"serviceStartDate":{"description":"The service start date of the credit memo item. \n","format":"date","type":"string"},"skuName":{"description":"The name of the charge associated with the invoice.\n","type":"string"},"unitOfMeasure":{"description":"The definable unit that you measure when determining charges.\n","type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":"Specifies whether to exclude this item from revenue accounting.\n","type":"boolean"},"taxationItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the taxation items of the credit memo item."},"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":":"},"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":"This field is available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"239.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"items":{"properties":{"amount":{"description":"The credit memo taxation amount.\n","type":"number"},"taxationItemId":{"description":"The Id of the debit memo item.\n","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoItemObjectCustomFields"}],"title":"items"}},"components/schemas/CreditMemoObjectNSFields":{"id":"components/schemas/CreditMemoObjectNSFields","kind":"json-schema","title":"creditMemoFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Credit Memo fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the credit memo's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Origin__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origin of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the credit memo was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Transaction__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related transaction in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"creditMemoFieldsNS","type":"object"}},"components/schemas/WriteOffInvoiceRequest":{"id":"components/schemas/WriteOffInvoiceRequest","kind":"json-schema","title":"WriteOffInvoiceRequest","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the write-off. The comment is used as the comment of the credit memo generated by writing off the specified invoice.\n","maxLength":255,"minLength":0,"type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The write off amount of the invoice."},"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 available only if you have enabled the enhanced write-off permission for your tenant. Contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/hc/en-us","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable this permission."},"children":[]}]}]}],"type":"number"},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exclude Billing Item From Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be automatically set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default for such non-revenue impacting write off credit memos, and this setting cannot be changed. This enhancement helps ensure that only revenue-impacting items are synchronized with Zuora Revenue, reducing unnecessary data processing."},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"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 available only if you have enabled the enhanced write-off permission for your tenant. Contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/hc/en-us","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable this permission."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"nonRevenueWriteOffAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the accounting code for the non revenue write off. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no"},"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":"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 available only if you have enabled the enhanced write-off permission for your tenant. Contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/hc/en-us","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable this permission."},"children":[]}]}]}],"type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for items. This field is optional."},"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":"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":"If specified, you must specify ALL the items of the invoice. The entire balance of the invoice will be written off, you cannot just write off some items of the invoice."},"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":"This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/hc/en-us","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable this permission."},"children":[]}]}]}]}]}],"items":{"$ref":"#/components/schemas/CreditMemoItemFromWriteOffInvoice"},"type":"array"},"memoDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the credit memo was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The memo date must be later than or equal to the invoice date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is the date when you write off the invoice."},"children":[]}]}]}],"format":"date","type":"string"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Write-off"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoObjectNSFields"}],"additionalProperties":true,"example":{"comment":"Customer bankruptcy - writing off outstanding balance","memoDate":"2024-08-19","reasonCode":"Write-off","taxAutoCalculation":false,"items":[{"invoiceItemId":"8ad097b490a1ec740190a5aaece25734","comment":"Item-level comment","serviceStartDate":"2024-01-01","serviceEndDate":"2024-01-31"}]}}},"components/schemas/InvoiceSettlementAsyncJobStatus":{"id":"components/schemas/InvoiceSettlementAsyncJobStatus","kind":"json-schema","title":"InvoiceSettlementAsyncJobStatus","data":{"enum":["Pending","Processing","Processed","Error"],"type":"string","description":"Job status of the Invoice Settlement async job.\n"}},"components/schemas/InvoiceSettlementAsyncJobOperationType":{"id":"components/schemas/InvoiceSettlementAsyncJobOperationType","kind":"json-schema","title":"InvoiceSettlementAsyncJobOperationType","data":{"enum":["AsyncCreditMemoApply","AsyncCreditMemoUnapply"],"type":"string","description":"Operation type of the Invoice Settlement async job.\n"}},"components/schemas/InvoiceSettlementAsyncJobReferenceType":{"id":"components/schemas/InvoiceSettlementAsyncJobReferenceType","kind":"json-schema","title":"InvoiceSettlementAsyncJobReferenceType","data":{"enum":["CreditMemo"],"type":"string","description":"Reference type of the Invoice Settlement async job.\n"}},"components/schemas/WriteOffInvoiceResponseCreditMemo":{"id":"components/schemas/WriteOffInvoiceResponseCreditMemo","kind":"json-schema","title":"WriteOffInvoiceResponseCreditMemo","data":{"description":"Container for the credit memo that is automatically generated when writing off\ninvoices.","example":{"id":"7e9fd1381a074fed8a27a3a34ad438ab"},"properties":{"id":{"description":"The ID of the credit memo that is created when the invoice is written off.\n","type":"string"}},"type":"object"}},"components/schemas/WriteOffInvoiceAsyncJobResponse":{"id":"components/schemas/WriteOffInvoiceAsyncJobResponse","kind":"json-schema","title":"WriteOffInvoiceAsyncJobResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"id":{"description":"The ID of the operation job.","type":"string"},"status":{"$ref":"#/components/schemas/InvoiceSettlementAsyncJobStatus"},"operationType":{"$ref":"#/components/schemas/InvoiceSettlementAsyncJobOperationType"},"referenceId":{"description":"The ID of the business object which is being operated.","type":"string"},"referenceType":{"$ref":"#/components/schemas/InvoiceSettlementAsyncJobReferenceType"},"error":{"description":"The error message if the operation fails.","type":"string","nullable":true},"creditMemo":{"$ref":"#/components/schemas/WriteOffInvoiceResponseCreditMemo"}},"type":"object"}]}},"components/schemas/CommonErrorResponse":{"id":"components/schemas/CommonErrorResponse","kind":"json-schema","title":"CommonErrorResponse","data":{"properties":{"code":{"description":"The error code.\n","format":"int32","type":"integer"},"message":{"description":"The error message.\n","type":"string"}},"type":"object","additionalProperties":true}},"components/schemas/CreditMemoObjectCustomFields":{"id":"components/schemas/CreditMemoObjectCustomFields","kind":"json-schema","title":"creditMemoFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Credit Memo object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Credit Memo object.\n","title":"creditMemoFieldsCustom","type":"object"}},"components/schemas/PUTWriteOffInvoiceRequest":{"id":"components/schemas/PUTWriteOffInvoiceRequest","kind":"json-schema","title":"PUTWriteOffInvoiceRequest","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the write-off. The comment is used as the comment of the credit memo generated by writing off the specified invoice.\n","maxLength":255,"minLength":0,"type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for items. This field is optional."},"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":"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":"If specified, you must specify ALL the items of the invoice. The entire balance of the invoice will be written off, you cannot just write off some items of the invoice."},"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":"This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/hc/en-us","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable this permission."},"children":[]}]}]}]}]}],"items":{"$ref":"#/components/schemas/CreditMemoItemFromWriteOffInvoice"},"type":"array"},"memoDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the credit memo was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The memo date must be later than or equal to the invoice date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is the date when you write off the invoice."},"children":[]}]}]}],"format":"date","type":"string"},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exclude Billing Item From Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be automatically set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default for such non-revenue impacting write off credit memos, and this setting cannot be changed. This enhancement helps ensure that only revenue-impacting items are synchronized with Zuora Revenue, reducing unnecessary data processing."},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"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 available only if you have enabled the enhanced write-off permission for your tenant. Contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/hc/en-us","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable this permission."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The write off amount of the invoice."},"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 available only if you have enabled the enhanced write-off permission for your tenant. Contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/hc/en-us","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable this permission."},"children":[]}]}]}],"type":"number"},"nonRevenueWriteOffAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the accounting code for the non revenue write off. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no"},"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":"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 available only if you have enabled the enhanced write-off permission for your tenant. Contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/hc/en-us","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable this permission."},"children":[]}]}]}],"type":"string"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Write-off"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoObjectCustomFields"},{"$ref":"#/components/schemas/CreditMemoObjectNSFields"}],"example":{"memoDate":"2019-01-02"},"type":"object"}},"components/schemas/PUTWriteOffInvoiceResponse":{"id":"components/schemas/PUTWriteOffInvoiceResponse","kind":"json-schema","title":"PUTWriteOffInvoiceResponse","data":{"properties":{"creditMemo":{"description":"Container for the credit memo that is automatically generated when writing off invoices.\n","properties":{"id":{"description":"The ID of the credit memo that is created when the invoice is written off.\n","type":"string"}},"type":"object"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/UnpostedInvoiceType":{"id":"components/schemas/UnpostedInvoiceType","kind":"json-schema","title":"UnpostedInvoiceType","data":{"properties":{"id":{"type":"string","description":"The unique ID of the invoice."},"accountId":{"type":"string","description":"The ID of the customer account associated with the invoice."},"invoiceNumber":{"type":"string","description":"The unique identification number of the invoice."},"status":{"type":"string","description":"The status of the invoice."},"invoiceDate":{"type":"string","format":"date","description":"The invoice created date."},"dueDate":{"type":"string","format":"date","description":"The date by which the payment for this invoice is due."},"amount":{"type":"string","format":"number","description":"The total amount of the invoice."},"balance":{"type":"string","format":"number","description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied."}}}},"components/schemas/UnpostInvoiceResponseType":{"id":"components/schemas/UnpostInvoiceResponseType","kind":"json-schema","title":"UnpostInvoiceResponseType","data":{"properties":{"invoice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unposted invoice details."},"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":" Present only when the operation completes synchronously. For asynchronous processing, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/UnpostedInvoiceType"}]},"jobId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation job ID for tracking."},"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 with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operations/get_operationjob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an operation job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to poll the asynchronous job's status."},"children":[]}]}]}],"type":"string"},"jobStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job status of the operation."},"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":"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":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the operation finished synchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the operation is still running asynchronously."},"children":[]}]}]}]}],"type":"string","enum":["Pending","Completed"]},"success":{"description":"Indicates whether the operation was successful.","type":"boolean"}}}},"components/schemas/GETCreditMemoTypewithSuccess":{"id":"components/schemas/GETCreditMemoTypewithSuccess","kind":"json-schema","title":"creditmemos","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account associated with the credit memo.\n","type":"string"},"accountNumber":{"description":"The number of the account associated with the credit memo.\n","type":"string"},"amount":{"description":"The total amount of the credit memo.\n","format":"double","type":"number"},"appliedAmount":{"description":"The applied amount of the credit memo.\n","format":"double","type":"number"},"autoApplyUponPosting":{"description":"Whether the credit memo automatically applies to the invoice upon posting.\n","type":"boolean"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"cancelledById":{"description":"The ID of the Zuora user who cancelled the credit memo.\n","type":"string","nullable":true},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the credit memo.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the credit memo.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the credit memo takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-05-20."},"children":[]}]}]}],"format":"date","type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the credit memo."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceErrorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceErrorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceFileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the e-invoice file generated for the credit memo."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the e-invoice file generation for the credit memo."},"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":"If e-invoice file generation succeeds, this field is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both the error code and message are empty, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eInvoiceFileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field stores the ID of the generated e-invoice file."},"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":"If the responses from tax vendors such as Sovos or Avalara are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taking too long, this field becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vendor responds successfully, you can use the 'Resync E-Invoice Status'"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action to update the status automatically.  You can view these updates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in System Health telemetry."},"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":"If a failure occurs during e-invoice file generation, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If e-invoice file generation conditionally succeeds, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConditionalSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If the e-invoice file has been approved by the tax authority, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The next status will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"If the e-invoice file has been rejected by the government, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot resend this e-invoice; you must create a new invoice instead."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled."},"children":[]}]}]}]}]}],"enum":["Processing","RetrieveTimeOut","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string","nullable":true},"excludeFromAutoApplyRules":{"description":"Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs.\n","type":"boolean"},"id":{"description":"The unique ID of the credit memo.\n","type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"latestPDFFileId":{"description":"The ID of the latest PDF file generated for the credit memo.\n","type":"string"},"number":{"description":"The unique identification number of the credit memo.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"postedById":{"description":"The ID of the Zuora user who posted the credit memo.\n","type":"string","nullable":true},"postedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo was posted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty.\n","type":"string"},"referredInvoiceId":{"description":"The ID of a referred invoice.\n","type":"string","nullable":true},"refundAmount":{"description":"The amount of the refund on the credit memo.\n","format":"double","type":"number"},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice"},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"reversed":{"description":"Whether the credit memo is reversed.\n","type":"boolean"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the credit memo."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string","nullable":true},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source of the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"BillRun"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is generated by a bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice and collect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, or by calling the Orders, Order Line Items, or Fulfillments API operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiSubscribe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiAmend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromPrpc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created from a product rate plan charge through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a credit memo from a charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create credit memo from invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverse invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}],"type":"string"},"sourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the credit memo source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"sourceType":{"description":"The type of the credit memo source.\n","enum":["Subscription","Standalone","Invoice","Order","CreditMemo","Consolidation"],"type":"string"},"status":{"description":"The status of the credit memo. \n","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the credit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-07-20."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxMessage":{"description":"The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of tax calculation related to the credit memo."},"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 only applicable to tax calculation by third-party tax engines. Also, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post,  Zuora automatically detects the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string","nullable":true},"totalTaxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"transferredToAccounting":{"description":"Whether the credit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedAmount":{"description":"The unapplied amount of the credit memo.\n","format":"double","type":"number"},"updatedById":{"description":"The ID of the Zuora user who last updated the credit memo.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoObjectNSFields"},{"$ref":"#/components/schemas/CreditMemoObjectCustomFields"}],"title":"creditmemos"}},"components/schemas/GETCreditMemoCollectionType":{"id":"components/schemas/GETCreditMemoCollectionType","kind":"json-schema","title":"GETCreditMemoCollectionType","data":{"properties":{"creditmemos":{"description":"Container for credit memos.\n","items":{"$ref":"#/components/schemas/GETCreditMemoTypewithSuccess"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/CreditMemoFromChargeDetailType":{"id":"components/schemas/CreditMemoFromChargeDetailType","kind":"json-schema","title":"charges","data":{"allOf":[{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the credit memo item."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"double","type":"number"},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the credit memo item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the product rate plan charge."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"minLength":0,"type":"string"},"financeInformation":{"description":"Container for the finance information related to the product rate plan charge associated with the credit memo.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","maxLength":100,"minLength":0,"type":"string"},"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","maxLength":100,"minLength":0,"type":"string"},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the product rate plan charge that the credit memo is created from."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"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 you're on Zuora API version 256 or an earlier version, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"type":"string"},"quantity":{"description":"The number of units for the credit memo item.\n","format":"double","type":"number"},"serviceEndDate":{"description":"The service end date of the credit memo item. If not specified, the effective end date of the corresponding product rate plan will be used.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the credit memo item. If not specified, the effective start date of the corresponding product rate plan will be used.\n","format":"date","type":"string"}},"required":["productRatePlanChargeId"],"type":"object"},{"$ref":"#/components/schemas/CreditMemoItemObjectCustomFields"}],"title":"charges"}},"components/schemas/CreditMemoFromChargeCustomRatesType":{"id":"components/schemas/CreditMemoFromChargeCustomRatesType","kind":"json-schema","title":"customRates","data":{"allOf":[{"properties":{"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency code for either Reporting or Home currency."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"customFxRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Custom FX conversion rate between Home/Reporting and Transactional currency items."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"decimal","type":"number"},"rateDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which a particular currency rate is fixed or obtained on."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["currency","customFxRate"],"type":"object"},{"$ref":"#/components/schemas/CreditMemoItemObjectCustomFields"}],"title":"customRates"}},"components/schemas/CreditMemoFromChargeRequest":{"id":"components/schemas/CreditMemoFromChargeRequest","kind":"json-schema","title":"memos","data":{"allOf":[{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the account associated with the credit memo."},"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":": When creating credit memos from product rate plan charges, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both in the request body. If both fields are specified, they must correspond to the same account."},"children":[]}]}]}],"type":"string"},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the customer account associated with the credit memo."},"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":": When creating credit memos from product rate plan charges, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both in the request body. If both fields are specified, they must correspond to the same account."},"children":[]}]}]}],"type":"string"},"autoPost":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically post the credit memo after it is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you do not need to separately call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_PostCreditMemo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post a credit memo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to post the credit memo."},"children":[]}]}]}],"type":"boolean"},"charges":{"description":"Container for product rate plan charges. The maximum number of items is 1,000.\n","items":{"$ref":"#/components/schemas/CreditMemoFromChargeDetailType"},"maxItems":1000,"type":"array"},"comment":{"description":"Comments about the credit memo.\n","type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code of a currency as defined in Billing Settings through the Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not specify a currency during credit memo creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"customRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both)."},"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":":"},"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":"The API custom rate feature is permission controlled."},"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":"You cannot set the custom rates, if both the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically include additional Currency Conversion information in data source exports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fx data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"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":"CreditMemo, CreditMemoItem, and CreditMemoItemTax will utilize the provided custom Fx rate to convert amounts from the transactional currency to the home currency."},"children":[]}]}]}]}]}],"items":{"$ref":"#/components/schemas/CreditMemoFromChargeCustomRatesType"},"maxItems":2,"type":"array"},"effectiveDate":{"description":"The date when the credit memo takes effect.\n","format":"date","type":"string"},"excludeFromAutoApplyRules":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a payment run does not pick up this credit memo or apply it to other invoices or debit memos."},"children":[]}]}]}],"type":"boolean"},"number":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customized credit memo number with the following format requirements:"},"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":"Max length: 32 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acceptable characters: a-z,A-Z,0-9,-,_"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be unique in the system, otherwise it may cause issues with bill runs and subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, Zuora will generate a unique number per the sequence set on the account level. If the account-level sequence set is not specified, the system default sequence set is used. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-config-of-prefix-and-number-for-billing-docs","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure prefix and numbering for billing documents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoObjectNSFields"},{"$ref":"#/components/schemas/CreditMemoObjectCustomFields"}],"example":{"accountId":"8ad09be48db5aba7018db604776d4854","charges":[{"amount":10,"productRatePlanChargeId":"8ad097b4909708e001909b41bb085d38"}]},"title":"memos"}},"components/schemas/GETCreditMemoType":{"id":"components/schemas/GETCreditMemoType","kind":"json-schema","title":"GETCreditMemoType","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account associated with the credit memo.\n","type":"string"},"accountNumber":{"description":"The number of the customer account associated with the credit memo.\n","type":"string"},"amount":{"description":"The total amount of the credit memo.\n","format":"double","type":"number"},"appliedAmount":{"description":"The applied amount of the credit memo.\n","format":"double","type":"number"},"autoApplyUponPosting":{"description":"Whether the credit memo automatically applies to the invoice upon posting.\n","type":"boolean"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"billToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact snapshot associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if the bill rule "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-billing-rules-billing-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preserve snapshot of bill-to and sold-to contacts when billing documents are posted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is disabled."},"children":[]}]}]}],"type":"string","nullable":true},"cancelledById":{"description":"The ID of the Zuora user who cancelled the credit memo.\n","type":"string","nullable":true},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the credit memo.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the credit memo.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the credit memo takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-05-20."},"children":[]}]}]}],"format":"date","type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the credit memo."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceErrorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceErrorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceFileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the e-invoice file generated for the credit memo."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the e-invoice file generation for the credit memo."},"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":"If e-invoice file generation succeeds, this field is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both the error code and message are empty, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eInvoiceFileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field stores the ID of the generated e-invoice file."},"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":"If the responses from tax vendors such as Sovos or Avalara are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taking too long, this field becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vendor responds successfully, you can use the 'Resync E-Invoice Status'"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action to update the status automatically.  You can view these updates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in System Health telemetry."},"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":"If a failure occurs during e-invoice file generation, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If e-invoice file generation conditionally succeeds, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConditionalSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If the e-invoice file has been approved by the tax authority, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The next status will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"If the e-invoice file has been rejected by the government, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot resend this e-invoice; you must create a new invoice instead."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled."},"children":[]}]}]}]}]}],"enum":["Processing","RetrieveTimeOut","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string","nullable":true},"excludeFromAutoApplyRules":{"description":"Whether the credit memo is excluded from the rule of automatically\napplying credit memos to invoices.\n","type":"boolean"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the credit memo item from revenue accounting."},"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 only available if you have the Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"id":{"description":"The unique ID of the credit memo.\n","type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"latestPDFFileId":{"description":"The ID of the latest PDF file generated for the credit memo.\n","type":"string","nullable":true},"number":{"description":"The unique identification number of the credit memo.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"postedById":{"description":"The ID of the Zuora user who posted the credit memo.\n","type":"string","nullable":true},"postedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo was posted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty.\n","type":"string"},"referredInvoiceId":{"description":"The ID of a referred invoice.\n","type":"string","nullable":true},"refundAmount":{"description":"The amount of the refund on the credit memo.\n","format":"double","type":"number"},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice"},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"reversed":{"description":"Whether the credit memo is reversed.\n","type":"boolean"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the credit memo."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string","nullable":true},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source of the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"BillRun"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is generated by a bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice and collect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, or by calling the Orders, Order Line Items, or Fulfillments API operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiSubscribe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiAmend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromPrpc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created from a product rate plan charge through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a credit memo from a charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create credit memo from invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverse invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}],"type":"string"},"sourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the credit memo source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"sourceType":{"description":"The type of the credit memo source.\n","enum":["Subscription","Standalone","Invoice","Order","CreditMemo","Consolidation"],"type":"string"},"status":{"description":"The status of the credit memo.\n","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the credit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-07-20."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxMessage":{"description":"The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of tax calculation related to the credit memo."},"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 only applicable to tax calculation by third-party tax engines. Also, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side.  If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string","nullable":true},"totalTaxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"transferredToAccounting":{"description":"Whether the credit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.\n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedAmount":{"description":"The unapplied amount of the credit memo.\n","format":"double","type":"number"},"updatedById":{"description":"The ID of the Zuora user who last updated the credit memo.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoObjectNSFields"},{"$ref":"#/components/schemas/CreditMemoObjectCustomFields"}]}},"components/schemas/CreditTaxationItemObjectCustomFields":{"id":"components/schemas/CreditTaxationItemObjectCustomFields","kind":"json-schema","title":"creditTaxationItemFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Credit Taxation Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Credit Taxation Item object.\n","title":"creditTaxationItemFieldsCustom","type":"object"}},"components/schemas/PutCreditMemoTaxItemType":{"id":"components/schemas/PutCreditMemoTaxItemType","kind":"json-schema","title":"taxItems","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the taxation item in the credit memo item.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the taxation item in the credit memo item.\n","properties":{"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"id":{"description":"The ID of the taxation item in the credit memo item.\n","type":"string"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific credit memo.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the tax is applied to the credit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"taxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"taxName":{"description":"The name of taxation.\n","type":"string"},"taxRate":{"description":"The tax rate applied to the credit memo.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate. \n","type":"string"},"taxRateType":{"description":"The type of the tax rate applied to the credit memo.\n","enum":["Percentage","FlatFee"],"type":"string"}},"required":["id"],"type":"object"},{"$ref":"#/components/schemas/CreditTaxationItemObjectCustomFields"}],"title":"taxItems"}},"components/schemas/PUTCreditMemoItemType":{"id":"components/schemas/PUTCreditMemoItemType","kind":"json-schema","title":"items","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax\n","format":"double","type":"number"},"comment":{"description":"Comments about the credit memo item.\n","type":"string"},"delete":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to delete the existing credit memo item."},"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":": To delete a credit memo item, set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and specify a credit memo item ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the credit memo item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"financeInformation":{"description":"Container for the finance information related to the credit memo item.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","maxLength":100,"minLength":0,"type":"string"},"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","maxLength":100,"minLength":0,"type":"string"},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the credit memo item."},"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":"Specify this field when updating or deleting an existing memo item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not specify this field when creating a memo item."},"children":[]}]}]}]}],"maxLength":32,"minLength":32,"type":"string"},"quantity":{"description":"The number of units for the credit memo item.\n","format":"double","type":"number"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the product rate plan charge that the credit memo is created from."},"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":": Do not specify the credit memo item "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when specifying this field."},"children":[]}]}]}],"type":"string"},"serviceEndDate":{"description":"The service end date of the credit memo item.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the credit memo item.\n","format":"date","type":"string"},"skuName":{"description":"The name of the SKU.\n","type":"string"},"taxItems":{"description":"Container for credit memo taxation items.\n","items":{"$ref":"#/components/schemas/PutCreditMemoTaxItemType"},"type":"array"},"unitOfMeasure":{"description":"The definable unit that you measure when determining charges.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoItemObjectCustomFields"}],"title":"items"}},"components/schemas/PUTCreditMemoType":{"id":"components/schemas/PUTCreditMemoType","kind":"json-schema","title":"PUTCreditMemoType","data":{"allOf":[{"properties":{"autoApplyUponPosting":{"description":"Whether the credit memo automatically applies to the invoice upon posting.\n","type":"boolean"},"comment":{"description":"Comments about the credit memo.\n","maxLength":255,"minLength":0,"type":"string"},"effectiveDate":{"description":"The date when the credit memo takes effect.\n","format":"date","type":"string"},"excludeFromAutoApplyRules":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a payment run does not pick up this credit memo or apply it to other invoices or debit memos."},"children":[]}]}]}],"type":"boolean"},"items":{"description":"Container for credit memo items.\n","items":{"$ref":"#/components/schemas/PUTCreditMemoItemType"},"type":"array"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n","type":"string"},"transferredToAccounting":{"description":"Whether the credit memo is transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoObjectNSFields"},{"$ref":"#/components/schemas/CreditMemoObjectCustomFields"}],"example":{"comment":"Details about this Credit Memo"}}},"components/schemas/PUTCreditMemosWithIdType":{"id":"components/schemas/PUTCreditMemosWithIdType","kind":"json-schema","title":"memos","data":{"allOf":[{"properties":{"id":{"description":"The ID of the credit memo.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PUTCreditMemoType"}],"title":"memos"}},"components/schemas/PUTBulkCreditMemosRequestType":{"id":"components/schemas/PUTBulkCreditMemosRequestType","kind":"json-schema","title":"PUTBulkCreditMemosRequestType","data":{"allOf":[{"properties":{"memos":{"description":"The container for a list of credit memos. The maximum number of credit memos is 50.\n","items":{"$ref":"#/components/schemas/PUTCreditMemosWithIdType"},"maxItems":50,"type":"array"}},"type":"object"}],"example":{"memos":[{"autoApplyUponPosting":false,"comment":"new comment","effectiveDate":"2017-04-17","excludeFromAutoApplyRules":false,"id":"402890555b797b57015b7986fc1a001f","items":[{"amount":1,"comment":"This is comment!","id":"402890555b797b57015b7986fc1a001c","quantity":1,"serviceEndDate":"2016-11-30","serviceStartDate":"2016-11-01","skuName":"SKU-1","taxItems":[{"amount":0.03,"id":"402890555b797b57015b7986fc3c001d","jurisdiction":"CALIFORNIA","locationCode":"06","taxCode":null,"taxCodeDescription":"This is tax code description!","taxDate":"2016-11-30","taxExemptAmount":0,"taxName":"STATE TAX1","taxRate":0.0625,"taxRateDescription":"This is tax rate description!","taxRateType":"Percentage"}],"unitOfMeasure":"Test_UOM"},{"amount":2,"comment":"This is comment!","id":"402890555b797b57015b7986fc41001e","serviceEndDate":"2016-11-30","serviceStartDate":"2016-11-01","skuName":"SKU-2","taxItems":[],"unitOfMeasure":"Test_UOM"}],"reasonCode":"Correcting invoice error"}]}}},"components/schemas/BulkCreditMemosResponseType":{"id":"components/schemas/BulkCreditMemosResponseType","kind":"json-schema","title":"BulkCreditMemosResponseType","data":{"allOf":[{"properties":{"memos":{"description":"The container for a list of credit memos.\n","items":{"$ref":"#/components/schemas/GETCreditMemoType"},"maxItems":50,"title":"memos","type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/CreditMemoTaxItemFromInvoiceTaxItemType":{"id":"components/schemas/CreditMemoTaxItemFromInvoiceTaxItemType","kind":"json-schema","title":"taxItems","data":{"properties":{"amount":{"description":"The amount of the credit memo taxation item.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the source taxation item.\n","properties":{"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. \n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"sourceTaxItemId":{"description":"The ID of the source taxation item.\n","type":"string"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific credit memo. \n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the tax is applied to the credit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"taxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"taxName":{"description":"The name of taxation.\n","type":"string"},"taxRate":{"description":"The tax rate applied to the credit memo.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate. \n","type":"string"},"taxRateType":{"description":"The type of the tax rate applied to the credit memo. \n","enum":["Percentage","FlatFee"],"type":"string"}},"title":"taxItems","type":"object"}},"components/schemas/CreditMemoItemFromInvoiceItemType":{"id":"components/schemas/CreditMemoItemFromInvoiceItemType","kind":"json-schema","title":"items","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the credit memo item.\n","format":"double","type":"number"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the credit memo item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"financeInformation":{"description":"Container for the finance information related to the credit memo item.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","maxLength":100,"minLength":0,"type":"string"},"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","maxLength":100,"minLength":0,"type":"string"},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"invoiceItemId":{"description":"The ID of the invoice item.\n","type":"string"},"quantity":{"description":"The number of units for the credit memo item.\n","format":"double","type":"number"},"serviceEndDate":{"description":"The service end date of the credit memo item.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the credit memo item.\n","format":"date","type":"string"},"skuName":{"description":"The name of the charge associated with the invoice.\n","type":"string"},"taxItems":{"description":"Container for taxation items.\n","items":{"$ref":"#/components/schemas/CreditMemoTaxItemFromInvoiceTaxItemType"},"type":"array"},"taxMode":{"default":"TaxExclusive","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":":"},"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":"Only includes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if the credit memo needs to be processed with a different tax mode than what was processed during invoice generation or the product rate plan charge was defined with. Otherwise, do not specify a tax mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxInclusive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxAutoCalculation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxInclusive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you cannot input tax amounts for credit memo items. The corresponding invoice item must use the same tax engine as the credit memo item to calculate tax amounts."},"children":[]}]}]}]}],"enum":["TaxExclusive","TaxInclusive"],"type":"string"},"unitOfMeasure":{"description":"The definable unit that you measure when determining charges.\n","type":"string"}},"required":["skuName","amount","invoiceItemId"],"type":"object"},{"$ref":"#/components/schemas/CreditMemoItemObjectCustomFields"}],"title":"items"}},"components/schemas/CreditMemoFromInvoiceRequest":{"id":"components/schemas/CreditMemoFromInvoiceRequest","kind":"json-schema","title":"memos","data":{"allOf":[{"properties":{"autoApplyToInvoiceUponPosting":{"description":"Whether the credit memo automatically applies to the invoice upon posting.\n","type":"boolean"},"autoPost":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically post the credit memo after it is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you do not need to separately call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_PostCreditMemo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post credit memo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to post the credit memo."},"children":[]}]}]}],"type":"boolean"},"comment":{"description":"Comments about the credit memo.\n","maxLength":255,"minLength":0,"type":"string"},"effectiveDate":{"description":"The date when the credit memo takes effect.\n","format":"date","type":"string"},"excludeFromAutoApplyRules":{"description":"Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.\n","type":"boolean"},"invoiceId":{"description":"The ID of the invoice that the credit memo is created from.\n","type":"string"},"items":{"description":"Container for items. The maximum number of items is 1,000.\n","items":{"$ref":"#/components/schemas/CreditMemoItemFromInvoiceItemType"},"maxItems":1000,"type":"array"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n","type":"string"},"taxAutoCalculation":{"default":true,"description":"Whether to automatically calculate taxes in the credit memo.\n","type":"boolean"}},"type":"object","required":["invoiceId"]},{"$ref":"#/components/schemas/CreditMemoObjectNSFields"},{"$ref":"#/components/schemas/CreditMemoObjectCustomFields"}],"example":{"invoiceId":"8a90d7a892d82d920192dbcb314501c7","items":[{"amount":10,"invoiceItemId":"8a90d7a892d82d920192dbcb31f401c8","skuName":"SKU-00000707"}]},"title":"memos"}},"components/schemas/BulkCreateCreditMemosFromInvoiceRequest":{"id":"components/schemas/BulkCreateCreditMemosFromInvoiceRequest","kind":"json-schema","title":"BulkCreateCreditMemosFromInvoiceRequest","data":{"properties":{"sourceType":{"type":"string","enum":["Invoice"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the source where credit memos are created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This enum field has 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":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": By setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple credit memos from invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": By setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple credit memos from product rate plan charges."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific schema of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object field in the request body depends on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"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 view the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema applicable to credit memo creation from invoices, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the following drop-down list."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema applicable to credit memo creation from product rate plan charges, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the following drop-down list."},"children":[]}]}]}]}]},"memos":{"description":"The container for a list of credit memos. The maximum number of credit memos is 50.\n","items":{"$ref":"#/components/schemas/CreditMemoFromInvoiceRequest"},"maxItems":50,"type":"array"}},"required":["sourceType"],"type":"object"}},"components/schemas/BulkCreateCreditMemosFromChargeRequest":{"id":"components/schemas/BulkCreateCreditMemosFromChargeRequest","kind":"json-schema","title":"BulkCreateCreditMemosFromChargeRequest","data":{"properties":{"sourceType":{"type":"string","enum":["Standalone","Invoice"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the source where credit memos are created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This enum field has 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":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": By setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple credit memos from invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": By setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple credit memos from product rate plan charges."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific schema of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object field in the request body depends on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"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 view the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema applicable to credit memo creation from invoices, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the following drop-down list."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema applicable to credit memo creation from product rate plan charges, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the following drop-down list."},"children":[]}]}]}]}]},"memos":{"description":"The container for a list of credit memos. The maximum number of credit memos is 50.\n","items":{"$ref":"#/components/schemas/CreditMemoFromChargeRequest"},"maxItems":50,"type":"array"}},"required":["sourceType"],"type":"object"}},"components/schemas/POSTBulkCreditMemosRequestType":{"id":"components/schemas/POSTBulkCreditMemosRequestType","kind":"json-schema","title":"POSTBulkCreditMemosRequestType","data":{"discriminator":{"propertyName":"sourceType","mapping":{"Invoice":"#/components/schemas/BulkCreateCreditMemosFromInvoiceRequest","Standalone":"#/components/schemas/BulkCreateCreditMemosFromChargeRequest"}},"oneOf":[{"$ref":"#/components/schemas/BulkCreateCreditMemosFromInvoiceRequest"},{"$ref":"#/components/schemas/BulkCreateCreditMemosFromChargeRequest"}]}},"components/schemas/GetCreditMemoPdfStatusResponse":{"id":"components/schemas/GetCreditMemoPdfStatusResponse","kind":"json-schema","title":"GetCreditMemoPdfStatusResponse","data":{"allOf":[{"properties":{"creditMemoId":{"description":"The ID of the credit memo whose pdf status is requested.\n","type":"string"},"creditMemoNumber":{"description":"The credit memo number of the credit memo whose pdf status is requested.\n","type":"string"},"pdfGenerationStatus":{"description":"The generation status of the credit memo PDF.\n","type":"string","enum":["None","Pending","Processing","Generated","Error","Obsolete"]},"createdOn":{"description":"The time at which the request to generate the PDF was created.\n","type":"string"},"updatedOn":{"description":"The time at which the request to generate the PDF was updated.\n","type":"string"},"pdfFileURL":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file path or the URL of the PDF when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"errorCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error category when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"errorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}]}},"components/schemas/GetCreditMemoPdfStatusBatchResponse":{"id":"components/schemas/GetCreditMemoPdfStatusBatchResponse","kind":"json-schema","title":"creditMemoFiles","data":{"description":"","example":{"creditMemoFiles":[{"creditMemoId":"402824aa8cc894d5018cc8a120576881","creditMemoNumber":"CM00000003","pdfGenerationStatus":"Generated","createdOn":"2024-01-01 11:35:56","updatedOn":"2024-01-01 11:35:56","pdfFileUrl":"/v1/files/2c98901f62d7d83d0162d7facea6262d"},{"creditMemoId":"2c98908a904dfc2601904e6e14090241","creditMemoNumber":"CM00000004","pdfGenerationStatus":"Error","createdOn":"2024-01-02 10:14:13","updatedOn":"2024-01-02 10:14:13","errorCode":"INVALID_TEMPLATE","errorMessage":"Unknown merge filed chargeNumber__c"},{"creditMemoId":"402824aa8cc894d5018cc8a120576881","creditMemoNumber":"CM00000005","pdfGenerationStatus":"Pending","createdOn":"2024-01-01 11:35:56","updatedOn":"2024-01-01 11:35:56"}],"success":true},"properties":{"creditMemoFiles":{"description":"Array of credit memo PDF statuses requested.\n","items":{"$ref":"#/components/schemas/GetCreditMemoPdfStatusResponse"},"type":"array"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object","title":"creditMemoFiles"}},"components/schemas/GETCMTaxItemTypeNew":{"id":"components/schemas/GETCMTaxItemTypeNew","kind":"json-schema","title":"data","data":{"allOf":[{"properties":{"appliedAmount":{"description":"The applied amount of the taxation item.\n","format":"double","type":"number"},"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the taxation item.\n","properties":{"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","type":"string","nullable":true},"onAccountAccountingCodeType":{"description":"The type of the accounting code that maps to an on account in your accounting system.\n","type":"string","nullable":true},"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","type":"string","nullable":true},"salesTaxPayableAccountingCodeType":{"description":"The type of the accounting code for the sales taxes payable.\n","type":"string","nullable":true}},"type":"object"},"id":{"description":"The ID of the taxation item.\n","type":"string"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"name":{"description":"The name of the taxation item.\n","type":"string"},"refundAmount":{"description":"The amount of the refund on the taxation item.\n","format":"double","type":"number"},"sourceTaxItemId":{"description":"The ID of the source taxation item.\n","type":"string","nullable":true},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific credit memo.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the tax is applied to the credit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"taxRate":{"description":"The tax rate applied to the credit memo.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate.\n","enum":["Percentage","FlatFee"],"type":"string"},"unappliedAmount":{"description":"The unapplied amount of the taxation item.\n","format":"double","type":"number"}},"type":"object"},{"$ref":"#/components/schemas/CreditTaxationItemObjectCustomFields"}],"title":"data"}},"components/schemas/GETTaxationItemsOfCreditMemoItemType":{"id":"components/schemas/GETTaxationItemsOfCreditMemoItemType","kind":"json-schema","title":"GETTaxationItemsOfCreditMemoItemType","data":{"allOf":[{"properties":{"data":{"description":"Container for the taxation items of the credit memo item.\n","items":{"$ref":"#/components/schemas/GETCMTaxItemTypeNew"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/DebitMemoObjectCustomFieldsCMWriteOff":{"id":"components/schemas/DebitMemoObjectCustomFieldsCMWriteOff","kind":"json-schema","title":"debitMemoFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Debit Memo object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Debit Memo object.\n","title":"debitMemoFieldsCustom","type":"object"}},"components/schemas/PUTCreditMemoWriteOff":{"id":"components/schemas/PUTCreditMemoWriteOff","kind":"json-schema","title":"PUTCreditMemoWriteOff","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the debit memo.\n","type":"string"},"memoDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The creation date of the debit memo and the effective date of the credit memo. Credit memos are applied to the corresponding debit memos on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memoDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memoDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to the current date."},"children":[]}]}]}],"format":"date","type":"string"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Write-off"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/DebitMemoObjectCustomFieldsCMWriteOff"}],"example":{"memoDate":"2022-05-05"}}},"components/schemas/PUTCreditMemoWriteOffResponseType":{"id":"components/schemas/PUTCreditMemoWriteOffResponseType","kind":"json-schema","title":"PUTCreditMemoWriteOffResponseType","data":{"properties":{"debitMemo":{"description":"Container for the credit memo that is automatically created.\n","properties":{"id":{"description":"The unique ID of the created debit memo.\n","type":"string"}},"type":"object"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/CreditMemoApplyDebitMemoItemRequestType":{"id":"components/schemas/CreditMemoApplyDebitMemoItemRequestType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount that is applied to the specific item. \n","format":"double","type":"number"},"creditMemoItemId":{"description":"The ID of the credit memo item.\n","type":"string"},"creditTaxItemId":{"description":"The ID of the credit memo taxation item.\n","type":"string"},"debitMemoItemId":{"description":"The ID of the debit memo item that the credit memo item is applied to.\n","type":"string"},"taxItemId":{"description":"The ID of the debit memo taxation item that the credit memo taxation item is applied to.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/CreditMemoApplyDebitMemoRequestType":{"id":"components/schemas/CreditMemoApplyDebitMemoRequestType","kind":"json-schema","title":"debitMemos","data":{"properties":{"amount":{"description":"The credit memo amount to be applied to the debit memo.\n","format":"double","type":"number"},"debitMemoId":{"description":"The unique ID of the debit memo that the credit memo is applied to.\n","type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for items. The maximum number of items is 1,000."},"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":"creditMemoItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the source, then it should be accompanied by a target "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debitMemoItemId"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditTaxItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the source, then it should be accompanied by a target "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CreditMemoApplyDebitMemoItemRequestType"},"type":"array"}},"required":["amount","debitMemoId"],"title":"debitMemos","type":"object"}},"components/schemas/CreditMemoApplyInvoiceItemRequestType":{"id":"components/schemas/CreditMemoApplyInvoiceItemRequestType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount that is applied to the specific item. \n","format":"double","type":"number"},"creditMemoItemId":{"description":"The ID of the credit memo item.\n","type":"string"},"creditTaxItemId":{"description":"The ID of the credit memo taxation item.\n","type":"string"},"invoiceItemId":{"description":"The ID of the invoice item that the credit memo item is applied to.\n","type":"string"},"taxItemId":{"description":"The ID of the invoice taxation item that the credit memo taxation item is applied to.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/CreditMemoApplyInvoiceRequestType":{"id":"components/schemas/CreditMemoApplyInvoiceRequestType","kind":"json-schema","title":"invoices","data":{"properties":{"amount":{"description":"The credit memo amount to be applied to the invoice.\n","format":"double","type":"number"},"invoiceId":{"description":"The unique ID of the invoice that the credit memo is applied to.\n","type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for items. The maximum number of items is 1,000."},"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":"creditMemoItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the source, then it should be accompanied by a target "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceItemId"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditTaxItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the source, then it should be accompanied by a target "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CreditMemoApplyInvoiceItemRequestType"},"type":"array"}},"required":["amount","invoiceId"],"title":"invoices","type":"object"}},"components/schemas/ApplyCreditMemoType":{"id":"components/schemas/ApplyCreditMemoType","kind":"json-schema","title":"ApplyCreditMemoType","data":{"example":{"effectiveDate":"2024-08-19","invoices":[{"invoiceId":"8ad097b490a1ec740190a5aaece25734","amount":11}]},"properties":{"applicationRule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application rule to use when applying the credit memo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not specify this field, the tenant-level application rule will be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrictions:"},"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":"This rule can only be applied to a single invoice, and cannot be applied to debit memos."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This rule cannot be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}],"type":"string","enum":["ApplyCreditToSourceItemRule"],"example":"ApplyCreditToSourceItemRule"},"debitMemos":{"description":"Container for debit memos that the credit memo is applied to. The maximum number of debit memos is 1,000.\n","items":{"$ref":"#/components/schemas/CreditMemoApplyDebitMemoRequestType"},"type":"array"},"effectiveDate":{"description":"The date when the credit memo is applied.\n","format":"date","type":"string"},"invoices":{"description":"Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000.\n","items":{"$ref":"#/components/schemas/CreditMemoApplyInvoiceRequestType"},"type":"array"}},"type":"object"}},"components/schemas/PostCreditMemoEmailRequestType":{"id":"components/schemas/PostCreditMemoEmailRequestType","kind":"json-schema","title":"PostCreditMemoEmailRequestType","data":{"example":{"useEmailTemplateSetting":true},"properties":{"emailAddresses":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The valid email addresses you want to email a credit memo to. Use commas to separate email addresses."},"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 only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useEmailTemplateSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"includeAdditionalEmailAddresses":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to send a credit memo to the additional email addresses of the memo account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set the additional email addresses in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Email Addresses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on the account detail page from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-customer-account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Customer Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":[true,false],"type":"boolean"},"pdfFileId":{"description":"The ID of the PDF file that you want to send in the email. \n\nIf you do not specify any PDF file ID, the latest PDF file generated for the credit memo is sent in the email.\n","type":"string"},"useEmailTemplateSetting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to email a credit memo based on the email template setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit memo is sent to the email addresses specified in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To Email"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the email template. The email template is the one you set in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" panel of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-email-template"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit Email Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about how to edit the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To Email"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the email template."},"children":[]}]}]}],"enum":[true,false],"type":"boolean"}},"type":"object"}},"components/schemas/CreditMemoFile":{"id":"components/schemas/CreditMemoFile","kind":"json-schema","title":"creditMemoFile","data":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the credit memo PDF file. This is the ID for the file object and different from the file handle ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdfFileUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. To open a file, you have to use the file handle ID."},"children":[]}]}]}],"type":"string"},"pdfFileUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relative URL of the credit memo PDF file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can obtain the absolute URL for downloading the file by adding a prefix in the following format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{environment_base_url}/apps"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://apisandbox.zuora.com/apps/v1/files/8a90a24f8e128020018e12cf610903f8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"versionNumber":{"description":"The version number of the credit memo PDF file.\n","format":"int64","type":"integer"}},"title":"creditMemoFile","type":"object"}},"components/schemas/GETCreditMemoFilesResponse":{"id":"components/schemas/GETCreditMemoFilesResponse","kind":"json-schema","title":"GETCreditMemoFilesResponse","data":{"properties":{"creditMemoFiles":{"description":"Container for credit memo PDF files.\n","items":{"$ref":"#/components/schemas/CreditMemoFile"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETCreditMemoItemTypewithSuccess":{"id":"components/schemas/GETCreditMemoItemTypewithSuccess","kind":"json-schema","title":"items","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax.\n","format":"double","type":"number"},"amountWithoutTax":{"description":"The credit memo item amount excluding tax.\n","format":"double","type":"number"},"appliedAmount":{"description":"The applied amount of the credit memo item.\n","format":"double","type":"number"},"appliedToItemId":{"description":"The unique ID of the credit memo item that the discount charge is applied to.\n","type":"string","nullable":true},"commitmentId":{"description":"The ID of the commitment.\n","type":"string"},"commitmentPeriodId":{"description":"The ID of the commitment period.\n","type":"string"},"createdById":{"description":"The ID of the Zuora user who created the credit memo item.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo item was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditFromItemId":{"description":"The ID of the credit from item.\n","type":"string"},"creditFromItemSource":{"description":"The type of the credit from item.\n","enum":["InvoiceItem","CreditMemoItem"],"type":"string"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the credit memo item."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the credit memo item from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For credit memo items generated by a bill run from returned or fulfillment-related order line items, this value is inherited"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the source order line item's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. When the source value is true, the credit memo"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item is excluded from revenue accounting and is not sent to Zuora Revenue as revenue-impacting."},"children":[]}]}]}],"type":"boolean"},"financeInformation":{"description":"Container for the finance information related to the credit memo item.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","type":"string","nullable":true},"deferredRevenueAccountingCodeType":{"description":"The type of the deferred revenue accounting code, such as Deferred Revenue. \n","type":"string","nullable":true},"nonRevenueWriteOffAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the accounting code for the non revenue write off. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"nonRevenueWriteOffAccountingCodeType":{"description":"Specify the accounting code type for the non revenue write off.\n","type":"string"},"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","type":"string","nullable":true},"onAccountAccountingCodeType":{"description":"The type of the accounting code that maps to an on account in your accounting system.\n","type":"string","nullable":true},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","type":"string","nullable":true},"recognizedRevenueAccountingCodeType":{"description":"The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount. \n","type":"string","nullable":true},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","type":"string"},"revenueScheduleNumber":{"description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, RS-00000001.\n","type":"string"}},"type":"object"},"id":{"description":"The ID of the credit memo item.\n","type":"string"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the credit memo item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"invoiceScheduleItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"numberOfDeliveries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, 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":"For the credit memo generated by a bill run, this field has a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the credit memo generated from an invoice, this field is blank."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the Delivery Pricing feature enabled."},"children":[]}]}]}]}],"type":"number"},"processingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of the charge for the credit memo item. Its possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"quantity":{"description":"The number of units for the credit memo item.\n","format":"double","type":"number"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"refundAmount":{"description":"The amount of the refund on the credit memo item.\n","format":"double","type":"number"},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice"},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"serviceEndDate":{"description":"The service end date of the credit memo item. \n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the credit memo item.\n","format":"date","type":"string"},"sku":{"description":"The SKU for the product associated with the credit memo item.\n","type":"string"},"skuName":{"description":"The name of the SKU.\n","type":"string"},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"soldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"sourceItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the source item."},"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 value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceItemType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionComponent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , the value of this field is the ID of the corresponding rate plan charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceItemType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceDetail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value of this field is the ID of the corresponding invoice item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceItemType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , the value of this field is the ID of the corresponding product rate plan charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceItemType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderLineItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , the value of this field is the ID of the corresponding return order line item."},"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":" For a credit memo item generated from a returned or fulfillment-related  order line item, this field contains the ID of the source order line item.  The source reference is retained so that the credit memo item can be traced to the  order line item that generated it."},"children":[]}]}]}],"type":"string"},"sourceItemType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the source item."},"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 credit memo is not created from an invoice or a product rate plan charge or a return order line item, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionComponent"},"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 a credit memo is created from an invoice, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceDetail"},"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 a credit memo is created from a product rate plan charge, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"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 a credit memo is created from a return order line item, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderLineItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["SubscriptionComponent","InvoiceDetail","ProductRatePlanCharge","OrderLineItem"],"type":"string"},"subscriptionId":{"description":"The ID of the subscription associated with the credit memo item.\n","type":"string"},"taxMode":{"description":"The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"taxationItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the taxation items of the credit memo item."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"239.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"data":{"description":"List of taxation items.\n","items":{"$ref":"#/components/schemas/GETCMTaxItemTypeNew"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"}},"type":"object"},"unappliedAmount":{"description":"The unapplied amount of the credit memo item.\n","format":"double","type":"number"},"unitOfMeasure":{"description":"The units to measure usage.\n","type":"string"},"unitPrice":{"description":"The per-unit price of the credit memo item.\n","format":"double","type":"number"},"updatedById":{"description":"The ID of the Zuora user who last updated the credit memo item.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo item was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoItemObjectCustomFields"}],"title":"items"}},"components/schemas/GETCreditMemoItemsListType":{"id":"components/schemas/GETCreditMemoItemsListType","kind":"json-schema","title":"GETCreditMemoItemsListType","data":{"properties":{"items":{"description":"Container for credit memo items.\n","items":{"$ref":"#/components/schemas/GETCreditMemoItemTypewithSuccess"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETCreditMemoItemType":{"id":"components/schemas/GETCreditMemoItemType","kind":"json-schema","title":"GETCreditMemoItemType","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax.\n","format":"double","type":"number"},"amountWithoutTax":{"description":"The credit memo item amount excluding tax.\n","format":"double","type":"number"},"appliedAmount":{"description":"The applied amount of the credit memo item.\n","format":"double","type":"number"},"appliedToItemId":{"description":"The unique ID of the credit memo item that the discount charge is applied to.\n","type":"string","nullable":true},"commitmentId":{"description":"The ID of the commitment.\n","type":"string"},"commitmentPeriodId":{"description":"The ID of the commitment period.\n","type":"string"},"createdById":{"description":"The ID of the Zuora user who created the credit memo item.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo item was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditFromItemId":{"description":"The ID of the credit from item.\n","type":"string"},"creditFromItemSource":{"description":"The type of the credit from item.\n","enum":["InvoiceItem","CreditMemoItem"],"type":"string"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the credit memo item."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the credit memo item from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For credit memo items generated by a bill run from returned or fulfillment-related order line items, this value is inherited"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the source order line item's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. When the source value is true, the credit memo"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item is excluded from revenue accounting and is not sent to Zuora Revenue as revenue-impacting."},"children":[]}]}]}],"type":"boolean"},"financeInformation":{"description":"Container for the finance information related to the credit memo item.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","type":"string","nullable":true},"deferredRevenueAccountingCodeType":{"description":"The type of the deferred revenue accounting code, such as Deferred Revenue.'\n","type":"string","nullable":true},"nonRevenueWriteOffAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the accounting code for the non revenue write off. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"nonRevenueWriteOffAccountingCodeType":{"description":"Specify the accounting code type for the non revenue write off.\n","type":"string","nullable":true},"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","type":"string","nullable":true},"onAccountAccountingCodeType":{"description":"The type of the accounting code that maps to an on account in your accounting system.\n","type":"string","nullable":true},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","type":"string","nullable":true},"recognizedRevenueAccountingCodeType":{"description":"The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n","type":"string","nullable":true},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","type":"string"},"revenueScheduleNumber":{"description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, RS-00000001.\n","type":"string"}},"type":"object"},"id":{"description":"The ID of the credit memo item.\n","type":"string"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the credit memo item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"invoiceScheduleItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"numberOfDeliveries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, 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":"For the credit memo generated by a bill run, this field has a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the credit memo generated from an invoice, this field is blank."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the Delivery Pricing feature enabled."},"children":[]}]}]}]}],"type":"number"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"processingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of the charge for the credit memo item. Its possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"quantity":{"description":"The number of units for the credit memo item.\n","format":"double","type":"number"},"refundAmount":{"description":"The amount of the refund on the credit memo item.\n","format":"double","type":"number"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice"},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"serviceEndDate":{"description":"The service end date of the credit memo item.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the credit memo item. If the associated charge is a one-time fee, this date is the date of that charge.\n","format":"date","type":"string"},"sku":{"description":"The SKU for the product associated with the credit memo item.\n","type":"string"},"skuName":{"description":"The name of the SKU.\n","type":"string"},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"soldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"sourceItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the source item."},"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 value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceItemType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionComponent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , the value of this field is the ID of the corresponding rate plan charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceItemType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceDetail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value of this field is the ID of the corresponding invoice item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceItemType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , the value of this field is the ID of the corresponding product rate plan charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceItemType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderLineItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , the value of this field is the ID of the corresponding return order line item."},"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":" For a credit memo item generated from a returned or fulfillment-related  order line item, this field contains the ID of the source order line item.  The source reference is retained so that the credit memo item can be traced to the  order line item that generated it."},"children":[]}]}]}],"type":"string"},"sourceItemType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the source item."},"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 credit memo is not created from an invoice or a product rate plan charge or a return order line item,, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionComponent"},"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 a credit memo is created from an invoice, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceDetail"},"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 a credit memo is created from a product rate plan charge, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"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 a credit memo is created from a return order line item, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderLineItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["SubscriptionComponent","InvoiceDetail","ProductRatePlanCharge","OrderLineItem"],"type":"string"},"subscriptionId":{"description":"The ID of the subscription associated with the credit memo item.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"taxMode":{"description":"The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"taxationItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the taxation items of the credit memo item."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"239.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"data":{"description":"List of taxation items.\n","items":{"$ref":"#/components/schemas/GETCMTaxItemTypeNew"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"}},"type":"object"},"unappliedAmount":{"description":"The unapplied amount of the credit memo item.\n","format":"double","type":"number"},"unitOfMeasure":{"description":"The units to measure usage.\n","type":"string"},"unitPrice":{"description":"The per-unit price of the credit memo item.\n","format":"double","type":"number"},"updatedById":{"description":"The ID of the Zuora user who last updated the credit memo item.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo item was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoItemObjectCustomFields"}]}},"components/schemas/GETCreditMemoPartTypewithSuccess":{"id":"components/schemas/GETCreditMemoPartTypewithSuccess","kind":"json-schema","title":"parts","data":{"properties":{"amount":{"description":"The amount of the credit memo part.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the credit memo part.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo part was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"debitMemoId":{"description":"The ID of the debit memo associated with the credit memo part.\n","type":"string","nullable":true},"id":{"description":"The ID of the credit memo part.\n","type":"string"},"invoiceId":{"description":"The ID of the invoice associated with the credit memo part.\n","type":"string","nullable":true},"updatedById":{"description":"The ID of the Zuora user who last updated the credit memo part.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo part was last upated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"title":"parts","type":"object"}},"components/schemas/GETCreditMemoPartsCollectionType":{"id":"components/schemas/GETCreditMemoPartsCollectionType","kind":"json-schema","title":"GETCreditMemoPartsCollectionType","data":{"properties":{"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"parts":{"description":"Container for credit memo parts.\n","items":{"$ref":"#/components/schemas/GETCreditMemoPartTypewithSuccess"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETCreditMemoPartType":{"id":"components/schemas/GETCreditMemoPartType","kind":"json-schema","title":"GETCreditMemoPartType","data":{"properties":{"amount":{"description":"The amount of the credit memo part.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the credit memo part.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo part was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"debitMemoId":{"description":"The ID of the debit memo associated with the credit memo part.\n","type":"string","nullable":true},"id":{"description":"The ID of the credit memo part.\n","type":"string"},"invoiceId":{"description":"The ID of the invoice associated with the credit memo part.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"updatedById":{"description":"The ID of the Zuora user who last updated the credit memo part.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the credit memo part was last upated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/POSTMemoPdfResponse":{"id":"components/schemas/POSTMemoPdfResponse","kind":"json-schema","title":"POSTMemoPdfResponse","data":{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/RefundCreditMemoItemType":{"id":"components/schemas/RefundCreditMemoItemType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount of the refund on the specific item.\n","format":"double","type":"number"},"creditMemoItemId":{"description":"The ID of the credit memo item that is refunded.\n","type":"string"},"creditTaxItemId":{"description":"The ID of the credit memo taxation item that is refunded.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/RefundObjectNSFields":{"id":"components/schemas/RefundObjectNSFields","kind":"json-schema","title":"refundFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Refund fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the refund's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Origin__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origin of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the refund was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SynctoNetSuite__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the refund should be synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"refundFieldsNS","type":"object"}},"components/schemas/RefundObjectCustomFields":{"id":"components/schemas/RefundObjectCustomFields","kind":"json-schema","title":"refundFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Refund object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Refund object.\n","title":"refundFieldsCustom","type":"object"}},"components/schemas/PostNonRefRefundType":{"id":"components/schemas/PostNonRefRefundType","kind":"json-schema","title":"PostNonRefRefundType","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the refund.\n","maxLength":255,"minLength":0,"type":"string"},"customRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item, Reporting currency item, or both)."},"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":":"},"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":"This field is available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later version."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot set the custom rates, if both the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically include additional Currency Conversion information in data source exports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fx data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/CreditMemoFromChargeCustomRatesType"},"maxItems":2,"type":"array"},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the refund. This field can be specified only for electronic refunds. The ID must be a valid gateway instance ID, and this gateway must support the specific payment method. \n\nIf no gateway ID is specified, the default gateway in the billing account configuration will be used. If no gateway is specified in the billing account, the default gateway of the corresponding tenant will be used.\n","type":"string"},"gatewayOptions":{"description":"The field used to pass gateway-specific parameters and parameter values.\n","properties":{"key":{"description":"The name of a gateway-specific parameter.\n","type":"string"},"value":{"description":"The value of the gateway-specific parameter.\n","type":"string"}},"type":"object"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for credit memo items. The maximum number of items is 1,000."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/RefundCreditMemoItemType"},"type":"array"},"methodType":{"description":"How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on a credit memo.\n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"paymentMethodId":{"description":"The ID of the payment method used for the refund. This field is required for an electronic refund, and the value must be an electronic payment method ID. This field must be left empty for an external refund. \n","type":"string"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n","type":"string"},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","maxLength":100,"minLength":0,"type":"string"},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The date of the refund cannot be before the credit memo date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds."},"children":[]}]}]}],"format":"date","type":"string"},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n","maxLength":100,"minLength":0,"type":"string"},"softDescriptor":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.","maxLength":35,"type":"string"},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.","maxLength":20,"type":"string"},"totalAmount":{"description":"The total amount of the refund. The amount cannot exceed the unapplied amount of the associated credit memo. If the original credit memo was applied to one or more invoices or debit memos, you have to unapply a full or partial credit memo from the invoices or debit memos, and then refund the full or partial unapplied credit memo to your customers.\n","format":"double","type":"number"},"type":{"description":"The type of the refund.\n","enum":["External","Electronic"],"type":"string"}},"required":["totalAmount","type"],"type":"object"},{"$ref":"#/components/schemas/RefundObjectNSFields"},{"$ref":"#/components/schemas/RefundObjectCustomFields"}],"example":{"type":"Electronic","totalAmount":10,"paymentMethodId":"8ad084db90a5e73b0190c02783f552fa"}}},"components/schemas/GETRefundCreditMemoType":{"id":"components/schemas/GETRefundCreditMemoType","kind":"json-schema","title":"GETRefundCreditMemoType","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment.\n","type":"string"},"amount":{"description":"The total amount of the refund.\n","format":"double","type":"number"},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the refund.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the refund.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-06 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of the credit memo that is refunded.\n","type":"string"},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string","nullable":true},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","type":"string","nullable":true},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n","type":"string","nullable":true}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the refund.\n","type":"string"},"gatewayResponse":{"description":"The message returned from the payment gateway for the refund. This message is gateway-dependent.\n","type":"string"},"gatewayResponseCode":{"description":"The response code returned from the payment gateway for the refund. This code is gateway-dependent.\n","type":"string"},"gatewayState":{"description":"The status of the refund in the gateway.\n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"id":{"description":"The ID of the created refund.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a refund was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"methodType":{"description":"How an external refund was issued to a customer.\n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"number":{"description":"The unique identification number of the refund.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentId":{"description":"The ID of the payment associated with the refund.\n","type":"string","nullable":true},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the refund.\n","type":"string"},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.\n","type":"string"},"reasonCode":{"description":"A code identifying the reason for the transaction.\n","type":"string","nullable":true},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string"},"refundDate":{"description":"The date when the refund takes effect, in yyyy-mm-dd format.\n","format":"date","type":"string"},"refundTransactionTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was issued, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was settled in the payment processor, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This field is used by the Spectrum gateway only and not applicable to other gateways."},"children":[]}]}]}],"type":"string","nullable":true},"softDescriptor":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"status":{"description":"The status of the refund.\n","enum":["Processed","Canceled","Error","Processing"],"type":"string"},"submittedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was submitted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"type":{"description":"The type of the refund.\n","enum":["External","Electronic"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the refund.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-07 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/RefundObjectNSFields"},{"$ref":"#/components/schemas/RefundObjectCustomFields"}]}},"components/schemas/PutReverseCreditMemoType":{"id":"components/schemas/PutReverseCreditMemoType","kind":"json-schema","title":"PutReverseCreditMemoType","data":{"example":{"applyEffectiveDate":"2017-02-20","memoDate":"2017-02-20"},"properties":{"applyEffectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the to-be-reversed credit memo is applied to the newly generated debit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The effective date must be later than or equal to the memo date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is the date when you reverse the credit memo and create the debit memo."},"children":[]}]}]}],"format":"date","type":"string"},"comment":{"description":"Comments about the reversal. The comment is used as the comment of the debit memo generated by reversing the specified credit memo.\n","maxLength":255,"minLength":0,"type":"string"},"memoDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the debit memo is created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The memo date must be later than or equal to the credit memo's memo date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is the date when you reverse the credit memo and create the debit memo."},"children":[]}]}]}],"format":"date","type":"string"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the reason for the reversal. The value must be an existing reason code or empty. The code is used as the reason code of the debit memo generated by reversing the specified credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not specify a value, Zuora uses the default reason code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Credit memo reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the debit memo."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/PutReverseCreditMemoResponseType":{"id":"components/schemas/PutReverseCreditMemoResponseType","kind":"json-schema","title":"PutReverseCreditMemoResponseType","data":{"properties":{"creditMemo":{"description":"Container for the credit memo that is automatically generated during the reversal of the invoice that is related to the credit memo. If no related invoice is reversed, the value is null.\n","properties":{"id":{"description":"The ID of the credit memo.","type":"string"}},"type":"object"},"debitMemo":{"description":"Container for the debit memo that is automatically generated during the credit memo reversal.\n","properties":{"id":{"description":"The ID of the debit memo.","type":"string"}},"type":"object"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/POSTTaxationItemForCMType":{"id":"components/schemas/POSTTaxationItemForCMType","kind":"json-schema","title":"taxationItems","data":{"allOf":[{"properties":{"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the taxation item.\n","properties":{"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"memoItemId":{"description":"The ID of the credit memo that the taxation item is created for.\n","type":"string"},"name":{"description":"The name of the taxation item.\n","type":"string"},"sourceTaxItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the taxation item of the invoice, which the credit memo is created from."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to use this REST API to create taxation items for a credit memo created from an invoice, the taxation items of the invoice must be created or imported through the SOAP API call."},"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":"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":"This field is only used if the credit memo is created from an invoice."},"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 contain this field in the request body, Zuora will automatically set a value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceTaxItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field based on the tax location code, tax jurisdiction, and tax rate."},"children":[]}]}]}]}],"type":"string"},"taxAmount":{"description":"The amount of the tax applied to the credit memo.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific credit memo.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":"The date when the tax is applied to the credit memo.\n","format":"date","type":"string"},"taxRate":{"description":"The tax rate applied to the credit memo.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate applied to the credit memo.\n","enum":["Percentage","FlatFee"],"type":"string"}},"required":["taxRate","jurisdiction","name","taxRateType","taxAmount"],"type":"object"},{"$ref":"#/components/schemas/TaxationItemObjectCustomFields"}],"title":"taxationItems"}},"components/schemas/POSTTaxationItemListForCMType":{"id":"components/schemas/POSTTaxationItemListForCMType","kind":"json-schema","title":"POSTTaxationItemListForCMType","data":{"example":{"taxationItems":[{"name":"STATE TAX","memoItemId":"8ad086fa932a0b5401932e82ab1f1fb3","jurisdiction":"CALIFORNIA","taxAmount":0.5,"taxCode":"ServiceTaxCode","taxDate":"2024-11-15","taxRate":0.05,"taxRateType":"Percentage"}]},"properties":{"taxationItems":{"description":"Container for taxation items.\n","items":{"$ref":"#/components/schemas/POSTTaxationItemForCMType"},"type":"array"}},"type":"object"}},"components/schemas/CreditMemoUnapplyDebitMemoItemRequestType":{"id":"components/schemas/CreditMemoUnapplyDebitMemoItemRequestType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount that is unapplied from the specific item. \n","format":"double","type":"number"},"creditMemoItemId":{"description":"The ID of the credit memo item.\n","type":"string"},"creditTaxItemId":{"description":"The ID of the credit memo taxation item.\n","type":"string"},"debitMemoItemId":{"description":"The ID of the debit memo item that the credit memo item is unapplied from.\n","type":"string"},"taxItemId":{"description":"The ID of the debit memo taxation item that the credit memo taxation item is unapplied from.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/CreditMemoUnapplyDebitMemoRequestType":{"id":"components/schemas/CreditMemoUnapplyDebitMemoRequestType","kind":"json-schema","title":"debitMemos","data":{"properties":{"amount":{"description":"The credit memo amount to be unapplied from the debit memo.\n","format":"double","type":"number"},"debitMemoId":{"description":"The unique ID of the debit memo that the credit memo is unapplied from.\n","type":"string"},"items":{"description":"Container for items. The maximum number of items is 1,000.\n","items":{"$ref":"#/components/schemas/CreditMemoUnapplyDebitMemoItemRequestType"},"type":"array"}},"required":["amount","debitMemoId"],"title":"debitMemos","type":"object"}},"components/schemas/CreditMemoUnapplyInvoiceItemRequestType":{"id":"components/schemas/CreditMemoUnapplyInvoiceItemRequestType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount that is unapplied from the specific item. \n","format":"double","type":"number"},"creditMemoItemId":{"description":"The ID of the credit memo item.\n","type":"string"},"creditTaxItemId":{"description":"The ID of the credit memo taxation item.\n","type":"string"},"invoiceItemId":{"description":"The ID of the invoice item that the credit memo item is unapplied from.\n","type":"string"},"taxItemId":{"description":"The ID of the invoice taxation item that the credit memo taxation item is unapplied from.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/CreditMemoUnapplyInvoiceRequestType":{"id":"components/schemas/CreditMemoUnapplyInvoiceRequestType","kind":"json-schema","title":"invoices","data":{"properties":{"amount":{"description":"The credit memo amount to be unapplied from the invoice.\n","format":"double","type":"number"},"invoiceId":{"description":"The unique ID of the invoice that the credit memo is unapplied from.\n","type":"string"},"items":{"description":"Container for items. The maximum number of items is 1,000.\n","items":{"$ref":"#/components/schemas/CreditMemoUnapplyInvoiceItemRequestType"},"type":"array"}},"required":["amount","invoiceId"],"title":"invoices","type":"object"}},"components/schemas/UnapplyCreditMemoType":{"id":"components/schemas/UnapplyCreditMemoType","kind":"json-schema","title":"UnapplyCreditMemoType","data":{"example":{"effectiveDate":"2024-10-30","invoices":[{"invoiceId":"8a90acec910816f601910bcf57a62363","amount":1}]},"properties":{"debitMemos":{"description":"Container for debit memos that the credit memo is unapplied from. The maximum number of debit memos is 1,000.\n","items":{"$ref":"#/components/schemas/CreditMemoUnapplyDebitMemoRequestType"},"type":"array"},"effectiveDate":{"description":"The date when the credit memo is unapplied.\n","format":"date","type":"string"},"invoices":{"description":"Container for invoices that the credit memo is unapplied from. The maximum number of invoices is 1,000.\n","items":{"$ref":"#/components/schemas/CreditMemoUnapplyInvoiceRequestType"},"type":"array"}},"type":"object"}},"components/schemas/InvoiceSettlementAsyncJobResponse":{"id":"components/schemas/InvoiceSettlementAsyncJobResponse","kind":"json-schema","title":"InvoiceSettlementAsyncJobResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"id":{"description":"The ID of the operation job.","type":"string"},"status":{"$ref":"#/components/schemas/InvoiceSettlementAsyncJobStatus"},"operationType":{"$ref":"#/components/schemas/InvoiceSettlementAsyncJobOperationType"},"referenceId":{"description":"The ID of the business object which is being operated.","type":"string"},"referenceType":{"$ref":"#/components/schemas/InvoiceSettlementAsyncJobReferenceType"},"error":{"description":"The error message if the operation error out.","type":"string","nullable":true}},"type":"object"}]}},"components/schemas/AsyncApplyCreditMemoToInvoice":{"id":"components/schemas/AsyncApplyCreditMemoToInvoice","kind":"json-schema","title":"AppliedInvoice","data":{"properties":{"amount":{"description":"The credit memo amount to be applied to the invoice.\n","type":"number"},"invoiceId":{"description":"The unique ID of the invoice that the credit memo is applied to.\n","type":"string"}},"required":["amount","invoiceId"],"title":"AppliedInvoice","type":"object"}},"components/schemas/AsyncApplyCreditMemoRequest":{"id":"components/schemas/AsyncApplyCreditMemoRequest","kind":"json-schema","title":"AsyncApplyCreditMemoRequest","data":{"example":{"effectiveDate":"2017-03-02","invoices":[{"amount":1,"invoiceId":"4028905f5a87c0ff015a87d3f8f10043"}]},"properties":{"effectiveDate":{"description":"The date when the credit memo is applied.\n","format":"date","type":"string"},"invoices":{"description":"Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000.\n","items":{"$ref":"#/components/schemas/AsyncApplyCreditMemoToInvoice"},"type":"array"}},"type":"object"}},"components/schemas/AsyncUnapplyCreditMemoToInvoice":{"id":"components/schemas/AsyncUnapplyCreditMemoToInvoice","kind":"json-schema","title":"UnappliedInvoice","data":{"properties":{"amount":{"description":"The credit memo amount to be unapplied from the invoice.\n","type":"number"},"invoiceId":{"description":"The unique ID of the invoice that the credit memo is unapplied from.\n","type":"string"}},"required":["amount","invoiceId"],"title":"UnappliedInvoice"}},"components/schemas/AsyncUnapplyCreditMemoRequest":{"id":"components/schemas/AsyncUnapplyCreditMemoRequest","kind":"json-schema","title":"AsyncUnapplyCreditMemoRequest","data":{"example":{"effectiveDate":"2017-03-02","invoices":[{"amount":1,"invoiceId":"4028905f5a87c0ff015a87d3f8f10043"}]},"properties":{"effectiveDate":{"description":"The date when the credit memo is unapplied.\n","format":"date","type":"string"},"invoices":{"description":"Container for invoices that the credit memo is unapplied. The maximum number of invoices is 1,000.\n","items":{"$ref":"#/components/schemas/AsyncUnapplyCreditMemoToInvoice"},"type":"array"}},"type":"object"}},"components/schemas/DebitMemoObjectNSFields":{"id":"components/schemas/DebitMemoObjectNSFields","kind":"json-schema","title":"debitMemoFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Debit Memo fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the debit memo's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the debit memo was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"debitMemoFieldsNS","type":"object"}},"components/schemas/DebitMemoObjectCustomFields":{"id":"components/schemas/DebitMemoObjectCustomFields","kind":"json-schema","title":"debitMemoFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Debit Memo object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Debit Memo object.\n","title":"debitMemoFieldsCustom","type":"object"}},"components/schemas/GETDebitMemoTypewithSuccess":{"id":"components/schemas/GETDebitMemoTypewithSuccess","kind":"json-schema","title":"debitmemos","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account associated with the debit memo.\n","type":"string"},"accountNumber":{"description":"The number of the customer account associated with the debit memo.\n","type":"string"},"amount":{"description":"The total amount of the debit memo.\n","format":"double","type":"number"},"autoPay":{"description":"Whether debit memos are automatically picked up for processing in the corresponding payment run. \n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run.      \n","type":"boolean"},"balance":{"description":"The balance of the debit memo.\n","format":"double","type":"number"},"beAppliedAmount":{"description":"The applied amount of the debit memo.\n","format":"double","type":"number"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"cancelledById":{"description":"The ID of the Zuora user who cancelled the debit memo.\n","type":"string","nullable":true},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the debit memo.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the debit memo.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the debit memo."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"debitMemoDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the debit memo takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-05-20."},"children":[]}]}]}],"format":"date","type":"string"},"dueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for the debit memo is due, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"einvoiceErrorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceErrorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceFileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the e-invoice file generated for the debit memo."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the e-invoice file generation for the debit memo."},"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":"If e-invoice file generation succeeds, this field is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both the error code and message are empty, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eInvoiceFileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field stores the ID of the generated e-invoice file."},"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":"If the responses from tax vendors such as Sovos or Avalara are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taking too long, this field becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vendor responds successfully, you can use the 'Resync E-Invoice Status'"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action to update the status automatically.  You can view these updates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in System Health telemetry."},"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":"If a failure occurs during e-invoice file generation, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If e-invoice file generation conditionally succeeds, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConditionalSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If the e-invoice file has been approved by the tax authority, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The next status will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"If the e-invoice file has been rejected by the government, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot resend this e-invoice; you must create a new invoice instead."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled."},"children":[]}]}]}]}]}],"enum":["Processing","RetrieveTimeOut","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string","nullable":true},"id":{"description":"The unique ID of the debit memo.\n","type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"latestPDFFileId":{"description":"The ID of the latest PDF file generated for the debit memo.\n","type":"string"},"number":{"description":"The unique identification number of the debit memo.\n","type":"string"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"postedById":{"description":"The ID of the Zuora user who posted the debit memo.\n","type":"string","nullable":true},"postedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo was posted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty.\n","type":"string"},"referredCreditMemoId":{"description":"The ID of the credit memo from which the debit memo was created.\n","type":"string","nullable":true},"referredInvoiceId":{"description":"The ID of a referred invoice.\n","type":"string","nullable":true},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the debit memo."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string","nullable":true},"sourceType":{"description":"The type of the debit memo source.\n","enum":["Subscription","Standalone","Order","Consolidation","Invoice","CreditMemo"],"type":"string"},"status":{"description":"The status of the debit memo. \n","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the debit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-07-20."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxMessage":{"description":"The message about the status of tax calculation related to the debit memo. If tax calculation fails in one debit memo, this field displays the reason for the failure.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of tax calculation related to the debit memo."},"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 only applicable to tax calculation by third-party tax engines. Also, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side.  If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string","nullable":true},"totalTaxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"transferredToAccounting":{"description":"Whether the debit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the debit memo.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:31:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/DebitMemoObjectNSFields"},{"$ref":"#/components/schemas/DebitMemoObjectCustomFields"}],"title":"debitmemos"}},"components/schemas/GETDebitMemoCollectionType":{"id":"components/schemas/GETDebitMemoCollectionType","kind":"json-schema","title":"GETDebitMemoCollectionType","data":{"properties":{"debitmemos":{"description":"Container for debit memos.\n","items":{"$ref":"#/components/schemas/GETDebitMemoTypewithSuccess"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/BatchDebitMemoType":{"id":"components/schemas/BatchDebitMemoType","kind":"json-schema","title":"debitMemos","data":{"properties":{"dueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for the debit memo is due, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"id":{"description":"The unique ID or number of the debit memo to be updated. For example, 402890555a87d7f5015a892f2ba10057 or or DM00000001.\n","type":"string"}},"title":"debitMemos","type":"object"}},"components/schemas/PUTBatchDebitMemosRequest":{"id":"components/schemas/PUTBatchDebitMemosRequest","kind":"json-schema","title":"PUTBatchDebitMemosRequest","data":{"example":{"debitMemos":[{"dueDate":"2017-12-28","id":"402890d25f9f083f015f9f28041d0008"},{"dueDate":"2017-12-20","id":"402890555a87d7f5015a892f2ba10057"}]},"properties":{"debitMemos":{"description":"Container for debit memo update details.\n","items":{"$ref":"#/components/schemas/BatchDebitMemoType"},"type":"array"}},"type":"object"}},"components/schemas/DebitMemoItemObjectCustomFields":{"id":"components/schemas/DebitMemoItemObjectCustomFields","kind":"json-schema","title":"debitMemoItemFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Debit Memo Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Debit Memo Item object.\n","title":"debitMemoItemFieldsCustom","type":"object"}},"components/schemas/DebitMemoFromChargeDetailType":{"id":"components/schemas/DebitMemoFromChargeDetailType","kind":"json-schema","title":"charges","data":{"allOf":[{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the debit memo item."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"double","type":"number"},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the debit memo item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the product rate plan charge."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"minLength":0,"type":"string"},"financeInformation":{"description":"Container for the finance information related to the product rate plan charge associated with the debit memo.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","maxLength":100,"minLength":0,"type":"string","nullable":true},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","maxLength":100,"minLength":0,"type":"string","nullable":true},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","maxLength":100,"minLength":0,"type":"string","nullable":true}},"type":"object"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the product rate plan charge that the debit memo is created from."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"quantity":{"description":"The number of units for the debit memo item.\n","format":"double","type":"number"},"serviceEndDate":{"description":"The service end date of the debit memo item. If not specified, the effective end date of the corresponding product rate plan will be used.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the debit memo item. If not specified, the effective start date of the corresponding product rate plan will be used.\n","format":"date","type":"string"}},"required":["productRatePlanChargeId"],"type":"object"},{"$ref":"#/components/schemas/DebitMemoItemObjectCustomFields"}],"title":"charges"}},"components/schemas/DebitMemoFromChargeCustomRatesType":{"id":"components/schemas/DebitMemoFromChargeCustomRatesType","kind":"json-schema","title":"customRates","data":{"allOf":[{"properties":{"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency code for either Reporting or Home currency."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"customFxRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Custom FX conversion rate between home currency and transactional currency items."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"decimal","type":"number"},"rateDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which a particular currency rate is fixed or obtained on."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["currency","customFxRate"],"type":"object"},{"$ref":"#/components/schemas/DebitMemoItemObjectCustomFields"}],"title":"customRates"}},"components/schemas/DebitMemoFromChargeRequest":{"id":"components/schemas/DebitMemoFromChargeRequest","kind":"json-schema","title":"memos","data":{"allOf":[{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the account associated with the debit memo."},"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":": When creating debit memos from product rate plan charges, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both in the request body. If both fields are specified, they must correspond to the same account."},"children":[]}]}]}],"type":"string"},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the account associated with the debit memo."},"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":": When creating debit memos from product rate plan charges, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both in the request body. If both fields are specified, they must correspond to the same account."},"children":[]}]}]}],"type":"string"},"autoPay":{"description":"Whether debit memos are automatically picked up for processing in the corresponding payment run. \n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"autoPost":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically post the debit memo after it is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you do not need to separately call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_PostDebitMemo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post a debit memo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to post the debit memo."},"children":[]}]}]}],"type":"boolean"},"charges":{"description":"Container for product rate plan charges. The maximum number of items is 1,000.\n","items":{"$ref":"#/components/schemas/DebitMemoFromChargeDetailType"},"maxItems":1000,"type":"array"},"comment":{"description":"Comments about the debit memo.\n","maxLength":255,"minLength":0,"type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code of a currency as defined in Billing Settings through the Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not specify a currency during debit memo creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"customRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both)."},"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":":"},"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 API custom rate feature is permission controlled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot set the custom rates, if both the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically include additional Currency Conversion information in data source exports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fx data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DebitMemo, DebitMemoItem, and DebitMemoItemTax will utilize the provided custom Fx rate to convert amounts from the transactional currency to the home currency."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/DebitMemoFromChargeCustomRatesType"},"maxItems":2,"type":"array"},"dueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for the debit memo is due, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"effectiveDate":{"description":"The date when the debit memo takes effect.\n","format":"date","type":"string"},"number":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customized debit memo number with the following format requirements:"},"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":"Max length: 32 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acceptable characters: a-z,A-Z,0-9,-,_"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be unique in the system, otherwise it may cause issues with bill runs and subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, Zuora will generate a unique number per the sequence set on the account level. If the account-level sequence set is not specified, the system default sequence set is used. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-config-of-prefix-and-number-for-billing-docs","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure prefix and numbering for billing documents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/DebitMemoObjectNSFields"},{"$ref":"#/components/schemas/DebitMemoObjectCustomFields"}],"example":{"accountId":"8ad09be48db5aba7018db604776d4854","charges":[{"amount":10,"productRatePlanChargeId":"8ad097b4909708e001909b41bb085d38"}]},"title":"memos"}},"components/schemas/GETDebitMemoType":{"id":"components/schemas/GETDebitMemoType","kind":"json-schema","title":"memos","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account associated with the debit memo.\n","type":"string"},"accountNumber":{"description":"The number of the customer account associated with the debit memo.       \n","type":"string"},"amount":{"description":"The total amount of the debit memo.\n","format":"double","type":"number"},"autoPay":{"description":"Whether debit memos are automatically picked up for processing in the corresponding payment run.\n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"balance":{"description":"The balance of the debit memo.\n","format":"double","type":"number"},"beAppliedAmount":{"description":"The amount that is applied to the debit memo.\n","format":"double","type":"number"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"billToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact snapshot associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if the bill rule "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-billing-rules-billing-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preserve snapshot of bill-to and sold-to contacts when billing documents are posted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is disabled."},"children":[]}]}]}],"type":"string","nullable":true},"cancelledById":{"description":"The ID of the Zuora user who cancelled the debit memo.\n","type":"string","nullable":true},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the debit memo."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the debit memo.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the debit memo.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"debitMemoDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the debit memo takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-05-20."},"children":[]}]}]}],"format":"date","type":"string"},"dueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for the debit memo is due, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"einvoiceErrorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceErrorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceFileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the e-invoice file generated for the debit memo."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string","nullable":true},"einvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the e-invoice file generation for the debit memo."},"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":"If e-invoice file generation succeeds, this field is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both the error code and message are empty, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eInvoiceFileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field stores the ID of the generated e-invoice file."},"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":"If the responses from tax vendors such as Sovos or Avalara are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taking too long, this field becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vendor responds successfully, you can use the 'Resync E-Invoice Status'"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action to update the status automatically.  You can view these updates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in System Health telemetry."},"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":"If a failure occurs during e-invoice file generation, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If e-invoice file generation conditionally succeeds, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConditionalSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If the e-invoice file has been approved by the tax authority, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The next status will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"If the e-invoice file has been rejected by the government, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot resend this e-invoice; you must create a new invoice instead."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled."},"children":[]}]}]}]}]}],"enum":["Processing","RetrieveTimeOut","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string","nullable":true},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the debit memo item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"id":{"description":"The unique ID of the debit memo.\n","type":"string"},"invoiceGroupNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice group associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"latestPDFFileId":{"description":"The ID of the latest PDF file generated for the debit memo.\n","type":"string","nullable":true},"number":{"description":"The unique identification number of the debit memo.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term assoicated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"postedById":{"description":"The ID of the Zuora user who posted the debit memo.\n","type":"string","nullable":true},"postedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo was posted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty.\n","type":"string"},"referredCreditMemoId":{"description":"The ID of the credit memo from which the debit memo was created.\n","type":"string","nullable":true},"referredInvoiceId":{"description":"The ID of a referred invoice.\n","type":"string","nullable":true},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the debit memo."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string","nullable":true},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the debit memo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"soldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the debit memo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"sourceType":{"description":"The type of the debit memo source.\n","enum":["Subscription","Standalone","Order","Consolidation","Invoice","CreditMemo"],"type":"string"},"status":{"description":"The status of the debit memo.\n","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the debit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-07-20."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxMessage":{"description":"The message about the status of tax calculation related to the debit memo. If tax calculation fails in one debit memo, this field displays the reason for the failure.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of tax calculation related to the debit memo."},"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 only applicable to tax calculation by third-party tax engines. Also, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side.  If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string","nullable":true},"totalTaxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"transferredToAccounting":{"description":"Whether the debit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.\n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the debit memo.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/DebitMemoObjectNSFields"},{"$ref":"#/components/schemas/DebitMemoObjectCustomFields"}],"title":"memos"}},"components/schemas/DebitTaxationItemObjectCustomFields":{"id":"components/schemas/DebitTaxationItemObjectCustomFields","kind":"json-schema","title":"debitTaxationItemFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Debit Taxation Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Debit Taxation Item object.\n","title":"debitTaxationItemFieldsCustom","type":"object"}},"components/schemas/PutDebitMemoTaxItemType":{"id":"components/schemas/PutDebitMemoTaxItemType","kind":"json-schema","title":"taxItems","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the taxation item in the debit memo item.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the taxation item in the debit memo item.\n","properties":{"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"id":{"description":"The ID of the taxation item in the debit memo item.\n","type":"string"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific debit memo.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the tax is applied to the debit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"taxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"taxName":{"description":"The name of taxation.\n","type":"string"},"taxRate":{"description":"The tax rate applied to the debit memo.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate applied to the debit memo.\n","enum":["Percentage","FlatFee"],"type":"string"}},"required":["id"],"type":"object"},{"$ref":"#/components/schemas/DebitTaxationItemObjectCustomFields"}],"title":"taxItems"}},"components/schemas/PUTDebitMemoItemType":{"id":"components/schemas/PUTDebitMemoItemType","kind":"json-schema","title":"items","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.\n","format":"double","type":"number"},"comment":{"description":"Comments about the debit memo item.\n","type":"string"},"delete":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to delete the existing debit memo item."},"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":": To delete a debit memo item, set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and specify a debit memo item ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the debit memo item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"financeInformation":{"description":"Container for the finance information related to the debit memo item.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","maxLength":100,"minLength":0,"type":"string"},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","maxLength":100,"minLength":0,"type":"string"},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the debit memo item."},"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":"Specify this field when updating or deleting an existing memo item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not specify this field when creating a memo item."},"children":[]}]}]}]}],"maxLength":32,"minLength":32,"type":"string"},"productRatePlanChargeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the product rate plan charge that the debit memo is created from."},"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":": Do not specify the debit memo item "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when specifying this field."},"children":[]}]}]}],"type":"string"},"quantity":{"description":"The number of units for the debit memo item.\n","format":"double","type":"number"},"serviceEndDate":{"description":"The service end date of the debit memo item.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the debit memo item. \n","format":"date","type":"string"},"skuName":{"description":"The name of the SKU.\n","type":"string"},"taxItems":{"description":"Container for debit memo taxation items.\n","items":{"$ref":"#/components/schemas/PutDebitMemoTaxItemType"},"type":"array"},"unitOfMeasure":{"description":"The definable unit that you measure when determining charges.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/DebitMemoItemObjectCustomFields"}],"title":"items"}},"components/schemas/PUTDebitMemoType":{"id":"components/schemas/PUTDebitMemoType","kind":"json-schema","title":"PUTDebitMemoType","data":{"allOf":[{"properties":{"autoPay":{"description":"Whether debit memos are automatically picked up for processing in the corresponding payment run. \n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"comment":{"description":"Comments about the debit memo.\n","maxLength":255,"minLength":0,"type":"string"},"dueDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for the debit memo is due, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"effectiveDate":{"description":"The date when the debit memo takes effect.\n","format":"date","type":"string"},"items":{"description":"Container for debit memo items.\n","items":{"$ref":"#/components/schemas/PUTDebitMemoItemType"},"type":"array"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code\n","type":"string"},"transferredToAccounting":{"description":"Whether the debit memo is transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/DebitMemoObjectNSFields"},{"$ref":"#/components/schemas/DebitMemoObjectCustomFields"}],"example":{"comment":"Details about this Debit Memo"}}},"components/schemas/PUTDebitMemoWithIdType":{"id":"components/schemas/PUTDebitMemoWithIdType","kind":"json-schema","title":"PUTDebitMemoWithIdType","data":{"allOf":[{"properties":{"id":{"description":"The ID of the debit memo.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PUTDebitMemoType"}]}},"components/schemas/PUTBulkDebitMemosRequestType":{"id":"components/schemas/PUTBulkDebitMemosRequestType","kind":"json-schema","title":"PUTBulkDebitMemosRequestType","data":{"allOf":[{"properties":{"memos":{"description":"The container for a list of debit memos. The maximum number of debit memos is 50.\n","items":{"$ref":"#/components/schemas/PUTDebitMemoWithIdType"},"maxItems":50,"title":"memos","type":"array"}},"type":"object"}],"example":{"memos":[{"autoPay":true,"comment":"new comment","dueDate":"2017-05-20","effectiveDate":"2017-04-17","id":"4028905f5a890526015a8db30954007a","items":[{"amount":1,"comment":"This is comment!","id":"402890555b797b57015b7986fc1a001c","quantity":1,"serviceEndDate":"2016-11-30","serviceStartDate":"2016-11-01","skuName":"SKU-1","taxItems":[{"amount":0.03,"id":"402890555b797b57015b7986fc3c001d","jurisdiction":"CALIFORNIA","locationCode":"06","taxCode":null,"taxCodeDescription":"This is tax code description!","taxDate":"2016-11-30","taxExemptAmount":0,"taxName":"STATE TAX1","taxRate":0.0625,"taxRateDescription":"This is tax rate description!","taxRateType":"Percentage"}],"unitOfMeasure":"Test_UOM"},{"amount":2,"comment":"This is comment!","id":"402890555b797b57015b7986fc41001e","serviceEndDate":"2016-11-30","serviceStartDate":"2016-11-01","skuName":"SKU-2","taxItems":[{"amount":0.06,"id":"402890555b797b57015b7986fc4c001f","jurisdiction":"CALIFORNIA","locationCode":"06","taxCode":null,"taxCodeDescription":"This is tax code description!","taxDate":"2016-11-30","taxExemptAmount":0,"taxName":"STATE TAX2","taxRate":0.0625,"taxRateDescription":"This is tax rate description!","taxRateType":"Percentage"}],"unitOfMeasure":"Test_UOM"}],"reasonCode":"Correcting invoice error"}]}}},"components/schemas/BulkDebitMemosResponseType":{"id":"components/schemas/BulkDebitMemosResponseType","kind":"json-schema","title":"BulkDebitMemosResponseType","data":{"allOf":[{"properties":{"memos":{"description":"The container for a list of debit memos.\n","items":{"$ref":"#/components/schemas/GETDebitMemoType"},"maxItems":50,"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/DebitMemoTaxItemFromInvoiceTaxItemType":{"id":"components/schemas/DebitMemoTaxItemFromInvoiceTaxItemType","kind":"json-schema","title":"taxItems","data":{"properties":{"amount":{"description":"The amount of the debit memo taxation item.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the source taxation item.\n","properties":{"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"sourceTaxItemId":{"description":"The ID of the source taxation item.\n","type":"string"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific debit memo.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the tax is applied to the debit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"taxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"taxName":{"description":"The name of taxation.\n","type":"string"},"taxRate":{"description":"The tax rate applied to the debit memo.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate applied to the debit memo.\n","enum":["Percentage","FlatFee"],"type":"string"}},"required":["amount"],"title":"taxItems","type":"object"}},"components/schemas/DebitMemoItemFromInvoiceItemType":{"id":"components/schemas/DebitMemoItemFromInvoiceItemType","kind":"json-schema","title":"items","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the debit memo item.\n","format":"double","type":"number"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the debit memo item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a later available version."},"children":[]}]}]}],"type":"string"},"financeInformation":{"description":"Container for the finance information related to the debit memo item.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","maxLength":100,"minLength":0,"type":"string"},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","maxLength":100,"minLength":0,"type":"string"},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"invoiceItemId":{"description":"The ID of the invoice item.\n","type":"string"},"quantity":{"description":"The number of units for the debit memo item.\n","format":"double","type":"number"},"serviceEndDate":{"description":"The service end date of the debit memo item.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the debit memo item. \n","format":"date","type":"string"},"skuName":{"description":"The name of the charge associated with the invoice.\n","type":"string"},"taxItems":{"description":"Container for taxation items.\n","items":{"$ref":"#/components/schemas/DebitMemoTaxItemFromInvoiceTaxItemType"},"type":"array"},"taxMode":{"default":"TaxExclusive","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax."},"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":": You can set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxInclusive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxAutoCalculation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxInclusive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you cannot input tax amounts for debit memo items. The corresponding invoice item must use the same tax engine as the debit memo item to calculate tax amounts."},"children":[]}]}]}],"enum":["TaxExclusive","TaxInclusive"],"type":"string"},"unitOfMeasure":{"description":"The definable unit that you measure when determining charges.\n","type":"string"}},"required":["skuName","amount"],"type":"object"},{"$ref":"#/components/schemas/DebitMemoItemObjectCustomFields"}],"title":"items"}},"components/schemas/DebitMemoFromInvoiceRequest":{"id":"components/schemas/DebitMemoFromInvoiceRequest","kind":"json-schema","title":"memos","data":{"allOf":[{"properties":{"autoPay":{"description":"Whether debit memos are automatically picked up for processing in the corresponding payment run. \nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"autoPost":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically post the debit memo after it is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you do not need to separately call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_PostDebitMemo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post debit memo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to post the debit memo."},"children":[]}]}]}],"type":"boolean"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the debit memo."},"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 available only if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled for your tenant."},"children":[]}]}]}],"type":"string"},"comment":{"description":"Comments about the debit memo. \n","maxLength":255,"minLength":0,"type":"string"},"effectiveDate":{"description":"The date when the debit memo takes effect.\n","format":"date","type":"string"},"invoiceId":{"description":"The ID of the invoice that the debit memo is created from.\n","type":"string"},"items":{"description":"Container for items. The maximum number of items is 1,000.\n","items":{"$ref":"#/components/schemas/DebitMemoItemFromInvoiceItemType"},"maxItems":1000,"type":"array"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n","type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the debit memo."},"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 available only if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled for your tenant."},"children":[]}]}]}],"type":"string"},"soldToSameAsBillTo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the sold-to contact and bill-to contact are the same entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The created debit memo has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:"},"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":"This field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"soldToContactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified."},"children":[]}]}]}]}],"type":"boolean"},"taxAutoCalculation":{"default":true,"description":"Whether to automatically calculate taxes in the debit memo.\n","type":"boolean"}},"type":"object","required":["invoiceId"]},{"$ref":"#/components/schemas/DebitMemoObjectNSFields"},{"$ref":"#/components/schemas/DebitMemoObjectCustomFields"}],"example":{"invoiceId":"8a90cc5c9301541f01930186636b1400","effectiveDate":"2024-11-11","items":[{"amount":10,"invoiceItemId":"8a90cc5c9301541f0193018663aa1413","skuName":"SKU-00000591"}],"reasonCode":"Correcting invoice error"},"title":"memos"}},"components/schemas/BulkCreateDebitMemosFromInvoiceRequest":{"id":"components/schemas/BulkCreateDebitMemosFromInvoiceRequest","kind":"json-schema","title":"BulkCreateDebitMemosFromInvoiceRequest","data":{"properties":{"sourceType":{"type":"string","enum":["Invoice"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the source where debit memos are created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This enum field has 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":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": By setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple debit memos from invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": By setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple debit memos from product rate plan charges."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific schema of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object field in the request body depends on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"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 view the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema applicable to debit memo creation from invoices, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the following drop-down list."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema applicable to debit memo creation from product rate plan charges, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the following drop-down list."},"children":[]}]}]}]}]},"memos":{"description":"The container for a list of debit memos. The maximum number of debit memos is 50.\n","items":{"$ref":"#/components/schemas/DebitMemoFromInvoiceRequest"},"maxItems":50,"type":"array"}},"required":["sourceType"],"type":"object"}},"components/schemas/BulkCreateDebitMemosFromChargeRequest":{"id":"components/schemas/BulkCreateDebitMemosFromChargeRequest","kind":"json-schema","title":"BulkCreateDebitMemosFromChargeRequest","data":{"properties":{"sourceType":{"type":"string","enum":["Standalone"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the source where debit memos are created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This enum field has 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":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": By setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple debit memos from invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": By setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can create multiple debit memos from product rate plan charges."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific schema of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object field in the request body depends on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"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 view the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema applicable to debit memo creation from invoices, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the following drop-down list."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema applicable to debit memo creation from product rate plan charges, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the following drop-down list."},"children":[]}]}]}]}]},"memos":{"description":"The container for a list of debit memos. The maximum number of debit memos is 50.\n","items":{"$ref":"#/components/schemas/DebitMemoFromChargeRequest"},"maxItems":50,"type":"array"}},"required":["sourceType"],"type":"object"}},"components/schemas/POSTBulkDebitMemosRequestType":{"id":"components/schemas/POSTBulkDebitMemosRequestType","kind":"json-schema","title":"POSTBulkDebitMemosRequestType","data":{"discriminator":{"propertyName":"sourceType","mapping":{"Invoice":"#/components/schemas/BulkCreateDebitMemosFromInvoiceRequest","Standalone":"#/components/schemas/BulkCreateDebitMemosFromChargeRequest"}},"oneOf":[{"$ref":"#/components/schemas/BulkCreateDebitMemosFromInvoiceRequest"},{"$ref":"#/components/schemas/BulkCreateDebitMemosFromChargeRequest"}]}},"components/schemas/GetDebitMemoPdfStatusResponse":{"id":"components/schemas/GetDebitMemoPdfStatusResponse","kind":"json-schema","title":"GetDebitMemoPdfStatusResponse","data":{"allOf":[{"properties":{"debitMemoId":{"description":"The ID of the debit memo whose pdf status is requested.\n","type":"string"},"debitMemoNumber":{"description":"The debit memo number of the debit memo whose pdf status is requested.\n","type":"string"},"pdfGenerationStatus":{"description":"The generation status of the debit memo PDF.\n","type":"string","enum":["None","Pending","Processing","Generated","Error","Obsolete"]},"createdOn":{"description":"The time at which the request to generate the PDF was created.\n","type":"string"},"updatedOn":{"description":"The time at which the request to generate the PDF was updated.\n","type":"string"},"pdfFileURL":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file path or the URL of the PDF when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"errorCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error category when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"errorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}]}},"components/schemas/GetDebitMemoPdfStatusBatchResponse":{"id":"components/schemas/GetDebitMemoPdfStatusBatchResponse","kind":"json-schema","title":"debitMemoFiles","data":{"description":"","example":{"debitMemoFiles":[{"debitMemoId":"402824aa8cc894d5018cc8a120576881","debitMemoNumber":"DM00000003","pdfGenerationStatus":"Generated","createdOn":"2024-01-01 11:32:19","updatedOn":"2024-01-01 11:32:19","pdfFileUrl":"/v1/files/2c98901f62d7d83d0162d7facea6262d"},{"debitMemoId":"2c98908a904dfc2601904e6e14090241","debitMemoNumber":"DM00000004","pdfGenerationStatus":"Error","createdOn":"2024-01-02 10:14:13","updatedOn":"2024-01-02 10:14:13","errorCode":"INVALID_TEMPLATE","errorMessage":"Unknown merge filed chargeNumber__c"},{"debitMemoId":"402824aa8cc894d5018cc8a120576881","debitMemoNumber":"DM00000005","pdfGenerationStatus":"Pending","createdOn":"2024-01-01 11:35:56","updatedOn":"2024-01-01 11:35:56"}],"success":true},"properties":{"debitMemoFiles":{"description":"Array of debit memo PDF statuses requested.\n","items":{"$ref":"#/components/schemas/GetDebitMemoPdfStatusResponse"},"type":"array"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object","title":"debitMemoFiles"}},"components/schemas/GetDebitMemoApplicationPartType":{"id":"components/schemas/GetDebitMemoApplicationPartType","kind":"json-schema","title":"applicationParts","data":{"properties":{"appliedAmount":{"description":"The amount that is applied to the debit memo.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the payment or credit memo.\n","format":"uuid","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment or credit memo was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-12-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of credit memo that is applied to the specified debit memo.\n","format":"uuid","type":"string","nullable":true},"paymentId":{"description":"The ID of the payment that is applied to the specified debit memo.\n","format":"uuid","type":"string","nullable":true},"updatedById":{"description":"The ID of the Zuora user who last updated the payment or credit memo.\n","format":"uuid","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment or credit memo was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2018-01-02 11:42:16."},"children":[]}]}]}],"type":"string"}},"title":"applicationParts","type":"object"}},"components/schemas/GetDebitMemoApplicationPartCollectionType":{"id":"components/schemas/GetDebitMemoApplicationPartCollectionType","kind":"json-schema","title":"GetDebitMemoApplicationPartCollectionType","data":{"properties":{"applicationParts":{"description":"Container for application parts.\n","items":{"$ref":"#/components/schemas/GetDebitMemoApplicationPartType"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETDMTaxItemTypeNew":{"id":"components/schemas/GETDMTaxItemTypeNew","kind":"json-schema","title":"data","data":{"allOf":[{"properties":{"balance":{"description":"The balance of the taxation item.\n","format":"double","type":"number"},"creditAmount":{"description":"The amount of credit memos applied to the debit memo. \n","format":"double","type":"number"},"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the taxation item.\n","properties":{"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","type":"string"},"salesTaxPayableAccountingCodeType":{"description":"The type of the accounting code for the sales taxes payable.\n","type":"string"}},"type":"object"},"id":{"description":"The ID of the taxation item.\n","type":"string"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"name":{"description":"The name of the taxation item.\n","type":"string"},"paymentAmount":{"description":"The amount of payments applied to the debit memo. \n","format":"double","type":"number"},"sourceTaxItemId":{"description":"The ID of the source taxation item.\n","type":"string","nullable":true},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific debit memo.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the tax is applied to the debit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"taxRate":{"description":"The tax rate applied to the debit memo.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate.\n","enum":["Percentage","FlatFee"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/DebitTaxationItemObjectCustomFields"}],"title":"data"}},"components/schemas/GETTaxationItemsOfDebitMemoItemType":{"id":"components/schemas/GETTaxationItemsOfDebitMemoItemType","kind":"json-schema","title":"GETTaxationItemsOfDebitMemoItemType","data":{"allOf":[{"properties":{"data":{"description":"Container for the taxation items of the debit memo item.\n","items":{"$ref":"#/components/schemas/GETDMTaxItemTypeNew"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/DebitMemoCollectRequest":{"id":"components/schemas/DebitMemoCollectRequest","kind":"json-schema","title":"DebitMemoCollectRequest","data":{"example":{"collect":true,"applyCredit":true},"properties":{"applicationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority order to apply credit memos and/or unapplied payments to the debit memo. Possible item values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UnappliedPayment"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"This field is valid only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyCredit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"CreditMemo\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only credit memos are used to apply the debit memo."},"children":[]}]}]}]}],"items":{"type":"string"},"type":"array"},"applyCredit":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply credit memos or unapplied payments, or both to the debit memo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the credit memo or unapplied payment, or both will be automatically applied to the debit memo. If no value is specified or the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no action is taken."},"children":[]}]}]}],"type":"boolean"},"collect":{"default":false,"description":"Indicates if the current request needs to collect payment or not.\n","type":"boolean"},"payment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some detail info that would be used to processed an electronic payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The info would only effect when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"gatewayId":{"description":"The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method.\nIf no gateway ID is specified in the request body, the default gateway for the customer account is used automatically, if this default one is not configured, the default gateway of the tenant would be used.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the payment.\nIf no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs.\n","type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/DebitMemoCollectResponseAppliedCreditMemos":{"id":"components/schemas/DebitMemoCollectResponseAppliedCreditMemos","kind":"json-schema","title":"DebitMemoCollectResponseAppliedCreditMemos","data":{"allOf":[{"properties":{"appliedAmount":{"description":"The applied amount of the credit memo to the debit memo.\n","format":"double","type":"number"},"id":{"description":"The unique ID of the credit memo.\n","type":"string"},"number":{"description":"The unique identification number of the credit memo.\n","type":"string"},"unappliedAmount":{"description":"The unapplied amount of the credit memo after applied to the debit memo.\n","format":"double","type":"number"}},"type":"object"}]}},"components/schemas/DebitMemoCollectResponseAppliedPayments":{"id":"components/schemas/DebitMemoCollectResponseAppliedPayments","kind":"json-schema","title":"DebitMemoCollectResponseAppliedPayments","data":{"allOf":[{"properties":{"appliedAmount":{"description":"The applied amount of the payment to the debit memo.\n","format":"double","type":"number"},"id":{"description":"The unique ID of the payment.\n","type":"string"},"number":{"description":"The unique identification number of the payment.\n","type":"string"},"unappliedAmount":{"description":"The unapplied amount of the payment after applied to the debit memo.\n","format":"double","type":"number"}},"type":"object"}]}},"components/schemas/DebitMemoCollectResponse":{"id":"components/schemas/DebitMemoCollectResponse","kind":"json-schema","title":"DebitMemoCollectResponse","data":{"allOf":[{"properties":{"appliedCreditMemos":{"description":"The information about which credit memo applied to the specific debit memo.\n","items":{"$ref":"#/components/schemas/DebitMemoCollectResponseAppliedCreditMemos"},"type":"array"},"appliedPayments":{"description":"The information about which payment applied to the specific debit memo.\n","items":{"$ref":"#/components/schemas/DebitMemoCollectResponseAppliedPayments"},"type":"array"},"debitMemo":{"description":"The information about the debit memo that just collected.\n","properties":{"id":{"description":"The unique ID of the debit memo.\n","type":"string"},"number":{"description":"The unique identification number of the debit memo.\n","type":"string"}},"type":"object"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"processedPayment":{"description":"The information about the payment that newly processed to the debit memo.\n","properties":{"amount":{"description":"The total amount of the payment.\n","format":"double","type":"number"},"gatewayId":{"description":"The ID of the gateway instance that processes the payment.\n","type":"string"},"gatewayResponse":{"description":"The message returned from the payment gateway for the payment. This message is gateway-dependent.\n","type":"string"},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the payment. This code is gateway-dependent.\n","type":"string"},"id":{"description":"The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.\n","type":"string"},"number":{"description":"The unique identification number of the payment. For example, P-00000001.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the payment.\n","type":"string"},"status":{"description":"The status of the payment.\n","enum":["Processing","Processed","Error","Canceled"],"type":"string"}},"type":"object"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}]}},"components/schemas/PostDebitMemoEmailType":{"id":"components/schemas/PostDebitMemoEmailType","kind":"json-schema","title":"PostDebitMemoEmailType","data":{"example":{"useEmailTemplateSetting":true},"properties":{"emailAddresses":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The valid email addresses you want to email a debit memo to. Use commas to separate email addresses."},"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 only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useEmailTemplateSetting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"includeAdditionalEmailAddresses":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to send a debit memo to the additional email addresses of the memo account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set the additional email addresses in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Email Addresses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on the account detail page from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-customer-account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Customer Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":[true,false],"type":"boolean"},"pdfFileId":{"description":"The ID of the PDF file that you want to send in the email. \n\nIf you do not specify any PDF file ID, the latest PDF file generated for the debit memo is sent in the email.\n","type":"string"},"useEmailTemplateSetting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to email a debit memo based on the email template setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the debit memo is sent to the email addresses specified in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To Email"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the email template. The email template is the one you set in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" panel of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog from the Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-create-email-template"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit Email Templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about how to edit the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To Email"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the email template."},"children":[]}]}]}],"enum":[true,false],"type":"boolean"}},"type":"object"}},"components/schemas/DebitMemoFile":{"id":"components/schemas/DebitMemoFile","kind":"json-schema","title":"debitMemoFile","data":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the debit memo PDF file. This is the ID for the file object and different from the file handle ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdfFileUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. To open a file, you have to use the file handle ID."},"children":[]}]}]}],"type":"string"},"pdfFileUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relative URL of the debit memo PDF file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can obtain the absolute URL for downloading the file by adding a prefix in the following format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{environment_base_url}/apps"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://apisandbox.zuora.com/apps/v1/files/2c98901f62d7d83d0162d7facea6262d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"versionNumber":{"description":"The version number of the debit memo PDF file.\n","format":"int64","type":"integer"}},"title":"debitMemoFile","type":"object"}},"components/schemas/GETDebitMemoFilesResponse":{"id":"components/schemas/GETDebitMemoFilesResponse","kind":"json-schema","title":"GETDebitMemoFilesResponse","data":{"properties":{"debitMemoFiles":{"description":"Container for debit memo PDF files.\n","items":{"$ref":"#/components/schemas/DebitMemoFile"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETDebitMemoItemTypewithSuccess":{"id":"components/schemas/GETDebitMemoItemTypewithSuccess","kind":"json-schema","title":"items","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.\n","format":"double","type":"number"},"amountWithoutTax":{"description":"The debit memo item amount excluding tax.\n","format":"double","type":"number"},"appliedToItemId":{"description":"The parent debit memo item that this debit memo items is applied to if this item is discount.\n","type":"string"},"balance":{"description":"The balance of the debit memo item.\n","format":"double","type":"number"},"beAppliedAmount":{"description":"The applied amount of the debit memo item.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the debit memo item.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo item was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the debit memo item."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the debit memo item from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"financeInformation":{"description":"Container for the finance information related to the debit memo item.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","type":"string"},"deferredRevenueAccountingCodeType":{"description":"The type of the deferred revenue accounting code, such as Deferred Revenue.\n","type":"string"},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","type":"string"},"recognizedRevenueAccountingCodeType":{"description":"The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n","type":"string"},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","type":"string"},"revenueScheduleNumber":{"description":"The revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, RS-00000001.\n","type":"string"}},"type":"object"},"id":{"description":"The ID of the debit memo item.\n","type":"string"},"processingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of the charge for the debit memo item. Its possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"quantity":{"description":"The number of units for the debit memo item.\n","format":"double","type":"number"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"serviceEndDate":{"description":"The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge.\n","format":"date","type":"string"},"sku":{"description":"The SKU for the product associated with the debit memo item.\n","type":"string"},"skuName":{"description":"The name of the SKU.\n","type":"string"},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the invoice item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the invoice item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string"},"soldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the invoice item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string"},"sourceItemId":{"description":"The ID of the source item.\n","type":"string"},"sourceItemType":{"description":"The type of the source item.\n","enum":["CreditMemoItem","SubscriptionComponent","InvoiceDetail","ProductRatePlanCharge"],"type":"string"},"subscriptionId":{"description":"The ID of the subscription associated with the debit memo item.\n","type":"string","nullable":true},"taxMode":{"description":"The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"taxationItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the taxation items of the debit memo item."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"239.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"data":{"description":"List of taxation items.\n","items":{"$ref":"#/components/schemas/GETDMTaxItemTypeNew"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"}},"type":"object"},"unitOfMeasure":{"description":"The units to measure usage.\n","type":"string"},"unitPrice":{"description":"The per-unit price of the debit memo item.\n","format":"double","type":"number"},"updatedById":{"description":"The ID of the Zuora user who last updated the debit memo item.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo item was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/DebitMemoItemObjectCustomFields"}],"title":"items"}},"components/schemas/GETDebitMemoItemCollectionType":{"id":"components/schemas/GETDebitMemoItemCollectionType","kind":"json-schema","title":"GETDebitMemoItemCollectionType","data":{"properties":{"items":{"description":"Container for debit memo items.\n","items":{"$ref":"#/components/schemas/GETDebitMemoItemTypewithSuccess"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETDebitMemoItemType":{"id":"components/schemas/GETDebitMemoItemType","kind":"json-schema","title":"GETDebitMemoItemType","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.\n","format":"double","type":"number"},"amountWithoutTax":{"description":"The debit memo item amount excluding tax.\n","format":"double","type":"number"},"appliedToItemId":{"description":"The parent debit memo item that this debit memo items is applied to if this item is discount.\n","type":"string"},"balance":{"description":"The balance of the debit memo item.\n","format":"double","type":"number"},"beAppliedAmount":{"description":"The applied amount of the debit memo item.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the debit memo item.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo item was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description about the debit memo item."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the debit memo item from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"financeInformation":{"description":"Container for the finance information related to the debit memo item.\n","properties":{"deferredRevenueAccountingCode":{"description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n","type":"string"},"deferredRevenueAccountingCodeType":{"description":"The type of the deferred revenue accounting code, such as Deferred Revenue.\n","type":"string"},"recognizedRevenueAccountingCode":{"description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n","type":"string"},"recognizedRevenueAccountingCodeType":{"description":"The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n","type":"string"},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","type":"string"},"revenueScheduleNumber":{"description":"The revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, RS-00000001.\n","type":"string"}},"type":"object"},"id":{"description":"The ID of the debit memo item.\n","type":"string"},"processingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of the charge for the debit memo item. Its possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"quantity":{"description":"The number of units for the debit memo item.\n","format":"double","type":"number"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"serviceEndDate":{"description":"The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge.\n","format":"date","type":"string"},"sku":{"description":"The SKU for the product associated with the debit memo item.\n","type":"string"},"skuName":{"description":"The name of the SKU.\n","type":"string"},"shipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the invoice item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the invoice item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string"},"soldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the invoice item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string"},"sourceItemId":{"description":"The ID of the source item.\n","type":"string"},"sourceItemType":{"description":"The type of the source item.\n","enum":["CreditMemoItem","SubscriptionComponent","InvoiceDetail","ProductRatePlanCharge"],"type":"string"},"subscriptionId":{"description":"The ID of the subscription associated with the debit memo item.\n","type":"string","nullable":true},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"taxMode":{"description":"The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"taxationItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the taxation items of the debit memo item."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"239.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"data":{"description":"List of taxation items.\n","items":{"$ref":"#/components/schemas/GETDMTaxItemTypeNew"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"}},"type":"object"},"unitOfMeasure":{"description":"The units to measure usage.\n","type":"string"},"unitPrice":{"description":"The per-unit price of the debit memo item.\n","format":"double","type":"number"},"updatedById":{"description":"The ID of the Zuora user who last updated the debit memo item.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the debit memo item was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/DebitMemoItemObjectCustomFields"}]}},"components/schemas/POSTTaxationItemForDMType":{"id":"components/schemas/POSTTaxationItemForDMType","kind":"json-schema","title":"taxationItems","data":{"allOf":[{"properties":{"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the taxation item.\n","properties":{"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"memoItemId":{"description":"The ID of the debit memo that the taxation item is created for.\n","type":"string"},"name":{"description":"The name of the taxation item.\n","type":"string"},"sourceTaxItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the taxation item of the invoice, which the debit memo is created from."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to use this REST API to create taxation items for a debit memo created from an invoice, the taxation items of the invoice must be created or imported through the SOAP API call."},"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":"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":"This field is only used if the debit memo is created from an invoice."},"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 contain this field in the request body, Zuora will automatically set a value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceTaxItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field based on the tax location code, tax jurisdiction, and tax rate."},"children":[]}]}]}]}],"type":"string"},"taxAmount":{"description":"The amount of the tax applied to the debit memo.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific debit memo.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":"The date when the tax is applied to the debit memo.\n","format":"date","type":"string"},"taxRate":{"description":"The tax rate applied to the debit memo.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate applied to the debit memo.\n","enum":["Percentage","FlatFee"],"type":"string"}},"required":["taxRate","jurisdiction","name","taxRateType","taxAmount"],"type":"object"},{"$ref":"#/components/schemas/TaxationItemObjectCustomFields"}],"title":"taxationItems"}},"components/schemas/POSTTaxationItemListForDMType":{"id":"components/schemas/POSTTaxationItemListForDMType","kind":"json-schema","title":"POSTTaxationItemListForDMType","data":{"example":{"taxationItems":[{"name":"STATE TAX","memoItemId":"8ad093f793300daf01933d50a548781f","jurisdiction":"CALIFORNIA","taxAmount":0.5,"taxCode":"ServiceTaxCode","taxDate":"2024-11-18","taxRate":0.05,"taxRateType":"Percentage"}]},"properties":{"taxationItems":{"description":"Container for taxation items.\n","items":{"$ref":"#/components/schemas/POSTTaxationItemForDMType"},"type":"array"}},"type":"object"}},"components/schemas/DebitMemoItemFromWriteOffInvoice":{"id":"components/schemas/DebitMemoItemFromWriteOffInvoice","kind":"json-schema","title":"items","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the credit memo item.\n","type":"string"},"amountWithoutTax":{"description":"The credit memo item amount excluding tax.\n","format":"double","type":"number"},"debitMemoItemId":{"description":"The ID of the debit memo item.\n","type":"string"},"serviceEndDate":{"description":"The service end date of the credit memo item. \n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the credit memo item. \n","format":"date","type":"string"},"skuName":{"description":"The name of the charge associated with the invoice.\n","type":"string"},"unitOfMeasure":{"description":"The definable unit that you measure when determining charges.\n","type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the credit memo item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"taxationItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the taxation items of the credit memo item."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"239.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"properties":{"amount":{"description":"The credit memo taxation amount.\n","type":"number"},"taxationItemId":{"description":"The Id of the debit memo item.\n","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoItemObjectCustomFields"}],"title":"items"}},"components/schemas/PUTWriteOffDebitMemoRequest":{"id":"components/schemas/PUTWriteOffDebitMemoRequest","kind":"json-schema","title":"PUTWriteOffDebitMemoRequest","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the write-off. The comment is used as the comment of the credit memo generated by writing off the specified invoice.\n","maxLength":255,"minLength":0,"type":"string"},"amount":{"description":"The write off amount of the invoice.\n","type":"number"},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice."},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exclude Billing Item From Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be automatically set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default for such non-revenue impacting write off credit memos, and this setting cannot be changed. This enhancement helps ensure that only revenue-impacting items are synchronized with Zuora Revenue, reducing unnecessary data processing."},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"nonRevenueWriteOffAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the accounting code for the non revenue write off. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no"},"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":"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 available only if you have enabled the enhanced write-off permission for your tenant. Contact "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.zuora.com/hc/en-us","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable this permission."},"children":[]}]}]}],"type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for items. This field is optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":" If specified, you must specify ALL the items of the invoice. The entire balance of the invoice will be written off, you cannot just write off some items of the invoice."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/DebitMemoItemFromWriteOffInvoice"},"type":"array"},"memoDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the credit memo was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The memo date must be later than or equal to the invoice date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is the date when you write off the invoice."},"children":[]}]}]}],"format":"date","type":"string"},"reasonCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Write-off"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/CreditMemoObjectCustomFields"},{"$ref":"#/components/schemas/CreditMemoObjectNSFields"}],"example":{"memoDate":"2019-01-02"},"type":"object"}},"components/schemas/PUTWriteOffDebitMemoResponse":{"id":"components/schemas/PUTWriteOffDebitMemoResponse","kind":"json-schema","title":"PUTWriteOffDebitMemoResponse","data":{"properties":{"creditMemo":{"description":"Container for the credit memo that is automatically generated when writing off invoices.\n","properties":{"id":{"description":"The ID of the credit memo that is created when the invoice is written off.\n","type":"string"}},"type":"object"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GetEInvoicingServiceProviderResponse":{"id":"components/schemas/GetEInvoicingServiceProviderResponse","kind":"json-schema","title":"GetEInvoicingServiceProviderResponse","data":{"allOf":[{"properties":{"companyIdentifier":{"description":"The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent.\n","type":"string"},"id":{"description":"The ID of the e-invoicing service provider.\n","type":"string"},"name":{"description":"The name of the e-invoicing service provider.\n","maxLength":100,"type":"string"},"provider":{"description":"The name of the e-invoicing service provider that can help you generate e-invoice files for billing documents.\n","enum":["Sovos","PEPPOL","Avalara"],"type":"string"},"serviceProviderNumber":{"description":"The unique number of the e-invoicing service provider.\n","type":"string"},"test":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the e-invoicing service provider's configuration is intended for testing."},"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 you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", requests are directed to the testing integration endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", requests are directed to the production integration endpoints."},"children":[]}]}]}]}],"type":"boolean"},"apiKey":{"description":"The API key is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos or Avalara service provider. \n","type":"string"},"use_certificate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to indicate whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientCertificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientCertificateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientCertificatePassord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields need to be supplied in the request."},"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":" If the flag is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the TLS endpoint config is enabled. If the flag is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the Non-TLS config endpoint is enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A TLS certificate and password are no longer required for integration with Sovos. Zuora now uses token-based authentication for all supported countries, including India."},"children":[]}]}]}],"type":"boolean","default":true},"clientCertificate":{"description":"The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format. This field only applies to the Sovos service provider. \n","type":"string","format":"byte"},"clientCertificateType":{"description":"The client certificate type is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos service provider. \n","type":"string","default":"PKCS12"}},"title":"serviceProviders","type":"object"}]}},"components/schemas/ListEInvoicingServiceProvidersResponse":{"id":"components/schemas/ListEInvoicingServiceProvidersResponse","kind":"json-schema","title":"ListEInvoicingServiceProvidersResponse","data":{"properties":{"serviceProviders":{"description":"Container for e-invoicing service providers.\n","items":{"$ref":"#/components/schemas/GetEInvoicingServiceProviderResponse"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/CreateEInvoicingServiceProviderRequest":{"id":"components/schemas/CreateEInvoicingServiceProviderRequest","kind":"json-schema","title":"CreateEInvoicingServiceProviderRequest","data":{"allOf":[{"properties":{"companyIdentifier":{"description":"The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent.\n","type":"string"},"name":{"description":"The name of the e-invoicing service provider.\n","maxLength":100,"type":"string"},"provider":{"description":"The name of the e-invoicing service provider that can help you generate e-invoice files for billing documents.\n","enum":["Sovos","PEPPOL","Avalara"],"type":"string"},"test":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the e-invoicing service provider's configuration is intended for testing."},"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 you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", requests are directed to the testing integration endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", requests are directed to the production integration endpoints."},"children":[]}]}]}]}],"type":"boolean"},"apiKey":{"description":"The API key is used to authenticate the e-invoicing service provider's requests. This field is required for configuring Sovos or Avalara as the service provider.\n","type":"string"},"secretKey":{"description":"The secret key is used to authenticate the e-invoicing service provider's requests. This field is required for configuring Sovos or Avalara as the service provider.\n","type":"string"},"use_certificate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to indicate whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientCertificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientCertificateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientCertificatePassord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields need to be supplied in the request."},"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":" If the flag is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the TLS endpoint config is enabled. If the flag is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the Non-TLS config endpoint is enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A TLS certificate and password are no longer required for integration with Sovos. Zuora now uses token-based authentication for all supported countries, including India."},"children":[]}]}]}],"type":"boolean","default":true},"clientCertificate":{"description":"The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format. This field is required for configuring Sovos as the service provider.\n","type":"string","format":"byte"},"clientCertificateType":{"description":"The client certificate type is used to specify the type of the client certificate. This field is required for configuring Sovos as the service provider.\n","type":"string","default":"PKCS12"},"clientCertificatePassword":{"description":"The client certificate password is the password to protect the client certificate. This field is required for configuring Sovos as the service provider.\n","type":"string","format":"password"}},"required":["name","provider"],"type":"object"}],"example":{"name":"Sovos e-invoice service","provider":"Sovos","test":false,"companyIdentifier":"CompanySample1","apiKey":"ApiKeySample","secretKey":"SecretKey","use_certificate":false,"clientCertificate":"U3dhZ2dlciByb2Nrcw==","clientCertificateType":"PKCS12","clientCertificatePassword":"ClientCertificatePassword"}}},"components/schemas/UpdateEInvoicingServiceProviderRequest":{"id":"components/schemas/UpdateEInvoicingServiceProviderRequest","kind":"json-schema","title":"UpdateEInvoicingServiceProviderRequest","data":{"allOf":[{"properties":{"companyIdentifier":{"description":"The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent.\n","type":"string"},"name":{"description":"The name of the e-invoicing service provider.\n","maxLength":100,"type":"string"},"test":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the e-invoicing service provider's configuration is intended for testing."},"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 you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", requests are directed to the testing integration endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", requests are directed to the production integration endpoints."},"children":[]}]}]}]}],"type":"boolean"},"apiKey":{"description":"The API key is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos or Avalara service provider. \n","type":"string"},"secretKey":{"description":"The secret key is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos or Avalara service provider. \n","type":"string"},"use_certificate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to indicate whether the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"clientCertificate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientCertificateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientCertificatePassord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields need to be supplied in the request."},"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":" If the flag is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the TLS endpoint config is enabled. If the flag is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the Non-TLS config endpoint is enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A TLS certificate and password are no longer required for integration with Sovos. Zuora now uses token-based authentication for all supported countries, including India."},"children":[]}]}]}],"type":"boolean","default":true},"clientCertificate":{"description":"The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format. This field only applies to the Sovos service provider. \n","type":"string","format":"byte"},"clientCertificateType":{"description":"The client certificate type is used to specify the type of the client certificate. This field only applies to the Sovos service provider. \n","type":"string","default":"PKCS12"},"clientCertificatePassword":{"description":"The client certificate password is the password to protect the client certificate. This field only applies to the Sovos service provider. \n","type":"string","format":"password"}},"type":"object"}],"example":{"name":"Sovos e-invoice service","test":false,"companyIdentifier":"CompanySample1","apiKey":"ApiKeySample","secretKey":"SecretKey","use_certificate":false,"clientCertificate":"U3dhZ2dlciByb2Nrcw==","clientCertificateType":"PKCS12","clientCertificatePassword":"ClientCertificatePassword"}}},"components/schemas/InvoiceFiltersCondition":{"id":"components/schemas/InvoiceFiltersCondition","kind":"json-schema","title":"InvoiceFiltersCondition","data":{"allOf":[{"description":"Container for condition information about the invoice filters.","properties":{"conditions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are combined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields. These "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields form a custom filter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is a formula combined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/InvoiceFiltersCondition"}},"field":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field name of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"operator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operator of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field.  The operator is added between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"eq: equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"neq: not equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" != "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"gt: greater than ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lt: less than ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" < "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"gte: greater than or equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lte: less than or equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lk: like ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"in: in ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the values are separated by comma)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nl: null ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nnl: not null ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not null)"},"children":[]}]}]}]}],"type":"string","enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"]},"relation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relation among the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"type":"string","enum":["and","or"]},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"objectType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target object type of the condition when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FilterCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["Invoice","InvoiceItem"]}},"type":"object","title":"Condition"}]}},"components/schemas/InvoiceFiltersResponseType":{"id":"components/schemas/InvoiceFiltersResponseType","kind":"json-schema","title":"InvoiceFilters","data":{"allOf":[{"properties":{"condition":{"$ref":"#/components/schemas/InvoiceFiltersCondition"}},"type":"object"}],"title":"InvoiceFilters"}},"components/schemas/CreditMemoFiltersCondition":{"id":"components/schemas/CreditMemoFiltersCondition","kind":"json-schema","title":"CreditMemoFiltersCondition","data":{"allOf":[{"description":"Container for condition information about the credit memo filters.","properties":{"conditions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are combined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields. These "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields form a custom filter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is a formula combined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/CreditMemoFiltersCondition"}},"field":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field name of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"operator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operator of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field.  The operator is added between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"eq: equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"neq: not equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" != "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"gt: greater than ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lt: less than ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" < "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"gte: greater than or equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lte: less than or equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lk: like ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"in: in ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the values are separated by comma)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nl: null ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nnl: not null ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not null)"},"children":[]}]}]}]}],"type":"string","enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"]},"relation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relation among the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"type":"string","enum":["and","or"]},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"objectType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target object type of the condition when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FilterCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["CreditMemo","CreditMemoItem"]}},"type":"object","title":"Condition"}]}},"components/schemas/CreditMemoFiltersResponseType":{"id":"components/schemas/CreditMemoFiltersResponseType","kind":"json-schema","title":"CreditMemoFilters","data":{"allOf":[{"properties":{"condition":{"$ref":"#/components/schemas/CreditMemoFiltersCondition"}},"type":"object"}],"title":"CreditMemoFilters"}},"components/schemas/DebitMemoFiltersCondition":{"id":"components/schemas/DebitMemoFiltersCondition","kind":"json-schema","title":"DebitMemoFiltersCondition","data":{"allOf":[{"description":"Container for condition information about the debit memo filters.","properties":{"conditions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are combined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields. These "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields form a custom filter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is a formula combined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/DebitMemoFiltersCondition"}},"field":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field name of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"operator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operator of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field.  The operator is added between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"eq: equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"neq: not equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" != "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"gt: greater than ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lt: less than ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" < "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"gte: greater than or equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lte: less than or equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lk: like ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"in: in ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the values are separated by comma)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nl: null ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nnl: not null ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not null)"},"children":[]}]}]}]}],"type":"string","enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"]},"relation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relation among the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"type":"string","enum":["and","or"]},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"objectType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target object type of the condition when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FilterCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["DebitMemo","DebitMemoItem"]}},"type":"object","title":"Condition"}]}},"components/schemas/DebitMemoFiltersResponseType":{"id":"components/schemas/DebitMemoFiltersResponseType","kind":"json-schema","title":"DebitMemoFilters","data":{"allOf":[{"properties":{"condition":{"$ref":"#/components/schemas/DebitMemoFiltersCondition"}},"type":"object"}],"title":"DebitMemoFilters"}},"components/schemas/GetEInvoicingBusinessRegionResponse":{"id":"components/schemas/GetEInvoicingBusinessRegionResponse","kind":"json-schema","title":"GetEInvoicingBusinessRegionResponse","data":{"allOf":[{"properties":{"id":{"description":"The unique ID of the e-invoicing business region.\n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The short name of a country or region where you must comply with e-invoicing requirements. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for India. For the full list of country names and codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"businessName":{"description":"The full official name that the Seller is registered with the relevant legal authority.\n","maxLength":255,"type":"string"},"businessNumber":{"description":"The specify the unique identifier number of the legal entity or person that you do business with.\n\nFor example, you must use a GSTIN for India and Tax Identification Number (TIN) for Saudi Arabia.\n","type":"string"},"businessNumberSchemaId":{"description":"The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.\n","type":"string"},"tradeName":{"description":"The name that the Seller is known as, other than the legal business name.\n","maxLength":100,"type":"string","nullable":true},"endpointId":{"description":"The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered.\n","type":"string"},"endpointSchemeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification scheme identifier of the Seller’s electronic address."},"children":[]}]}]}],"type":"string"},"taxRegisterNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller’s address) of the Seller for tax purposes, or a reference that enables the Seller to state the registered tax status."},"children":[]}]}]}],"type":"string","nullable":true},"state":{"description":"The name of the state or province where the business is located.\n","type":"string","nullable":true},"city":{"description":"The the name of the city where the business is located.\n","type":"string"},"postalCode":{"description":"The short code that can identify the business address.\n","type":"string"},"addressLine1":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the Seller’s address, which is often a street address or business name."},"children":[]}]}]}],"type":"string","nullable":true},"addressLine2":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second line of the Seller’s address, which is often the name of a building."},"children":[]}]}]}],"type":"string","nullable":true},"contactName":{"description":"The name of the Seller contact to receive e-invoicing data.\n","maxLength":255,"type":"string","nullable":true},"phoneNumber":{"description":"The business phone number of the Seller contact to receive e-invoicing data.\n","type":"string","nullable":true},"email":{"description":"The email address of the Seller contact to receive e-invoicing data.\n","type":"string","nullable":true},"serviceProviderId":{"description":"The unique ID of the e-invoicing service provider that is associated to the business region.\n","type":"string"},"businessRegionNumber":{"description":"The unique number of the e-invoicing business region.\n","type":"string"},"digitalSignatureEnable":{"description":"Whether the e-invoicing service provider signs PDF files for billing documents.\n","default":false,"type":"boolean"},"digitalSignatureBoxEnable":{"description":"Whether the digital signature box is displayed on PDF files for billing documents.\n","default":false,"type":"boolean"},"digitalSignatureBoxPosX":{"description":"The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.\n","type":"number","minimum":0},"digitalSignatureBoxPosY":{"description":"The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. \n","type":"number","minimum":0},"responseMapping":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for e-invoicing response field mappings that map values from the e-invoicing service provider’s response data to fields on the EInvoiceData object in Zuora. Each response field mapping consists of a field name and a field path."},"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 applicable only to the Sovos or Avalara service provider."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure e-invoicing response field mappings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","title":"responseMapping","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response field mapping consists of a key-value pair:"},"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":"Field name: the name of the field on the EInvoiceData object (except for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EInvoiceFile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, which applies only to Sovos). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora supports the following field names. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Supported_response_fields","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported response fields"},"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":"code","inline":true,"attributes":{"content":"AuthorizationCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EInvoiceFile"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QrCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReferenceNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field10"},"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":"Field value: the path of an XML node in the e-invoicing response data from Sovos. The value of this field must be compliant with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.w3schools.com/xml/xpath_intro.asp","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"XPath"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Field_path_format","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field path format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}},"processType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The process type of the e-invoicing business region."},"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 service provider is Sovos, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ClearanceWithCancellation"},"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 service provider is Avalara, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEPPOLNetwork"},"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 service provider is PEPPOL, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string","enum":["Clearance","ClearanceWithCancellation","PEPPOLNetwork","Unknown"]},"invoiceEnabled":{"description":"It will control whether the invoice should be supported by the process type or not. This field is available when the service provider is Sovos or Avalara.\n","type":"boolean","default":false},"creditMemoEnabled":{"description":"It will control whether the credit memo should be supported by the process type or not. This field is available when the service provider is Sovos or Avalara.\n","type":"boolean","default":false},"debitMemoEnabled":{"description":"It will control whether the debit memo should be supported by the process type or not. This field is available when the service provider is Sovos or Avalara.\n","type":"boolean","default":false},"invoiceFilters":{"description":"The documents belonging to the e-invoicing business region. \n","items":{"$ref":"#/components/schemas/InvoiceFiltersResponseType"},"type":"array","nullable":true},"creditMemoFilters":{"description":"The documents belonging to the e-invoicing business region. \n","items":{"$ref":"#/components/schemas/CreditMemoFiltersResponseType"},"type":"array","nullable":true},"debitMemoFilters":{"description":"The documents belonging to the e-invoicing business region. \n","items":{"$ref":"#/components/schemas/DebitMemoFiltersResponseType"},"type":"array","nullable":true},"fileFormat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file format for each business category. An example response is \"[ \"application/xml\", \"application/vnd.oasis.ubl+xml\" ]\""},"children":[]}]}]}],"type":"array","nullable":true,"items":{"type":"string"}},"success":{"description":"Indicats if the request succeeds.\n","type":"boolean"}},"title":"regions","type":"object"}]}},"components/schemas/ListEInvoicingBusinessRegionsResponse":{"id":"components/schemas/ListEInvoicingBusinessRegionsResponse","kind":"json-schema","title":"ListEInvoicingBusinessRegionsResponse","data":{"properties":{"regions":{"description":"Container for e-invoicing business regions.\n","items":{"$ref":"#/components/schemas/GetEInvoicingBusinessRegionResponse"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/InvoiceFiltersRequestType":{"id":"components/schemas/InvoiceFiltersRequestType","kind":"json-schema","title":"InvoiceFilters","data":{"allOf":[{"properties":{"condition":{"$ref":"#/components/schemas/InvoiceFiltersCondition"}},"required":["filterType"],"type":"object"}],"title":"InvoiceFilters"}},"components/schemas/CreditMemoFiltersRequestType":{"id":"components/schemas/CreditMemoFiltersRequestType","kind":"json-schema","title":"CreditMemoFilters","data":{"allOf":[{"properties":{"condition":{"$ref":"#/components/schemas/CreditMemoFiltersCondition"}},"required":["filterType"],"type":"object"}],"title":"CreditMemoFilters"}},"components/schemas/DebitMemoFiltersRequestType":{"id":"components/schemas/DebitMemoFiltersRequestType","kind":"json-schema","title":"DebitMemoFilters","data":{"allOf":[{"properties":{"condition":{"$ref":"#/components/schemas/DebitMemoFiltersCondition"}},"required":["filterType"],"type":"object"}],"title":"DebitMemoFilters"}},"components/schemas/CreateEInvoicingBusinessRegionRequest":{"id":"components/schemas/CreateEInvoicingBusinessRegionRequest","kind":"json-schema","title":"CreateEInvoicingBusinessRegionRequest","data":{"allOf":[{"properties":{"addressLine1":{"description":"The first line of the Seller's address, which is often a street address or business name.\n","type":"string"},"addressLine2":{"description":"The second line of the Seller's address, which is often the name of a building.\n","type":"string"},"businessName":{"description":"The full official name that the Seller is registered with the relevant legal authority.\n","maxLength":255,"type":"string"},"businessNumber":{"description":"The specify the unique identifier number of the legal entity or person that you do business with.\n\nFor example, you must use a GSTIN for India and Tax Identification Number (TIN) for Saudi Arabia.\n","type":"string"},"businessNumberSchemaId":{"description":"The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.\n","type":"string"},"city":{"description":"The the name of the city where the business is located.\n","type":"string"},"contactName":{"description":"The name of the Seller contact to receive e-invoicing data.\n","maxLength":255,"type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The short name of a country or region where you must comply with e-invoicing requirements. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for India. For the full list of country names and codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"digitalSignatureEnable":{"description":"Whether the e-invoicing service provider signs PDF files for billing documents.\n","default":false,"type":"boolean"},"digitalSignatureBoxEnable":{"description":"Whether the digital signature box is displayed on PDF files for billing documents.\n","default":false,"type":"boolean"},"digitalSignatureBoxPosX":{"description":"The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.\n","type":"number","minimum":0},"digitalSignatureBoxPosY":{"description":"The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. \n","type":"number","minimum":0},"email":{"description":"The email address of the Seller contact to receive e-invoicing data.\n","type":"string"},"endpointId":{"description":"The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered.\n","type":"string"},"endpointSchemeId":{"description":"The identification scheme identifier of the Seller's electronic address.\n","type":"string"},"phoneNumber":{"description":"The business phone number of the Seller contact to receive e-invoicing data.\n","type":"string"},"postalCode":{"description":"The short code that can identify the business address.\n","type":"string"},"responseMapping":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for e-invoicing response field mappings that map values from the e-invoicing service provider's response data to fields on the EInvoiceData object in Zuora. Each response field mapping consists of a field name and a field path."},"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 applicable only to the Sovos or Avalara service provider."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure e-invoicing response field mappings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","title":"responseMapping","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response field mapping consists of a key-value pair:"},"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":"Field name: the name of the field on the EInvoiceData object (except for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EInvoiceFile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, which applies only to Sovos). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora supports the following field names. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Supported_response_fields","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported response fields"},"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":"code","inline":true,"attributes":{"content":"AuthorizationCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EInvoiceFile"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QrCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReferenceNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field10"},"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":"Field value: the path of an XML node in the e-invoicing response data from Sovos. The value of this field must be compliant with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.w3schools.com/xml/xpath_intro.asp","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"XPath"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Field_path_format","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field path format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}},"processType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The process type of the e-invoicing business region."},"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 service provider is Sovos, specify the process type as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ClearanceWithCancellation"},"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 service provider is Avalara, specify the process type as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEPPOLNetwork"},"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 service provider is PEPPOL, leave this field empty."},"children":[]}]}]}]}],"type":"string","enum":["Clearance","ClearanceWithCancellation","PEPPOLNetwork"]},"invoiceEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field controls whether the invoice should be supported by the process type or not. For some countries, this field is required to be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage country-specific configurations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"creditMemoEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field controls whether the credit memo should be supported by the process type or not. For some countries, this field is required to be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage country-specific configurations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"debitMemoEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field controls whether the debit memo should be supported by the process type or not. For some countries, this field is required to be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage country-specific configurations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"invoiceFilters":{"description":"The documents belonging to the e-invoicing business region. \n","items":{"$ref":"#/components/schemas/InvoiceFiltersRequestType"},"type":"array"},"creditMemoFilters":{"description":"The documents belonging to the e-invoicing business region. \n","items":{"$ref":"#/components/schemas/CreditMemoFiltersRequestType"},"type":"array"},"debitMemoFilters":{"description":"The documents belonging to the e-invoicing business region. \n","items":{"$ref":"#/components/schemas/DebitMemoFiltersRequestType"},"type":"array"},"serviceProviderId":{"description":"The unique ID of the e-invoicing service provider that is associated to the business region.\n","type":"string"},"state":{"description":"The name of the state or province where the business is located.\n","type":"string"},"taxRegisterNumber":{"description":"The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller's address) of the Seller for tax purposes, or a reference that enables the Seller to state the registered tax status.\n","type":"string"},"tradeName":{"description":"The name that the Seller is known as, other than the legal business name.\n","maxLength":100,"type":"string"},"fileFormat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can define the file format for each business category as shown in the following example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fileFormat\" : {"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"B2B\" : [ \"XML\" ],"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"B2C\" : [ ],"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"B2G\" : [ \"XML\" ]"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"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":"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 optional; however, if you use Avalara integration, it becomes a mandatory field."},"children":[]}]}]}],"type":"array","items":{"type":"string"}}},"required":["country","businessName"],"type":"object"}],"example":{"addressLine1":null,"addressLine2":null,"businessName":"legal business name","businessNumber":"20002039","businessNumberSchemaId":"88","city":"Tokyo","contactName":null,"country":"JP","email":null,"endpointId":"8992","endpointSchemeId":"88","invoiceFilters":[{"objectType":"Invoice","condition":{"field":"SoldToContact.Country","operator":"eq","value":"India"}}],"phoneNumber":null,"postalCode":"368779","serviceProviderId":"4028948972a2bf990172bc9b27724ddc","state":null,"taxRegisterNumber":"TAX393999","tradeName":"Zuora","fileFormat":{"B2B":["XML"],"B2C":[""],"B2G":["XML"]}}}},"components/schemas/UpdateEInvoicingBusinessRegionRequest":{"id":"components/schemas/UpdateEInvoicingBusinessRegionRequest","kind":"json-schema","title":"UpdateEInvoicingBusinessRegionRequest","data":{"allOf":[{"properties":{"addressLine1":{"description":"The first line of the Seller's address, which is often a street address or business name.\n","type":"string"},"addressLine2":{"description":"The second line of the Seller's address, which is often the name of a building.\n","type":"string"},"businessName":{"description":"The full official name that the Seller is registered with the relevant legal authority.\n","maxLength":255,"type":"string"},"businessNumber":{"description":"The specify the unique identifier number of the legal entity or person that you do business with.\n\nFor example, you must use a GSTIN for India and Tax Identification Number (TIN) for Saudi Arabia.\n","type":"string"},"businessNumberSchemaId":{"description":"The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.\n","type":"string"},"city":{"description":"The the name of the city where the business is located.\n","type":"string"},"contactName":{"description":"The name of the Seller contact to receive e-invoicing data.\n","maxLength":255,"type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The short name of a country or region where you must comply with e-invoicing requirements. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for India. For the full list of country names and codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"digitalSignatureEnable":{"description":"Whether the e-invoicing service provider signs PDF files for billing documents.\n","default":false,"type":"boolean"},"digitalSignatureBoxEnable":{"description":"Whether the digital signature box is displayed on PDF files for billing documents.\n","default":false,"type":"boolean"},"digitalSignatureBoxPosX":{"description":"The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.\n","type":"number","minimum":0},"digitalSignatureBoxPosY":{"description":"The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. \n","type":"number","minimum":0},"email":{"description":"The email address of the Seller contact to receive e-invoicing data.\n","type":"string"},"endpointId":{"description":"The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered.\n","type":"string"},"endpointSchemeId":{"description":"The identification scheme identifier of the Seller's electronic address.\n","type":"string"},"phoneNumber":{"description":"The business phone number of the Seller contact to receive e-invoicing data.\n","type":"string"},"postalCode":{"description":"The short code that can identify the business address.\n","type":"string"},"responseMapping":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for e-invoicing response field mappings that map values from Sovos response data to fields on the EInvoiceData object in Zuora. Each response field mapping consists of a field name and a field path."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this field is applicable only to the Sovos service provider."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure e-invoicing response field mappings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","title":"responseMapping","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response field mapping consists of a key-value pair:"},"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":"Field name: the name of the field on the EInvoiceData object (except for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EInvoiceFile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora supports the following field names. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Supported_response_fields","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported response fields"},"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":"code","inline":true,"attributes":{"content":"AuthorizationCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EInvoiceFile"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QrCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReferenceNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field10"},"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":"Field value: the path of an XML node in the e-invoicing response data from Sovos. The value of this field must be compliant with the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.w3schools.com/xml/xpath_intro.asp","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"XPath"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Field_path_format","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field path format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}},"processType":{"description":"The process type of the e-invoicing business region.\n","type":"string","enum":["Clearance","Cancellation","PostAudit","PEPPOL"]},"invoiceEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field controls whether the invoice should be supported by the process type or not. For some countries, this field is required to be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage country-specific configurations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"creditMemoEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field controls whether the credit memo should be supported by the process type or not. For some countries, this field is required to be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage country-specific configurations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"debitMemoEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field controls whether the debit memo should be supported by the process type or not. For some countries, this field is required to be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage country-specific configurations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"invoiceFilters":{"description":"The documents belonging to the e-invoicing business region. \n","items":{"$ref":"#/components/schemas/InvoiceFiltersRequestType"},"type":"array"},"creditMemoFilters":{"description":"The documents belonging to the e-invoicing business region. \n","items":{"$ref":"#/components/schemas/CreditMemoFiltersRequestType"},"type":"array"},"debitMemoFilters":{"description":"The documents belonging to the e-invoicing business region. \n","items":{"$ref":"#/components/schemas/DebitMemoFiltersRequestType"},"type":"array"},"serviceProviderId":{"description":"The unique ID of the e-invoicing service provider that is associated to the business region.\n","type":"string"},"state":{"description":"The name of the state or province where the business is located.\n","type":"string"},"taxRegisterNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller’s address) of the Seller for tax purposes, or a reference that enables the Seller to state the registered tax status."},"children":[]}]}]}],"type":"string"},"tradeName":{"description":"The name that the Seller is known as, other than the legal business name.\n","maxLength":100,"type":"string"},"fileFormat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can define the file format for each business category as shwown in the following example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fileFormat\" : {"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"B2B\" : [ \"XML\" ],"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"B2C\" : [ ],"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"B2G\" : [ \"XML\" ]"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"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":"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 optional; however, if you use Avalara integration, it becomes a mandatory field."},"children":[]}]}]}],"type":"array","items":{"type":"string"}}},"type":"object"}],"example":{"addressLine1":null,"addressLine2":null,"businessName":"legal business name","businessNumber\"":"20002039","businessNumberSchemaId":"88","city":"Tokyo","contactName":null,"country":"JP","email":null,"endpointId":"8992","endpointSchemeId":"88","phoneNumber":null,"postalCode":"368779","serviceProviderId":"4028948972a2bf990172bc9b27724ddc","state":null,"taxRegisterNumber":"TAX393999","tradeName":"Zuora","fileFormat":{"B2B":["XML"],"B2C":[""],"B2G":["XML"]}}}},"components/schemas/GETEinvoiceFetchMandates":{"id":"components/schemas/GETEinvoiceFetchMandates","kind":"json-schema","title":"GETEinvoiceFetchMandates","data":{"allOf":[{"properties":{"countryCode":{"description":"2-digit country code. \n","type":"string","nullable":false},"fileFormats":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following mapping will be used for user representation of file formats:"},"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":"XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OASIS_Universal_Business_Language_XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.oasis.ubl+xml"},"children":[]}]}]}]}],"type":"array","items":{"type":"string"},"nullable":false},"category":{"description":"The business categories that Zuora supports for customer accounts. Supported values are B2B, B2C, or B2G.\n","type":"string","enum":["B2B","B2C","B2G"]},"processType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The process type of the e-invoicing business region."},"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 service provider is Sovos, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ClearanceWithCancellation"},"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 service provider is Avalara, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEPPOLNetwork"},"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 service provider is PEPPOL, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Clearance","ClearanceWithCancellation","PEPPOLNetwork","Unknown"],"type":"string"},"defaultFileFormats":{"description":"The default file format.\n","type":"string"}}}]}},"components/schemas/GETEinvoiceFetchMandatesErrorsReasons":{"id":"components/schemas/GETEinvoiceFetchMandatesErrorsReasons","kind":"json-schema","title":"GETEinvoiceFetchMandatesErrorsReasons","data":{"allOf":[{"properties":{"code":{"description":"Code for the validation error.\n","type":"string"},"message":{"description":"Validation error message.\n","type":"string"}}}]}},"components/schemas/GETEinvoiceFetchMandatesErrors":{"id":"components/schemas/GETEinvoiceFetchMandatesErrors","kind":"json-schema","title":"GETEinvoiceFetchMandatesErrors","data":{"allOf":[{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was not processed successfully."},"children":[]}]}]}],"type":"boolean"},"processId":{"description":"Process Id of the validation error.\n","type":"string"},"reasons":{"description":"Container for error reasons.\n","items":{"$ref":"#/components/schemas/GETEinvoiceFetchMandatesErrorsReasons"}},"requestId":{"description":"Request Id for the validation error.\n","type":"string"}}}]}},"components/schemas/EinvoiceFetchMandates":{"id":"components/schemas/EinvoiceFetchMandates","kind":"json-schema","title":"EinvoiceFetchMandates","data":{"properties":{"data":{"description":"Container for fetching mandates.\n","items":{"$ref":"#/components/schemas/GETEinvoiceFetchMandates"},"type":"array"},"error":{"description":"Container for fetching validation errors.\n","items":{"$ref":"#/components/schemas/GETEinvoiceFetchMandatesErrors"},"type":"array"}},"type":"object"}},"components/schemas/GETEinvoiceInvoiceFetchMandate":{"id":"components/schemas/GETEinvoiceInvoiceFetchMandate","kind":"json-schema","title":"GETEinvoiceInvoiceFetchMandate","data":{"allOf":[{"properties":{"countryCode":{"description":"2-digit country code. \n","type":"string","nullable":false},"fileFormats":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following mapping will be used for user representation of file formats:"},"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":"XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OASIS_Universal_Business_Language_XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.oasis.ubl+xml"},"children":[]}]}]}]}],"type":"array","items":{"type":"string"},"nullable":false},"category":{"description":"The business categories that Zuora supports for customer accounts. Supported values are B2B, B2C, or B2G.\n","type":"string","enum":["B2B","B2C","B2G"]},"processType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The process type of the e-invoicing business region."},"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 service provider is Sovos, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ClearanceWithCancellation"},"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 service provider is Avalara, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEPPOLNetwork"},"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 service provider is PEPPOL, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Clearance","ClearanceWithCancellation","PEPPOLNetwork","Unknown"],"type":"string"},"defaultFileFormats":{"description":"The default file format.\n","type":"string"}}}]}},"components/schemas/GETEinvoiceInvoiceFetchMandatesErrorsReasons":{"id":"components/schemas/GETEinvoiceInvoiceFetchMandatesErrorsReasons","kind":"json-schema","title":"GETEinvoiceInvoiceFetchMandatesErrorsReasons","data":{"allOf":[{"properties":{"code":{"description":"Code for the validation error.\n","type":"string"},"message":{"description":"Validation error message.\n","type":"string"}}}]}},"components/schemas/GETEinvoiceInvoiceFetchMandatesError":{"id":"components/schemas/GETEinvoiceInvoiceFetchMandatesError","kind":"json-schema","title":"GETEinvoiceInvoiceFetchMandatesError","data":{"allOf":[{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was not processed successfully."},"children":[]}]}]}],"type":"boolean"},"processId":{"description":"Process Id of the validation error.\n","type":"string"},"reasons":{"description":"Container for error reasons.\n","items":{"$ref":"#/components/schemas/GETEinvoiceInvoiceFetchMandatesErrorsReasons"}},"requestId":{"description":"Request Id for the validation error.\n","type":"string"}}}]}},"components/schemas/EinvoiceInvoiceFetchMandate":{"id":"components/schemas/EinvoiceInvoiceFetchMandate","kind":"json-schema","title":"EinvoiceInvoiceFetchMandate","data":{"properties":{"success":{"description":"Container for fetching mandates.\n","items":{"$ref":"#/components/schemas/GETEinvoiceInvoiceFetchMandate"},"type":"array"},"error":{"description":"Container for fetching validation errors.\n","items":{"$ref":"#/components/schemas/GETEinvoiceInvoiceFetchMandatesError"},"type":"array"}},"type":"object"}},"components/schemas/GETEinvoiceCreditMemosMandate":{"id":"components/schemas/GETEinvoiceCreditMemosMandate","kind":"json-schema","title":"GETEinvoiceCreditMemosMandate","data":{"allOf":[{"properties":{"countryCode":{"description":"2-digit country code. \n","type":"string","nullable":false},"fileFormats":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following mapping will be used for user representation of file formats:"},"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":"XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OASIS_Universal_Business_Language_XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.oasis.ubl+xml"},"children":[]}]}]}]}],"type":"array","items":{"type":"string"},"nullable":false},"category":{"description":"Business categories that Zuora supports for customer accounts. Supported values are B2B, B2C, or B2G.\n","type":"string","enum":["B2B","B2C","B2G"]},"processType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The process type of the e-invoicing business region."},"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 service provider is Sovos, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ClearanceWithCancellation"},"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 service provider is Avalara, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEPPOLNetwork"},"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 service provider is PEPPOL, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Clearance","ClearanceWithCancellation","PEPPOLNetwork","Unknown"],"type":"string"},"defaultFileFormats":{"description":"The default file format.\n","type":"string"}}}]}},"components/schemas/GETEinvoiceCreditMemosMandatesErrorsReasons":{"id":"components/schemas/GETEinvoiceCreditMemosMandatesErrorsReasons","kind":"json-schema","title":"GETEinvoiceCreditMemosMandatesErrorsReasons","data":{"allOf":[{"properties":{"code":{"description":"Code for the validation error.\n","type":"string"},"message":{"description":"Validation error message.\n","type":"string"}}}]}},"components/schemas/GETEinvoiceCreditMemosMandatesErrors":{"id":"components/schemas/GETEinvoiceCreditMemosMandatesErrors","kind":"json-schema","title":"GETEinvoiceCreditMemosMandatesErrors","data":{"allOf":[{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was not processed successfully."},"children":[]}]}]}],"type":"boolean"},"processId":{"description":"Process Id of the validation error.\n","type":"string"},"reasons":{"description":"Container for error reasons.\n","items":{"$ref":"#/components/schemas/GETEinvoiceCreditMemosMandatesErrorsReasons"}},"requestId":{"description":"Request Id for the validation error.\n","type":"string"}}}]}},"components/schemas/CreditMemosEinvoiceMandate":{"id":"components/schemas/CreditMemosEinvoiceMandate","kind":"json-schema","title":"CreditMemosEinvoiceMandate","data":{"properties":{"success":{"description":"Container for fetching mandates.\n","items":{"$ref":"#/components/schemas/GETEinvoiceCreditMemosMandate"},"type":"array"},"error":{"description":"Container for fetching validation errors.\n","items":{"$ref":"#/components/schemas/GETEinvoiceCreditMemosMandatesErrors"},"type":"array"}},"type":"object"}},"components/schemas/GETEinvoiceDebitMemosMandates":{"id":"components/schemas/GETEinvoiceDebitMemosMandates","kind":"json-schema","title":"GETEinvoiceDebitMemosMandates","data":{"allOf":[{"properties":{"countryCode":{"description":"2-digit country code. \n","type":"string","nullable":false},"fileFormats":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following mapping will be used for user representation of file formats:"},"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":"XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OASIS_Universal_Business_Language_XML: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.oasis.ubl+xml"},"children":[]}]}]}]}],"type":"array","items":{"type":"string"},"nullable":false},"category":{"description":"Business categories that Zuora supports for customer accounts. Supported values are B2B, B2C, or B2G.\n","type":"string","enum":["B2B","B2C","B2G"]},"processType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The process type of the e-invoicing business region."},"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 service provider is Sovos, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ClearanceWithCancellation"},"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 service provider is Avalara, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Clearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEPPOLNetwork"},"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 service provider is PEPPOL, the process type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Clearance","ClearanceWithCancellation","PEPPOLNetwork","Unknown"],"type":"string"},"defaultFileFormats":{"description":"The default file format.\n","type":"string"}}}]}},"components/schemas/GETEinvoiceDebitMemosMandatesErrorsReasons":{"id":"components/schemas/GETEinvoiceDebitMemosMandatesErrorsReasons","kind":"json-schema","title":"GETEinvoiceDebitMemosMandatesErrorsReasons","data":{"allOf":[{"properties":{"code":{"description":"Code for the validation error.\n","type":"string"},"message":{"description":"Validation error message.\n","type":"string"}}}]}},"components/schemas/GETEinvoiceDebitMemosMandatesErrors":{"id":"components/schemas/GETEinvoiceDebitMemosMandatesErrors","kind":"json-schema","title":"GETEinvoiceDebitMemosMandatesErrors","data":{"allOf":[{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was not processed successfully."},"children":[]}]}]}],"type":"boolean"},"processId":{"description":"Process Id of the validation error.\n","type":"string"},"reasons":{"description":"Container for error reasons.\n","items":{"$ref":"#/components/schemas/GETEinvoiceDebitMemosMandatesErrorsReasons"}},"requestId":{"description":"Request Id for the validation error.\n","type":"string"}}}]}},"components/schemas/DebitMemosEinvoiceMandate":{"id":"components/schemas/DebitMemosEinvoiceMandate","kind":"json-schema","title":"DebitMemosEinvoiceMandate","data":{"properties":{"success":{"description":"Container for fetching mandates.\n","items":{"$ref":"#/components/schemas/GETEinvoiceDebitMemosMandates"},"type":"array"},"errors":{"description":"Container for fetching validation errors.\n","items":{"$ref":"#/components/schemas/GETEinvoiceDebitMemosMandatesErrors"},"type":"array"}},"type":"object"}},"components/schemas/GETEinvoiceDownloadErrors":{"id":"components/schemas/GETEinvoiceDownloadErrors","kind":"json-schema","title":"GETEinvoiceDownloadErrors","data":{"allOf":[{"properties":{"code":{"description":"Code for the validation error.\n","type":"string"},"message":{"description":"Validation error message.\n","type":"string"}}}]}},"components/schemas/GETEinvoiceDownload":{"id":"components/schemas/GETEinvoiceDownload","kind":"json-schema","title":"GETEinvoiceDownload","data":{"allOf":[{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was not processed successfully."},"children":[]}]}]}],"type":"boolean"},"processId":{"description":"Process Id of the validation error.\n","type":"string"},"reasons":{"description":"Container for error reasons.\n","items":{"$ref":"#/components/schemas/GETEinvoiceDownloadErrors"}},"requestId":{"description":"Request Id for the validation error.\n","type":"string"}}}]}},"components/schemas/EinvoiceDownload":{"id":"components/schemas/EinvoiceDownload","kind":"json-schema","title":"EinvoiceDownload","data":{"properties":{"success":{"description":"Stream the file contents.\n"},"error":{"description":"Container for downloading e-invoice.\n","items":{"$ref":"#/components/schemas/GETEinvoiceDownload"},"type":"array"}},"type":"object"}},"components/schemas/GETCreditMemosEinvoiceDownloadErrors":{"id":"components/schemas/GETCreditMemosEinvoiceDownloadErrors","kind":"json-schema","title":"GETCreditMemosEinvoiceDownloadErrors","data":{"allOf":[{"properties":{"code":{"description":"Code for the validation error.\n","type":"string"},"message":{"description":"Validation error message.\n","type":"string"}}}]}},"components/schemas/GETCreditMemosEinvoiceDownload":{"id":"components/schemas/GETCreditMemosEinvoiceDownload","kind":"json-schema","title":"GETCreditMemosEinvoiceDownload","data":{"allOf":[{"properties":{"processId":{"description":"Process Id of the validation error.\n","type":"string"},"reasons":{"description":"Container for error reasons.\n","items":{"$ref":"#/components/schemas/GETCreditMemosEinvoiceDownloadErrors"}},"requestId":{"description":"Request Id for the validation error.\n","type":"string"}}}]}},"components/schemas/CreditMemosEinvoiceDownload":{"id":"components/schemas/CreditMemosEinvoiceDownload","kind":"json-schema","title":"CreditMemosEinvoiceDownload","data":{"properties":{"success":{"description":"Stream the file contents.\n"},"error":{"description":"Container for downloading Credit Memo.\n","items":{"$ref":"#/components/schemas/GETCreditMemosEinvoiceDownload"},"type":"array"}},"type":"object"}},"components/schemas/GETDebitMemosEinvoiceDownload":{"id":"components/schemas/GETDebitMemosEinvoiceDownload","kind":"json-schema","title":"GETDebitMemosEinvoiceDownload","data":{"allOf":[{"properties":{"processId":{"description":"Process Id of the validation error.\n","type":"string"},"reasons":{"description":"Container for error reasons.\n","items":{"$ref":"#/components/schemas/GETEinvoiceDownloadErrors"}},"requestId":{"description":"Request Id for the validation error.\n","type":"string"}}}]}},"components/schemas/DebitMemosEinvoiceDownload":{"id":"components/schemas/DebitMemosEinvoiceDownload","kind":"json-schema","title":"DebitMemosEinvoiceDownload","data":{"properties":{"success":{"description":"Stream the file contents.\n"},"error":{"description":"Container for downloading Debit Memo.\n","items":{"$ref":"#/components/schemas/GETDebitMemosEinvoiceDownload"},"type":"array"}},"type":"object"}},"components/schemas/PutCancelEInvoiceRequest":{"id":"components/schemas/PutCancelEInvoiceRequest","kind":"json-schema","title":"PutCancelEInvoiceRequest","data":{"allOf":[{"properties":{"reason":{"description":"The reason code for cancelation.\n","type":"string","enum":["01","02","03","04"]},"documentReferenceID":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID or number of the billing document that replaces the e-invoice being canceled. You can replace the canceled e-invoice with a new invoice or debit memo."},"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 documentReferenceID is applicable only for the reason 01 when you cancel E-Invoice for Mexico."},"children":[]}]}]}],"type":"string"}}}],"example":{"reason":"01","documentReferenceID":"DM12345678"}}},"components/schemas/GetEInvoiceFileTemplateResponse":{"id":"components/schemas/GetEInvoiceFileTemplateResponse","kind":"json-schema","title":"GetEInvoiceFileTemplateResponse","data":{"allOf":[{"properties":{"content":{"description":"The content of the e-invoice file template, which must be encoded in Base64 format.\n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The short name of a country or region where you must comply with e-invoicing requirements. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for India. For the full list of country names and codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"documentType":{"description":"The type of billing document for which the e-invoice file template is intended.\n","enum":["Invoice","CreditMemo","DebitMemo"],"type":"string"},"id":{"description":"The unique ID of the e-invoice file template.\n","type":"string"},"name":{"description":"The name of the e-invoice file template.\n","maxLength":255,"type":"string"},"provider":{"description":"The name of the e-invoicing service provider that assists in generating e-invoice files for billing documents. \n","enum":["Sovos"],"type":"string"},"templateNumber":{"description":"The unique number of the e-invoice file template.\n","type":"string"}},"title":"templates","type":"object"}]}},"components/schemas/ListEInvoiceFileTemplatesResponse":{"id":"components/schemas/ListEInvoiceFileTemplatesResponse","kind":"json-schema","title":"ListEInvoiceFileTemplatesResponse","data":{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"templates":{"description":"Container for e-invoice file emplates.\n","items":{"$ref":"#/components/schemas/GetEInvoiceFileTemplateResponse"},"type":"array"}},"type":"object"}},"components/schemas/CreateEInvoiceFileTemplateRequest":{"id":"components/schemas/CreateEInvoiceFileTemplateRequest","kind":"json-schema","title":"CreateEInvoiceFileTemplateRequest","data":{"allOf":[{"properties":{"content":{"description":"The content of the e-invoice file template, which must be encoded in Base64 format.\n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The short name of a country or region where you must comply with e-invoicing requirements. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for India. For the full list of country names and codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"documentType":{"description":"The type of billing documents, which the e-invoice file template is intended for.\n","enum":["Invoice","CreditMemo","DebitMemo"],"type":"string"},"name":{"description":"The name of the e-invoice file template.\n","maxLength":255,"type":"string"},"provider":{"description":"The name of an e-invoicing service provider that assists in generating e-invoice files.\n","enum":["Sovos"],"type":"string"}},"required":["country","documentType","provider","content","name"],"type":"object"}],"example":{"content":"base64 encoded content","country":"IN","documentType":"Invoice","name":"Sovos e-invoice service","provider":"Sovos"}}},"components/schemas/UpdateEInvoiceFileTemplateRequest":{"id":"components/schemas/UpdateEInvoiceFileTemplateRequest","kind":"json-schema","title":"UpdateEInvoiceFileTemplateRequest","data":{"allOf":[{"properties":{"content":{"description":"The content of the e-invoice file template, which must be encoded in Base64 format.\n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The short name of a country or region where you must comply with e-invoicing requirements. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for India. For the full list of country names and codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"documentType":{"description":"The type of billing documents, which the e-invoice file template is intended for.\n","enum":["Invoice","CreditMemo","DebitMemo"],"type":"string"},"name":{"description":"The name of the e-invoice file template.\n","maxLength":255,"type":"string"},"provider":{"description":"The name of an e-invoicing service provider that assists in generating e-invoice files.\n","enum":["Sovos"],"type":"string"}},"type":"object"}],"example":{"content":"base64 encoded content","country":"IN","documentType":"Invoice","name":"Sovos e-invoice service","provider":"Sovos"}}},"components/schemas/EInvoiceLifecycleStatusUpdateRequest":{"id":"components/schemas/EInvoiceLifecycleStatusUpdateRequest","kind":"json-schema","title":"EInvoiceLifecycleStatusUpdateRequest","data":{"allOf":[{"properties":{"sourceObjectId":{"description":"The UUID of the source document in Zuora. Use an invoice ID, credit memo ID, or debit memo ID.\n","type":"string"},"sourceObjectType":{"description":"The type of source document. \n","type":"string","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO"]},"requestedStatus":{"description":"The business status to request for the source document.   \n","type":"string","enum":["Completed","Cancelled","DirectPaymentRequest","Affidaute","AffiledConfidential","ChangeOfAccountToPay","NotBilled"]},"reason":{"description":"The reason for the status update.\n"}},"required":["sourceObjectId","sourceObjectType","requestedStatus"],"type":"object"}],"example":{"sourceObjectId":"2c92c0f9876543210187654321ab0012","sourceObjectType":"INVOICE","requestedStatus":"Completed","reason":"Customer payment was fully settled."}}},"components/schemas/EInvoiceLifecycleStatusUpdateResponse":{"id":"components/schemas/EInvoiceLifecycleStatusUpdateResponse","kind":"json-schema","title":"EInvoiceLifecycleStatusUpdateResponse","data":{"allOf":[{"properties":{"id":{"description":"The unique ID of the lifecycle status update record.\n","type":"string"},"sourceObjectId":{"description":"The ID of the source document.\n","type":"string"},"sourceObjectType":{"description":"The type of source object. \n","type":"string","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO"]},"requestedStatus":{"description":"The business status requested by the seller.\n","type":"string","enum":["Completed","Cancelled","DirectPaymentRequest","Affidaute","AffiledConfidential","ChangeOfAccountToPay","NotBilled"]},"status":{"description":"The current processing status of the lifecycle update request.\n","type":"string","enum":["Scheduled","Submitted","UnderReconciliation","Completed","Failed","ChangeDetected"]},"createdOn":{"description":"The date and time when the status update was created.\n","type":"string","format":"date-time"}}}]}},"components/schemas/EInvoiceLifecycleStatusUpdateRecord":{"id":"components/schemas/EInvoiceLifecycleStatusUpdateRecord","kind":"json-schema","title":"EInvoiceLifecycleStatusUpdateRecord","data":{"title":"EInvoiceLifecycleStatusUpdateRecord","type":"object","description":"Customer-facing projection of an e-invoice business lifecycle status update audit record.","properties":{"id":{"type":"string","description":"Unique identifier of the status update record."},"sourceObjectId":{"type":"string","description":"Internal UUID of the source object (invoice, credit memo, debit memo, payment, or refund)."},"sourceObjectNumber":{"type":"string","description":"Human-readable document number of the source object."},"sourceObjectType":{"type":"string","description":"Type of the source object.","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND","CREDIT_MEMO_APPLICATION"]},"paymentId":{"type":"string","description":"ID of the parent payment (populated when sourceObjectType is PAYMENT)."},"paymentNumber":{"type":"string","description":"Number of the parent payment (populated when sourceObjectType is PAYMENT)."},"refundId":{"type":"string","description":"ID of the parent refund (populated when sourceObjectType is REFUND)."},"refundNumber":{"type":"string","description":"Number of the parent refund (populated when sourceObjectType is REFUND)."},"parentObjectId":{"type":"string","description":"Internal UUID of the parent object, when this record is anchored on a related object."},"parentObjectNumber":{"type":"string","description":"Human-readable number of the parent object."},"parentObjectType":{"type":"string","description":"Type of the parent object."},"serviceProviderId":{"type":"string","description":"Identifier of the e-invoicing service provider."},"serviceProviderType":{"type":"string","description":"Type of the e-invoicing service provider."},"sequenceId":{"type":"string","description":"Sequence identifier used to order related status update records."},"userRequestedAction":{"type":"string","description":"Action that triggered this status update record."},"userRequestStatus":{"type":"string","description":"Business status requested by the seller, when applicable."},"status":{"type":"string","description":"Request lifecycle status of this status update record.","enum":["Scheduled","Submitted","UnderReconciliation","Completed","Failed","Rejected","RetrieveTimeout","ChangeDetected"]},"reason":{"type":"string","description":"Reason associated with the current status."},"triggeredBy":{"type":"string","description":"Event or mechanism that triggered this status update record."},"einvoiceBusinessStatus":{"type":"string","description":"Business lifecycle status of the e-invoice as reported by the service provider."},"einvoiceBusinessStatusCode":{"type":"string","description":"Provider-specific code for the e-invoice business status."},"einvoiceBusinessStatusReason":{"type":"string","description":"Provider-specific reason for the e-invoice business status."},"authorityStatus":{"type":"string","description":"Tax authority acceptance status as reported by the service provider."},"businessReasonCode":{"type":"string","description":"Business reason code associated with this status update."},"transactionId":{"type":"string","description":"External transaction identifier returned by the service provider."},"taskExecutionId":{"type":"string","description":"ID of the async task execution processing this status update."},"snapshotFileId":{"type":"string","description":"ID of the snapshot file associated with this status update."},"errorCode":{"type":"string","description":"Error code if the status update failed."},"errorMessage":{"type":"string","description":"Error message if the status update failed."},"createdDate":{"type":"string","format":"date-time","x-field-extra-annotation":"@com.fasterxml.jackson.annotation.JsonFormat(shape = com.fasterxml.jackson.annotation.JsonFormat.Shape.STRING)","x-extra-annotation":"@com.fasterxml.jackson.annotation.JsonFormat(shape = com.fasterxml.jackson.annotation.JsonFormat.Shape.STRING)","description":"Timestamp when the status update record was created."},"updatedDate":{"type":"string","format":"date-time"}}}},"components/schemas/GetEInvoiceLifecycleStatusUpdatesResponse":{"id":"components/schemas/GetEInvoiceLifecycleStatusUpdatesResponse","kind":"json-schema","title":"GetEInvoiceLifecycleStatusUpdatesResponse","data":{"title":"GetEInvoiceLifecycleStatusUpdatesResponse","allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"statusUpdates":{"type":"array","items":{"$ref":"#/components/schemas/EInvoiceLifecycleStatusUpdateRecord"},"description":"List of e-invoice business lifecycle status updates matching the query criteria."},"page":{"type":"integer","description":"Current page number (1-based)."},"pageSize":{"type":"integer","description":"Number of results per page."},"total":{"type":"integer","format":"int64","description":"Total number of matching records across all pages."}}}]}},"components/schemas/GetEInvoiceLifecycleStatusUpdateResponse":{"id":"components/schemas/GetEInvoiceLifecycleStatusUpdateResponse","kind":"json-schema","title":"GetEInvoiceLifecycleStatusUpdateResponse","data":{"title":"GetEInvoiceLifecycleStatusUpdateResponse","allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"statusUpdates":{"type":"array","items":{"$ref":"#/components/schemas/EInvoiceLifecycleStatusUpdateRecord"},"description":"List of e-invoice business lifecycle status updates matching the query criteria."}}}]}},"components/schemas/EComplianceReconcileRequest":{"id":"components/schemas/EComplianceReconcileRequest","kind":"json-schema","title":"EComplianceReconcileRequest","data":{"allOf":[{"properties":{"complianceType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of e-compliance request."},"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":"EInvoiceBusinessLifecycle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when reconciling e-invoice business lifecycle status updates."},"children":[]}]}]}],"enum":["EReporting","EInvoiceBusinessLifecycle"],"type":"string"},"sourceObjectKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The business identifier of the source object to reconcile.  Use the document number for invoices, credit memos, and debit memos."},"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":"PaymentApplicationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for payments, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RefundApplicationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for refunds, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemoApplicationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for credit memo applications."},"children":[]}]}]}],"type":"string"},"sourceObjectType":{"description":"The type of source object for the e-compliance operation. \n","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND","CREDIT_MEMO_APPLICATION"],"type":"string"},"transactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional external transaction ID to use for this reconcile request."},"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":" If you do not specify this field, Zuora uses the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the current request context."},"children":[]}]}]}],"type":"string"}},"required":["complianceType","sourceObjectKey","sourceObjectType"],"type":"object"}],"example":{"complianceType":"EInvoiceBusinessLifecycle","sourceObjectKey":"e4c081829f3b3c68019f3bd8d6161368","sourceObjectType":"INVOICE"}}},"components/schemas/EReportingRequest":{"id":"components/schemas/EReportingRequest","kind":"json-schema","title":"EReportingRequest","data":{"title":"EReportingRequest","type":"object","description":"Customer-facing projection of an E-Reporting request.","properties":{"id":{"type":"string","description":"Unique identifier of the e-compliance request."},"status":{"type":"string","description":"Current status of the e-compliance request."},"sourceObjectId":{"type":"string","format":"uuid","description":"Internal UUID of the source object (invoice, memo, payment application, or refund application)."},"sourceObjectNumber":{"type":"string","description":"Human-readable document number of the source object."},"sourceObjectType":{"type":"string","description":"Type of the source object.","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND","CREDIT_MEMO_APPLICATION"]},"paymentId":{"type":"string","description":"ID of the parent payment (populated when sourceObjectType is PAYMENT)."},"paymentNumber":{"type":"string","description":"Number of the parent payment (populated when sourceObjectType is PAYMENT)."},"refundId":{"type":"string","description":"ID of the parent refund (populated when sourceObjectType is REFUND)."},"refundNumber":{"type":"string","description":"Number of the parent refund (populated when sourceObjectType is REFUND)."},"parentObjectId":{"type":"string","description":"Internal UUID of the parent object."},"parentObjectNumber":{"type":"string","description":"Human-readable number of the parent object."},"parentObjectType":{"type":"string","description":"Type of the parent object.","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND","CREDIT_MEMO_APPLICATION"]},"reportingScheme":{"type":"string","description":"Reporting scheme used (e.g., FatturaPA, PEPPOL)."},"mandateId":{"type":"string","description":"Mandate identifier for the e-reporting submission."},"triggeredBy":{"type":"string","description":"Event or mechanism that triggered the e-compliance request."},"mode":{"type":"string","description":"Reporting mode (e.g., INDIVIDUAL)."},"countryId":{"type":"string","description":"Country identifier associated with the request."},"serviceProviderId":{"type":"string","description":"Identifier of the e-reporting service provider."},"serviceProviderType":{"type":"string","description":"Type of the e-reporting service provider."},"transactionId":{"type":"string","description":"External transaction identifier returned by the service provider."},"businessStatus":{"type":"string","description":"Business status of the e-reporting document as reported by the service provider."},"authorityStatus":{"type":"string","description":"Tax authority acceptance status as reported by the service provider."},"userRequestedAction":{"type":"string","description":"Action requested by the user that initiated this request."},"snapshotFileId":{"type":"string","description":"ID of the snapshot file associated with this request."},"fileId":{"type":"string","description":"ID of the file associated with this request."},"errorCode":{"type":"string","description":"Error code if the request failed."},"errorMessage":{"type":"string","description":"Error message if the request failed."},"createdDate":{"type":"string","format":"date-time","x-field-extra-annotation":"@com.fasterxml.jackson.annotation.JsonFormat(shape = com.fasterxml.jackson.annotation.JsonFormat.Shape.STRING)","x-extra-annotation":"@com.fasterxml.jackson.annotation.JsonFormat(shape = com.fasterxml.jackson.annotation.JsonFormat.Shape.STRING)","description":"Timestamp when the request was created."},"updatedDate":{"type":"string","format":"date-time","x-field-extra-annotation":"@com.fasterxml.jackson.annotation.JsonFormat(shape = com.fasterxml.jackson.annotation.JsonFormat.Shape.STRING)","x-extra-annotation":"@com.fasterxml.jackson.annotation.JsonFormat(shape = com.fasterxml.jackson.annotation.JsonFormat.Shape.STRING)","description":"Timestamp when the request was last updated."},"templateId":{"type":"string","description":"ID of the e-reporting template used for this request."}}}},"components/schemas/EInvoiceLifecycleStatusUpdate":{"id":"components/schemas/EInvoiceLifecycleStatusUpdate","kind":"json-schema","title":"EInvoiceLifecycleStatusUpdate","data":{"title":"EInvoiceLifecycleStatusUpdate","type":"object","description":"Response object for e-invoice lifecycle status update trigger request.","properties":{"id":{"type":"string","description":"Unique ID of the lifecycle status update record."},"status":{"type":"string","description":"Current status of the lifecycle update request.","enum":["Scheduled","Submitted","UnderReconciliation","Completed","Failed","ChangeDetected"]},"requestedStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The business status requested by the seller (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentCollected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the status update was created."},"sourceObjectId":{"type":"string","description":"ID of the source document (invoice, credit memo, or debit memo)."},"sourceObjectType":{"type":"string","description":"Type of the source object.","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO"]}}}},"components/schemas/EComplianceActionResponse":{"id":"components/schemas/EComplianceActionResponse","kind":"json-schema","title":"EComplianceActionResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"eReportingRequest":{"$ref":"#/components/schemas/EReportingRequest"},"lifecycleStatusUpdate":{"$ref":"#/components/schemas/EInvoiceLifecycleStatusUpdate"}}}]}},"components/schemas/EReportingTemplatesResponse":{"id":"components/schemas/EReportingTemplatesResponse","kind":"json-schema","title":"EReportingTemplatesResponse","data":{"title":"EReportingTemplatesResponse","allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"templates":{"description":"A list of E-Reporting templates.","items":{"properties":{"id":{"description":"The unique ID of the E-Reporting template.","type":"string"},"name":{"description":"The name of the template.","type":"string"},"ereportingSupplierId":{"description":"The ID of the E-Reporting supplier (business region) this template belongs to.","type":"string"},"sourceObjectType":{"description":"The type of source object the template is used for.","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND","CREDIT_MEMO_APPLICATION"],"type":"string"},"businessCategory":{"description":"The business category this template applies to.","enum":["B2B","B2B_CROSS_BORDER","B2C","B2G","ANY"],"type":"string"},"status":{"description":"The status of the template.","enum":["DRAFT","ACTIVE","INACTIVE"],"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}]}},"components/schemas/PostEReportingTemplateRequest":{"id":"components/schemas/PostEReportingTemplateRequest","kind":"json-schema","title":"PostEReportingTemplateRequest","data":{"title":"PostEReportingTemplateRequest","allOf":[{"properties":{"name":{"description":"The name of the template. Maximum 100 characters.","type":"string","minLength":1,"maxLength":100},"ereportingSupplierId":{"description":"The ID of the E-Reporting supplier (business region) this template belongs to.","type":"string","minLength":1},"sourceObjectType":{"description":"The type of source object the template is used for.","type":"string","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND","CREDIT_MEMO_APPLICATION"]},"businessCategory":{"description":"The business category this template applies to.","type":"string","enum":["B2B","B2B_CROSS_BORDER","B2C","B2G","ANY"]},"status":{"description":"The initial status of the template.","type":"string","enum":["DRAFT","ACTIVE","INACTIVE"]},"content":{"description":"The Base64-encoded HTML content of the template.","type":"string","minLength":1}},"required":["name","ereportingSupplierId","sourceObjectType","businessCategory","status","content"],"type":"object"}],"example":{"name":"FR_B2B_INVOICE_REPORTING","ereportingSupplierId":"4028948972a2bf990172bc9b27724ddc","sourceObjectType":"INVOICE","businessCategory":"B2B","status":"DRAFT","content":"PGh0bWw+dGVtcGxhdGU8L2h0bWw+"}}},"components/schemas/EReportingTemplate":{"id":"components/schemas/EReportingTemplate","kind":"json-schema","title":"EReportingTemplate","data":{"title":"EReportingTemplate","allOf":[{"properties":{"id":{"description":"The unique ID of the E-Reporting template.","type":"string"},"name":{"description":"The name of the template.","type":"string"},"ereportingSupplierId":{"description":"The ID of the E-Reporting supplier (business region) this template belongs to.","type":"string"},"sourceObjectType":{"description":"The type of source object the template is used for.","type":"string","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND","CREDIT_MEMO_APPLICATION"]},"businessCategory":{"description":"The business category this template applies to.","type":"string","enum":["B2B","B2B_CROSS_BORDER","B2C","B2G","ANY"]},"status":{"description":"The status of the template.","type":"string","enum":["DRAFT","ACTIVE","INACTIVE"]},"content":{"description":"The Base64-encoded HTML content of the template.","type":"string"},"templateNumber":{"description":"The system-generated unique number of the E-Reporting template.","type":"string"},"createdOn":{"description":"The date and time when the template was created.","type":"string","format":"date-time"},"updatedOn":{"description":"The date and time when the template was last updated.","type":"string","format":"date-time"}}}]}},"components/schemas/EReportingTemplateResponse":{"id":"components/schemas/EReportingTemplateResponse","kind":"json-schema","title":"EReportingTemplateResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"$ref":"#/components/schemas/EReportingTemplate"}]}},"components/schemas/PutEReportingTemplateRequest":{"id":"components/schemas/PutEReportingTemplateRequest","kind":"json-schema","title":"PutEReportingTemplateRequest","data":{"title":"PutEReportingTemplateRequest","allOf":[{"properties":{"name":{"description":"The name of the template. Maximum 100 characters.","type":"string","maxLength":100},"ereportingSupplierId":{"description":"The ID of the E-Reporting supplier (business region) this template belongs to.","type":"string"},"sourceObjectType":{"description":"The type of source object the template is used for.","type":"string","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND","CREDIT_MEMO_APPLICATION"]},"businessCategory":{"description":"The business category this template applies to.","type":"string","enum":["B2B","B2B_CROSS_BORDER","B2C","B2G","ANY"]},"status":{"description":"The status of the template.","type":"string","enum":["DRAFT","ACTIVE","INACTIVE"]},"content":{"description":"The Base64-encoded HTML content of the template. If omitted, the existing content is retained.","type":"string"}}}],"example":{"name":"FR_B2B_INVOICE_REPORTING","ereportingSupplierId":"4028948972a2bf990172bc9b27724ddc","sourceObjectType":"INVOICE","businessCategory":"B2B","content":"PGh0bWw+dGVtcGxhdGU8L2h0bWw+","status":"ACTIVE"}}},"components/schemas/EReportingBusinessRegion":{"id":"components/schemas/EReportingBusinessRegion","kind":"json-schema","title":"EReportingBusinessRegion","data":{"title":"EReportingBusinessRegion","type":"object","properties":{"id":{"description":"The unique ID of the e-reporting business region.\n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-digit ISO code of the country where you must comply with e-reporting requirements. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Spain. For the full list of country codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=countries-regions-subregions-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Standard Country Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"state":{"description":"The name of the state or province within the country where the business is located.\n","type":"string","maxLength":40},"city":{"description":"The name of the city where the business is located.\n","type":"string","maxLength":40},"postalCode":{"description":"The postal code of the Seller's business address.\n","type":"string","maxLength":20},"addressLine1":{"description":"The first line of the Seller's business address.\n","type":"string","maxLength":255},"addressLine2":{"description":"The second line of the Seller's business address.\n","type":"string","maxLength":255},"businessName":{"description":"The full official name that the Seller is registered with the relevant legal authority.\n","type":"string","maxLength":255},"businessNumber":{"description":"The unique identifier number of the legal entity or person that you do business with.\n","type":"string","maxLength":50},"businessNumberSchemeId":{"description":"The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.\n","type":"string","maxLength":20},"tradeName":{"description":"The name that the Seller is known as, other than the legal business name.\n","type":"string","maxLength":100},"endpointId":{"description":"The Seller's electronic address to which application-level responses might be delivered.\n","type":"string","maxLength":50},"endpointSchemeId":{"description":"The identification scheme identifier of the Seller's electronic address.\n","type":"string","maxLength":20},"taxRegisterNumber":{"description":"The Seller's tax identification number or local identification for tax purposes.\n","type":"string","maxLength":50},"contactName":{"description":"The name of the Seller contact to receive e-reporting data.\n","type":"string","maxLength":255},"phoneNumber":{"description":"The business phone number of the Seller contact to receive e-reporting data.\n","type":"string","maxLength":40},"email":{"description":"The email address of the Seller contact to receive e-reporting data.\n","type":"string","format":"email","maxLength":80},"engineId":{"description":"The unique ID of the e-reporting service provider (engine) associated with this business region.\n","type":"string","maxLength":50},"reportingScheme":{"description":"The reporting scheme that determines the e-reporting format and protocol used for this business region. This field is immutable after creation. \n","type":"string","enum":["GENERIC_EREPORTING","SII","TICKETBAI"]},"mode":{"description":"The processing mode for e-reporting submissions.\n","type":"string","enum":["INDIVIDUAL","BATCH"]},"natureKey":{"description":"An optional customer-provided identifier for the business region.\n","type":"string"},"invoiceEnabled":{"description":"Whether invoice documents are enabled for e-reporting in this business region.\n","type":"boolean"},"creditMemoEnabled":{"description":"Whether credit memo documents are enabled for e-reporting in this business region.\n","type":"boolean"},"debitMemoEnabled":{"description":"Whether debit memo documents are enabled for e-reporting in this business region.\n","type":"boolean"},"paymentEnabled":{"description":"Whether payment documents are enabled for e-reporting in this business region.\n","type":"boolean"},"refundEnabled":{"description":"Whether refund documents are enabled for e-reporting in this business region.\n","type":"boolean"},"creditMemoApplicationEnabled":{"description":"Whether credit memo application events are enabled for e-reporting in this business region.\n","type":"boolean"},"invoicePostedTriggerEnabled":{"description":"Whether the invoice posted event triggers an e-reporting submission.\n","type":"boolean"},"cmPostedTriggerEnabled":{"description":"Whether the credit memo posted event triggers an e-reporting submission.\n","type":"boolean"},"dmPostedTriggerEnabled":{"description":"Whether the debit memo posted event triggers an e-reporting submission.\n","type":"boolean"},"paymentAppliedTriggerEnabled":{"description":"Whether the payment applied event triggers an e-reporting submission.\n","type":"boolean"},"refundAppliedTriggerEnabled":{"description":"Whether the refund applied event triggers an e-reporting submission.\n","type":"boolean"},"creditMemoApplicationTriggerEnabled":{"description":"Whether the credit memo application event triggers an e-reporting submission.\n","type":"boolean"},"einvoiceSuccessTriggerEnabled":{"description":"Whether a successful e-invoice submission triggers an e-reporting submission.\n","type":"boolean"},"invoiceFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied to invoice documents before e-reporting submission. Valid root object types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"creditMemoFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied to credit memo documents before e-reporting submission. Valid root object types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemoItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"debitMemoFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied to debit memo documents before e-reporting submission. Valid root object types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DebitMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DebitMemoItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"paymentFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied when a payment is applied before e-reporting submission. Valid root object type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Item sub-queries may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentApplication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"refundFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied when a refund is applied before e-reporting submission. Valid root object type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Item sub-queries may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RefundApplication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"creditMemoApplicationFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied when a credit memo is applied before e-reporting submission. Valid root object type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemoApplication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Item sub-queries may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemoApplicationItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"b2bFileFormat":{"description":"The file format used for business-to-business e-reporting submissions.\n","type":"string"},"b2cFileFormat":{"description":"The file format used for business-to-consumer e-reporting submissions.\n","type":"string"},"b2gFileFormat":{"description":"The file format used for business-to-government e-reporting submissions.\n","type":"string"},"responseMapping":{"description":"A mapping of response field keys to their handling configuration for e-reporting responses.\n","type":"object","additionalProperties":true}}}},"components/schemas/EReportingBusinessRegionResponse":{"id":"components/schemas/EReportingBusinessRegionResponse","kind":"json-schema","title":"EReportingBusinessRegionResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"$ref":"#/components/schemas/EReportingBusinessRegion"}]}},"components/schemas/PostEReportingBusinessRegionRequest":{"id":"components/schemas/PostEReportingBusinessRegionRequest","kind":"json-schema","title":"PostEReportingBusinessRegionRequest","data":{"type":"object","title":"PostEReportingBusinessRegionRequest","required":["country","reportingScheme","engineId","businessName"],"properties":{"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-digit ISO code of the country where you must comply with e-reporting requirements. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Spain. This field is immutable after creation."},"children":[]}]}]}],"type":"string"},"reportingScheme":{"description":"The reporting scheme that determines the e-reporting format and protocol. This field is immutable after creation. \n","type":"string","enum":["GENERIC_EREPORTING","SII","TICKETBAI"]},"engineId":{"description":"The unique ID of the e-reporting service provider (engine) to associate with this business region.\n","type":"string","minLength":1,"maxLength":50},"businessName":{"description":"The full official name that the Seller is registered with the relevant legal authority.\n","type":"string","minLength":1,"maxLength":255},"state":{"description":"The name of the state or province within the country where the business is located.\n","type":"string","maxLength":40},"city":{"description":"The name of the city where the business is located.\n","type":"string","maxLength":40},"postalCode":{"description":"The postal code of the Seller's business address.\n","type":"string","maxLength":20},"addressLine1":{"description":"The first line of the Seller's business address.\n","type":"string","maxLength":255},"addressLine2":{"description":"The second line of the Seller's business address.\n","type":"string","maxLength":255},"businessNumber":{"description":"The unique identifier number of the legal entity or person that you do business with.\n","type":"string","maxLength":50},"businessNumberSchemeId":{"description":"The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.\n","type":"string","maxLength":20},"tradeName":{"description":"The name that the Seller is known as, other than the legal business name.\n","type":"string","maxLength":100},"endpointId":{"description":"The Seller's electronic address to which application-level responses might be delivered.\n","type":"string","maxLength":50},"endpointSchemeId":{"description":"The identification scheme identifier of the Seller's electronic address.\n","type":"string","maxLength":20},"taxRegisterNumber":{"description":"The Seller's tax identification number or local identification for tax purposes.\n","type":"string","maxLength":50},"contactName":{"description":"The name of the Seller contact to receive e-reporting data.\n","type":"string","maxLength":255},"phoneNumber":{"description":"The business phone number of the Seller contact to receive e-reporting data.\n","type":"string","maxLength":40},"email":{"description":"The email address of the Seller contact to receive e-reporting data.\n","type":"string","format":"email","maxLength":80},"mode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The processing mode for e-reporting submissions. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INDIVIDUAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["INDIVIDUAL","BATCH"],"default":"INDIVIDUAL"},"natureKey":{"description":"An optional customer-provided identifier for the business region.\n","type":"string"},"invoiceEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether invoice documents are enabled for e-reporting in this business region. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"creditMemoEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether credit memo documents are enabled for e-reporting in this business region. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"debitMemoEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether debit memo documents are enabled for e-reporting in this business region. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"paymentEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether payment documents are enabled for e-reporting in this business region. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"refundEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether refund documents are enabled for e-reporting in this business region. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"creditMemoApplicationEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether credit memo application events are enabled for e-reporting in this business region. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"invoicePostedTriggerEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the invoice posted event triggers an e-reporting submission. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"cmPostedTriggerEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the credit memo posted event triggers an e-reporting submission. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"dmPostedTriggerEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the debit memo posted event triggers an e-reporting submission. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"paymentAppliedTriggerEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the payment applied event triggers an e-reporting submission. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"refundAppliedTriggerEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the refund applied event triggers an e-reporting submission. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"creditMemoApplicationTriggerEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the credit memo application event triggers an e-reporting submission. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"einvoiceSuccessTriggerEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether a successful e-invoice submission triggers an e-reporting submission. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"invoiceFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied to invoice documents before e-reporting submission. Valid root object types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"creditMemoFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied to credit memo documents before e-reporting submission. Valid root object types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemoItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"debitMemoFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied to debit memo documents before e-reporting submission. Valid root object types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DebitMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DebitMemoItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"paymentFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied when a payment is applied before e-reporting submission. Valid root object type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Item sub-queries may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentApplication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"refundFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied when a refund is applied before e-reporting submission. Valid root object type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Item sub-queries may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RefundApplication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"creditMemoApplicationFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied when a credit memo is applied before e-reporting submission. Valid root object type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemoApplication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Item sub-queries may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemoApplicationItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"b2bFileFormat":{"description":"The file format used for business-to-business e-reporting submissions.\n","type":"string"},"b2cFileFormat":{"description":"The file format used for business-to-consumer e-reporting submissions.\n","type":"string"},"b2gFileFormat":{"description":"The file format used for business-to-government e-reporting submissions.\n","type":"string"},"responseMapping":{"description":"A mapping of response field keys to their handling configuration for e-reporting responses.\n","type":"object","additionalProperties":true}},"example":{"businessName":"Acme Corp Spain","businessNumber":"12345678A","businessNumberSchemeId":"ES:VAT","tradeName":"Acme Spain","endpointId":"9908:es-acme","endpointSchemeId":"9908","taxRegisterNumber":"ES12345678A","country":"ES","state":"","city":"Madrid","postalCode":"28013","addressLine1":"Gran Via 1","addressLine2":"Floor 2","contactName":"Maria Garcia","phoneNumber":"+34 555 0101","email":"maria.garcia@example.com","invoiceEnabled":true,"mode":"INDIVIDUAL","natureKey":"es-sii-main","reportingScheme":"SII","engineId":"4028948972a2bf990172bc9b27724ddc"}}},"components/schemas/EReportingBusinessRegionsResponse":{"id":"components/schemas/EReportingBusinessRegionsResponse","kind":"json-schema","title":"EReportingBusinessRegionsResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"regions":{"description":"A list of e-reporting business regions.\n","type":"array","items":{"$ref":"#/components/schemas/EReportingBusinessRegion"}}}}]}},"components/schemas/PutEReportingBusinessRegionRequest":{"id":"components/schemas/PutEReportingBusinessRegionRequest","kind":"json-schema","title":"PutEReportingBusinessRegionRequest","data":{"title":"PutEReportingBusinessRegionRequest","allOf":[{"properties":{"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The short name of a country or region where you must comply with e-invoicing requirements. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for India. For the full list of country names and codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=countries-regions-subregions-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Standard Country Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"engineId":{"description":"The unique ID of the e-reporting service provider (engine) to associate with this business region.\n","type":"string","maxLength":50},"state":{"description":"The name of the state or province within the country where the business is located.\n","type":"string","maxLength":40},"city":{"description":"The name of the city where the business is located.\n","type":"string","maxLength":40},"postalCode":{"description":"The postal code of the Seller's business address.\n","type":"string","maxLength":20},"addressLine1":{"description":"The first line of the Seller's business address.\n","type":"string","maxLength":255},"addressLine2":{"description":"The second line of the Seller's business address.\n","type":"string","maxLength":255},"businessName":{"description":"The full official name that the Seller is registered with the relevant legal authority.\n","type":"string","maxLength":255},"businessNumber":{"description":"The unique identifier number of the legal entity or person that you do business with.\n","type":"string","maxLength":50},"businessNumberSchemeId":{"description":"The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.\n","type":"string","maxLength":20},"tradeName":{"description":"The name that the Seller is known as, other than the legal business name.\n","type":"string","maxLength":100},"endpointId":{"description":"The Seller's electronic address to which application-level responses might be delivered.\n","type":"string","maxLength":50},"endpointSchemeId":{"description":"The identification scheme identifier of the Seller's electronic address.\n","type":"string","maxLength":20},"taxRegisterNumber":{"description":"The Seller's tax identification number or local identification for tax purposes.\n","type":"string","maxLength":50},"contactName":{"description":"The name of the Seller contact to receive e-reporting data.\n","type":"string","maxLength":255},"phoneNumber":{"description":"The business phone number of the Seller contact to receive e-reporting data.\n","type":"string","maxLength":40},"email":{"description":"The email address of the Seller contact to receive e-reporting data.\n","type":"string","format":"email","maxLength":80},"mode":{"description":"The processing mode for e-reporting submissions.\n","type":"string","enum":["INDIVIDUAL","BATCH"]},"natureKey":{"description":"An optional customer-provided identifier for the business region.\n","type":"string"},"invoiceEnabled":{"description":"Whether invoice documents are enabled for e-reporting in this business region.\n","type":"boolean"},"creditMemoEnabled":{"description":"Whether credit memo documents are enabled for e-reporting in this business region.\n","type":"boolean"},"debitMemoEnabled":{"description":"Whether debit memo documents are enabled for e-reporting in this business region.\n","type":"boolean"},"paymentEnabled":{"description":"Whether payment documents are enabled for e-reporting in this business region.\n","type":"boolean"},"refundEnabled":{"description":"Whether refund documents are enabled for e-reporting in this business region.\n","type":"boolean"},"creditMemoApplicationEnabled":{"description":"Whether credit memo application events are enabled for e-reporting in this business region.\n","type":"boolean"},"invoicePostedTriggerEnabled":{"description":"Whether the invoice posted event triggers an e-reporting submission.\n","type":"boolean"},"cmPostedTriggerEnabled":{"description":"Whether the credit memo posted event triggers an e-reporting submission.\n","type":"boolean"},"dmPostedTriggerEnabled":{"description":"Whether the debit memo posted event triggers an e-reporting submission.\n","type":"boolean"},"paymentAppliedTriggerEnabled":{"description":"Whether the payment applied event triggers an e-reporting submission.\n","type":"boolean"},"refundAppliedTriggerEnabled":{"description":"Whether the refund applied event triggers an e-reporting submission.\n","type":"boolean"},"creditMemoApplicationTriggerEnabled":{"description":"Whether the credit memo application event triggers an e-reporting submission.\n","type":"boolean"},"einvoiceSuccessTriggerEnabled":{"description":"Whether a successful e-invoice submission triggers an e-reporting submission.\n","type":"boolean"},"invoiceFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied to invoice documents before e-reporting submission. Valid root object types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"creditMemoFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied to credit memo documents before e-reporting submission. Valid root object types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemoItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"debitMemoFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied to debit memo documents before e-reporting submission. Valid root object types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DebitMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DebitMemoItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"paymentFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied when a payment is applied before e-reporting submission. Valid root object type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Item sub-queries may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentApplication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"refundFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied when a refund is applied before e-reporting submission. Valid root object type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Item sub-queries may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RefundApplication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"creditMemoApplicationFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter conditions applied when a credit memo is applied before e-reporting submission. Valid root object type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemoApplication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Item sub-queries may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditMemoApplicationItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"b2bFileFormat":{"description":"The file format used for business-to-business e-reporting submissions.\n","type":"string"},"b2cFileFormat":{"description":"The file format used for business-to-consumer e-reporting submissions.\n","type":"string"},"b2gFileFormat":{"description":"The file format used for business-to-government e-reporting submissions.\n","type":"string"},"responseMapping":{"description":"A mapping of response field keys to their handling configuration for e-reporting responses.\n","type":"object","additionalProperties":true}}}],"example":{"country":"ES","businessName":"Acme Corp Spain","businessNumber":"12345678A","businessNumberSchemeId":"ES:VAT","tradeName":"Acme Spain","taxRegisterNumber":"ES12345678A","endpointId":"9908:es-acme","endpointSchemeId":"9908","addressLine1":"Gran Via 1","addressLine2":"Floor 2","city":"Madrid","state":"","postalCode":"28013","contactName":"Maria Garcia","phoneNumber":"+34 555 0101","email":"maria.garcia@example.com","invoiceEnabled":true,"mode":"INDIVIDUAL","natureKey":"es-sii-main","engineId":"4028948972a2bf990172bc9b27724ddc"}}},"components/schemas/EComplianceSourceObjectType":{"id":"components/schemas/EComplianceSourceObjectType","kind":"json-schema","title":"EComplianceSourceObjectType","data":{"type":"string","description":"Type of source object for e-compliance operations (trigger or reconcile).","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND","CREDIT_MEMO_APPLICATION"],"x-enum-varnames":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND","CREDIT_MEMO_APPLICATION"]}},"components/schemas/GetEReportingRequestsResponse":{"id":"components/schemas/GetEReportingRequestsResponse","kind":"json-schema","title":"GetEReportingRequestsResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/EReportingRequest"},"description":"List of E-Reporting requests matching the query criteria."},"page":{"type":"integer","description":"Current page number (1-based)."},"pageSize":{"type":"integer","description":"Number of results per page."},"total":{"type":"integer","format":"int64","description":"Total number of matching records across all pages."}}}]}},"components/schemas/EComplianceType":{"id":"components/schemas/EComplianceType","kind":"json-schema","title":"EComplianceType","data":{"type":"string","description":"Type of e-compliance request.","enum":["EReporting","EInvoiceBusinessLifecycle"],"x-enum-varnames":["EReporting","EInvoiceBusinessLifecycle"]}},"components/schemas/EComplianceTriggerRequest":{"id":"components/schemas/EComplianceTriggerRequest","kind":"json-schema","title":"EComplianceTriggerRequest","data":{"x-error-code":1004,"type":"object","title":"EComplianceTriggerRequest","description":"Request body for triggering an e-compliance request.","required":["complianceType","sourceObjectKey","sourceObjectType","supplierId"],"properties":{"complianceType":{"x-error-code":1,"$ref":"#/components/schemas/EComplianceType"},"sourceObjectKey":{"x-error-code":2,"type":"string","description":"Source object key. Use the document number for invoice, credit memo, and debit memo; use PaymentApplicationId for payment; use RefundApplicationId for refund; use CreditMemoApplicationId for credit memo application."},"sourceObjectType":{"x-error-code":3,"type":"string","$ref":"#/components/schemas/EComplianceSourceObjectType"},"supplierId":{"x-error-code":4,"type":"string","description":"ID of the e-reporting supplier to use for the request."},"templateId":{"x-error-code":5,"type":"string","description":"Optional ID of the e-reporting template to use. If not specified, the system will auto-resolve a template based on the source object and supplier."}}}},"components/schemas/EComplianceRegenerateRequest":{"id":"components/schemas/EComplianceRegenerateRequest","kind":"json-schema","title":"EComplianceRegenerateRequest","data":{"x-error-code":1005,"type":"object","description":"Request body for regenerating an e-compliance request.","required":["complianceType","requestId"],"properties":{"complianceType":{"x-error-code":1,"$ref":"#/components/schemas/EComplianceType"},"requestId":{"x-error-code":2,"type":"string","description":"ID of the existing e-compliance request to regenerate."}}}},"components/schemas/InvoiceScheduleItemCustomFields":{"id":"components/schemas/InvoiceScheduleItemCustomFields","kind":"json-schema","title":"invoiceScheduleItemCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Invoice Schedule Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Invoice Schedule Item object.\n","title":"invoiceScheduleItemCustomFields","type":"object"}},"components/schemas/POSTScheduleItemType":{"id":"components/schemas/POSTScheduleItemType","kind":"json-schema","title":"scheduleItems","data":{"allOf":[{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the invoice to be generated during the processing of the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in one request."},"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 you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the corresponding response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returned in the corresponding response is calculated based on the percentage of the total amount."},"children":[]}]}]}]}],"type":"number"},"name":{"description":"The name of the invoice schedule item.\n","maxLength":100,"type":"string"},"percentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of the total amount to be billed during the processing of the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in one request."},"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 you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the corresponding response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returned in the corresponding response is calculated based on the percentage of the total amount."},"children":[]}]}]}]}],"type":"number","maximum":100},"runDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date in the tenant’s time zone when the invoice schedule item is planned to be processed to generate an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When specifying run dates for invoice schedule items, consider that:"},"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":"An invoice schedule item with a blank run date will not be executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only update the run date for an invoice schedule item in Pending status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the run date of an invoice schedule item is left empty, the dates of all subsequent invoice schedule items must also be blank."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify run dates in chronological order for invoice schedule items."},"children":[]}]}]}]}],"format":"date","type":"string"},"targetDateForAdditionalSubscriptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The regular charges must come from the subscriptions specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalSubscriptionsToBill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceScheduleItemCustomFields"},{}],"title":"scheduleItems"}},"components/schemas/InvoiceScheduleSpecificSubscriptions":{"id":"components/schemas/InvoiceScheduleSpecificSubscriptions","kind":"json-schema","title":"specificSubscriptions","data":{"properties":{"chargeNumbers":{"description":"A list of charges in the subscription that are chosen to be included in the invoice schedule.\n","type":"string"},"orderKey":{"description":"The unique ID or number of the order associated with the invoice schedule.\n","type":"string"},"subscriptionKey":{"description":"The unique number of the subscription contained in the order associated with the invoice schedule.\n","type":"string"}},"title":"specificSubscriptions","type":"object"}},"components/schemas/InvoiceScheduleCustomFields":{"id":"components/schemas/InvoiceScheduleCustomFields","kind":"json-schema","title":"invoiceScheduleCustomFields","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Invoice Schedule object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Invoice Schedule object.\n","title":"invoiceScheduleCustomFields","type":"object"}},"components/schemas/POSTCreateInvoiceScheduleRequest":{"id":"components/schemas/POSTCreateInvoiceScheduleRequest","kind":"json-schema","title":"POSTCreateInvoiceScheduleRequest","data":{"allOf":[{"properties":{"accountKey":{"description":"The ID or number of the account associated with the invoice schedule.\n","type":"string"},"additionalSubscriptionsToBill":{"description":"A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. \n\nOne invoice schedule can have at most 600 additional subscriptions.\n","items":{"type":"string"},"type":"array"},"invoiceSeparately":{"description":"Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices.\n","type":"boolean"},"notes":{"description":"Comments on the invoice schedule.\n","maxLength":255,"type":"string"},"orders":{"description":"A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders.\n","items":{"type":"string"},"type":"array"},"scheduleItems":{"description":"Container for invoice schedule items. One invoice schedule can have at most 50 invoice schedule items.\n","items":{"$ref":"#/components/schemas/POSTScheduleItemType"},"type":"array"},"specificSubscriptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of the numbers of specific subscriptions associated with the invoice schedule."},"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 subscriptions specified in this field belong to the orders specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, only the specific subscriptions instead of the orders are associated with the invoice schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified, all the subscriptions from the order are associated with the invoice schedule."},"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":"fence","attributes":{"content":"{\n  \"orders\": [\n    \"O-00000001\", \"O-00000002\"\n  ],\n  \"specificSubscriptions\": [\n    {\n      \"orderKey\": \"O-00000001\",\n      \"subscriptionKey\": \"S-00000001\"\n    }\n  ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"orders\": [\n    \"O-00000001\", \"O-00000002\"\n  ],\n  \"specificSubscriptions\": [\n    {\n      \"orderKey\": \"O-00000001\",\n      \"subscriptionKey\": \"S-00000001\"\n    }\n  ]\n}\n"},"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":"For the order with number O-00000001, only subscription S-00000001 contained in the order is associated with the invoice schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the order with number O-00000002, all subscriptions contained in the order are associated with the invoice schedule."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/InvoiceScheduleSpecificSubscriptions"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceScheduleCustomFields"},{}],"example":{"accountKey":"A00000007","additionalSubscriptionsToBill":["S-00000001","S-00000002"],"invoiceSeparately":false,"notes":"2022 Billing Schedule","orders":["O-00000007","O-00000008"],"scheduleItems":[{"amount":50000,"runDate":"2022-02-24","targetDateForAdditionalSubscriptions":"2022-02-24"},{"amount":14000,"runDate":"2022-10-17","targetDateForAdditionalSubscriptions":"2022-10-17"},{"amount":6200,"runDate":"2022-11-14","targetDateForAdditionalSubscriptions":"2022-11-14"}],"specificSubscriptions":[{"orderKey":"O-00000008","subscriptionKey":"S-00000008"}]}}},"components/schemas/ScheduleItemsResponse":{"id":"components/schemas/ScheduleItemsResponse","kind":"json-schema","title":"scheduleItems","data":{"allOf":[{"properties":{"actualAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual amount that needs to be billed during the processing of the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field keeps unchanged. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actualAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field reflects the actual amount to be billed."},"children":[]}]}]}],"format":"number","type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the invoice generated during the processing of the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in one request."},"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 you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the corresponding response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returned in the corresponding response is calculated based on the percentage of the total amount."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field keeps unchanged once invoice schedule items are created."},"children":[]}]}]}],"format":"number","type":"string"},"creditMemoId":{"description":"The ID of the credit memo that is generated during the processing of the invoice schedule item.\n","type":"string"},"id":{"description":"The unique ID of the invoice schedule item.\n","type":"string"},"invoiceId":{"description":"The ID of the invoice that is generated during the processing of the invoice schedule item.\n","type":"string"},"name":{"description":"The name of the invoice schedule item.\n","maxLength":100,"type":"string"},"percentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of the total amount to be billed during the processing of the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in one request."},"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 you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the corresponding response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returned in the corresponding response is calculated based on the percentage of the total amount."},"children":[]}]}]}]}]},"runDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date in the tenant’s time zone when the invoice schedule item is processed to generate an invoice."},"children":[]}]}]}],"format":"date","type":"string"},"status":{"description":"The status of the invoice schedule item.\n","enum":["Pending","Executing","Processed"],"type":"string"},"targetDateForAdditionalSubscriptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The regular charges must come from the subscriptions specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalSubscriptionsToBill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"format":"date","type":"string"},"organizationLabel":{"description":"Indicates the organization assigned to the Invoice Schedule Item for multi-org.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceScheduleItemCustomFields"},{}],"title":"scheduleItems"}},"components/schemas/InvoiceScheduleResponses":{"id":"components/schemas/InvoiceScheduleResponses","kind":"json-schema","title":"InvoiceScheduleResponses","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account that the invoice schedule belongs to.\n","type":"string"},"actualAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual amount that needs to be billed during the processing of the invoice schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field keeps unchanged. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actualAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field reflects the actual amount to be billed."},"children":[]}]}]}],"type":"number"},"additionalSubscriptionsToBill":{"description":"A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. \n\nOne invoice schedule can have at most 600 additional subscriptions.\n","items":{"type":"string"},"type":"array"},"billedAmount":{"description":"The amount that has been billed during the processing of the invoice schedule.\n","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the billing documents generated during the processing of the invoice schedule."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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 you have the Multiple Currencies feature disabled, the corresponding account's default currency is always used."},"children":[]}]}]}]}],"type":"string"},"id":{"description":"The unique ID of the invoice schedule.\n","type":"string"},"invoiceSeparately":{"description":"Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices.\n","type":"boolean"},"nextRunDate":{"description":"The run date of the next execution of invoice schedule. By default, the next run date is the same as run date of next pending invoice schedule item. It can be overwritten with a different date other than the default value. When the invoice schedule has completed the execution, the next run date is null.\n","format":"date","type":"string"},"notes":{"description":"Comments on the invoice schedule.\n","maxLength":255,"type":"string"},"number":{"description":"The sequence number of the invoice schedule.\n","type":"string"},"orders":{"description":"A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders.\n","items":{"type":"string"},"type":"array"},"scheduleItems":{"description":"Container for schedule items. One invoice schedule can have at most 50 invoice schedule items.\n","items":{"$ref":"#/components/schemas/ScheduleItemsResponse"},"type":"array"},"specificSubscriptions":{"description":"A list of the numbers of specific subscriptions associated with the invoice schedule.\n","items":{"$ref":"#/components/schemas/InvoiceScheduleSpecificSubscriptions"},"type":"array"},"status":{"description":"The status of the invoice schedule.\n","enum":["Pending","PartiallyProcessed","Paused","FullyProcessed"],"type":"string"},"totalAmount":{"description":"The total amount that needs to be billed during the processing of the invoice schedule. \n\nThe value of this field keeps unchanged once invoice schedule items are created.\n","type":"number"},"unbilledAmount":{"description":"The amount that is waiting to be billed during the processing of the invoice schedule.\n","type":"number"},"organizationLabel":{"description":"Indicates the organization assigned to the Invoice Schedule for multi-org.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceScheduleCustomFields"},{}]}},"components/schemas/UpdateScheduleItems":{"id":"components/schemas/UpdateScheduleItems","kind":"json-schema","title":"scheduleItems","data":{"allOf":[{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the invoice to be generated during the processing of the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in one request."},"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 you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the corresponding response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returned in the corresponding response is calculated based on the percentage of the total amount."},"children":[]}]}]}]}],"format":"number","type":"string"},"id":{"description":"The unique ID of the invoice schedule item to be updated. \n\nIf this field is not provided, a new invoice schedule item is added to the invoice schedule.\n","type":"string"},"name":{"description":"The name of the invoice schedule item.\n","maxLength":100,"type":"string"},"percentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of the total amount to be billed during the processing of the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in one request."},"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 you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the corresponding response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returned in the corresponding response is calculated based on the percentage of the total amount."},"children":[]}]}]}]}]},"runDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date in the tenant’s time zone when the invoice schedule item is planned to be processed to generate an invoice."},"children":[]}]}]}],"format":"date","type":"string"},"targetDateForAdditionalSubscriptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The regular charges must come from the subscriptions specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalSubscriptionsToBill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceScheduleItemCustomFields"},{}],"title":"scheduleItems"}},"components/schemas/PUTUpdateInvoiceScheduleRequest":{"id":"components/schemas/PUTUpdateInvoiceScheduleRequest","kind":"json-schema","title":"PUTUpdateInvoiceScheduleRequest","data":{"allOf":[{"properties":{"additionalSubscriptionsToBill":{"description":"A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. \n\nOne invoice schedule can have at most 600 additional subscriptions.\n","items":{"type":"string"},"type":"array"},"invoiceSeparately":{"description":"Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices.\n","type":"boolean"},"nextRunDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The run date of the next execution of the invoice schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the next run date is the same as the run date of next pending invoice schedule item. The date can be overwritten by a different date other than the default value. If the invoice schedule has completed the execution, the next run date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"notes":{"description":"Comments on the invoice schedule.\n","maxLength":255,"type":"string"},"orders":{"description":"A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders.\n\nThe orders specified in this field override all the existing orders associated with the invoice schedule.\n","items":{"type":"string"},"type":"array"},"scheduleItems":{"description":"Container for invoice schedule items. The maximum number of schedule items is 50.\n\nThe invoice schedule items specified in this field override all the existing invoice schedule items.\n","items":{"$ref":"#/components/schemas/UpdateScheduleItems"},"type":"array"},"specificSubscriptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of the numbers of specific subscriptions associated with the invoice schedule."},"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 subscriptions specified in this field belong to the orders specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, only the specific subscriptions instead of the orders are associated with the invoice schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified, all the subscriptions from the order are associated with the invoice schedule."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific subscriptions specified in this field override all the existing specific subscriptions associated with the invoice schedule."},"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":"fence","attributes":{"content":"{\n  \"orders\": [\n    \"O-00000001\", \"O-00000002\"\n  ],\n  \"specificSubscriptions\": [\n    {\n      \"orderKey\": \"O-00000001\",\n      \"subscriptionKey\": \"S-00000001\"\n    }\n  ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"orders\": [\n    \"O-00000001\", \"O-00000002\"\n  ],\n  \"specificSubscriptions\": [\n    {\n      \"orderKey\": \"O-00000001\",\n      \"subscriptionKey\": \"S-00000001\"\n    }\n  ]\n}\n"},"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":"For the order with number O-00000001, only subscription S-00000001 contained in the order is associated with the invoice schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the order with number O-00000002, all subscriptions contained in the order are associated with the invoice schedule."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/InvoiceScheduleSpecificSubscriptions"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/InvoiceScheduleCustomFields"},{}],"example":{"additionalSubscriptionsToBill":["S-00000001","S-00000002"],"invoiceSeparately":false,"nextRunDate":"2022-02-01","notes":"2022 Billing Schedule - V2","orders":["O-00000007","O-00000008"],"scheduleItems":[{"amount":54000,"id":"8a8881aa82118bec018211daf9f01680","runDate":"2022-02-24","targetDateForAdditionalSubscriptions":"2022-02-24"},{"amount":10000,"id":"8a8881aa82118bec018211daf9f11681","runDate":"2022-10-17","targetDateForAdditionalSubscriptions":"2022-10-17"},{"amount":6200,"id":"8a8881aa82118bec018211daf9f11682","runDate":"2022-11-14","targetDateForAdditionalSubscriptions":"2022-11-14"}],"specificSubscriptions":[{"orderKey":"O-00000008","subscriptionKey":"S-00000008"}]}}},"components/schemas/POSTExecuteInvoiceScheduleRequest":{"id":"components/schemas/POSTExecuteInvoiceScheduleRequest","kind":"json-schema","title":"POSTExecuteInvoiceScheduleRequest","data":{"allOf":[{"properties":{"scheduleItemId":{"description":"The ID of the invoice schedule item to be executed.\n\nThe item must be the earliest pending schedule item. If all the invoice schedule items have been processed and credit is needed to be generated, do not specify this field in the request.\n","type":"string"}},"type":"object"},{}],"example":{"scheduleItemId":"8ad09b7d82b5c62f0182c5cd16944f73"}}},"components/schemas/BillRunFilters":{"id":"components/schemas/BillRunFilters","kind":"json-schema","title":"billRunFilters","data":{"allOf":[{"properties":{"accountId":{"description":"The target account of the bill run.\n","type":"string"},"filterType":{"description":"The type of the filter to determine whether to create a bill run at the account level or subscription level.\n","enum":["Account","Subscription","InvoiceSchedule"],"type":"string"},"subscriptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the target subscription belonged to the target account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"},{}],"title":"billRunFilters"}},"components/schemas/ExecuteInvoiceScheduleBillRunResponse":{"id":"components/schemas/ExecuteInvoiceScheduleBillRunResponse","kind":"json-schema","title":"ExecuteInvoiceScheduleBillRunResponse","data":{"allOf":[{"properties":{"autoEmail":{"description":"Whether to automatically send an email after Auto-Post is complete.\n","type":"boolean"},"autoPost":{"description":"Whether to automatically post the bill run after the bill run is created.\n","type":"boolean"},"autoRenewal":{"description":"Whether to automatically renew auto-renew subscriptions that are up for renewal.\n","type":"boolean"},"batches":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of the batches of accounts for this bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot exist with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billRunFilters"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllBatches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or Batch"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a number between 1 and 50, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Batch7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of the bill cycle, this field is only valid when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"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":"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":"AllBillCycleDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or 1 - 31 for an ad-hoc bill run"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllBillCycleDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or 1 - 31 or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AsRunDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a scheduled bill run"},"children":[]}]}]}]}],"type":"string"},"billRunFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of the target account or subscriptions for this bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot exist with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BillRunFilters"},"type":"array"},"billRunNumber":{"description":"The number of bill run.\n","type":"string"},"chargeTypeToExclude":{"description":"The types of the charges to be excluded from the generation of billing documents.\n","items":{"enum":["OneTime","Recurring","Usage"],"type":"string"},"type":"array"},"createdById":{"description":"The ID of the user who created the bill run.\n","type":"string"},"createdDate":{"description":"The date and time when the bill run was created.\n","type":"string"},"id":{"description":"The unique ID of the bill run.\n","type":"string"},"invoiceDate":{"description":"The invoice date for this bill run, only valid for ad-hoc bill runs.\n","format":"date","type":"string"},"invoiceDateOffset":{"description":"The offset compared to bill run execution date, only valid for scheduled bill runs.\n","type":"integer"},"noEmailForZeroAmountInvoice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to suppress emails for invoices with the total amount of zero or not for this bill run after the bill run is complete."},"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":": Do not email invoices with the total amount of zero."},"children":[]}]}]}],"type":"boolean"},"organizationLabels":{"description":"The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.            \n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"scheduledExecutionTime":{"description":"The scheduled execution time for a bill run.\n","type":"string"},"status":{"description":"The status of the bill run.\n","enum":["Pending","Processing","Completed","Error","Canceled","Posted","PostInProgress","CancelInProgress","RemoveInProgress","Paused"],"type":"string"},"targetDate":{"description":"The target date for this bill run, only valid for ad-hoc bill run.\n","format":"date","type":"string"},"targetDateOffset":{"description":"The offset compared to bill run execution date, only valid for scheduled bill run.\n","type":"integer"},"updatedById":{"description":"The ID of the user who updated the bill run.\n","type":"string"},"updatedDate":{"description":"The date and time when the bill run was updated.\n","type":"string"}},"type":"object"},{}],"example":{"autoEmail":false,"autoPost":false,"autoRenewal":false,"billRunFilters":[{"accountId":"2c9081a03c63c94c013c66688a2c00bf","filterType":"Subscription","subscriptionId":"402882297e387c51017e38a245c313db"}],"billRunNumber":"BR-00000016","chargeTypeToExclude":["OneTime","Usage"],"createdById":"ff808081298c6e5401298c7274a40005","createdDate":"2022-01-24 19:58:27","id":"2c9890077e8a8490017e8bf3a5171a43","invoiceDate":"2020-02-01","noEmailForZeroAmountInvoice":false,"status":"Pending","success":true,"targetDate":"2020-02-01","updatedById":"ff808081298c6e5401298c7274a40005","updatedDate":"2022-01-24 19:58:27"}}},"components/schemas/DetachInvoiceScheduleRequest":{"id":"components/schemas/DetachInvoiceScheduleRequest","kind":"json-schema","title":"DetachInvoiceScheduleRequest","data":{"example":{"specificSubscriptions":[{"orderKey":"O-00017019","subscriptionKey":"A-S00008953","chargeNumbers":["C-00065317"]}]},"properties":{"specificSubscriptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of charge numbers to be detached from the invoice schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item in this array represents a specific subscription associated with the invoice schedule. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumbers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify all the charges you want to detach for each subscription."},"children":[]}]}]}],"items":{"type":"object","properties":{"chargeNumbers":{"description":"A list of charge numbers in the subscription to be detached from the invoice schedule.\n\nIf you want to detach all charges, you must specify all of the charge numbers in this field.\n","type":"string"},"orderKey":{"description":"The unique ID or number of the order associated with the invoice schedule.\n","type":"string"},"subscriptionKey":{"description":"The unique number of the subscription contained in the order associated with the invoice schedule.\n","type":"string"}},"title":"specificSubscriptions"},"type":"array"}},"type":"object"}},"components/schemas/AttachInvoiceScheduleRequest":{"id":"components/schemas/AttachInvoiceScheduleRequest","kind":"json-schema","title":"AttachInvoiceScheduleRequest","data":{"example":{"specificSubscriptions":[{"orderKey":"O-00017019","subscriptionKey":"A-S00008953","chargeNumbers":["C-00065317"]}]},"properties":{"specificSubscriptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of charge numbers to be attached to the invoice schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item in this array represents a specific subscription associated with the invoice schedule. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumbers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify all the charges you want to attach for each subscription."},"children":[]}]}]}],"items":{"type":"object","properties":{"chargeNumbers":{"description":"A list of charge numbers in the subscription to be attached to the invoice schedule.\n\nIf you want to attach all charges, you must specify all of the charge numbers in this field.\n","type":"string"},"orderKey":{"description":"The unique ID or number of the order associated with the invoice schedule.\n","type":"string"},"subscriptionKey":{"description":"The unique number of the subscription contained in the order associated with the invoice schedule.\n","type":"string"}},"title":"specificSubscriptions"},"type":"array"}},"type":"object"}},"components/schemas/ProxyCreateTaxationItem":{"id":"components/schemas/ProxyCreateTaxationItem","kind":"json-schema","title":"ProxyCreateTaxationItem","data":{"allOf":[{"properties":{"AccountingCode":{"description":" The Chart of Accounts ","type":"string"},"ExemptAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The calculated tax amount excluded due to the exemption."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"InvoiceItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the specific invoice item that the taxation information applies to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid invoice item ID"},"children":[]}]}]}],"type":"string"},"Jurisdiction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a string of 32 characterrs or fewer"},"children":[]}]}]}],"type":"string"},"LocationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"type":"string"},"Name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the tax rate, such as sales tax or GST. This name is displayed on invoices."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 128 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a string of 128 characters or fewer"},"children":[]}]}]}],"type":"string"},"TaxAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the tax applied to the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"TaxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code identifies which tax rules and tax rates to apply to a specific charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a string of 32 characters or fewer"},"children":[]}]}]}],"type":"string"},"TaxCodeDescription":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description for the tax code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 255 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a string of 255 characters or fewer"},"children":[]}]}]}],"type":"string"},"TaxDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the tax is applied to the charge, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29"},"children":[]}]}]}],"format":"date","type":"string"},"TaxRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax rate applied to the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid decimal value"},"children":[]}]}]}],"format":"double","type":"number"},"TaxRateDescription":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the tax rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 255 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a string of 255 characters or fewer"},"children":[]}]}]}],"type":"string"},"TaxRateType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the tax rate applied to the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 10 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FlatFee"},"children":[]}]}]}],"type":"string"}},"required":["InvoiceItemId","Jurisdiction","Name","TaxAmount","TaxRate","TaxDate","TaxRateType"],"type":"object"},{"$ref":"#/components/schemas/TaxationItemObjectCustomFields"}],"example":{"InvoiceItemId":"8ad086fa92d66ffe0192dc7e5dd65161","Jurisdiction":"CALIFORNIA","Name":"CA TAX","TaxAmount":3,"TaxDate":"2024-11-04","TaxRate":3,"TaxRateType":"FlatFee"}}},"components/schemas/GETTaxationItemType":{"id":"components/schemas/GETTaxationItemType","kind":"json-schema","title":"GETTaxationItemType","data":{"allOf":[{"properties":{"createdById":{"description":"The ID of the Zuora user who created the taxation item. \n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the taxation item was created in the Zuora system, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the taxation item.\n","properties":{"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","type":"string","nullable":true},"onAccountAccountingCodeType":{"description":"The type of the accounting code that maps to an on account in your accounting system.\n","type":"string","nullable":true},"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","type":"string"},"salesTaxPayableAccountingCodeType":{"description":"The type of the accounting code for the sales taxes payable.\n","type":"string"}},"type":"object"},"id":{"description":"The ID of the taxation item.\n","type":"string"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string","nullable":true},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string","nullable":true},"memoItemId":{"description":"The ID of the credit or debit memo associated with the taxation item.\n","type":"string","nullable":true},"name":{"description":"The name of the taxation item.\n","type":"string"},"sourceTaxItemId":{"description":"The ID of the taxation item of the invoice, which the credit or debit memo is created from.\n","type":"string","nullable":true},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"taxAmount":{"description":"The amount of the tax applied to the credit or debit memo.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific credit or debit memo.\n","type":"string","nullable":true},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string","nullable":true},"taxDate":{"description":"The date when the tax is applied to the credit or debit memo.\n","format":"date","type":"string"},"taxRate":{"description":"The tax rate applied to the credit or debit memo.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string","nullable":true},"taxRateType":{"description":"The type of the tax rate applied to the credit or debit memo.\n","enum":["Percentage","FlatFee"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the taxation item.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the taxation item was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TaxationItemObjectCustomFields"}]}},"components/schemas/PUTTaxationItemType":{"id":"components/schemas/PUTTaxationItemType","kind":"json-schema","title":"PUTTaxationItemType","data":{"allOf":[{"properties":{"applicableTaxUnRounded":{"description":"The unrounded amount of the tax.\n","type":"number"},"country":{"description":"The country code.\n","type":"string"},"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"financeInformation":{"description":"Container for the finance information related to the taxation item.\n","properties":{"onAccountAccountingCode":{"description":"The accounting code that maps to an on account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"salesTaxPayableAccountingCode":{"description":"The accounting code for the sales taxes payable.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"name":{"description":"The name of the taxation item to be updated.\n","type":"string"},"taxAmount":{"description":"The amount of the tax applied to the credit or debit memo.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific credit or debit memo.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":"The date when the tax is applied to the credit or debit memo.\n","format":"date","type":"string"},"taxRate":{"description":"The tax rate applied to the credit or debit memo.\n","format":"double","type":"number"},"taxRateDescription":{"description":"The description of the tax rate. \n","type":"string"},"taxRateType":{"description":"The type of the tax rate applied to the credit or debit memo.\n","enum":["Percentage","FlatFee"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/TaxationItemObjectCustomFields"}],"example":{"taxRateDescription":"Details of the tax rate"}}},"components/schemas/CreditMemoEntityPrefix":{"id":"components/schemas/CreditMemoEntityPrefix","kind":"json-schema","title":"creditMemo","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the prefix and starting document number of credit memos."},"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 only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"properties":{"prefix":{"description":"The prefix of credit memos.\n","example":"CM","type":"string"},"startNumber":{"description":"The starting document number of credit memos.\n","example":10,"type":"integer"}},"title":"creditMemo","type":"object"}},"components/schemas/DebitMemoEntityPrefix":{"id":"components/schemas/DebitMemoEntityPrefix","kind":"json-schema","title":"debitMemo","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the prefix and starting document number of debit memos."},"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 only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"properties":{"prefix":{"description":"The prefix of debit memos.\n","example":"DM","type":"string"},"startNumber":{"description":"The starting document number of debit memos.\n","example":10,"type":"integer"}},"title":"debitMemo","type":"object"}},"components/schemas/InvoiceEntityPrefix":{"id":"components/schemas/InvoiceEntityPrefix","kind":"json-schema","title":"Invoice","data":{"description":"Container for the prefix and starting document number of invoices.\n","properties":{"prefix":{"description":"The prefix of invoices.\n","example":"INV","type":"string"},"startNumber":{"description":"The starting document number of invoices.\n","example":10,"type":"integer"}},"title":"Invoice","type":"object"}},"components/schemas/PaymentEntityPrefix":{"id":"components/schemas/PaymentEntityPrefix","kind":"json-schema","title":"payment","data":{"description":"Container for the prefix and starting number of payments.\n","properties":{"prefix":{"description":"The prefix of payments.\n","example":"P-","type":"string"},"startNumber":{"description":"The starting number of payments.\n","example":10,"type":"integer"}},"title":"payment","type":"object"}},"components/schemas/RefundEntityPrefix":{"id":"components/schemas/RefundEntityPrefix","kind":"json-schema","title":"refund","data":{"description":"Container for the prefix and starting number of refunds.\n","properties":{"prefix":{"description":"The prefix of refunds.\n","example":"R-","type":"string"},"startNumber":{"description":"The starting number of refunds.\n","example":10,"type":"integer"}},"title":"refund","type":"object"}},"components/schemas/GETSequenceSetResponse":{"id":"components/schemas/GETSequenceSetResponse","kind":"json-schema","title":"sequenceSets","data":{"description":"","properties":{"creditMemo":{"$ref":"#/components/schemas/CreditMemoEntityPrefix"},"debitMemo":{"$ref":"#/components/schemas/DebitMemoEntityPrefix"},"id":{"description":"The unique ID of the sequence set. For example, 402892c74c9193cd014c96bbe7c101f9.\n","type":"string"},"invoice":{"$ref":"#/components/schemas/InvoiceEntityPrefix"},"name":{"description":"The name of the sequence set.\n","type":"string"},"payment":{"$ref":"#/components/schemas/PaymentEntityPrefix"},"refund":{"$ref":"#/components/schemas/RefundEntityPrefix"}},"title":"sequenceSets","type":"object"}},"components/schemas/GETSequenceSetsResponse":{"id":"components/schemas/GETSequenceSetsResponse","kind":"json-schema","title":"GETSequenceSetsResponse","data":{"description":"","properties":{"sequenceSets":{"description":"Array of sequence sets configured for billing documents, payments, and refunds.\n","items":{"$ref":"#/components/schemas/GETSequenceSetResponse"},"type":"array"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/POSTSequenceSetRequest":{"id":"components/schemas/POSTSequenceSetRequest","kind":"json-schema","title":"sequenceSets","data":{"description":"","properties":{"creditMemo":{"$ref":"#/components/schemas/CreditMemoEntityPrefix"},"debitMemo":{"$ref":"#/components/schemas/DebitMemoEntityPrefix"},"invoice":{"$ref":"#/components/schemas/InvoiceEntityPrefix"},"name":{"description":"The name of the sequence set to configure for billing documents, payments, and refunds.\n","example":"FRANCE","type":"string"},"sequenceSetNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sequence set number to assign when creating the sequence set."},"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 value is set only during creation and cannot be updated after the sequence set is created."},"children":[]}]}]}],"type":"string"},"payment":{"$ref":"#/components/schemas/PaymentEntityPrefix"},"refund":{"$ref":"#/components/schemas/RefundEntityPrefix"}},"required":["name","invoice","creditMemo","debitMemo"],"title":"sequenceSets","type":"object"}},"components/schemas/POSTSequenceSetsRequest":{"id":"components/schemas/POSTSequenceSetsRequest","kind":"json-schema","title":"POSTSequenceSetsRequest","data":{"description":"","example":{"sequenceSets":[{"name":"FR","sequenceSetNumber":"FR","creditMemo":{"prefix":"FCM","startNumber":10},"debitMemo":{"prefix":"FDM","startNumber":10},"invoice":{"prefix":"FINV","startNumber":10},"payment":{"prefix":"FP-","startNumber":10},"refund":{"prefix":"FR-","startNumber":10}}]},"properties":{"sequenceSets":{"description":"Array of sequence sets configured for billing documents, payments, and refunds.\n","items":{"$ref":"#/components/schemas/POSTSequenceSetRequest"},"type":"array"}},"type":"object"}},"components/schemas/POSTSequenceSetsResponse":{"id":"components/schemas/POSTSequenceSetsResponse","kind":"json-schema","title":"POSTSequenceSetsResponse","data":{"description":"","properties":{"sequenceSets":{"description":"Array of sequence sets configured for billing documents, payments, and refunds.\n","items":{"$ref":"#/components/schemas/GETSequenceSetResponse"},"type":"array"},"success":{"description":"Indicates whether the call succeeded.\n","example":true,"type":"boolean"}},"type":"object"}},"components/schemas/PUTSequenceSetRequest":{"id":"components/schemas/PUTSequenceSetRequest","kind":"json-schema","title":"PUTSequenceSetRequest","data":{"description":"","example":{"creditMemo":{"prefix":"FR-CM"}},"properties":{"creditMemo":{"$ref":"#/components/schemas/CreditMemoEntityPrefix"},"debitMemo":{"$ref":"#/components/schemas/DebitMemoEntityPrefix"},"invoice":{"$ref":"#/components/schemas/InvoiceEntityPrefix"},"name":{"description":"The name of the sequence set configured for billing documents, payments, and refunds.\n","type":"string"},"payment":{"$ref":"#/components/schemas/PaymentEntityPrefix"},"refund":{"$ref":"#/components/schemas/RefundEntityPrefix"}},"type":"object"}},"components/schemas/PUTSequenceSetResponse":{"id":"components/schemas/PUTSequenceSetResponse","kind":"json-schema","title":"PUTSequenceSetResponse","data":{"description":"","properties":{"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/PostBillingPreviewParam":{"id":"components/schemas/PostBillingPreviewParam","kind":"json-schema","title":"PostBillingPreviewParam","data":{"example":{"accountId":"8ad09bce83f1da020183f97e245c1c47","targetDate":"2024-09-30"},"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the customer account to which the billing preview applies."},"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":": When posting billing preview, you must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"maxLength":255,"type":"string"},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the customer account to which the billing preview applies."},"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":": When posting billing preview, you must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"type":"string"},"assumeRenewal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to generate a preview of future invoice items and credit memo items with the assumption that the subscriptions are renewed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set one of the following values in this field to decide how the assumption is applied in the billing preview."},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"None:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Default) The assumption is not applied to the subscriptions. Zuora generates preview invoice item data and credit memo item data based on the current term end date and the target date."},"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":"If the target date is later than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the current term end date."},"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":"If the target date is earlier than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","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":"Autorenew:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The assumption is applied to the subscriptions that have auto-renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date."},"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":"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":"This field can only be used if the subscription renewal term is not set to 0."},"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":"The credit memo item data is only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}]}],"type":"string"},"chargeTypeToExclude":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charge types to exclude from the billing preview."},"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":"Possible values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OneTime, Recurring, Usage, and any combination of these values."},"children":[]}]}]}],"type":"string"},"includingDraftItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether draft document items are included in the billing preview run. By default, draft document items are not included."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field loads draft invoice items and credit memo items. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeTypeToExclude"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includingEvergreenSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assumeRenewal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields do not affect the behavior of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includingDraftItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"includingEvergreenSubscription":{"description":"Indicates if evergreen subscriptions are included in the billingPreview call.\n","type":"boolean"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the billingPreview call. The billingPreview call generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the TargetDate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the TargetDate is later than the subscription current term end date, the preview invoice item data and credit memo item data is generated from the first day of the customer's next billing period to the current term end date. If you want to generate preview invoice item data and credit memo item data past the end of the subscription current term, specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssumeRenewal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request."},"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 credit memo item data is only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["targetDate"],"type":"object"}},"components/schemas/POSTBillingPreviewCreditMemoItem":{"id":"components/schemas/POSTBillingPreviewCreditMemoItem","kind":"json-schema","title":"creditMemoItems","data":{"properties":{"amount":{"description":"The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax\n","format":"double","type":"number"},"amountWithoutTax":{"description":"The credit memo item amount excluding tax.\n","format":"double","type":"number"},"appliedToItemId":{"description":"The unique ID of the credit memo item that the discount charge is applied to.\n","type":"string","nullable":true},"chargeDate":{"description":"The date when the credit memo item is created.\n","type":"string"},"chargeNumber":{"description":"Number of the charge.\n","type":"string"},"chargeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"comment":{"description":"Comment of the credit memo item.\n","type":"string"},"id":{"description":"Credit memo item id.\n","type":"string"},"numberOfDeliveries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of deliveries dedicated to the Delivery Pricing charges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the Delivery Pricing feature enabled."},"children":[]}]}]}],"type":"number"},"processingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the kind of charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]}]}]}],"type":"string"},"quantity":{"description":"Quantity of this item, in the configured unit of measure for the charge.\n","format":"decimal","type":"string"},"ratePlanChargeId":{"description":"Id of the rate plan charge associated with this item.\n","type":"string"},"serviceEndDate":{"description":"End date of the service period for this item, i.e., the last day of the service period, in yyyy-mm-dd format.\n","format":"date","type":"string"},"serviceStartDate":{"description":"Start date of the service period for this item, in yyyy-mm-dd format. If the charge is a one-time fee, this is the date of that charge.\n","format":"date","type":"string"},"sku":{"description":"Unique SKU for the product associated with this item.\n","type":"string"},"skuName":{"description":"Name of the unique SKU for the product associated with this item.\n","type":"string"},"subscriptionId":{"description":"ID of the subscription associated with this item.\n","type":"string"},"subscriptionNumber":{"description":"Name of the subscription associated with this item.\n","type":"string"},"unitOfMeasure":{"description":"Unit used to measure consumption.\n","type":"string"}},"title":"creditMemoItems","type":"object"}},"components/schemas/POSTBillingPreviewInvoiceItem":{"id":"components/schemas/POSTBillingPreviewInvoiceItem","kind":"json-schema","title":"invoiceItems","data":{"properties":{"appliedToItemId":{"description":"The unique ID of the invoice item that the discount charge is applied to.\n","type":"string","nullable":true},"chargeAmount":{"description":"The amount of the charge. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.\n","format":"decimal","type":"string"},"chargeDate":{"description":"The date when the invoice item was created.\n","type":"string"},"chargeDescription":{"description":"Description of the charge.\n","type":"string"},"chargeId":{"description":"Id of the charge.\n","type":"string"},"chargeName":{"description":"Name of the charge.\n","type":"string"},"chargeNumber":{"description":"Number of the charge.\n","type":"string"},"chargeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"id":{"description":"Invoice item ID.\n","type":"string"},"numberOfDeliveries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of deliveries dedicated to the Delivery Pricing charges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the Delivery Pricing feature enabled."},"children":[]}]}]}],"type":"number"},"processingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the kind of charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax"},"children":[]}]}]}]}],"type":"string"},"productName":{"description":"Name of the product associated with this item.\n","type":"string"},"quantity":{"description":"Quantity of this item, in the configured unit of measure for the charge.\n","format":"decimal","type":"string"},"serviceEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the service period for this item, i.e., the last day of the service period, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"serviceStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the service period for this item, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. If the charge is a one-time fee, this is the date of that charge."},"children":[]}]}]}],"format":"date","type":"string"},"subscriptionId":{"description":"ID of the subscription associated with this item.\n","type":"string"},"subscriptionName":{"description":"Name of the subscription associated with this item.\n","type":"string"},"subscriptionNumber":{"description":"Number of the subscription associated with this item.\n","type":"string"},"taxAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-zuora-tax-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Tax"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the product rate plan charge associated with the invoice item is of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-tax-code-and-set-tax-mode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax inclusive mode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the value of this field is the amount of tax applied to the charge. Otherwise, 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":"."},"children":[]}]}]}],"format":"decimal","type":"string"},"unitOfMeasure":{"description":"Unit used to measure consumption.\n","type":"string"}},"title":"invoiceItems","type":"object"}},"components/schemas/BillingPreviewResult":{"id":"components/schemas/BillingPreviewResult","kind":"json-schema","title":"BillingPreviewResult","data":{"properties":{"accountId":{"description":"ID of the customer account to which the billing preview applies.\n","type":"string"},"creditMemoItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of credit memo items returned as the result of the billing preivew request."},"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 credit memo items are only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/POSTBillingPreviewCreditMemoItem"},"type":"array"},"invoiceItems":{"description":"An array of invoice items returned as the result of the billing preview request.\n","items":{"$ref":"#/components/schemas/POSTBillingPreviewInvoiceItem"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/POSTInvoiceCollectType":{"id":"components/schemas/POSTInvoiceCollectType","kind":"json-schema","title":"POSTInvoiceCollectType","data":{"example":{"accountKey":"4028925a4cb74ec9014cb7520fc00005","invoiceId":"4028925a4cb74ec9014cb7540988002e"},"properties":{"accountKey":{"description":"Customer account ID or account number.\n","type":"string"},"documentDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that should appear on the invoice and credit memo being generated,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. If this field is omitted"},"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":"invoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified, the current date is used by default."},"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 credit memo is only available if you have the Invoice Settlement feature enabled."},"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 available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"215.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"invoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID or number of an existing invoice for which to collect payment using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the account's default payment method. If this value is specified, no new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice is generated, and the following fields are ignored:"},"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":"invoiceDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTargetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (if the Zuora minor API version is 214.0 or earlier)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (if the Zuora minor API version is 215.0 or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}],"type":"string"},"paymentGateway":{"description":"The name of the gateway that will be used for the payment. Must be a valid gateway name and the gateway must support the specific payment method. If a value is not specified, the default gateway on the Account will be used.\n","type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date through which to calculate charges on this account if an invoice or a credit memo is generated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. If this field is omitted and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified, the current date is used by default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"215.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"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":"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 credit memo is only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]}],"format":"date","type":"string"},"paymentMethodId":{"description":"The unique identifier of the payment method.\n","type":"string"}},"required":["accountKey"],"type":"object"}},"components/schemas/POSTInvoiceCollectCreditMemosType":{"id":"components/schemas/POSTInvoiceCollectCreditMemosType","kind":"json-schema","title":"creditMemos","data":{"properties":{"id":{"description":"The ID of the credit memo.\n","type":"string"},"totalAmount":{"description":"The amount of the credit memo.\n","format":"double","type":"number"},"memoNumber":{"description":"The unique identification number of the credit memo.\n","type":"string"}},"title":"creditMemos","type":"object"}},"components/schemas/POSTInvoiceCollectInvoicesType":{"id":"components/schemas/POSTInvoiceCollectInvoicesType","kind":"json-schema","title":"invoices","data":{"properties":{"invoiceAmount":{"description":"The amount of the invoice.\n","format":"decimal","type":"string"},"invoiceId":{"description":"The ID of the invoice.\n","type":"string"},"invoiceNumber":{"description":"The unique identification number of the invoice.\n","type":"string"}},"title":"invoices","type":"object"}},"components/schemas/POSTInvoiceCollectResponseType":{"id":"components/schemas/POSTInvoiceCollectResponseType","kind":"json-schema","title":"POSTInvoiceCollectResponseType","data":{"properties":{"amountCollected":{"description":"Payment amount applied.\n","format":"double","type":"number"},"creditMemos":{"description":"Information on one or more credit memos associated with this operation.\n","items":{"$ref":"#/components/schemas/POSTInvoiceCollectCreditMemosType"},"type":"array"},"invoices":{"description":"Information on one or more invoices associated with this operation.\n","items":{"$ref":"#/components/schemas/POSTInvoiceCollectInvoicesType"},"type":"array"},"paymentId":{"description":"Payment ID.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GetOperationJobResponseType":{"id":"components/schemas/GetOperationJobResponseType","kind":"json-schema","title":"GetOperationJobResponseType","data":{"properties":{"id":{"description":"The ID of the operation job to retrieve information about.\n","type":"string"},"objectId":{"description":"The ID of the business object which is being operated.\n","type":"string"},"objectType":{"description":"The object type of the job. \n","enum":["Invoice"],"type":"string"},"operationType":{"description":"The operation type of the job.\n","enum":["Delete","Reverse"],"type":"string"},"reasons":{"items":{"properties":{"code":{"description":"The error code of the response.\n","type":"string"},"message":{"description":"The detail information of the error response.\n","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of the operation job. \n","enum":["Pending","Processing","Failed","Completed"],"type":"string"},"success":{"description":"Whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/DocumentList":{"id":"components/schemas/DocumentList","kind":"json-schema","title":"DocumentList","data":{"example":{"docType":"Invoice","objectIds":["402880de8ce7edc3018ce7f18404315a","402880de8ce7edc3018ce7f18e0b3804"]},"properties":{"docType":{"description":"The type of billing document.","enum":["Invoice","CreditMemo","DebitMemo"],"type":"string"},"objectIds":{"description":"The collection of billing document IDs.","items":{"type":"string"},"type":"array"}},"type":"object"}},"components/schemas/POSTBulkPdfGenerationJobRequestType":{"id":"components/schemas/POSTBulkPdfGenerationJobRequestType","kind":"json-schema","title":"POSTBulkPdfGenerationJobRequestType","data":{"allOf":[{"type":"object","required":["documents","fileName","indexFileFormat"],"example":{"documents":[{"docType":"Invoice","objectIds":["402880de8ce7edc3018ce7f18404315a","402880de8ce7edc3018ce7f18e0b3804"]}],"fileName":"all-invoices-posted-jan-2024","name":"BulkPDFGenerationJobV1","indexFileFormat":"JSON","generateMissingPDF":true,"ignoreArchivedFiles":true},"properties":{"documents":{"description":"An array that contains a collection of objects where each object contains billing document type and their IDs.\n","items":{"$ref":"#/components/schemas/DocumentList"},"type":"array"},"fileName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The prefix part of output file name(s). The response will include multiple file URLs. The number of zip files generated corresponds to the number of invoice IDs. Each zip file contains up to 1000 document IDs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Eg:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if fileName is \"all-invoices-posted-jan-2024\" then fileURL(s) will start with the file name followed by an underscore and a number. For instance, all-invoices-posted-jan-2024_1.zip, all-invoices-posted-jan-2024_2.zip, and so on."},"children":[]}]}]}],"type":"string","maxLength":32},"name":{"description":"The name of the job.\n","type":"string","maxLength":32},"indexFileFormat":{"description":"The format of the index file. It contains the metadata about the files and their contents.\n","enum":["JSON","CSV"],"type":"string"},"generateMissingPDF":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This flag controls the behavior of whether to generate PDF(s) for billing documents that do not already have one."},"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":"setting it to true indicates service would go through the provided document ID list, find the billing documents that do not have a generated PDF,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generate them all at once, and then proceed to the zipping process."},"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":"setting it to false indicates service would go through the provided document ID list, find the billing documents that do not have a generated PDF,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mark them as Invalid, and skip them from the zipping process. IDs marked as invalid will be included 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 default value is false."},"children":[]}]}]}],"type":"boolean"},"ignoreArchivedFiles":{"description":"Ignores archived PDF files during export without causing the entire job request to fail when enabled. \n","type":"boolean"},"persistIndexFile":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the generation of the index file, allowing you to efficiently handle high volumes of requests. By default, this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the index file is generated and included in the zip file."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the index file is not generated and consequently not included in the zip file."},"children":[]}]}]}]}],"type":"boolean"}}}]}},"components/schemas/POSTBulkPdfGenerationJobResponseType":{"id":"components/schemas/POSTBulkPdfGenerationJobResponseType","kind":"json-schema","title":"POSTBulkPdfGenerationJobResponseType","data":{"example":{"jobId":"402880de8ce7edc3018ce7f18404312a","invalidIds":[],"success":true},"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"jobId":{"description":"Unique Id for the Job Triggered.\n","type":"string"},"invalidIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collection of Ids that are not valid."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id is considered to be invalid if,"},"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":"Billing Document Id doesn't exist in the database for the corresponding Billing Document Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generateMissingPDF property is false in the Job Request and Valid PDF doesn't exist for the Billing Document Id"},"children":[]}]}]}]}]},"skippedDocuments":{"description":[{"$$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":"skippedDocuments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array will be empty unless archived files are marked to skip during job creation."},"children":[]}]}]}],"items":{"type":"object","properties":{"docType":{"description":"The document type of the skipped document.\n","enum":["Invoice","CreditMemo","DebitMemo"],"type":"string"},"objectIds":{"description":"The IDs of the skipped document objects.\n","type":"array","items":{"type":"string"}}}},"type":"array"}},"type":"object"}]}},"components/schemas/GETBulkpdfGenerationJobResponseType":{"id":"components/schemas/GETBulkpdfGenerationJobResponseType","kind":"json-schema","title":"GETBulkpdfGenerationJobResponseType","data":{"example":{"jobId":"402880de8ce7edc3018ce7f18404312a","jobName":"BulkPDFGenerationJobV1","status":"Completed","stepStatus":"PostProcessing","fileUrls":["https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_1.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99","https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_2.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99"],"createdOn":"2024-01-08 12:52:05","createdBy":"caf630704a6f4100818601625ecffe0b","success":true},"properties":{"jobId":{"description":"Unique Id for the Triggered Job","type":"string"},"jobName":{"description":"Name of the Job provided during the POST request of the Job","type":"string"},"status":{"description":"Status of the job","enum":["Submitted","Executing","Completed","Error","Aborted","Cancelled"],"type":"string"},"stepStatus":{"description":"Status of the Current Step that the Job is undergoing","enum":["JobCreated","TasksCreated","GenerateMissPDF","PdfToZip","PostProcessing"],"type":"string"},"fileUrls":{"description":"Collection of S3 Pre-Signed URL(s) that can be downloaded","items":{"type":"string"},"type":"array"},"failedDocuments":{"description":"Array of objects where each object contains billing document type and the IDs which failed to execute.","items":{"$ref":"#/components/schemas/DocumentList"},"type":"array"},"createdOn":{"description":"Job Created Time","type":"string"},"createdBy":{"description":"Id of the user who created the job","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/Condition":{"id":"components/schemas/Condition","kind":"json-schema","title":"Condition","data":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for condition information about the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-bill-run-advanced-filter","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill Run Advanced Filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"conditions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are combined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields. These "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields form a custom filter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is a formula combined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-bill-run-advanced-filter-common-use-cases","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common use cases of Bill Run Advanced Filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/Condition"}},"field":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field name of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string","nullable":true},"operator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operator of a single condition that is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field.  The operator is added between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"eq: equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"neq: not equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" != "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"gt: greater than ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lt: less than ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" < "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"gte: greater than or equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lte: less than or equal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"lk: like ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"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":"in: in ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the values are separated by comma)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nl: null ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nnl: not null ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not null)"},"children":[]}]}]}]}],"type":"string","nullable":true,"enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"]},"relation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relation among the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"type":"string","nullable":true,"enum":["and","or"]},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value or list of values to compare against, depending on the operator. For most operators (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a single literal value or a supported built-in variable. When you use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator in an Advanced Filter, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a comma-separated list with no more than 500 values. If more than 500 values are provided, the API returns a validation error and the Bill Run is not started. This limit applies only to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator and does not affect the total number of accounts or subscriptions a Bill Run can process."},"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":"filterType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FilterCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can provide either:"},"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":"A literal value (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"15\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A built-in variable in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{VariableName}}"},"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":"Built-in variables are supported only in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of date-type conditions and are resolved at runtime:"},"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":"code","inline":true,"attributes":{"content":"{{Today}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Current date in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{BillRunDate}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Bill run execution date in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{TargetDate}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Bill run target date in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{InvoiceDate}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Bill run invoice date in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"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":"\"value\": \"{{BillRunDate}}\""},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Built‑in variable for Bill Cycle Day:"},"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":"{{AsRunDay}}"},"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":"The day of the month from the bill run execution date, formatted for Bill Cycle Day (BCD) matching."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must use this variable only with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]}]}]}],"type":"string","nullable":true}},"type":"object","title":"Condition"}]}},"components/schemas/BillRunFilterRequestType":{"id":"components/schemas/BillRunFilterRequestType","kind":"json-schema","title":"billRunFilters","data":{"allOf":[{"properties":{"accountId":{"description":"The target account of the bill run. \n\nIf multiple subscriptions are specified, the account ID must be the same.\n","type":"string"},"filterType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create bill runs based on the selected filter type:"},"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":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Create bill runs by account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Create bill runs by subscription, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionId"},"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":"code","inline":true,"attributes":{"content":"FilterCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Create bill runs by custom filter combining the Account, Subscription, and Rate Plan objects, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"condition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/bill-runs/automate-billing-document-generation/bill-run-advanced-filter","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill Run Advanced Filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Account","Subscription","FilterCondition"],"type":"string"},"condition":{"$ref":"#/components/schemas/Condition"},"objectType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target object type of the condition when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FilterCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/bill-runs/automate-billing-document-generation/bill-run-advanced-filter","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill Run Advanced Filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["Account","Subscription","RatePlanCharge"]},"subscriptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target subscripiton ID of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"}},"required":["accountId","filterType"],"type":"object"}],"title":"billRunFilters"}},"components/schemas/BillRunScheduleRequestType":{"id":"components/schemas/BillRunScheduleRequestType","kind":"json-schema","title":"schedule","data":{"allOf":[{"description":"Container for information about the scheduled bill run.\n","properties":{"repeatFrom":{"description":"The start date of the scheduled bill run.\n","format":"date","type":"string"},"repeatTo":{"description":"The end date of of the scheduled bill run.\n","format":"date","type":"string"},"repeatType":{"description":"The repeat type of the bill run.\n","enum":["None","Daily","Weekly","Monthly"],"type":"string"},"runTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled run time (hour) of day."},"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":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 0 - 23"},"children":[]}]}]}],"type":"integer"},"weeklyOnDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The repeat day in a week."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"enum":["Mon","Tue","Wed","Thu","Fri","Sat","Sun"],"type":"string"},"type":"array"},"monthlyOnEndOfMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to schedule monthly bill run on the end of month or the specific day of month."},"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 available only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to the end of month."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"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":"When repeatFrom = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-04-30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthlyOnEndOfMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", next bill run will be scheduled on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-05-31"},"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":"When repeatFrom = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-04-30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthlyOnEndOfMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", next bill run will be scheduled on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-05-30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"boolean"}},"required":["repeatFrom","repeatType","runTime"],"type":"object"}],"title":"schedule"}},"components/schemas/POSTCreateBillRunRequestType":{"id":"components/schemas/POSTCreateBillRunRequestType","kind":"json-schema","title":"POSTCreateBillRunRequestType","data":{"allOf":[{"properties":{"autoEmail":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically send emails after Auto-Post is complete."},"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":" To use this field, you must first set the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/billing-settings-configuration/general-billing-settings/define-billing-rules","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support Bill Run Auto-Post?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" billing rule to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI."},"children":[]}]}]}],"type":"boolean"},"autoPost":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically post the bill run after the bill run is created."},"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":" To use this field, you must first set the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/billing-settings-configuration/general-billing-settings/define-billing-rules","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support Bill Run Auto-Post?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" billing rule to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Zuora UI."},"children":[]}]}]}],"type":"boolean"},"autoRenewal":{"default":false,"description":"Whether to automatically renew auto-renew subscriptions that are up for renewal.\n","type":"boolean"},"batches":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch of accounts for this bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billRunFilters"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllBatches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Batch*n*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of numbers 1 - 50, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Batch7"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/entitlements/current-entitlements/performance-booster-elite","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance Booster Elite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" package."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of the bill cycle. This field is only valid if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"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":"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":"AllBillCycleDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or one of numbers 1 - 31 for an ad-hoc bill run"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllBillCycleDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", one of numbers 1 - 31, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AsRunDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a scheduled bill run"},"children":[]}]}]}]}],"type":"string"},"billRunFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target account, subscriptions, invoice schedule, or a combination of objects for this bill run. You can only specify either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BillRunFilterRequestType"},"type":"array"},"billRunType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the bill run. If you do not specify any value for this field, the default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Regular"},"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":"You can use this field only if the \"Catch-Up Bill Run\" feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify this field to create a catch up bill run."},"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":"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":"Regular"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CatchUp"},"children":[]}]}]}]}],"type":"string"},"chargeTypeToExclude":{"description":"The types of the charges to be excluded from the generation of billing documents. You can specify at most two charge types in the array.\n","items":{"enum":["OneTime","Recurring","Usage"],"type":"string"},"type":"array"},"includeSubscriptions":{"default":true,"description":"Indicates whether to bill subscriptions in the bill run.\n","type":"boolean"},"includeOrderLineItems":{"default":true,"description":"Indicates whether to bill order line items in the bill run.\n","type":"boolean"},"invoiceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice date for the bill run."},"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":"When creating an ad-hoc bill run, if you do not specify any value for this field, the default value is the current date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a scheduled bill run, if you do not specify any value for this field, the invoice date is the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatFrom"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You can use one of the following methods to specify the invoice date:"},"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":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDateMonthOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceDateDayOfMonth"},"children":[]}]}]}]}],"format":"date","type":"string"},"invoiceDateMonthOffset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The month offset of invoice date for this bill run compared to bill run execution date."},"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":"Notes"},"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":"This field is only valid when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"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":"You can use one of the following methods to specify the invoice date:"},"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":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDateMonthOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceDateDayOfMonth"},"children":[]}]}]}]}]}]}],"type":"integer"},"invoiceDateDayOfMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of month of invoice date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month."},"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":"Notes"},"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":"This field is only valid when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"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":"You can use one of the following methods to specify the invoice date:"},"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":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDateMonthOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceDateDayOfMonth"},"children":[]}]}]}]}]}]}],"type":"integer","maximum":31,"minimum":1},"name":{"description":"The name of the bill run.\n","type":"string"},"noEmailForZeroAmountInvoice":{"default":false,"description":"Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete. \n\nIt is best practice to not send emails for invoices with zero amount.\n","type":"boolean"},"organizationLabels":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization(s) that the bill run is created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each item in the array, either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only required when you have already turned on Multi-Org feature."},"children":[]}]}]}],"items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"schedule":{"$ref":"#/components/schemas/BillRunScheduleRequestType"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for this bill run."},"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":"You must specify this field when creating an ad-hoc bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For scheduled bill runs, if you do not specify any value for this field, the target date is the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}],"format":"date","type":"string"},"targetDateMonthOffset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The month offset of target date for this bill run compared to bill run execution date."},"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 only valid when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"targetDateDayOfMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of month of target date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month."},"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 only valid when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer","maximum":31,"minimum":1}},"type":"object"}],"example":{"batches":null,"billRunFilters":[{"filterType":"FilterCondition","objectType":"Account","condition":{"relation":"and","conditions":[{"field":"BillCycleDay","operator":"neq","value":"{{AsRunDay}}"}]}}],"autoRenewal":false,"noEmailForZeroAmountInvoice":false,"autoPost":true,"autoEmail":false,"chargeTypeToExclude":[],"billCycleDay":null,"invoiceDate":"2026-01-01","targetDate":"2026-01-01","billRunType":"Regular","name":""}}},"components/schemas/BillRunFilterResponseType":{"id":"components/schemas/BillRunFilterResponseType","kind":"json-schema","title":"billRunFilters","data":{"allOf":[{"properties":{"accountId":{"description":"The target account of the bill run.\n","type":"string","nullable":true},"filterType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create bill runs based on the selected filter type:"},"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":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Create bill runs by account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Create bill runs by subscription, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionId"},"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":"code","inline":true,"attributes":{"content":"InvoiceSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Create a scheduled bill run, you must specify the schedule field. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/bill-runs/automate-billing-document-generation/manage-scheduled-bill-runs","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage scheduled bill runs"},"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":"code","inline":true,"attributes":{"content":"FilterCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Create bill runs by custom filter combining the Account, Subscription, and Rate Plan objects, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"condition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/bill-runs/automate-billing-document-generation/bill-run-advanced-filter","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill Run Advanced Filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Account","Subscription","InvoiceSchedule","FilterCondition"],"type":"string"},"condition":{"$ref":"#/components/schemas/Condition"},"objectType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target object type of the condition when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FilterCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/bill-runs/automate-billing-document-generation/bill-run-advanced-filter","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill Run Advanced Filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["Account","Subscription","RatePlanCharge"]},"subscriptionId":{"description":"The target subscripiton ID of the account. \n","type":"string","nullable":true}},"type":"object"}],"title":"billRunFilters"}},"components/schemas/BillRunScheduleResponseType":{"id":"components/schemas/BillRunScheduleResponseType","kind":"json-schema","title":"schedule","data":{"allOf":[{"description":"Container for information about the scheduled bill run.\n","properties":{"repeatFrom":{"description":"The start date of the scheduled bill run.\n","format":"date","type":"string"},"repeatTo":{"description":"The end date of of the scheduled bill run.\n","format":"date","type":"string"},"repeatType":{"description":"The repeat type of the bill run.\n","enum":["None","Daily","Weekly","Monthly"],"type":"string"},"runTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled run time (hour) of day."},"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":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 0 - 23"},"children":[]}]}]}],"type":"integer"},"weeklyOnDay":{"description":"The repeat day in a week.\n","items":{"enum":["Mon","Tue","Wed","Thu","Fri","Sat","Sun"],"type":"string"},"type":"array"},"monthlyOnEndOfMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to schedule monthly bill run on the end of month or the specific day of month."},"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 available only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to the end of month."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"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":"When repeatFrom = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-04-30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and monthlyOnEndOfMonth = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", next bill run will be scheduled on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-05-31"},"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":"When repeatFrom = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-04-30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and monthlyOnEndOfMonth = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", next bill run will be scheduled on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-05-30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"boolean"}},"type":"object"}],"title":"schedule"}},"components/schemas/GetBillRunResponseType":{"id":"components/schemas/GetBillRunResponseType","kind":"json-schema","title":"GetBillRunResponseType","data":{"properties":{"autoEmail":{"description":"Whether to automatically send emails after Auto-Post is complete.\n","type":"boolean"},"autoPost":{"description":"Whether to automatically post the bill run after the bill run is created.\n","type":"boolean"},"autoRenewal":{"description":"Whether to automatically renew auto-renew subscriptions that are up for renewal.\n","type":"boolean"},"batches":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch of accounts for this bill run, this field can not exist with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billRunFilters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" together."},"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":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllBatches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Batch"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a number between 1 and 50, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Batch7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of the bill cycle, this field is only valid when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"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":"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":"AllBillCycleDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or one of numbers 1 - 31 for an ad-hoc bill run"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllBillCycleDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", one of numbers 1 - 31, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AsRunDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a scheduled bill run"},"children":[]}]}]}]}],"type":"string"},"billRunFilters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target account, subscriptions, invoice schedule, or a combination of objects for this bill run."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/BillRunFilterResponseType"},"type":"array"},"billRunNumber":{"description":"The number of the bill run.\n","type":"string"},"chargeTypeToExclude":{"description":"The types of the charges to be excluded from the generation of billing documents.\n","items":{"enum":["OneTime","Recurring","Usage"],"type":"string"},"type":"array","nullable":true},"createdById":{"description":"The ID of the user who created the bill run.\n","type":"string"},"createdDate":{"description":"The date and time when the bill run was created.\n","type":"string"},"includeSubscriptions":{"default":true,"description":"Indicates whether to bill subscriptions in the bill run.\n","type":"boolean"},"includeOrderLineItems":{"default":true,"description":"Indicates whether to bill order line items in the bill run.\n","type":"boolean"},"id":{"description":"The unqie ID of the bill run.\n","type":"string"},"invoiceDate":{"description":"The invoice date for this bill run, only valid for ad-hoc bill runs.\n","format":"date","type":"string"},"invoiceDateOffset":{"description":"The offset compared to bill run execution date, only valid for scheduled bill runs.\n","type":"integer","nullable":true},"invoiceDateMonthOffset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The month offset of invoice date for this bill run compared to bill run execution date."},"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 only valid when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDateMonthOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDateDayOfMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, do not use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDateOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, and vice versa."},"children":[]}]}]}],"type":"integer","nullable":true},"invoiceDateDayOfMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of month of invoice date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month."},"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 only valid when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDateMonthOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDateDayOfMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, do not use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceDateOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, and vice versa."},"children":[]}]}]}],"type":"integer","nullable":true,"maximum":31,"minimum":1},"name":{"description":"The name of the bill run.\n","type":"string"},"noEmailForZeroAmountInvoice":{"description":"Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete. \n","type":"boolean"},"organizationLabels":{"description":"The organization(s) that the run is created for. \n\nNote: This field is available only when the Multi-Org feature is enabled.\n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"schedule":{"$ref":"#/components/schemas/BillRunScheduleResponseType"},"scheduledExecutionTime":{"description":"The scheduled execution time for a bill run.\n","type":"string","nullable":true},"status":{"description":"The status of the bill run.\n","enum":["Pending","Processing","Completed","Error","Canceled","Posted","PostInProgress","CancelInProgress","RemoveInProgress","Paused"],"type":"string"},"targetDate":{"description":"The target date for this bill run, only valid for ad-hoc bill runs.\n","format":"date","type":"string"},"targetDateOffset":{"description":"The offset compared to bill run execution date, only valid for scheduled bill runs.\n","type":"integer","nullable":true},"targetDateMonthOffset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The month offset of target date for this bill run compared to bill run execution date."},"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 only valid when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDateMonthOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDateDayOfMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, do not use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDateOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, and vice versa."},"children":[]}]}]}],"type":"integer","nullable":true},"targetDateDayOfMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of month of target date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month."},"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 only valid when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDateMonthOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDateDayOfMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, do not use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDateOffset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, and vice versa."},"children":[]}]}]}],"type":"integer","nullable":true,"maximum":31,"minimum":1},"updatedById":{"description":"The ID of the user who last updated the bill run.\n","type":"string"},"updatedDate":{"description":"The date and time when the bill run was last updated.\n","type":"string"}},"type":"object","example":{"id":"8a90ff929bb9d7c0019bbc7d34ec2c5f","autoEmail":false,"autoPost":false,"autoRenewal":false,"billCycleDay":"AllBillCycleDays","billRunNumber":"BR-00007954","name":"Bill subscriptions matched the dynamic invoice date 2025-06-01","invoiceDate":"2025-06-01","noEmailForZeroAmountInvoice":false,"status":"Pending","targetDate":"2025-06-01","targetDateOffset":null,"invoiceDateOffset":null,"scheduledExecutionTime":null,"createdById":"e1187a1f28c8487ca6b40c40ffb10853","createdDate":"2026-01-14 04:31:20","updatedById":"e1187a1f28c8487ca6b40c40ffb10853","updatedDate":"2026-01-14 04:31:20","batches":["AllBatches"],"chargeTypeToExclude":null,"billRunFilters":[{"filterType":"FilterCondition","accountId":null,"subscriptionId":null,"invoiceScheduleId":null,"invoiceScheduleItemId":null,"objectType":"Subscription","condition":{"field":null,"operator":null,"value":null,"conditions":[{"field":"billRunEffectiveDate__c","operator":"lte","value":"{{InvoiceDate}}","conditions":[],"relation":null}],"relation":"and"}}],"schedule":null,"invoiceDateMonthOffset":null,"invoiceDateDayOfMonth":null,"targetDateMonthOffset":null,"targetDateDayOfMonth":null,"includeSubscriptions":true,"includeOrderLineItems":true,"success":true}}},"components/schemas/NextRunResponseType":{"id":"components/schemas/NextRunResponseType","kind":"json-schema","title":"nextRun","data":{"allOf":[{"description":"Container about information about the next bill run to be executed.\n","properties":{"autoEmail":{"description":"Whether to automatically send emails after Auto-Post is complete.\n","type":"boolean"},"autoPost":{"description":"Whether to automatically post the bill run after the bill run is created.\n","type":"boolean"},"autoRenewal":{"description":"Whether to automatically renew auto-renew subscriptions that are up for renewal.\n","type":"boolean"},"batches":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch of accounts for this bill run."},"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":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllBatches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Batch"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of numbers 1 - 50, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Batch7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of the bill cycle. This field is only valid if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"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":"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":"AllBillCycleDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or one of numbers 1 - 31 for an ad-hoc bill run"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllBillCycleDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", one of numbers 1 - 31, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AsRunDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a scheduled bill run"},"children":[]}]}]}]}],"type":"string"},"billRunFilters":{"description":"The target account or subscriptions for this bill run. \n","items":{"$ref":"#/components/schemas/BillRunFilterResponseType"},"type":"array"},"billRunNumber":{"description":"The number of the bill run.\n","type":"string"},"chargeTypeToExclude":{"description":"The types of the charges to be excluded from the generation of billing documents.\n","items":{"enum":["OneTime","Recurring","Usage"],"type":"string"},"type":"array"},"createdById":{"description":"The ID of the user who created the bill run.\n","type":"string"},"createdDate":{"description":"The date and time when the bill run was created.\n","type":"string"},"id":{"description":"The ID of the bill run.\n","type":"string"},"invoiceDate":{"description":"The invoice date for this bill run, only valid for ad-hoc bill runs.\n","format":"date","type":"string"},"invoiceDateOffset":{"description":"The offset compared to the bill run execution date, only valid for scheduled bill runs.\n","type":"integer"},"noEmailForZeroAmountInvoice":{"description":"Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete. \n","type":"boolean"},"schedule":{"$ref":"#/components/schemas/BillRunScheduleResponseType"},"scheduledExecutionTime":{"description":"The scheduled execution time for the bill run.\n","type":"string"},"status":{"description":"The status of the bill run.\n","enum":["Pending","Processing","Completed","Error","Canceled","Posted","PostInProgress","CancelInProgress","RemoveInProgress","Paused"],"type":"string"},"targetDate":{"description":"The target date for this bill run, only valid for ad-hoc bill runs.\n","format":"date","type":"string"},"targetDateOffset":{"description":"The offset compared to the bill run execution date, only valid for scheduled bill runs.\n","type":"integer"},"updatedById":{"description":"The ID of the user who last updated the bill run.\n","type":"string"},"updatedDate":{"description":"The date and time when the bill run was last updated.\n","type":"string"}},"type":"object"}],"example":{"autoEmail":false,"autoPost":false,"autoRenewal":false,"batches":null,"billCycleDay":null,"billRunFilters":[{"accountId":"2c9081a03c63c94c013c66688a2c00bf","filterType":"Subscription","subscriptionId":"402882297e387c51017e38a245c313db"}],"billRunNumber":"BR-00000016","chargeTypeToExclude":["OneTime","Usage"],"createdById":"ff808081298c6e5401298c7274a40005","createdDate":"2022-01-24 19:58:27","id":"2c9890077e8a8490017e8bf3a5171a43","invoiceDate":"2020-02-01","invoiceDateOffset":null,"noEmailForZeroAmountInvoice":false,"schedule":null,"scheduledExecutionTime":null,"status":"Pending","success":true,"targetDate":"2020-02-01","targetDateOffset":null,"updatedById":"ff808081298c6e5401298c7274a40005","updatedDate":"2022-01-24 19:58:27"},"title":"nextRun"}},"components/schemas/CancelBillRunResponseType":{"id":"components/schemas/CancelBillRunResponseType","kind":"json-schema","title":"CancelBillRunResponseType","data":{"allOf":[{"$ref":"#/components/schemas/GetBillRunResponseType"},{"properties":{"nextRun":{"$ref":"#/components/schemas/NextRunResponseType"}},"type":"object"}],"example":{"id":"8a90ff929bb9d7c0019bbc7d34ec2c5f","autoEmail":false,"autoPost":false,"autoRenewal":false,"billCycleDay":"AllBillCycleDays","billRunNumber":"BR-00007954","name":"Bill subscriptions matched the dynamic invoice date 2025-06-01","invoiceDate":"2025-06-01","noEmailForZeroAmountInvoice":false,"status":"Pending","targetDate":"2025-06-01","targetDateOffset":null,"invoiceDateOffset":null,"scheduledExecutionTime":null,"createdById":"e1187a1f28c8487ca6b40c40ffb10853","createdDate":"2026-01-14 04:31:20","updatedById":"e1187a1f28c8487ca6b40c40ffb10853","updatedDate":"2026-01-14 04:31:20","batches":["AllBatches"],"chargeTypeToExclude":null,"billRunFilters":[{"filterType":"FilterCondition","accountId":null,"subscriptionId":null,"invoiceScheduleId":null,"invoiceScheduleItemId":null,"objectType":"Subscription","condition":{"field":null,"operator":null,"value":null,"conditions":[{"field":"billRunEffectiveDate__c","operator":"lte","value":"{{InvoiceDate}}","conditions":[],"relation":null}],"relation":"and"}}],"schedule":null,"invoiceDateMonthOffset":null,"invoiceDateDayOfMonth":null,"targetDateMonthOffset":null,"targetDateDayOfMonth":null,"includeSubscriptions":true,"includeOrderLineItems":true,"success":true}}},"components/schemas/POSTEmailBillingDocfromBillRunType":{"id":"components/schemas/POSTEmailBillingDocfromBillRunType","kind":"json-schema","title":"POSTEmailBillingDocfromBillRunType","data":{"example":{"resend":"true"},"properties":{"resend":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to send out emails for all the billing documents that are associated with the bill run."},"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":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", emails are sent out only for the billing documents that never have emails sent out. "},"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":": Do not perform this API operation with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiple times in a short period. Otherwise, you may receive the same email multiple times, which contradicts the purpose of this setting."},"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":"If the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", emails are sent out for all the billing documents."},"children":[]}]}]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/BillingPreviewRunFilter":{"id":"components/schemas/BillingPreviewRunFilter","kind":"json-schema","title":"BillingPreviewRunFilter","data":{"type":"array","description":"A list of filters to apply to the billing preview run. You can specify only one filter. \n","maxItems":1,"items":{"type":"object","properties":{"filterType":{"description":"The type of filter to apply.\n","enum":["Account"],"type":"string"},"accountId":{"description":"The target account ID.\n","type":"string","pattern":"^[0-9a-fA-F]{32}$"}},"required":["filterType","accountId"]}}},"components/schemas/PostBillingPreviewRunParam":{"id":"components/schemas/PostBillingPreviewRunParam","kind":"json-schema","title":"PostBillingPreviewRunParam","data":{"example":{"batches":"Batch1","targetDate":"2024-11-05"},"properties":{"assumeRenewal":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to generate a preview of future invoice items and credit memo items with the assumption that the subscriptions are renewed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set one of the following values in this field to decide how the assumption is applied in the billing preview."},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","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":"None:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Default) The assumption is not applied to the subscriptions. Zuora generates preview invoice item data and credit memo item data based on the current term end date and the target date."},"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":"If the target date is later than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the current term end date."},"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":"If the target date is earlier than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","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":"Autorenew:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The assumption is applied to the subscriptions that have auto-renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date."},"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":"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":"This field can only be used if the subscription renewal term is not set to 0."},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Autorenew"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is not supported when the billing preview includes usage-based charges, including Prepaid with Drawdown charges and Tiered with Overage charges. To run the billing preview for these charges, set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assumeRenewal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"None"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you need to simulate renewal, complete the subscription renewal before you run the billing preview."},"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":"The credit memo item data is only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}]}],"type":"string"},"batches":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer batches to include in the billing preview run. You can specify multiple batches separated by comma. If not specified, all customer batches are included."},"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":":"},"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":"By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=performance-booster-elite","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance Booster Elite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" package."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"314.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"maxLength":1000,"type":"string"},"chargeTypeToExclude":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charge types to exclude from the forecast run."},"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":"Possible values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OneTime, Recurring, Usage, and any comma-separated combination of these values."},"children":[]}]}]}],"type":"string"},"includingDraftItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether draft document items are included in the billing preview run. By default, draft document items are not included."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field loads draft invoice items and credit memo items. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeTypeToExclude"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includingEvergreenSubscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assumeRenewal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields do not affect the behavior of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includingDraftItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"includingEvergreenSubscription":{"description":"Whether evergreen subscriptions are included in the billing preview run. By default, evergreen subscriptions are not included.\n","type":"boolean"},"organizationLabels":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization(s) that this billing preview run is created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each item in the array, either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only required when you have already turned on Multi-Org feature."},"children":[]}]}]}],"items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"storageOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The saving options. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Csv"},"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 compare the current billing preview run result with a specified billing preview run result and store the difference in the database, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storageOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Database"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-billing-preview-run-result-data-source"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Preview Run Result data source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Csv","Database"],"type":"string"},"storeDifference":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to compare the current billing preview run result with a specified billing preview run result and store the difference in the database. You can view the difference in the Billing Preview Run Result Difference data source. "},"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 feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. If you want to use the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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 default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"comparedBillingPreviewRunId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify an existing billing preview run result to compare the current billing preview result with. You can view the difference in the Billing Preview Run Result Difference data source. "},"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 feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. If you want to use the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the billing preview run. The billing preview run generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be in "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the target date is later than the subscription current term end date, the preview invoice item data and credit memo item data is generated from the first day of the customer's next billing period to the current term end date. If you want to generate preview invoice item data and credit memo item data past the end of the subscription current term, specify the AssumeRenewal field in the request."},"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 credit memo item data is only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"date","type":"string"},"filters":{"$ref":"#/components/schemas/BillingPreviewRunFilter"}},"required":["targetDate"],"type":"object"}},"components/schemas/GetBillingPreviewRunResponse":{"id":"components/schemas/GetBillingPreviewRunResponse","kind":"json-schema","title":"GetBillingPreviewRunResponse","data":{"description":"get billingPreviewRun response","properties":{"assumeRenewal":{"description":"","type":"string"},"batches":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer batches included in the billing preview run."},"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 available only if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"314.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"chargeTypeToExclude":{"description":"The charge types excluded from the forecast run.\n","type":"string"},"createdById":{"description":"The ID of the user who created the billing preview run.\n","type":"string"},"createdDate":{"description":"The date and time when the billing preview run was created.\n","type":"string"},"endDate":{"description":"The date and time when the billing preview run completes.\n","type":"string"},"errorMessage":{"description":"The error message generated by a failed billing preview run.\n","type":"string","nullable":true},"includingDraftItems":{"description":"Whether draft document items are included in the billing preview run. By default, draft document items are not included.\n","type":"boolean"},"includingEvergreenSubscription":{"description":"Indicates if evergreen subscriptions are included in the billing preview run.\n","type":"boolean"},"organizationLabels":{"description":"The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.            \n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"resultFileUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the zipped CSV result file generated by the billing preview run. This file contains the preview invoice item data and credit memo item data for the specified customers."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storageOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Database"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resultFileUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is null."},"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 credit memo item data is only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"runNumber":{"description":"The run number of the billing preview run.\n","type":"string"},"startDate":{"description":"The date and time when the billing preview run starts.\n","format":"datetime","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the >billing preview run."},"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":"Possible 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":"text","inline":true,"attributes":{"content":"0: Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1: Processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2: Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3: Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4: Canceled"},"children":[]}]}]}]}],"type":"string"},"storageOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The saving options. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Csv","Database"],"type":"string"},"succeededAccounts":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of accounts for which preview invoice item data and credit memo item data was successfully generated during the billing preview run."},"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 credit memo item data is only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"integer"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":"The target date for the billing preview run.          \n","format":"date","type":"string"},"totalAccounts":{"description":"The total number of accounts in the billing preview run.\n","format":"int32","type":"integer"},"updatedById":{"description":"The ID of the user who last updated the billing preview run.\n","type":"string"},"updatedDate":{"description":"The date and time when the billing preview run was last updated.\n","type":"string"}},"type":"object"}},"components/schemas/POSTPaymentMethodResponse":{"id":"components/schemas/POSTPaymentMethodResponse","kind":"json-schema","title":"POSTPaymentMethodResponse","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"properties":{"id":{"description":"Internal ID of the payment method that was created.\n","type":"string"},"reasons":{"items":{"description":"Error information. Only applicable if the payment method was not created.\n","properties":{"code":{"description":"Error code.\n","type":"string"},"message":{"description":"Error message.\n","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}]}},"components/schemas/CreateApplePayPaymentMethodCardholderInfo":{"id":"components/schemas/CreateApplePayPaymentMethodCardholderInfo","kind":"json-schema","title":"CardHolderInfo","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container for the cardholder information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder name is required for credit card validation. It is strongly recommended to specify the nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this container. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardHolderName"},"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 required cardholder address fields vary by gateway. It is strongly recommended to review the gateway's documentation for the most accurate and up-to-date information."},"children":[]}]}]}],"properties":{"addressLine1":{"description":"The first address line.\n","maxLength":255,"type":"string"},"addressLine2":{"description":"The second address line.\n","maxLength":255,"type":"string"},"cardHolderName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder's full name as it appears on the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder name information is required for credit card validation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora retrieves the cardholder name using the following priority:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field if available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full bill-to-contact name of the customer account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is strongly recommended to provide the cardholder name through this field."},"children":[]}]}]}],"maxLength":50,"type":"string"},"city":{"description":"The city.\n\nIt is recommended to provide the city and country information when\ncreating a payment method. The information will be used to process\npayments. If the information is not provided during payment method\ncreation, the city and country data will be missing during payment\nprocessing.\n","maxLength":40,"type":"string"},"country":{"description":"The country, which must be a valid country name or abbreviation.\n\nIt is recommended to provide the city and country information when\ncreating a payment method. The information will be used to process\npayments. If the information is not provided during payment method\ncreation, the city and country data will be missing during payment\nprocessing.\n","type":"string"},"email":{"description":"The cardholder's email address.\n","maxLength":80,"type":"string"},"phone":{"description":"The phone number.\n","maxLength":40,"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state, which must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"zipCode":{"description":"The zip code.\n","maxLength":20,"type":"string"}},"title":"CardHolderInfo","type":"object"}},"components/schemas/POSTPaymentMethodDecryption":{"id":"components/schemas/POSTPaymentMethodDecryption","kind":"json-schema","title":"POSTPaymentMethodDecryption","data":{"example":{"accountID":"402891a25a02e11c015a02f3c6100003","cardHolderInfo":{"cardHolderName":"Amy Lawrence","addressLine1":"101 Redwood Shores Parkway","city":"Redwood City","country":"USA"},"integrationType":"ApplePay","invoiceId":"INV000000005","merchantID":"merchant.US.com.zuora.services001","mitConsentAgreementSrc":"External","mitProfileAction":"Activate","mitProfileType":"Recurring","paymentGateway":"CyberSourceOPG","paymentToken":{"data":"xGc......JDxuYz1gug0KZRrGXJQ=","header":{"ephemeralPublicKey":"MFkwEw......TMbLoojKBA==","publicKeyHash":"HuLvfqvLon......9jEyX0w=","transactionId":"abbadd18818baea1f37b40844c9e09afa9733b0eccb373905b811da43cf1753b"},"signature":"MIAGCSqGSIb......AEtrLSv7hE9gAAAAAAAA==","version":"EC_v1"},"processPayment":true},"properties":{"accountID":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the customer account associated with this payment method."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create an orphan payment method that is not associated with any customer account, you can skip this field.  As soon as the account information is available, associate the payment method with an account through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a payment method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  operation."},"children":[]}]}]}],"type":"string"},"cardHolderInfo":{"$ref":"#/components/schemas/CreateApplePayPaymentMethodCardholderInfo"},"integrationType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to identify the token decryption type."},"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 only value at this time is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApplePay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"invoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of invoice this payment will apply to."},"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":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processPayment"},"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":", this field is required."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one invoice can be paid; for scenarios where you want to pay for multiple invoices, set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and call payment API separately."},"children":[]}]}]}],"type":"string"},"merchantID":{"description":"The Merchant ID that was configured for use with Apple Pay in the Apple iOS Developer Center.\n","type":"string"},"mitConsentAgreementSrc":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for the following gateway integrations to create stored credential profiles within payment methods:"},"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":"Chase Paymentech Orbital Gateway"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CyberSource Payment API v2.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stripe v2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vantiv (Now Worldpay)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Worldpay 1.4"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify how the consent agreement has been established with the customer. The allowed value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified. If you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["External"],"type":"string"},"mitProfileAction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for the following gateway integrations to create stored credential profiles within payment methods:"},"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":"Chase Paymentech Orbital Gateway"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CyberSource Payment API v2.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stripe v2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vantiv (Now Worldpay)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Worldpay 1.4"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify either of the following values in this field:"},"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":"code","inline":true,"attributes":{"content":"Activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use this value if you are creating the stored credential profile after receiving the customer's consent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the CIT does not succeed, Zuora will not create a stored credential profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Agreed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Persist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"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 you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["Activate","Persist"],"type":"string"},"mitProfileType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for the following gateway integrations to create stored credential profiles within payment methods:"},"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":"Chase Paymentech Orbital Gateway"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CyberSource Payment API v2.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stripe v2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vantiv (Now Worldpay)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Worldpay 1.4"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates the type of the stored credential profile to process recurring or unsecheduled transactions. It is required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified. If you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["Recurring","Unscheduled"],"type":"string"},"paymentGateway":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The label name of the gateway instance configured in Zuora that will be used for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment method validation and payment processing."},"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":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processPayment"},"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":", this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentGateway"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"processPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  or is not provided, the specified gateway instance will be used for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment method validation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a valid gateway instance and it must support the Apple Pay payment method."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not specified, the default gateway of your Zuora customer account will be used."},"children":[]}]}]}],"type":"string"},"paymentToken":{"description":"The payload with the Apple Pay token or payment data.\n","type":"object"},"processPayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A boolean flag to control whether a payment should be processed after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating payment method. The payment amount will be equivalent to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount the merchant supplied in the ApplePay session. Default is false."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentGateway"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field with the payment gateway instance name."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"You must select the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify new credit card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" check box on the gateway instance settings page. Otherwise, the cryptogram will not be sent to the gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A separate subscribe or payment API call is required after this payment method creation call."},"children":[]}]}]}]}],"type":"boolean"}},"required":["integrationType","merchantID","paymentToken"],"type":"object"}},"components/schemas/POSTPaymentMethodResponseDecryption":{"id":"components/schemas/POSTPaymentMethodResponseDecryption","kind":"json-schema","title":"POSTPaymentMethodResponseDecryption","data":{"properties":{"amount":{"description":"The payment amount contained within the encrypted token.\n","type":"string"},"paymentId":{"description":"The ID of newly processed payment,\n","type":"string"},"paymentMethodId":{"description":"ID of the newly-created payment method.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETPMAccountHolderInfo":{"id":"components/schemas/GETPMAccountHolderInfo","kind":"json-schema","title":"accountHolderInfo","data":{"description":"The account holder information.\n","properties":{"accountHolderName":{"description":"The full name of the account holder.\n","type":"string"},"addressLine1":{"description":"The first line of the address for the account holder.\n","type":"string"},"addressLine2":{"description":"The second line of the address for the account holder. \n","type":"string"},"city":{"description":"The city where the account holder stays.\n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country where the account holder stays."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected. Regardless of the country texts selected when creating the payment method, only the supported country name returns in this field. For a complete list of supported country names, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Internationalization is not supported for the API field value."},"children":[]}]}]}],"type":"string"},"email":{"description":"The email address of the account holder.\n","type":"string"},"phone":{"description":"The phone number of the account holder.\n","type":"string"},"state":{"description":"The state where the account holder stays.\n","type":"string"},"zipCode":{"description":"The zip code for the address of the account holder.\n","type":"string"}},"title":"accountHolderInfo","type":"object"}},"components/schemas/POSTPMMandateInfo":{"id":"components/schemas/POSTPMMandateInfo","kind":"json-schema","title":"mandateInfo","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following mandate fields are common to all supported payment methods:"},"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":"mandateId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandateReason"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandateStatus"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following mandate fields are specific to the ACH and Bank Transfer payment methods:"},"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":"mandateReceivedStatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingMandateStatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandateCreationDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandateUpdateDate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following mandate fields are specific to the Credit Card, Apple Pay, and Google Pay payment methods:"},"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":"mitTransactionId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAgreedOn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitConsentAgreementRef"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitConsentAgreementSrc"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileType"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]}]}]}]}],"properties":{"existingMandateStatus":{"description":"Indicates whether the mandate is an existing mandate.\n","enum":["Yes","No"],"type":"string"},"mandateCreationDate":{"description":"The date on which the mandate was created.\n","format":"date","type":"string"},"mandateId":{"description":"The mandate ID.\n","type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","type":"string"},"mandateReceivedStatus":{"description":"Indicates whether the mandate is received from the gateway\n","enum":["Yes","No"],"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","type":"string"},"mandateUpdateDate":{"description":"The date on which the mandate was updated.\n","format":"date","type":"string"},"mitConsentAgreementRef":{"description":"Reference for the consent agreement that you have established with the customer.  \n","type":"string","nullable":true},"mitConsentAgreementSrc":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Specifies how the consent agreement has been established with the customer. The allowed value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["External"],"type":"string","nullable":true},"mitProfileAction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora creates and activates the stored credential profile. Only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the CIT does not succeed, Zuora will not create a stored credential profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Agreed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Persist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"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 you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"enum":["Activate","Persist"],"type":"string","nullable":true},"mitProfileAgreedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the stored credential profile is agreed. The date format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string","nullable":true},"mitProfileType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the type of the stored credential profile. If you do not specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, Zuora will automatically create a stored credential profile for the payment method, with the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to this field."},"children":[]}]}]}],"type":"string","nullable":true},"mitTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the ID of the transaction. Only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mitProfileAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Persist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":128,"type":"string","nullable":true}},"title":"mandateInfo","type":"object"}},"components/schemas/GETPaymentMethodResponseBankTransfer":{"id":"components/schemas/GETPaymentMethodResponseBankTransfer","kind":"json-schema","title":"GETPaymentMethodResponseBankTransfer","data":{"properties":{"IBAN":{"description":"The International Bank Account Number used to create the SEPA payment method. The value is masked.\n","type":"string"},"accountNumber":{"description":"The number of the customer's bank account and it is masked.\n","type":"string"},"bankCode":{"description":"The sort code or number that identifies the bank. This is also known as the sort code.         \n","type":"string"},"bankTransferType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the Bank Transfer payment method. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"branchCode":{"description":"The branch code of the bank used for Direct Debit.          \n","type":"string"},"businessIdentificationCode":{"description":"The BIC code used for SEPA. The value is masked.       \n","type":"string"},"identityNumber":{"description":"The identity number of the account holder or the cardholder.\n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponseACH":{"id":"components/schemas/GETPaymentMethodResponseACH","kind":"json-schema","title":"GETPaymentMethodResponseACH","data":{"properties":{"bankABACode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nine-digit routing number or ABA number used by banks. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"bankAccountName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the account holder, which can be either a person or a company. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"bankAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bank account number associated with the ACH payment. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"bankAccountType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of bank account associated with the ACH payment. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"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 creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" preferably."},"children":[]}]}]}],"enum":["BusinessChecking","Checking","Saving"],"type":"string"},"bankName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the bank where the ACH payment account is held. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"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 creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponseCreditCard":{"id":"components/schemas/GETPaymentMethodResponseCreditCard","kind":"json-schema","title":"GETPaymentMethodResponseCreditCard","data":{"properties":{"cardNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked credit card number."},"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":"cardNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the following fields will not be returned:"},"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":"expirationMonth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expirationYear"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderInfo"},"children":[]}]}]}]}],"type":"string"},"expirationMonth":{"description":"One or two digits expiration month (1-12).\n        \n","type":"integer"},"expirationYear":{"description":"Four-digit expiration year.\n","type":"integer"},"securityCode":{"description":"The CVV or CVV2 security code for the credit card or debit card.\n            Only required if changing expirationMonth, expirationYear, or cardHolderName.\n            To ensure PCI compliance, this value isn''t stored and can''t be queried.                  \n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponsePayPal":{"id":"components/schemas/GETPaymentMethodResponsePayPal","kind":"json-schema","title":"GETPaymentMethodResponsePayPal","data":{"properties":{"BAID":{"description":"ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.\n","type":"string"},"email":{"description":"Email address associated with the PayPal payment method. \n","type":"string"},"preapprovalKey":{"description":"The PayPal preapproval key.\n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponseGooglePay":{"id":"components/schemas/GETPaymentMethodResponseGooglePay","kind":"json-schema","title":"GETPaymentMethodResponseGooglePay","data":{"properties":{"googleBIN":{"description":"This field is only available for Google Pay payment methods.\n","type":"string"},"googleCardNumber":{"description":"This field is only available for Google Pay payment methods.\n","type":"string"},"googleCardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for Google Pay payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Google Pay payment methods on Adyen, the first 100 characters of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.adyen.com/development-resources/paymentmethodvariant"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentMethodVariant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned from Adyen are stored in this field."},"children":[]}]}]}],"type":"string"},"googleExpiryDate":{"description":"This field is only available for Google Pay payment methods.\n","type":"string"},"googleGatewayToken":{"description":"This field is only available for Google Pay payment methods.\n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponseApplePay":{"id":"components/schemas/GETPaymentMethodResponseApplePay","kind":"json-schema","title":"GETPaymentMethodResponseApplePay","data":{"properties":{"appleBIN":{"description":"This field is only available for Apple Pay payment methods.\n","type":"string"},"appleCardNumber":{"description":"This field is only available for Apple Pay payment methods.\n","type":"string"},"appleCardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available for Apple Pay payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Apple Pay payment methods on Adyen, the first 100 characters of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.adyen.com/development-resources/paymentmethodvariant"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentMethodVariant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned from Adyen are stored in this field."},"children":[]}]}]}],"type":"string"},"appleExpiryDate":{"description":"This field is only available for Apple Pay payment methods.\n","type":"string"},"appleGatewayToken":{"description":"This field is only available for Apple Pay payment methods.\n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodResponse":{"id":"components/schemas/GETPaymentMethodResponse","kind":"json-schema","title":"GETPaymentMethodResponse","data":{"allOf":[{"properties":{"accountHolderInfo":{"$ref":"#/components/schemas/GETPMAccountHolderInfo"},"accountVerificationService":{"description":"Displays the name of the service provider. For example, Plaid.\n","type":"string"},"accountVerificationStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the status of the account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access token is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access token has expired and must be linked again."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expiring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access token will expire in few days(7 days for Plaid) and must be linked again"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The end customer has revoked the account permission. The end customer can login again and select the same method for the access token to be linked again."},"children":[]}]}]}]}],"enum":["Active","Expired","Expiring","Inactive"],"type":"string"},"bankIdentificationNumber":{"description":"The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method.\n","type":"string"},"createdBy":{"description":"ID of the user who created this payment method.","type":"string"},"createdOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment method was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"creditCardMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked credit card number, such as:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"*********1112\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"*********1112\n"},"children":[]}]}],"type":"string"},"creditCardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the credit card or debit card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JCB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Diners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about credit card types supported by different payment gateways, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Payment Gateways"},"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":"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 only returned for the Credit Card and Debit Card payment types."},"children":[]}]}]}],"type":"string"},"deviceSessionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The session ID of the user when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created or updated."},"children":[]}]}]}],"type":"string","nullable":true},"existingMandate":{"description":"Indicates whether the mandate is an existing mandate.\n","enum":["Yes","No"],"type":"string","nullable":true},"id":{"description":"The payment method ID.\n","type":"string"},"ipAddress":{"description":"The IP address of the user when the payment method was created or updated.\n","type":"string","nullable":true},"isDefault":{"description":"Indicates whether this payment method is the default payment method for the account.\n","type":"boolean"},"lastFailedSaleTransactionDate":{"description":"The date of the last failed attempt to collect payment with this payment method.\n","type":"string","nullable":true},"lastTransaction":{"description":"Indicates the occurrence and status of the last transaction.","type":"string"},"lastTransactionTime":{"description":"The time when the last transaction of this payment method happened.","format":"date-time","type":"string"},"mandateInfo":{"$ref":"#/components/schemas/POSTPMMandateInfo"},"maxConsecutivePaymentFailures":{"description":"The number of allowable consecutive failures Zuora attempts with the payment method before stopping.\n","type":"integer","nullable":true},"numConsecutiveFailures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of consecutive failed payments for this payment method. It is reset to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" upon successful payment."},"children":[]}]}]}],"format":"int32","type":"integer"},"paymentRetryWindow":{"description":"The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.\n","type":"integer","nullable":true},"secondTokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A gateway unique identifier that replaces sensitive payment method data."},"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 only returned for the Credit Card Reference Transaction payment type."},"children":[]}]}]}],"type":"string"},"status":{"description":"The status of the payment method.\n","enum":["Active","Closed","Scrubbed"],"type":"string"},"tokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile."},"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 only returned for the Credit Card Reference Transaction payment type."},"children":[]}]}]}],"type":"string"},"totalNumberOfErrorPayments":{"description":"The number of error payments that used this payment method.\n","format":"int32","type":"integer"},"totalNumberOfProcessedPayments":{"description":"The number of successful payments that used this payment method.\n","format":"int32","type":"integer"},"type":{"description":"The type of the payment method.\n","type":"string","enum":["CreditCard","CreditCardReferenceTransaction","ACH","SEPA","Betalingsservice","Autogiro","Bacs","Becs","Becsnz","PAD","PayPalCP","PayPalEC","PayPalNativeEC","PayPalAdaptive","AdyenApplePay","AdyenGooglePay","GooglePay"]},"updatedBy":{"description":"ID of the user who made the last update to this payment method.","type":"string"},"updatedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last date and time when the payment method was updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"useDefaultRetryRule":{"description":"Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.\n","type":"boolean"},"cardBinInfo":{"description":"The BIN information of a card payment method.\n","properties":{"brand":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card brand, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"cardClass":{"description":"The type of the card.\n","type":"string","enum":["ChargeCard","Credit","Debit","DeferredDebit","Prepaid"]},"productType":{"description":"The product type of the card.\n","type":"string","enum":["Commercial_or_Corporate_Card","Consumer_Card"]},"issuer":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The issuer bank of the card, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JPMORGAN CHASE BANK N.A."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"issuingCountryCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The issuing country code of the card, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/PaymentMethodObjectCustomFields"},{"$ref":"#/components/schemas/GETPaymentMethodResponseBankTransfer"},{"$ref":"#/components/schemas/GETPaymentMethodResponseACH"},{"$ref":"#/components/schemas/GETPaymentMethodResponseCreditCard"},{"$ref":"#/components/schemas/GETPaymentMethodResponsePayPal"},{"$ref":"#/components/schemas/GETPaymentMethodResponseGooglePay"},{"$ref":"#/components/schemas/GETPaymentMethodResponseApplePay"}]}},"components/schemas/PUTPMAccountHolderInfo":{"id":"components/schemas/PUTPMAccountHolderInfo","kind":"json-schema","title":"accountHolderInfo","data":{"description":"The account holder information. This field is not supported in updating Credit Card Reference Transaction payment methods.\n","properties":{"addressLine1":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first line of the address for the account holder."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required for SEPA Direct Debit payment methods on Stripe v2 for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"certain countries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"addressLine2":{"description":"The second line of the address for the account holder. \n","type":"string"},"city":{"description":"The city where the account holder stays.\n","type":"string"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country where the account holder stays."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required for SEPA payment methods on Stripe v2 for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"certain countries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"email":{"description":"The email address of the account holder.\n","type":"string"},"phone":{"description":"The phone number of the account holder.\n","type":"string"},"state":{"description":"The state where the account holder stays.\n","type":"string"},"zipCode":{"description":"The zip code for the address of the account holder.\n","type":"string"}},"title":"accountHolderInfo","type":"object"}},"components/schemas/PUTPMCreditCardInfo":{"id":"components/schemas/PUTPMCreditCardInfo","kind":"json-schema","title":"PUTPMCreditCardInfo","data":{"properties":{"expirationMonth":{"description":"One or two digits expiration month (1-12).\n        \n","type":"integer"},"expirationYear":{"description":"Four-digit expiration year.\n","type":"integer"},"securityCode":{"description":"Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried. \n\nIf securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway.\n\nIf securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway.\n","type":"string"}},"type":"object"}},"components/schemas/PUTPaymentMethodObjectCustomFields":{"id":"components/schemas/PUTPaymentMethodObjectCustomFields","kind":"json-schema","title":"paymentMethodFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the payment method. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields are not supported in updating Credit Card Reference Transaction payment methods."},"children":[]}]}]}]},"description":"Container for custom fields of a payment method object.\n","title":"paymentMethodFieldsCustom","type":"object"}},"components/schemas/PUTPaymentMethodRequest":{"id":"components/schemas/PUTPaymentMethodRequest","kind":"json-schema","title":"PUTPaymentMethodRequest","data":{"allOf":[{"properties":{"accountHolderInfo":{"$ref":"#/components/schemas/PUTPMAccountHolderInfo"},"accountKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer account ID such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2x92c0f859b0480f0159d3a4a6ee5bb6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the customer account number such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A02855638"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can use this field to associate an orphan payment method with a customer account. If a payment method is already associated with a customer account, you cannot change the associated payment method through this operation. You cannot remove the previous account ID and leave this field empty, either."},"children":[]}]}]}],"type":"string"},"authGateway":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is not supported in updating Credit Card Reference Transaction payment methods."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-gateway-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Gateway Routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled:"},"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 field is not specified, gateway routing rules will be invoked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to update the payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Payment Gateway Routing is disabled:"},"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 field is not specified, the default payment gateway will be used to update the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to update the payment."},"children":[]}]}]}]}],"type":"string"},"currencyCode":{"description":"The currency used for payment method authorization.\n","type":"string"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is not supported in updating Credit Card Reference Transaction payment methods."},"children":[]}]}]}],"properties":{"key":{"description":"The name of a gateway-specific parameter.\n","type":"string"},"value":{"description":"The value of the gateway-specific parameter.\n","type":"string"}},"type":"object"},"ipAddress":{"description":"The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. \n\nIf the IP address length is beyond 45 characters, a validation error occurs.\n\nFor validating SEPA payment methods on Stripe v2, this field is required.\n","type":"string"},"mandateInfo":{"description":"The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method.\n","properties":{"mandateId":{"description":"The mandate ID.\n","maxLength":36,"type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","maxLength":64,"type":"string"},"mandateStatus":{"description":"The status of the mandate from the gateway side.\n","maxLength":64,"type":"string"}},"type":"object"},"processingOptions":{"description":"The container for payment method processing options.\n","properties":{"checkDuplicated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to perform a duplication check when you create a payment method of the following 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":"Credit Card"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Transfer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"With this field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-duplication-check","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplication check on payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},"maxConsecutivePaymentFailures":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of payment failures allowed for this payment method."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","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":"useDefaultRetryRule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer","minimum":1,"maximum":100,"nullable":true},"paymentRetryWindow":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The retry interval in hours."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","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":"useDefaultRetryRule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer","minimum":1,"maximum":1000,"nullable":true},"useDefaultRetryRule":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to apply the default retry rule configured for your tenant in the Zuora Payments settings:"},"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 use the default retry rule, specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"To use the custom retry rule specific to this payment method, specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/PUTPMCreditCardInfo"},{"$ref":"#/components/schemas/PUTPaymentMethodObjectCustomFields"}],"example":{"securityCode":"331"}}},"components/schemas/PUTPaymentMethodResponse":{"id":"components/schemas/PUTPaymentMethodResponse","kind":"json-schema","title":"PUTPaymentMethodResponse","data":{"properties":{"id":{"description":"ID of the updated payment method.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PUTVerifyPaymentMethodType":{"id":"components/schemas/PUTVerifyPaymentMethodType","kind":"json-schema","title":"PUTVerifyPaymentMethodType","data":{"example":{"securityCode":"737"},"properties":{"currencyCode":{"description":"The currency used for payment method authorization. \n","type":"string"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts."},"children":[]}]}]}],"properties":{"key":{"description":"The name of a gateway-specific parameter.\n","type":"string"},"value":{"description":"The value of the gateway-specific parameter.\n","type":"string"}},"type":"object"},"paymentGatewayName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment gateway instance."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-gateway-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Gateway Routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled:"},"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 field is not specified, gateway routing rules will be invoked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to verify the payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Payment Gateway Routing is disabled:"},"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 field is not specified, the default payment gateway will be used to verify the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to verify the payment."},"children":[]}]}]}]}],"type":"string"},"securityCode":{"description":"The CVV or CVV2 security code for the credit card or debit card. To ensure PCI compliance, the value of this field is not stored and cannot be queried.\n","type":"string"}},"type":"object"}},"components/schemas/PUTVerifyPaymentMethodResponseType":{"id":"components/schemas/PUTVerifyPaymentMethodResponseType","kind":"json-schema","title":"PUTVerifyPaymentMethodResponseType","data":{"properties":{"paymentMethodId":{"description":"The ID of the verified payment method.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GetBankAccountBalanceResponse":{"id":"components/schemas/GetBankAccountBalanceResponse","kind":"json-schema","title":"GetBankAccountBalanceResponse","data":{"properties":{"success":{"description":"Indicates whether this call succeeds.\n","type":"boolean"},"currency":{"description":"The currency of the account balance.\n","type":"string"},"availableBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of funds available to be withdrawn from the account."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://plaid.com/docs/api/products/balance/#accounts-balance-get-response-accounts-balances","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plaid's documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","format":"double"},"currentBalance":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of funds in the account, which does not take pending transactions into account."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://plaid.com/docs/api/products/balance/#accounts-balance-get-response-accounts-balances","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plaid's documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","format":"double"}},"type":"object"}},"components/schemas/GetStoredCredentialProfilesResponse":{"id":"components/schemas/GetStoredCredentialProfilesResponse","kind":"json-schema","title":"GetStoredCredentialProfilesResponse","data":{"properties":{"profiles":{"description":"Container for stored credential profiles.\n","items":{"properties":{"activatedOn":{"description":"The date when the stored credential profile was activated (if applicable).\n","format":"date-time","type":"string"},"agreedOn":{"description":"The date when the stored credential profile was created.\n","format":"date-time","type":"string"},"brand":{"description":"The stored credential transaction framework. For example, Visa.\n","type":"string"},"cancelledOn":{"description":"The date when the stored credential profile was cancelled (if applicable).\n","format":"date-time","type":"string","nullable":true},"consentAgreementRef":{"description":"Your reference for the consent agreement that you have established with the customer.\n","maxLength":128,"type":"string"},"consentAgreementSrc":{"enum":["External"],"type":"string"},"expiredOn":{"description":"The date when the stored credential profile was expired (if applicable).\n","format":"date-time","type":"string","nullable":true},"number":{"description":"The number that identifies the stored credential profile within the payment method.\n","type":"integer"},"paymentMethodId":{"description":"ID of the payment method.\n","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the stored credential profile."},"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":"Agreed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The stored credential profile has not been validated via an authorization transaction with the payment gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The stored credential profile has been validated via an authorization transaction with the payment gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The stored credentials are no longer valid, per a customer request. Zuora cannot use the stored credentials in transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The stored credentials are no longer valid, per an expiration policy in the stored credential transaction framework. Zuora cannot use the stored credentials in transactions."},"children":[]}]}]}]}],"enum":["Agreed","Active","Cancelled","Expired"],"type":"string"},"type":{"enum":["Recurring","Unscheduled"],"type":"string"}}},"type":"array"},"success":{"type":"boolean"}},"type":"object"}},"components/schemas/CreateStoredCredentialProfileRequest":{"id":"components/schemas/CreateStoredCredentialProfileRequest","kind":"json-schema","title":"CreateStoredCredentialProfileRequest","data":{"example":{"authGateway":"4028905f5702783601570291e14c0015","consentAgreementRef":"ACCT1338AgreementV1.pdf","consentAgreementSrc":"External","status":"Active","type":"Recurring"},"properties":{"action":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how Zuora activates the stored credential profile. Only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Activate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the CIT does not succeed, Zuora will not create a stored credential profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Agreed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Persist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"enum":["Activate","Persist"],"type":"string"},"agreedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the profile is agreed. The date format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"authGateway":{"description":"Specifies the ID of the payment gateway that Zuora will use when activating the stored credential profile.\n","type":"string"},"cardSecurityCode":{"description":"The security code of the credit card.\n","type":"string"},"consentAgreementRef":{"description":"Specifies your reference for the consent agreement that you have established with the customer.\n","maxLength":128,"type":"string"},"consentAgreementSrc":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the consent agreement has been established with the customer. The allowed value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["External"],"type":"string"},"networkTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a network transaction. Only applicable if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Persist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":128,"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the status of the stored credential profile."},"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":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use this value if you are creating the stored credential profile after receiving the customer's consent, or if the stored credential profile represents a stored credential profile in an external system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify how Zuora activates the stored credential profile."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Agreed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use this value if you are migrating the payment method to the stored credential transaction framework."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this case, Zuora will not send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile."},"children":[]}]}]}]}]}],"enum":["Agreed","Active"],"type":"string"},"type":{"description":"Indicates the type of the stored credential profile to process recurring or unsecheduled transactions.\n","enum":["Recurring","Unscheduled"],"type":"string"}},"required":["status","type","consentAgreementSrc"],"type":"object"}},"components/schemas/ModifiedStoredCredentialProfileResponse":{"id":"components/schemas/ModifiedStoredCredentialProfileResponse","kind":"json-schema","title":"ModifiedStoredCredentialProfileResponse","data":{"properties":{"number":{"description":"The number that identifies the stored credential profile within the payment method.\n","type":"integer"},"paymentMethodId":{"description":"ID of the payment method.\n","type":"string"},"success":{"type":"boolean"}},"type":"object"}},"components/schemas/AddGatewayProfileDataRequest":{"id":"components/schemas/AddGatewayProfileDataRequest","kind":"json-schema","title":"AddGatewayProfileDataRequest","data":{"example":{"authGateway":"4028905f5702783601570291e14c0015","networkTransactionId":"00151658206D5A669F2c"},"properties":{"authGateway":{"description":"Specifies the ID of the payment gateway that Zuora will use when activating the stored credential profile.\n","type":"string"},"networkTransactionId":{"description":"The ID of a network transaction provided by the payment gateway.\n","type":"string"}},"required":["authGateway","networkTransactionId"],"type":"object"}},"components/schemas/AddGatewayProfileDataResponse":{"id":"components/schemas/AddGatewayProfileDataResponse","kind":"json-schema","title":"AddGatewayProfileDataResponse","data":{"properties":{"id":{"description":"ID of the created gateway profile data.\n","type":"string"},"success":{"description":"Indicates whether this call succeeds.\n","type":"boolean"}},"type":"object"}},"components/schemas/GETListApplePayDomainsResponse":{"id":"components/schemas/GETListApplePayDomainsResponse","kind":"json-schema","title":"GETListApplePayDomainsResponse","data":{"properties":{"domains":{"description":"Container for domains that are already registered with Apple Pay.\n","items":{"properties":{"createdBy":{"description":"The ID of the user who created this domain.\n","type":"string"},"createdOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the domain was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"domainIdentifier":{"description":"This identifier is automatically assigned during\ndomain registration and is used for Apple Pay merchant validation\nand session initialization.\n","type":"string"},"domainName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the domain registered with Apple Pay, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"testapplepay.zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"domainVerified":{"description":"Indicates whether the domain registration is successfully verified. \n","type":"boolean"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the domain, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402881a38924ff1001892502da090021"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"updatedBy":{"description":"The ID of the user who made the last update to this domain.\n","type":"string"},"updatedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last date and time when the domain was updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"walletType":{"description":"The type of digital wallet associated with the domain.\n","type":"string"}}},"type":"array"},"success":{"description":"Indicates whether this call succeeds.\n","type":"boolean"}},"type":"object"}},"components/schemas/POSTRegisterApplePayDomainRequest":{"id":"components/schemas/POSTRegisterApplePayDomainRequest","kind":"json-schema","title":"POSTRegisterApplePayDomainRequest","data":{"example":{"domainName":"testapplepay.zuora.com","walletType":"ApplePay"},"properties":{"domainName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the domain to be registered. for example,  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"testapplepay.zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"walletType":{"description":"The type of digital wallet for the domain registration. This field is required and determines which wallet-specific domain management flow is executed.\n","type":"string","enum":["ApplePay","GooglePay"]}},"required":["domainName","walletType"],"type":"object"}},"components/schemas/POSTRegisterApplePayDomainResponse":{"id":"components/schemas/POSTRegisterApplePayDomainResponse","kind":"json-schema","title":"POSTRegisterApplePayDomainResponse","data":{"properties":{"domainName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the domain registered with Apple Pay, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"testapplepay.zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"domainVerified":{"description":"Indicates whether the domain registration is successfully verified.\n","type":"boolean"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the domain, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402881a38924ff1001892502da090021"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"domainIdentifier":{"description":"This identifier is automatically assigned during\ndomain registration and is used for Apple Pay merchant validation\nand session initialization.\n","type":"string"},"walletType":{"description":"The type of digital wallet associated with the domain.\n","type":"string"},"success":{"description":"Indicates whether this call succeeds.\n","type":"boolean"}},"type":"object"}},"components/schemas/DELETEUnresigerApplePayDomainResponse":{"id":"components/schemas/DELETEUnresigerApplePayDomainResponse","kind":"json-schema","title":"DELETEUnresigerApplePayDomainResponse","data":{"properties":{"success":{"description":"Indicates whether this call succeeds.","type":"boolean"}},"type":"object"}},"components/schemas/POSTCreatePaymentSessionRequest":{"id":"components/schemas/POSTCreatePaymentSessionRequest","kind":"json-schema","title":"POSTCreatePaymentSessionRequest","data":{"example":{"currency":"USD","accountId":"402882e98d3a964b018d3a9c99ef0167","processPayment":true,"storePaymentMethod":true,"paymentGateway":"402883827d097a28017d09b41f690261","invoices":[{"invoiceNumber":"INV00001274"},{"invoiceNumber":"INV00001278"}],"amount":100},"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the customer account in Zuora that is associated with this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is optional when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"amount":{"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":"processPayment"},"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":", it is the amount of the payment. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be the current total balances of the specified invoices."},"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":"processPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it is the authorization amount for the payment method."},"children":[]}]}]}],"type":"number"},"authAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authorization amount for the payment method. Specify a value greater"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"than 0."},"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 being deprecated. It is recommended to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"number"},"currency":{"description":"The currency of the payment in the format of the three-character ISO\ncurrency code.\n","type":"string"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields supported by gateways vary. For more information, see the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-setup-gateway-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify any unsupported gateway option parameters, they will be ignored"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without error prompts."},"children":[]}]}]}],"type":"object","title":"GatewayOptions","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gateway options specification consists of key-value pairs:"},"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":"Field name: The name of a gateway-specific parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: The value of the gateway-specific parameter."},"children":[]}]}]}]}]}},"paymentGateway":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment gateway instance configured in Zuora that will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process the payment, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"e884322ab8c711edab030242ac120004"},"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 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-gateway-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Gateway Routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled:"},"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 field is not specified, gateway routing rules will be invoked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Payment Gateway Routing is disabled:"},"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 field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"children":[]}]}]}]}],"type":"string"},"processPayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicate whether a payment should be processed after creating the payment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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 set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"storePaymentMethod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that the payment method will be stored in Zuora and will be used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in subsequent recurring payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that the payment method will not be stored in Zuora."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End-customers need to be brought back on-session to authenticate the payment."},"children":[]}]}]}],"type":"boolean","default":true},"invoices":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The array of invoices that a payment applies to. All the specified invoices will be fully paid."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be the current total balances of the specified invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"invoices\": [\n  {\n    \"invoiceNumber\": \"INV00001274\"\n  },\n  {\n    \"invoiceNumber\": \"INV00001278\"\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"invoices\": [\n  {\n    \"invoiceNumber\": \"INV00001274\"\n  },\n  {\n    \"invoiceNumber\": \"INV00001278\"\n  }\n]\n"},"children":[]}]}],"items":{"type":"object","properties":{"invoiceNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice number, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV0000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}}},"type":"array"}},"required":["currency","processPayment","amount"],"type":"object"}},"components/schemas/POSTCreatePaymentSessionResponse":{"id":"components/schemas/POSTCreatePaymentSessionResponse","kind":"json-schema","title":"POSTCreatePaymentSessionResponse","data":{"properties":{"token":{"description":"The token for the payment session data.\n","type":"string"}},"type":"object"}},"components/schemas/ProxyGetPaymentMethodSnapshot":{"id":"components/schemas/ProxyGetPaymentMethodSnapshot","kind":"json-schema","title":"ProxyGetPaymentMethodSnapshot","data":{"properties":{"AccountId":{"description":"The ID of the customer account associated with this payment method.","type":"string"},"AchAbaCode":{"description":"The nine-digit routing number or ABA number used by banks. Applicable to ACH payment methods.","type":"string"},"AchAccountName":{"description":"The name of the account holder, which can be either a person or a company. Applicable to ACH payment methods.","type":"string"},"AchAccountNumberMask":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a masked displayable version of the ACH account number, used for security purposes. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"XXXXXXXXX54321"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"AchAccountType":{"description":"The type of bank account associated with the ACH payment.","enum":["BusinessChecking","Checking","Saving"],"type":"string"},"AchBankName":{"description":"The name of the bank where the ACH payment account is held.","type":"string"},"BankBranchCode":{"description":"The branch code of the bank used for direct debit.","type":"string"},"BankCheckDigit":{"description":"The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods.","type":"string"},"BankCity":{"description":"The city of the direct debit bank.","type":"string"},"BankCode":{"description":"The sort code or number that identifies the bank. This is also known as the sort code.","type":"string"},"BankIdentificationNumber":{"description":"The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method.","type":"string"},"BankName":{"description":"The name of the direct debit bank.","type":"string"},"BankPostalCode":{"description":"The zip code or postal code of the direct debit bank.","type":"string"},"BankStreetName":{"description":"The name of the street of the direct debit bank.","type":"string"},"BankStreetNumber":{"description":"The number of the direct debit bank.","type":"string"},"BankTransferAccountName":{"description":"The name on the direct debit bank account.","type":"string"},"BankTransferAccountNumberMask":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a masked displayable version of the bank account number, used for security purposes. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"XXXXXXXXX54321"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"BankTransferAccountType":{"description":"The type of the customer's bank account. Applicable to direct debit payment methods.","type":"string"},"BankTransferType":{"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 direct debit transfer. The value of this field is dependent on the country of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible Values:"},"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":"code","inline":true,"attributes":{"content":"AutomatischIncasso"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (NL)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Germany)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Austria)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DemandeDePrelevement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (FR)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DirectDebitUK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UK)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Domicil"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Belgium)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (CH)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Italy)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrdenDeDomiciliacion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Spain)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Autogiro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Sweden)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Betalingsservice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Denmark)"},"children":[]}]}]}]}]}],"enum":["AutomatischIncasso","LastschriftDE","LastschriftAT","DemandeDePrelevement","DirectDebitUK","Domicil","LastschriftCH","RID","OrdenDeDomiciliacion","Autogiro","Betalingsservice"],"type":"string"},"BusinessIdentificationCode":{"description":"The business identification code for Swiss direct payment methods that use the Global Collect payment gateway. Only applicable to direct debit payments in Switzerland with Global Collect.","type":"string"},"City":{"description":"The city of the customer's address. Applicable to debit payment methods.","type":"string"},"CompanyName":{"description":"The name of the company.\n","type":"string"},"Country":{"description":"The two-letter country code of the customer's address. Applicable to direct debit payment methods.","type":"string"},"CreditCardAddress1":{"description":"The first line of the card holder's address, which is often a street address or business name. Applicable to credit card and direct debit payment methods.","type":"string"},"CreditCardAddress2":{"description":"The second line of the card holder's address. Applicable to credit card and direct debit payment methods.","type":"string"},"CreditCardCity":{"description":"The city of the card holder's address. Applicable to credit card and direct debit payment methods.","type":"string"},"CreditCardCountry":{"description":"The country of the card holder's address.","type":"string"},"CreditCardExpirationMonth":{"description":"The expiration month of the credit card or debit card. Applicable to credit card and direct debit payment methods.","format":"int32","type":"integer"},"CreditCardExpirationYear":{"description":"The expiration month of the credit card or debit card. Applicable to credit card and direct debit payment methods.","format":"int32","type":"integer"},"CreditCardHolderName":{"description":"The full name of the card holder. Applicable to credit card and direct debit payment methods.","type":"string"},"CreditCardMaskNumber":{"description":"A masked version of the credit or debit card number.","type":"string"},"CreditCardPostalCode":{"description":"The billing address's zip code.","type":"string"},"CreditCardState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing address's state. Applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditCardCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is either Canada or the US."},"children":[]}]}]}],"type":"string"},"CreditCardType":{"description":"The type of credit card or debit card.","enum":["AmericanExpress","Discover","MasterCard","Visa"],"type":"string"},"DeviceSessionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The session ID of the user when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created or updated."},"children":[]}]}]}],"type":"string"},"Email":{"description":"An email address for the payment method in addition to the bill to contact email address.","type":"string"},"ExistingMandate":{"description":"Indicates if the customer has an existing mandate or a new mandate. Only applicable to direct debit payment methods.","enum":["Yes","No"],"type":"string"},"FirstName":{"description":"The customer's first name. Only applicable to direct debit payment methods.","type":"string"},"IBAN":{"description":"The International Bank Account Number. Only applicable to direct debit payment methods.","type":"string"},"IPAddress":{"description":"The IP address of the user when the payment method was created or updated.","type":"string"},"Id":{"description":"Object identifier.","type":"string"},"IdentityNumber":{"description":"The unique identity number of the customer account. \n","type":"string"},"IsCompany":{"description":"Whether the customer account is a company.\n","type":"boolean"},"LastFailedSaleTransactionDate":{"description":"The date of the last failed attempt to collect payment with this payment method.","format":"date-time","type":"string"},"LastName":{"description":"The customer's last name. Only applicable to direct debit payment methods.","type":"string"},"LastTransactionDateTime":{"description":"The date of the most recent transaction.","format":"date-time","type":"string"},"LastTransactionStatus":{"description":"The status of the most recent transaction.","type":"string"},"MandateCreationDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the mandate was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods."},"children":[]}]}]}],"format":"date","type":"string"},"MandateID":{"description":"The ID of the mandate. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods.","type":"string"},"MandateReceived":{"description":"Indicates if  the mandate was received. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods.","type":"string"},"MandateUpdateDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the mandate was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods."},"children":[]}]}]}],"format":"date","type":"string"},"MaxConsecutivePaymentFailures":{"description":"The number of allowable consecutive failures Zuora attempts with the payment method before stopping.","type":"integer"},"Name":{"description":"The name of the payment method.","type":"string"},"NumConsecutiveFailures":{"description":"The number of consecutive failed payment for the payment method.","format":"int32","type":"integer"},"PaymentMethodId":{"description":"Object identifier of the payment method.","type":"string"},"PaymentMethodStatus":{"description":"Specifies the status of the payment method.","enum":["Active","Closed"],"type":"string"},"PaymentRetryWindow":{"description":"The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.","type":"integer"},"PaypalBaid":{"description":"The PayPal billing agreement ID, which is a contract between two PayPal accounts.","type":"string"},"PaypalEmail":{"description":"The email address associated with the account holder's PayPal account or of the PayPal account of the person paying for the service.","type":"string"},"PaypalPreapprovalKey":{"description":"PayPal's Adaptive Payments API key.","type":"string"},"PaypalType":{"description":"Specifies the PayPal gateway: PayFlow Pro (Express Checkout) or Adaptive Payments.","enum":["ExpressCheckout","AdaptivePayments"],"type":"string"},"Phone":{"description":"The phone number that the account holder registered with the bank. This field is used for credit card validation when passing to a gateway.","type":"string"},"PostalCode":{"description":"The zip code of the customer's address. Only applicable to direct debit payment methods.","type":"string"},"SecondTokenId":{"description":"A gateway unique identifier that replaces sensitive payment method data. Applicable to CC Reference Transaction payment methods.","type":"string"},"State":{"description":"The state of the customer's address. Only applicable to direct debit payment methods.","type":"string"},"StreetName":{"description":"The street name of the customer's address. Only applicable to direct debit payment methods.","type":"string"},"StreetNumber":{"description":"The street number of the customer's address. Only applicable to direct debit payment methods.","type":"string"},"TokenId":{"description":"A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. Applicable to CC Reference Transaction payment methods.","type":"string"},"TotalNumberOfErrorPayments":{"description":"The number of error payments that used this payment method.","format":"int32","type":"integer"},"TotalNumberOfProcessedPayments":{"description":"The number of successful payments that used this payment method.","format":"int32","type":"integer"},"Type":{"description":"The type of payment method.","enum":["ACH","ApplePay","BankTransfer","Cash","Check","CreditCard","CreditCardReferenceTransaction","DebitCard","Other","PayPal","WireTransfer"],"type":"string"},"UseDefaultRetryRule":{"description":"Determines whether to use the default retry rules configured in the Zuora Payments settings.","type":"boolean"}},"type":"object"}},"components/schemas/ProxyGetPaymentMethodTransactionLog":{"id":"components/schemas/ProxyGetPaymentMethodTransactionLog","kind":"json-schema","title":"ProxyGetPaymentMethodTransactionLog","data":{"properties":{"Gateway":{"description":"","type":"string"},"GatewayReasonCode":{"description":"","type":"string"},"GatewayReasonCodeDescription":{"description":"","type":"string"},"GatewayTransactionType":{"description":"","type":"string"},"Id":{"description":"Object identifier.","type":"string"},"PaymentMethodId":{"description":"","type":"string"},"PaymentMethodType":{"description":"","type":"string"},"RequestString":{"description":"","type":"string"},"ResponseString":{"description":"","type":"string"},"TransactionDate":{"description":"","format":"date-time","type":"string"},"TransactionId":{"description":"","type":"string"}},"type":"object"}},"components/schemas/GETPaymentMethodUpdaterInstancesResponse":{"id":"components/schemas/GETPaymentMethodUpdaterInstancesResponse","kind":"json-schema","title":"GETPaymentMethodUpdaterInstancesResponse","data":{"properties":{"success":{"description":"Indicates whether the call is successful.","type":"boolean"},"updaters":{"description":"Container for PMU instances available on your tenant.\n","properties":{"daysToUpdateBeforeBcd":{"description":"The days prior to the Bill Cycle Day to start PMU service.\n","type":"integer"},"id":{"description":"The ID of the PMU instance.\n","type":"string"},"isActive":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that this PMU instance is active."},"children":[]}]}]}],"type":"boolean"},"isDefault":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that it is the default PMU instance."},"children":[]}]}]}],"type":"boolean"},"isTest":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that this PMU instance is for testing."},"children":[]}]}]}],"type":"string"},"processAssociatedGwOnly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that only the payment methods for customer accounts that meet either of the following conditions are included in the updates:"},"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 default payment gateway of the customer account is set to an instance of the same type as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updaterGatewayType"},"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":"The default payment gateway of the customer account is not configured, but the default payment gateway of the tenant is set to an instance of the same type as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updaterGatewayType"},"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":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that information of all payment methods is submitted."},"children":[]}]}]}],"type":"boolean"},"processAutopayDefaultPmOnly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that only the default payment methods for customer accounts with the AutoPay setting enabled are included in the updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that data of all payment methods for all customer accounts is submitted, regardless of whether AutoPay is enabled for the customer account or not."},"children":[]}]}]}],"type":"boolean"},"processMastercard":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that Mastercard data processing is supported."},"children":[]}]}]}],"type":"boolean"},"processVisa":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that Visa data processing is supported."},"children":[]}]}]}],"type":"boolean"},"updaterGatewayType":{"description":"The payment gateway type of the PMU instance.\n","type":"string"},"updaterName":{"description":"The name of the PMU instance.\n","type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/POSTPaymentMethodUpdaterBatchRequest":{"id":"components/schemas/POSTPaymentMethodUpdaterBatchRequest","kind":"json-schema","title":"POSTPaymentMethodUpdaterBatchRequest","data":{"example":{"billingCycleDay":5,"updaterAccountId":"418734b01fbb11ee821f0e4e5eec84cf"},"properties":{"billingCycleDay":{"description":"The billing cycle day. The allowed value is an integer in the range of 1 - 31.\n\nThe payment methods from accounts where the billing cycle day is the specified value in this field will be included in the updates.\n","type":"integer"},"updaterAccountId":{"description":"The ID (UUID) of the PMU account. This field must be a string of 32 characters consisting of digits and letters a - f.\n","type":"string"}},"required":["updaterAccountId","billingCycleDay"],"type":"object"}},"components/schemas/POSTPaymentMethodUpdaterResponse":{"id":"components/schemas/POSTPaymentMethodUpdaterResponse","kind":"json-schema","title":"POSTPaymentMethodUpdaterResponse","data":{"properties":{"success":{"description":"Indicates whether the request to create a PMU batch is sent successfully.\n","type":"boolean"}},"type":"object"}},"components/schemas/POSTRSASignatureType":{"id":"components/schemas/POSTRSASignatureType","kind":"json-schema","title":"POSTRSASignatureType","data":{"example":{"method":"POST","pageId":"2c92c0f855e2b4630155ec9e6a1b6eec","uri":"https://apisandbox.zuora.com/apps/PublicHostedPageLite.do"},"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional client parameter that can be used for validating client-side HPM parameters."},"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://docs.zuora.com?resourceId=payments-clientparameters-for-paymentpage2.0"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client parameters for Payment Pages 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-paymentpage2.0-digitalsignature-generation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate client-side HPM parameters"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for details."},"children":[]}]}]}],"type":"string"},"authorizationAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional client parameter that can be used for validating client-side HPM parameters."},"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://docs.zuora.com?resourceId=payments-clientparameters-for-paymentpage2.0"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client parameters for Payment Pages 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-paymentpage2.0-digitalsignature-generation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate client-side HPM parameters"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for details."},"children":[]}]}]}],"type":"number"},"method":{"description":"The type of the request. Set it to POST.\n","type":"string"},"pageId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page id of your Payment Pages 2.0 form. Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show Page Id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" next to the Payment Page name in the Hosted Page List to retrieve the page id."},"children":[]}]}]}],"type":"string"},"uri":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL that the Payment Page will be served from."},"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":"For US Cloud 1 Production environment: Use https://na.zuora.com/apps/PublicHostedPageLite.do"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For US Cloud 1 Sandbox environment: Use https://sandbox.na.zuora.com/apps/PublicHostedPageLite.do"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For US Cloud 2 Production environment: Use https://www.zuora.com/apps/PublicHostedPageLite.do"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For US Cloud 2 API Sandbox environment: Use https://apisandbox.zuora.com/apps/PublicHostedPageLite.do"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For US Central Sandbox environment: Use https://test.zuora.com/apps/PublicHostedPageLite.do"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For EU Cloud Production environment: Use https://eu.zuora.com/apps/PublicHostedPageLite.do"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For EU Cloud Sandbox environment: Use https://sandbox.eu.zuora.com/apps/PublicHostedPageLite.do"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For EU Central Sandbox environment: Use https://test.eu.zuora.com/apps/PublicHostedPageLite.do"},"children":[]}]}]}]}],"type":"string"}},"required":["method","pageId","uri"],"type":"object"}},"components/schemas/POSTRSASignatureResponseType":{"id":"components/schemas/POSTRSASignatureResponseType","kind":"json-schema","title":"POSTRSASignatureResponseType","data":{"properties":{"key":{"description":"Public key generated for this Payment Page.\n","type":"string"},"signature":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digital signature generated for this Payment Page."},"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":"signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is successfully returned, please limit the number of the fields in your request to make sure that the maximum length supported by the RSA signature algorithm is not exceeded."},"children":[]}]}]}],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"tenantId":{"description":"ID of the Zuora tenant.\n","type":"string"},"token":{"description":"Token generated for this Payment Page.\n","type":"string"}},"type":"object"}},"components/schemas/POSTDecryptionType":{"id":"components/schemas/POSTDecryptionType","kind":"json-schema","title":"POSTDecryptionType","data":{"example":{"method":"POST","publicKey":"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWRFTwxQOqaG4JDZSQF/NJWvCDoSXm3TYilNzoN8nBbuvhKa7SZBBS+VP6rFqcbIU38Fu+Rf09vqyYOxuasPJe7yhqeOiStWB/aCPLhwXBeKt37L/qkwpNOKb1FETtUgrc+UjbtT0pnl55wCfi+Ik//X5SQi0B+c0ei1DQv99qmPJJErrhnBtdxeaWAT0EYAo42AOQ5cp0UWDY6OdOYL6+RyFOUFIs1yEgtfg4VMMSpSOKBOhYclQYuSC7nBF5Cc18ydtzsBpf7l49gCLTFzG45NCDAocada8KihFNpGXbauV9V4EPRD4lofaXdsXJ5Tw8/+KCsrUlvIQI3vcEv9LQIDAQAB","signature":"BeNYuHFkp/sbfm3clYyCkKEqd7XVTRDOJ1/5rL0tpkqxiSq+maqYkDz5kA+lN64ipoefQuJ7Rdm5TpICErufeJfa2sfTmGARDJ0hr+StXfLsIxHmDoNH5dqcXv3W6MR4kaljEqPVuhzGQ0We98DG52JcHWqqN53oHwTyuZuXocQqnmiE23IPm8UrU3g4hX/OLat0R81wDQ1SslZ+4pnqlncpTpopCK4FxeG3B0gYMhZcYd17Cmf0N3tEHVXHDlJIm4rOx0OVT+YBnjbKYLM0jxYu7PRKRis+yzN1BoappOEB0gmPjznIeiYF0u/fJdZWoEwK7d9mrfJeOBbpFyRoHA=="},"properties":{"method":{"description":"The type of the request. Set it to POST.\n","type":"string"},"publicKey":{"description":"The public key generated by Zuora.\n","type":"string"},"signature":{"description":"The signature generated by Zuora.\n","type":"string"}},"required":["method","publicKey","signature"],"type":"object"}},"components/schemas/POSTDecryptResponseType":{"id":"components/schemas/POSTDecryptResponseType","kind":"json-schema","title":"POSTDecryptResponseType","data":{"properties":{"decryptedSignature":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The string of a list of the following items: Payment Pages 2.0 URL, tenant ID, timestamp,the Payment Page ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The items are separated by '#', e.g., \"/apps/publichostedpagelite.do#12271#rvBp1AxBJwk6FrT7aqFuABIINiRbwJCc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"#1418848373103#2c92c0f948f899\""},"children":[]}]}]}],"type":"string"},"publicKey":{"description":"The public key passed in as a request parameter.\n","type":"string"},"signature":{"description":"The signature passed in as a request parameter.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GetHostedPageType":{"id":"components/schemas/GetHostedPageType","kind":"json-schema","title":"hostedpages","data":{"properties":{"pageId":{"description":"Page ID of the Payment Page that Zuora assigns when it is created.\n","type":"string"},"pageName":{"description":"Name of the Payment Page that specified during the page configuration.\n","type":"string"},"pageType":{"description":"Payment method type of this Payment Page, e.g. 'Credit Card', 'ACH', or 'Bank Transfer'.\n","type":"string"},"pageVersion":{"description":"Version of the Payment Page. 2 for Payment Pages 2.0.\n","type":"string"}},"title":"hostedpages","type":"object"}},"components/schemas/GetHostedPagesType":{"id":"components/schemas/GetHostedPagesType","kind":"json-schema","title":"GetHostedPagesType","data":{"properties":{"hostedpages":{"description":"Container for the hosted page information.\n","items":{"$ref":"#/components/schemas/GetHostedPageType"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/OpenPaymentMethodTypeRequestFields":{"id":"components/schemas/OpenPaymentMethodTypeRequestFields","kind":"json-schema","title":"fields","data":{"properties":{"checksum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The checksum value of a payment method is used to identify if this payment method is the same as another one, or if this payment method is altered to another new payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set this flag to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the following scenarios:"},"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 field should be part of checksum calculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is a critical differentiator for this type."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you select the credit card number and expiration date as the checksum fields for the CreditCard payment method type, when you modified the expiration date, Zuora considers this payment method as a different payment method compared to the original one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"type":"boolean"},"defaultValue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value of the field. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a required field is added after the custom payment method type is published, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defaultValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"maxLength":255,"type":"string","nullable":true},"description":{"description":"An explanation of this field. It can be an empty string.\n","maxLength":70,"type":"string"},"editable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this field can be updated through PUT API or UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"editable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can specify the value of this field in the UI and POST API when creating a payment method. However, after you created the payment method, you cannot edit this field through PUT API or UI."},"children":[]}]}]}],"type":"boolean"},"index":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order of the field in this type, starting from 1. It must be unique."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"type":"integer"},"label":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The label that is used to refer to this field in the Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An alphanumeric string, excluding JSON preserved characters e.g.  * \\ ’ ”"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty or any reserved field name."},"children":[]}]}]}],"maxLength":30,"type":"string"},"maxLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A maximum length limitation of the field value. The specified value must be in the range of [1,8000]. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minLength"},"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":"After the custom payment method type is created, you can only increase the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Decreasing the value is not supported."},"children":[]}]}]}],"type":"integer"},"minLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A minimal length limitation of the field value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxLength"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this metadata does not determine whether the field is a required field. It only defines the minimal length of the field value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the custom payment method type is created, you can only decrease the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Increasing the value is not supported."},"children":[]}]}]}],"type":"integer"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API name of this field. It must be uinique."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An alphanumeric string starting with a capital letter, excluding JSON preserved characters e.g.  * \\ ’ ”"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Though this field must be defined with a string starting with a capital letter, use this string with the first letter in lowercase when you specify it in other API operations. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPayToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the defined value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In the request of the \"Create a payment method\" API operation, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amazonPayToken"},"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 field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty or any reserved field name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"maxLength":30,"type":"string"},"representer":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This flag determines whether this field will be used for identifying this payment method in the Zuora UI. The field will be shown in the Payment Method field in the UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"In one custom payment method type, set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"representer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for at least one field ."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In one custom payment method type, you can set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"representer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for multiple fields."},"children":[]}]}]}]}],"type":"boolean"},"required":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify whether this field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"type":"boolean"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type, ISO_LOCAL_DATE format is supported, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2011-12-03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The timezone is not expected for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2011-12-03+01:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type, only ISO_OFFSET_DATE_TIME format is supported, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2011-12-03T10:15:30+01:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Timezone must be included. A string like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2011-12-03T10:15:30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2011-12-03T10:15:30+01:00[Europe/Paris]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need to define a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type with timezone or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type without timezone, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type for now."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"enum":["string","date","datetime","number","boolean"],"type":"string"},"visible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this field can be retrieved through GET API or UI for displaying payment method details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can still specify the value of this field in the UI and POST API when creating the payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"visible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"editable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is not accessible through GET API or UI for displaying details, but you can still see it and edit the value in the UI and PUT API when updating this payment method."},"children":[]}]}]}]}],"type":"boolean"}},"title":"fields"}},"components/schemas/POSTCreateOpenPaymentMethodTypeRequest":{"id":"components/schemas/POSTCreateOpenPaymentMethodTypeRequest","kind":"json-schema","title":"POSTCreateOpenPaymentMethodTypeRequest","data":{"example":{"entityId":"","fields":[{"checksum":true,"defaultValue":null,"description":"The Token value","editable":true,"index":1,"label":"AmazonToken","maxLength":100,"minLength":1,"name":"AmazonToken","representer":true,"required":true,"type":"string","visible":true},{"checksum":true,"defaultValue":null,"description":"The Type of Token, e.g. GoCardlessToken","editable":true,"index":2,"label":"Amazon TokenType","maxLength":100,"minLength":1,"name":"AmazonTokenType","representer":true,"required":true,"type":"string","visible":true}],"internalName":"AmazonPay","label":"ZuoraQA Amazon Pay","methodReferenceIdField":"AmazonToken","subTypeField":"AmazonTokenType","tenantId":"9","userReferenceIdField":""},"properties":{"entityId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this custom payment method type is specific to one entity only, provide the entity ID in this field in UUID format, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"123e4567-e89b-12d3-a456-426614174000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get the entity ID through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/older-api/operation/GET_Entities/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-entity: List entities"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API operation or the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Entity Profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" administration setting in the UI. To convert the format of the entity ID to UUID, separate the entity ID string in five groups with hyphens, in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<8-characters>-<4-characters>-<4-characters>-<4-characters>-<12-characters>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a total of 36 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: After the custom payment method type is created, you can only update this field to be empty."},"children":[]}]}]}],"type":"string"},"fields":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array containing field metadata of the custom payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"All the following nested metadata must be provided in the request to define a field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one field must be defined in the fields array for a custom payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 20 fields can be defined in the fields array for a custom payment method type."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/OpenPaymentMethodTypeRequestFields"},"type":"array"},"internalName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string to identify the custom payment method type in the API name of the payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field must be alphanumeric, starting with a capital letter, excluding JSON preserved characters such as  * \\ ’ ”. Additionally, '_' or '-' is not allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field must be unique in a tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used along with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by the system to construct and generate the API name of the custom payment method type in the following way:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<internalName>__c_<tenantId>"},"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":"internalName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the API name of the custom payment method type will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay__c_12368"},"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 field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"maxLength":19,"type":"string"},"isSupportAsyncPayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to enable the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-electronic-payment-processing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous Payment Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in handling transactions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with your custom payment method, specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You also need to complete tasks described in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-enable-asynchronous-payment-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable the Asynchronous Payment Statuses feature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Zuora Knowledge Center."},"children":[]}]}]}],"type":"boolean","default":false},"label":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The label that is used to refer to this type in the Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be alphanumeric, excluding JSON preserved characters such as  * \\ ’ ”"},"children":[]}]}]}],"maxLength":40,"type":"string"},"methodReferenceIdField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"type":"string"},"subTypeField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference indicating the subtype of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"type":"string"},"tenantId":{"description":"Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.\n\nThis field cannot be updated after the creation of the custom payment method type.\n","type":"string"},"userReferenceIdField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the user or customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"type":"string"}},"required":["internalName","tenantId","label","methodReferenceIdField","fields"]}},"components/schemas/POSTCreateOpenPaymentMethodTypeResponse":{"id":"components/schemas/POSTCreateOpenPaymentMethodTypeResponse","kind":"json-schema","title":"POSTCreateOpenPaymentMethodTypeResponse","data":{"properties":{"paymentMethodType":{"description":"The API name of the custom payment method type.\n","type":"string"},"publishDate":{"description":"The date when the custom payment method type was published. It is empty if the custom payment method type has not been published yet.\n","type":"string"},"revision":{"description":"The revision number of the custom payment method type, which starts from 1 and increases by 1 when you update a published revision for the first time.\n","type":"integer"},"status":{"description":"The status of the custom payment method type.\n","type":"string"}}}},"components/schemas/OpenPaymentMethodTypeResponseFields":{"id":"components/schemas/OpenPaymentMethodTypeResponseFields","kind":"json-schema","title":"fields","data":{"properties":{"checksum":{"description":"The checksum value of a payment method is used to identify if this payment method is the same as another one, or if this payment method is altered to another new payment method.\n\nFor example, if you select the credit card number and expiration date as the checksum fields for the CreditCard payment method type, when you modified the expiration date, Zuora considers this payment method as a different payment method compared to the original one.\n","type":"boolean"},"defaultValue":{"description":"The default value of the field.\n","type":"string","nullable":true},"description":{"description":"An explanation of this field.\n","type":"string"},"editable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this field can be updated through PUT API or UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"editable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can specify the value of this field in the UI and POST API when creating a payment method. However, after you created the payment method, you cannot edit this field through PUT API or UI."},"children":[]}]}]}],"type":"boolean"},"index":{"description":"The order of the field in this type, starting from 1.\n","type":"integer"},"label":{"description":"The label that is used to refer to this field in the Zuora UI.\n","type":"string"},"maxLength":{"description":"A maximum length limitation of the field value.\n","type":"integer"},"minLength":{"description":"A minimal length limitation of the field value.\n","type":"integer"},"name":{"description":"The API name of this field. It must be uinique.\n","type":"string"},"representer":{"description":"This flag determines whether this field will be used for identifying this payment method in the Zuora UI. The field will be shown in the Payment Method field in the UI.\n","type":"boolean"},"required":{"description":"Specify whether this field is required.\n","type":"boolean"},"type":{"description":"The type of this field.\n","enum":["string","date","datetime","number","boolean"],"type":"string"},"visible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this field can be retrieved through GET API or UI for displaying payment method details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can still specify the value of this field in the UI and POST API when creating the payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"visible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"editable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is not accessible through GET API or UI for displaying details, but you can still see it and edit the value in the UI and PUT API when updating this payment method."},"children":[]}]}]}]}],"type":"boolean"}},"title":"fields"}},"components/schemas/PUTPublishOpenPaymentMethodTypeResponse":{"id":"components/schemas/PUTPublishOpenPaymentMethodTypeResponse","kind":"json-schema","title":"PUTPublishOpenPaymentMethodTypeResponse","data":{"properties":{"entityId":{"description":"If an entity UUID is provided, this custom payment method type is specific to this entity only. If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant.\n","type":"string"},"fields":{"description":"An array containing field metadata of the custom payment method type.\n","items":{"$ref":"#/components/schemas/OpenPaymentMethodTypeResponseFields"},"type":"array"},"internalName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string to identify the custom payment method type in the API name of the payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used along with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by the system to construct and generate the API name of the custom payment method type in the following way:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<internalName>__c_<tenantId>"},"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":"internalName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the API name of the custom payment method type will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay__c_12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"label":{"description":"The label that is used to refer to this type in the Zuora UI.\n","type":"string"},"methodReferenceIdField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query."},"children":[]}]}]}],"type":"string"},"revision":{"description":"The revision number of the custom payment method type, which starts from 1 and increases by 1 when you update a published revision for the first time.\n","type":"integer"},"status":{"description":"The status of the custom payment method type.\n","type":"string"},"subTypeField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference indicating the subtype of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}],"type":"string"},"tenantId":{"description":"Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.\n","type":"string"},"userReferenceIdField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the user or customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}],"type":"string"},"version":{"description":"The time when the custom payment method type was first published.\n","type":"string"}}}},"components/schemas/PUTUpdateOpenPaymentMethodTypeRequest":{"id":"components/schemas/PUTUpdateOpenPaymentMethodTypeRequest","kind":"json-schema","title":"PUTUpdateOpenPaymentMethodTypeRequest","data":{"example":{"entityId":"","fields":[{"checksum":true,"defaultValue":null,"description":"The Token value","editable":true,"index":1,"label":"AmazonToken","maxLength":100,"minLength":1,"name":"AmazonToken","representer":true,"required":true,"type":"string","visible":true},{"checksum":true,"defaultValue":null,"description":"The Type of Token, e.g. GoCardlessToken","editable":true,"index":2,"label":"Amazon TokenType","maxLength":100,"minLength":1,"name":"AmazonTokenType","representer":true,"required":true,"type":"string","visible":true}],"internalName":"AmazonPay","label":"ZuoraQA Amazon Pay","methodReferenceIdField":"AmazonToken","subTypeField":"AmazonTokenType","tenantId":"9","userReferenceIdField":""},"properties":{"entityId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this custom payment method type is specific to one entity only, specify the entity ID in UUID format when creating the draft payment method type, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"123e4567-e89b-12d3-a456-426614174000"},"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":"You can only update this field to be empty, indicating that this custom payment method type is available to the global entity and all the sub entities in the tenant."},"children":[]}]}]}],"type":"string"},"fields":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array containing field metadata of the custom payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"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":"All the following nested metadata fields must be provided in the request to define a field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one field must be defined in the fields array for a custom payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 20 fields can be defined in the fields array for a custom method type."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/OpenPaymentMethodTypeRequestFields"},"type":"array"},"internalName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string to identify the custom payment method type in the API name of the payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used along with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by the system to construct and generate the API name of the custom payment method type in the following way:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<internalName>__c_<tenantId>"},"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":"internalName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the API name of the custom payment method type will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay__c_12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":19,"type":"string"},"isSupportAsyncPayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to enable the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-electronic-payment-processing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous Payment Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in handling transactions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with your custom payment method, specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You also need to complete tasks described in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-enable-asynchronous-payment-status","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable the Asynchronous Payment Statuses feature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Zuora Knowledge Center."},"children":[]}]}]}],"type":"boolean","default":false},"label":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The label that is used to refer to this type in the Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be alphanumeric, excluding JSON preserved characters such as  * \\ ’ ”"},"children":[]}]}]}],"maxLength":40,"type":"string"},"methodReferenceIdField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must be the same as the value specified when creating the draft revision of this custom payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"type":"string"},"subTypeField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference indicating the subtype of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"type":"string"},"tenantId":{"description":"Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.\n\nThis field cannot be updated after the creation of the custom payment method type.\n","type":"string"},"userReferenceIdField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the user or customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be updated after the creation of the custom payment method type."},"children":[]}]}]}],"type":"string"}},"required":["internalName","tenantId","label","methodReferenceIdField","fields"]}},"components/schemas/PUTUpdateOpenPaymentMethodTypeResponse":{"id":"components/schemas/PUTUpdateOpenPaymentMethodTypeResponse","kind":"json-schema","title":"PUTUpdateOpenPaymentMethodTypeResponse","data":{"properties":{"paymentMethodType":{"description":"The API name of the custom payment method type.\n","type":"string"},"publishDate":{"description":"The date when the custom payment method type was published. It is emptry if the custom payment method type has not been published yet.\n","type":"string"},"revision":{"description":"The revision number of the custom payment method type, which starts from 1 and increases by 1 when you update a published revision for the first time.\n","type":"integer"},"status":{"description":"The status of the custom payment method type.\n","type":"string"}}}},"components/schemas/GETOpenPaymentMethodTypeRevisionResponse":{"id":"components/schemas/GETOpenPaymentMethodTypeRevisionResponse","kind":"json-schema","title":"GETOpenPaymentMethodTypeRevisionResponse","data":{"properties":{"entityId":{"description":"If an entity UUID is provided, this custom payment method type is specific to this entity only. If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant.\n","type":"string"},"fields":{"description":"An array containing field metadata of the custom payment method type.\n","items":{"$ref":"#/components/schemas/OpenPaymentMethodTypeResponseFields"},"type":"array"},"internalName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string to identify the custom payment method type in the API name of the payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used along with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by the system to construct and generate the API name of the custom payment method type in the following way:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<internalName>__c_<tenantId>"},"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":"internalName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the API name of the custom payment method type will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmazonPay__c_12368"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"label":{"description":"The label that is used to refer to this type in the Zuora UI.\n","type":"string"},"methodReferenceIdField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}],"type":"string"},"revision":{"description":"The revision number of the custom payment method type, which starts from 1 and increases by 1 when you update a published revision for the first time.\n","type":"integer"},"status":{"description":"The status of the custom payment method type.\n","type":"string"},"subTypeField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference indicating the subtype of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}],"type":"string"},"tenantId":{"description":"Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.\n","type":"string"},"userReferenceIdField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the user or customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}],"type":"string"},"version":{"description":"The time when the custom payment method type was first published.\n","type":"string"}}}},"components/schemas/POSTDelayAuthorizeCapture":{"id":"components/schemas/POSTDelayAuthorizeCapture","kind":"json-schema","title":"POSTDelayAuthorizeCapture","data":{"example":{"accountId":"402881e861bd8a7e0161c6a453750026","amount":1.99,"gatewayOrderId":"A001"},"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the customer account. Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"type":"string"},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the customer account. Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"type":"string"},"amount":{"description":"The amount of the transaction.","type":"number"},"currency":{"description":"The 3-letter ISO 4217 currency code for the authorization transaction. If not provided, defaults to the currency of the customer account.","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts."},"children":[]}]}]}],"properties":{"key":{"description":"The name of a gateway-specific parameter.\n","type":"string"},"value":{"description":"The value of the gateway-specific parameter.\n","type":"string"}},"type":"object"},"gatewayOrderId":{"description":"The order ID for the specific gateway.\n\nThe specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.\n","type":"string"},"mitTransactionSource":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework."},"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":"C_Unscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchant-initiated transaction (MIT) that occurs at regular intervals."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_Unscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_MOTO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-stripe-gateway-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Stripe payment gateway integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"enum":["C_Unscheduled","M_Recurring","M_Unscheduled","M_MOTO"],"type":"string"},"paymentGatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment gateway instance."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-gateway-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Gateway Routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled:"},"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 field is not specified, gateway routing rules will be invoked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to authorize the payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Payment Gateway Routing is disabled:"},"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 field is not specified, the default payment gateway will be used to authorize the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to authorize the payment."},"children":[]}]}]}]}],"type":"string"},"softDescriptor":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text, rendered on a cardholder’s statement, describing a particular product or service purchased by the cardholder."},"children":[]}]}]}],"type":"string"},"softDescriptorPhone":{"description":"The phone number that relates to the soft descriptor, usually the phone number of customer service.","type":"string"}},"required":["amount","gatewayOrderId"],"type":"object"}},"components/schemas/POSTAuthorizeResponse":{"id":"components/schemas/POSTAuthorizeResponse","kind":"json-schema","title":"POSTAuthorizeResponse","data":{"example":{"currency":"EUR","gatewayOrderId":"A001","resultCode":0,"resultMessage":"Request ID: 5231719060426316203012","success":true,"transactionId":"5231719060426316203012"},"properties":{"currency":{"description":"The three-letter ISO 4217 currency code used for the authorization transaction.\n","type":"string"},"gatewayOrderId":{"description":"The order ID for the specific gateway.\n\nThe specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.\n","type":"string"},"paymentGatewayResponse":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response data returned from the gateway. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the support for returning additional error information from the gateway is enabled."},"children":[]}]}]}],"properties":{"additionalInfo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The additional information returned from the gateway. The returned fields vary for gateways. Here is an example."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"additionalInfo\": {\n  \"ProcessorName\": \"MasterCard Saferpay Test\",\n  \"ProcessorResult\": \"51\",\n  \"ProcessorMessage\": \"Insufficient funds\",\n  \"ErrorName\": \"TRANSACTION_DECLINED\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"additionalInfo\": {\n  \"ProcessorName\": \"MasterCard Saferpay Test\",\n  \"ProcessorResult\": \"51\",\n  \"ProcessorMessage\": \"Insufficient funds\",\n  \"ErrorName\": \"TRANSACTION_DECLINED\"\n}\n"},"children":[]}]}],"type":"object"},"gatewayResponseCode":{"description":"The HTTP response code.\n","type":"string"},"gatewayResponseMessage":{"description":"The error message returned from the gateway.\n","type":"string"},"gatewayType":{"description":"The gateway type.\n","type":"string"},"gatewayVersion":{"description":"The gateway version.\n","type":"string"}},"type":"object"},"processId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the running process when the exception occurs. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"reasons":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container of the error code and message. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"properties":{"code":{"description":"Error code.\n","type":"string"},"message":{"description":"Error message. It usually contains a combination of gateway response code and response message.\n","type":"string"}},"type":"object"},"type":"array"},"requestId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the request. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}],"type":"string"},"resultCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result code of the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 indicates that the request succeeded, and the following values indicate that the request failed:"},"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":"1: The request is declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7: The field format is not correct."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10: Client connection has timed out."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11: Host connection has timed out."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12: Processor connection has timed out."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13: Gateway server is busy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20: The card type is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"21: The merchant account information is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"22: A generic error occurred on the processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"40: The card type has not been set up yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41: The limit for a single transaction is exceeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"42: Address checking failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"43: Card security code checking failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"44: Failed due to the gateway security setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"45: Fraud protection is declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"46: Address checking or card security code checking failed (for Authorize.net gateway only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"47: The maximum amount is exceeded (for Authorize.net gateway only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"48: The IP address is blocked by the gateway (for Authorize.net gateway only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"49: Card security code checking failed (for Authorize.net gateway only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"60: User authentication failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"61: The currency code is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"62: The transaction ID is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"63: The credit card number is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"64: The card expiration date is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"65: The transaction is duplicated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"66: Credit transaction error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"67: Void transaction error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"90: A valid amount is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"91: The BA code is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"92: The account number is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"93: The ACH transaction is not accepted by the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"94: An error occurred for the ACH transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"95: The version parameter is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"96: The transaction type is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"97: The transaction method is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"98: The bank account type is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"99: The authorization code is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200: General transaction error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500: The transaction is queued for submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"999: Unknown error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1: An error occurred in gateway communication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-2: Idempotency is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-3: Inquiry call is not supported."},"children":[]}]}]}]}],"type":"string"},"resultMessage":{"description":"The corresponding request ID.","type":"string"},"success":{"description":"Indicates whether the call succeeded.","type":"boolean"},"transactionId":{"description":"The ID of the transaction.","type":"string"}},"type":"object"}},"components/schemas/POSTVoidAuthorize":{"id":"components/schemas/POSTVoidAuthorize","kind":"json-schema","title":"POSTVoidAuthorize","data":{"example":{"accountId":"402881e861bd8a7e0161c6a453750026","gatewayOrderId":"A001","transactionId":"5205213224866613203009"},"properties":{"accountId":{"description":"The ID of the customer account.","type":"string"},"accountNumber":{"description":"The number of the customer account.","type":"string"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts."},"children":[]}]}]}],"properties":{"key":{"description":"The name of a gateway-specific parameter.\n","type":"string"},"value":{"description":"The value of the gateway-specific parameter.\n","type":"string"}},"type":"object"},"gatewayOrderId":{"description":"The order ID for the specific gateway.\n\nThe specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.\n","type":"string"},"paymentGatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment gateway instance."},"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 field is specified and it is a Worldline Global Collect gateway, the specified gateway is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified or is not a Worldline Global Collect gateway, the cancellation operation uses the payment gateway originally used for the authorization."},"children":[]}]}]}]}],"type":"string","nullable":true},"transactionId":{"description":"The ID of the transaction.","type":"string"}},"required":["transactionId","gatewayOrderId"],"type":"object"}},"components/schemas/POSTVoidAuthorizeResponse":{"id":"components/schemas/POSTVoidAuthorizeResponse","kind":"json-schema","title":"POSTVoidAuthorizeResponse","data":{"example":{"gatewayOrderId":"A001","resultCode":0,"resultMessage":"Request ID: 5231719060426316203012","success":true,"transactionId":"5231719060426316203012"},"properties":{"gatewayOrderId":{"description":"The order ID for the specific gateway.\n\nThe specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.\n","type":"string"},"resultCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result code of the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 indicates that the request succeeded, and the following values indicate that the request failed:"},"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":"1: The request is declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7: The field format is not correct."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10: Client connection has timed out."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11: Host connection has timed out."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12: Processor connection has timed out."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13: Gateway server is busy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20: The card type is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"21: The merchant account information is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"22: A generic error occurred on the processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"40: The card type has not been set up yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"41: The limit for a single transaction is exceeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"42: Address checking failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"43: Card security code checking failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"44: Failed due to the gateway security setting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"45: Fraud protection is declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"46: Address checking or card security code checking failed (for Authorize.net gateway only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"47: The maximum amount is exceeded (for Authorize.net gateway only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"48: The IP address is blocked by the gateway (for Authorize.net gateway only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"49: Card security code checking failed (for Authorize.net gateway only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"60: User authentication failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"61: The currency code is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"62: The transaction ID is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"63: The credit card number is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"64: The card expiration date is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"65: The transaction is duplicated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"66: Credit transaction error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"67: Void transaction error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"90: A valid amount is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"91: The BA code is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"92: The account number is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"93: The ACH transaction is not accepted by the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"94: An error occurred for the ACH transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"95: The version parameter is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"96: The transaction type is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"97: The transaction method is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"98: The bank account type is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"99: The authorization code is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200: General transaction error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500: The transaction is queued for submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"999: Unknown error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1: An error occurred in gateway communication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-2: Idempotency is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-3: Inquiry call is not supported."},"children":[]}]}]}]}],"type":"string"},"resultMessage":{"description":"The corresponding request ID.","type":"string"},"success":{"description":"Indicates whether the call succeeded.","type":"boolean"},"transactionId":{"description":"The ID of the transaction.","type":"string"}},"type":"object"}},"components/schemas/GETAPaymentGatwayResponse":{"id":"components/schemas/GETAPaymentGatwayResponse","kind":"json-schema","title":"paymentgateways","data":{"properties":{"id":{"description":"The ID of the payment gateway.","type":"string"},"isActive":{"description":"Specifies if this payment gateway is in active status.","type":"boolean"},"isDefault":{"description":"Specifies if this is the default payment gateway to process payments for your customer accounts.","type":"boolean"},"name":{"description":"The name of the payment gateway.","type":"string"},"type":{"description":"The type of the payment gateway","type":"string"}},"title":"paymentgateways","type":"object"}},"components/schemas/GETPaymentGatwaysResponse":{"id":"components/schemas/GETPaymentGatwaysResponse","kind":"json-schema","title":"GETPaymentGatwaysResponse","data":{"properties":{"paymentgateways":{"description":"","items":{"$ref":"#/components/schemas/GETAPaymentGatwayResponse"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PostTriggerPreDebitNotificationRequest":{"id":"components/schemas/PostTriggerPreDebitNotificationRequest","kind":"json-schema","title":"PostTriggerPreDebitNotificationRequest","data":{"example":{"invoiceKey":"c2289d0a8d3af0f2018d3b2b1fd00000","paymentGatewayId":"80289d0a8d3af0f2018d3b1b8b800000","paymentMethodId":"40289d0a8d3af0f2018d3b2b1fd00000"},"properties":{"invoiceKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for an invoice. It can be either a UUID"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c92c8955bd63cc1015bd7c151af0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or an invoice number"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV-0000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"paymentGatewayId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment gateway used to process the payment, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8ad08aef83d0c3000183d4b5a2d51933"},"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 it is not provided, the ID of the default payment gateway is used."},"children":[]}]}]}]},"paymentMethodId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment method used for the payment, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4ad08aef83d0c30102183d4b5a2d51733"},"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 it is not provided, the ID of the default payment method is used."},"children":[]}]}]}]}},"required":["invoiceKey"],"type":"object"}},"components/schemas/PostTriggerPreDebitNotificationResponse":{"id":"components/schemas/PostTriggerPreDebitNotificationResponse","kind":"json-schema","title":"PostTriggerPreDebitNotificationResponse","data":{"example":{"success":true,"invoiceId":"c2289d0a8d3af0f2018d3b2b1fd00000","paymentMethodId":"40289d0a8d3af0f2018d3b2b1fd00000","gatewayId":"80289d0a8d3af0f2018d3b1b8b800000","gatewayType":"Adyen","gatewayVersion":"2","notificationReferenceId":"40289d0a8d3af0f2018d3b2b1fd00000","secondNotificationReferenceId":null,"thirdNotificationReferenceId":null,"extraParameters":null},"properties":{"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"},"invoiceId":{"description":"The ID of the invoice, for which the pre-debit notification is triggered.\n","type":"string"},"paymentMethodId":{"description":"The ID of the associated payment method.\n","type":"string"},"gatewayId":{"description":"The ID of the associated payment gateway.\n","type":"string"},"gatewayType":{"description":"The gateway type used in this operation.\n","type":"string"},"gatewayVersion":{"description":"The version number of the gateway used.\n","type":"string"},"notificationReferenceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shopperNotificationReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returned from the gateway."},"children":[]}]}]}],"type":"string"},"secondNotificationReferenceId":{"description":"The additional second reference ID returned from the gateway.\n","type":"string","nullable":true},"thirdNotificationReferenceId":{"description":"The additional third reference ID returned from the gateway.\n","type":"string","nullable":true},"extraParameters":{"description":"The extra optional parameter returned from the gateway.\n","type":"string","nullable":true}},"type":"object"}},"components/schemas/POSTReversePaymentRequest":{"id":"components/schemas/POSTReversePaymentRequest","kind":"json-schema","title":"POSTReversePaymentRequest","data":{"example":{"amount":10},"properties":{"amount":{"description":"The amount that needs to be reversed (chargeback). It cannot be greater than the total Payment amount. \n","type":"number"},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string"},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string"},"gatewayResponse":{"description":"The transaction response returned by the gateway for this transaction. If the transaction was declined, this reason is provided in the message.\n","type":"string"},"gatewayResponseCode":{"description":"Response message Code returned by the gateway about the transaction status.\n","type":"string"},"payoutId":{"description":"The payout ID from the gateway side.\n","type":"string"},"referenceId":{"description":"Unique Id generated by the gateway for each transaction. Use this ID to find the respective Zuora Payment ID. \n","maxLength":100,"type":"string"},"secondReferenceId":{"description":"The second reference Id. Some gateways use two unique transaction IDs.\n","maxLength":100,"type":"string"},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the transaction settlement. The format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"required":["amount"],"type":"object"}},"components/schemas/POSTReversePaymentResponse":{"id":"components/schemas/POSTReversePaymentResponse","kind":"json-schema","title":"POSTReversePaymentResponse","data":{"properties":{"accountId":{"description":"The ID of the customer account that the payment is for.\n","type":"string"},"amount":{"description":"The total amount of the payment.\n","format":"double","type":"number"},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the payment.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the refund.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the chargeback is created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2019-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of the credit memo that is refunded.\n","type":"string","nullable":true},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n  \n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","maxLength":100,"minLength":0,"type":"string"},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n  \n","type":"string"}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the payment.\n","type":"string","nullable":true},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string","nullable":true},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string","nullable":true},"gatewayResponse":{"description":"The message returned from the payment gateway for the payment. This message is gateway-dependent.\n","type":"string","nullable":true},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the payment. This code is gateway-dependent.\n","type":"string","nullable":true},"gatewayState":{"description":"The status of the payment in the gateway; specifically used for reconciliation.\n","enum":["Submitted","NotSubmitted","Settled","FailedToSettle"],"type":"string"},"id":{"description":"The ID of the payment chargeback.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a charge was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"methodType":{"description":"How an external refund was issued to a customer. \n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"number":{"description":"The unique identification number of the payment. For example, P-00000001.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentId":{"description":"The ID of the payment that is refunded.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the payment.\n","type":"string"},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n","type":"string","nullable":true},"payoutId":{"description":"The payout ID from the gateway side.\n","type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction.   \n","type":"string"},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string","nullable":true},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01."},"children":[]}]}]}],"format":"date","type":"string"},"refundTransactionTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was issued, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional refund. \n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the transaction is settled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"softDescriptor":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps Zuora to other gateways.          \n","type":"string","nullable":true},"status":{"description":"The status of the payment.\n","type":"string"},"submittedOn":{"description":"The date and time when the payment was submitted, in yyyy-mm-dd hh:mm:ss format.\n","type":"string","nullable":true},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"type":{"description":"The type of the payment.\n","enum":["External","Electronic"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the payment.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2019-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/POSTRejectPaymentRequest":{"id":"components/schemas/POSTRejectPaymentRequest","kind":"json-schema","title":"POSTRejectPaymentRequest","data":{"example":{"gatewayReconciliationReason":"insufficient_funds"},"properties":{"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string"},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string"},"gatewayResponse":{"description":"The transaction response returned by the gateway for this transaction. If the transaction was declined, this reason is provided in the message.\n","type":"string"},"gatewayResponseCode":{"description":"Response message Code returned by the gateway about the transaction status.\n","type":"string"},"referenceId":{"description":"Unique Id generated by the gateway for each transaction. Use this ID to find the respective Zuora Payment ID. \n","maxLength":100,"type":"string"},"secondReferenceId":{"description":"The second reference Id. Some gateway uses two unique transaction IDs.\n","maxLength":100,"type":"string"},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the transaction settlement. The format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/POSTRejectPaymentResponse":{"id":"components/schemas/POSTRejectPaymentResponse","kind":"json-schema","title":"POSTRejectPaymentResponse","data":{"properties":{"accountId":{"description":"The ID of the customer account that the payment is for.\n","type":"string"},"amount":{"description":"The total amount of the payment.\n","format":"double","type":"number"},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the payment.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the refund.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the chargeback is created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2019-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of the credit memo that is refunded.\n","type":"string","nullable":true},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n  \n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","maxLength":100,"minLength":0,"type":"string"},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n  \n","type":"string"}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the payment.\n","type":"string","nullable":true},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string","nullable":true},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string","nullable":true},"gatewayResponse":{"description":"The message returned from the payment gateway for the payment. This message is gateway-dependent.\n","type":"string","nullable":true},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the payment. This code is gateway-dependent.\n","type":"string","nullable":true},"gatewayState":{"description":"The status of the payment in the gateway; specifically used for reconciliation.\n","enum":["Submitted","NotSubmitted","Settled","FailedToSettle"],"type":"string"},"id":{"description":"The ID of the payment chargeback.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a charge was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"methodType":{"description":"How an external refund was issued to a customer. \n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"number":{"description":"The unique identification number of the payment. For example, P-00000001.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentId":{"description":"The ID of the payment that is refunded.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the payment.\n","type":"string"},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n","type":"string","nullable":true},"payoutId":{"description":"The payout ID from the gateway side.\n","type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction.      \n","type":"string"},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string","nullable":true},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01."},"children":[]}]}]}],"format":"date","type":"string"},"refundTransactionTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was issued, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional refund. \n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the transaction is settled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"softDescriptor":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps Zuora to other gateways.          \n","type":"string","nullable":true},"status":{"description":"The status of the payment.\n","type":"string"},"submittedOn":{"description":"The date and time when the payment was submitted, in yyyy-mm-dd hh:mm:ss format.\n","type":"string","nullable":true},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"type":{"description":"The type of the payment.\n","enum":["External","Electronic"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the payment.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2019-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/POSTSettlePaymentRequest":{"id":"components/schemas/POSTSettlePaymentRequest","kind":"json-schema","title":"POSTSettlePaymentRequest","data":{"example":{"gatewayReconciliationReason":"paid"},"properties":{"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string"},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string"},"payoutId":{"description":"The payout ID from the gateway side.\n","type":"string"},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the transaction settlement. The format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/POSTSettlePaymentResponse":{"id":"components/schemas/POSTSettlePaymentResponse","kind":"json-schema","title":"POSTSettlePaymentResponse","data":{"properties":{"accountId":{"description":"The ID of the customer account that the payment is for.\n","type":"string"},"accountNumber":{"description":"The number of the customer account that the payment is for.\n","type":"string"},"amount":{"description":"The total amount of the payment.\n","format":"double","type":"number"},"appliedAmount":{"description":"The applied amount of the payment.\n","format":"double","type":"number"},"authTransactionId":{"description":"The authorization transaction ID from the payment gateway.\n","type":"string","nullable":true},"bankIdentificationNumber":{"description":"The first six or eight digits of the credit card or debit card used for the payment, when applicable.\n","type":"string"},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the payment.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the refund.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the chargeback is created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2019-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditBalanceAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount that the payment transfers to the credit balance. The value is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only for those payments that come from legacy payment operations performed without the Invoice Settlement feature."},"children":[]}]}]}],"format":"double","type":"number"},"currency":{"description":"A currency defined in the web-based UI administrative settings.\n","type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"paymentGatewayNumber":{"description":"The number of the payment gateway instance.\n","type":"string","nullable":true},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n  \n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","maxLength":100,"minLength":0,"type":"string"},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n  \n","type":"string"}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the payment.\n","type":"string"},"gatewayOrderId":{"description":"A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.\n","type":"string","nullable":true},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string"},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string","nullable":true},"gatewayResponse":{"description":"The message returned from the payment gateway for the payment. This message is gateway-dependent.\n","type":"string"},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the payment. This code is gateway-dependent.\n","type":"string"},"gatewayState":{"description":"The status of the payment in the gateway; specifically used for reconciliation.\n","enum":["Submitted","NotSubmitted","Settled","FailedToSettle"],"type":"string"},"id":{"description":"The ID of the payment chargeback.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a charge was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"number":{"description":"The unique identification number of the payment. For example, P-00000001.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the payment.\n","type":"string"},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n","type":"string"},"payoutId":{"description":"The payout ID from the gateway side.\n","type":"string","nullable":true},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string"},"refundAmount":{"description":"The amount of the payment that is refunded.\n","format":"double","type":"number"},"secondPaymentReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the payment. \n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the transaction is settled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"softDescriptor":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string","nullable":true},"status":{"description":"The status of the payment.\n","type":"string"},"submittedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was submitted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"success":{"description":"Indicates if the request is processed successfully.\n","type":"boolean"},"type":{"description":"The type of the payment.\n","enum":["External","Electronic"],"type":"string"},"unappliedAmount":{"description":"The unapplied amount of the payment.\n","format":"double","type":"number"},"updatedById":{"description":"The ID of the Zuora user who last updated the payment.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2019-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/POSTReconcileRefundRequest":{"id":"components/schemas/POSTReconcileRefundRequest","kind":"json-schema","title":"POSTReconcileRefundRequest","data":{"example":{"action":"settle","gatewayReconciliationStatus":"paid"},"properties":{"action":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action of the refund reconciliation."},"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":"settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Sets Gateway State to \"Settled\" and returns the refund object as response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Sets Gateway State to \"FailedToSettle\" and handle the event according to the settings configured in the Gateway Reconciliation Configuration in Payments Settings through Zuora UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-enable-batch-gateway-reconciliation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure how to handle refund rejected events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}],"enum":["settle","reject"],"type":"string"},"actionDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the refund reconciliation action, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"datetime","type":"string"},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string"},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string"},"payoutId":{"description":"The payout ID of the refund from the gateway side.\n","type":"string"}},"type":"object"}},"components/schemas/POSTReconcileRefundResponse":{"id":"components/schemas/POSTReconcileRefundResponse","kind":"json-schema","title":"POSTReconcileRefundResponse","data":{"example":{"id":"8ad083f092d66ff90192dc309ec31b7e","number":"R-00000025","status":"Processed","type":"Electronic","methodType":"CreditCard","accountId":"8ad09bce83f1da020183f97e245c1c47","amount":55,"refundDate":"2024-10-30","comment":null,"paymentMethodId":null,"paymentMethodSnapshotId":"8ad083f092d66ff90192dc309e941b7d","paymentId":"8ad097b48f0b078f018f0df4a6cf2ff4","paymentNumber":"P-00001536","creditMemoId":null,"reasonCode":"Other","gatewayId":"8ad095dd813e750f0181461a8e350ce7","paymentGatewayNumber":null,"gatewayResponse":"This transaction has been approved by the gateway.","gatewayResponseCode":"approve","gatewayState":"Settled","markedForSubmissionOn":null,"referenceId":5066779.708498786,"secondRefundReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":"2024-10-30 14:50:27","settledOn":"2024-11-13 16:07:24","cancelledOn":null,"createdDate":"2024-10-30 14:50:26","createdById":"8ad084a67f9c7138017fab8a8b511b5a","updatedDate":"2024-11-13 16:07:24","updatedById":"8ad084a67f9c7138017fab8a8b511b5a","refundTransactionTime":"2024-10-30 14:50:27","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":"Accounts Receivable","unappliedPaymentAccountingCodeType":"AccountsReceivable","transferredToAccounting":"No"},"gatewayReconciliationStatus":"paid","gatewayReconciliationReason":null,"payoutId":null,"success":true},"properties":{"accountId":{"description":"The ID of the customer account that the refund is for.\n","type":"string"},"amount":{"description":"The total amount of the refund.\n","format":"double","type":"number"},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the transaction was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the refund.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the refund.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund is created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of the credit memo that is refunded.\n","type":"string","nullable":true},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n  \n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","maxLength":100,"minLength":0,"type":"string"},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n  \n","type":"string"}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the refund.\n","type":"string"},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string","nullable":true},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string"},"gatewayResponse":{"description":"The message returned from the payment gateway for the refund. This message is gateway-dependent.\n","type":"string"},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the refund. This code is gateway-dependent.\n","type":"string"},"gatewayState":{"description":"The status of the refund in the gateway; specifically used for reconciliation.\n","enum":["Settled","FailedToSettle"],"type":"string"},"id":{"description":"The ID of the refund.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a refund was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"methodType":{"description":"How an external refund was issued to a customer. \n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"number":{"description":"The unique identification number of the refund. For example, R-00000001.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentId":{"description":"The ID of the payment that is refunded.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the refund.\n","type":"string","nullable":true},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n","type":"string"},"payoutId":{"description":"The payout ID of the refund from the gateway side.\n","type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction.      \n","type":"string"},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string"},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2020-03-01."},"children":[]}]}]}],"format":"date","type":"string"},"refundTransactionTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was issued, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional refund. \n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the transaction is settled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"softDescriptor":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps Zuora to other gateways.          \n","type":"string","nullable":true},"status":{"description":"The status of the refund.\n","type":"string"},"submittedOn":{"description":"The date and time when the refund was submitted, in yyyy-mm-dd hh:mm:ss format.\n","type":"string"},"success":{"description":"Indicates if the request is processed successfully.\n","type":"boolean"},"type":{"description":"The type of the refund.\n","enum":["External","Electronic"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the refund.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/PaymentSchedulePaymentOptionFields":{"id":"components/schemas/PaymentSchedulePaymentOptionFields","kind":"json-schema","title":"paymentOption","data":{"properties":{"detail":{"description":"The field used to pass the transactional payment data to the gateway side in the key-value format.\n","properties":{"key":{"description":"The name of the field.\n","type":"string"},"value":{"description":"The value of the field.\n","type":"string"}},"type":"object"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the payment option. Currently, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GatewayOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported for specifying Gateway Options fields supported by a payment gateway."},"children":[]}]}]}],"type":"string"}},"title":"paymentOption","type":"object"}},"components/schemas/PaymentObjectNSFields":{"id":"components/schemas/PaymentObjectNSFields","kind":"json-schema","title":"paymentFieldsNS","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for Payment fields provided by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"IntegrationId__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"IntegrationStatus__NS":{"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's synchronization with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Origin__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origin of the corresponding object in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"SyncDate__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the payment was synchronized with NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"},"Transaction__NS":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related transaction in NetSuite. Only available if you have installed the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/connect/app/?appId=265"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Connector for NetSuite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"type":"string"}},"title":"paymentFieldsNS","type":"object"}},"components/schemas/PaymentObjectCustomFields":{"id":"components/schemas/PaymentObjectCustomFields","kind":"json-schema","title":"paymentFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Payment object.\n","title":"paymentFieldsCustom","type":"object"}},"components/schemas/GETARPaymentTypewithSuccess":{"id":"components/schemas/GETARPaymentTypewithSuccess","kind":"json-schema","title":"payments","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account that the payment is for.\n","type":"string"},"accountNumber":{"description":"The number of the customer account that the payment is for.\n","type":"string"},"amount":{"description":"The total amount of the payment.\n","format":"double","type":"number"},"appliedAmount":{"description":"The applied amount of the payment.\n","format":"double","type":"number"},"authTransactionId":{"description":"The authorization transaction ID from the payment gateway.\n","type":"string","nullable":true},"bankIdentificationNumber":{"description":"The first six or eight digits of the credit card or debit card used for the payment, when applicable.\n","type":"string","nullable":true},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the payment.\n","type":"string"},"createdById":{"description":"The ID of the Zuora user who created the payment part.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditBalanceAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount that the payment transfers to the credit balance. The value is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only for those payments that come from legacy payment operations performed without the Invoice Settlement feature."},"children":[]}]}]}],"format":"double","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is not enabled, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is enabled and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency."},"children":[]}]}]}],"type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"financeInformation":{"description":"Container for the finance information related to the payment.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string","nullable":true},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","type":"string","nullable":true},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n","type":"string","nullable":true}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the payment.\n","type":"string","nullable":true},"gatewayOrderId":{"description":"A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.\n","type":"string","nullable":true},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string","nullable":true},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string","nullable":true},"gatewayResponse":{"description":"The message returned from the payment gateway for the payment. This message is gateway-dependent.\n","type":"string","nullable":true},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the payment. This code is gateway-dependent.\n","type":"string","nullable":true},"gatewayState":{"description":"The status of the payment in the gateway; use for reconciliation. \n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"id":{"description":"The unique ID of the payment. For example, 4028905f5a87c0ff015a87eb6b75007f.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a payment was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"number":{"description":"The unique identification number of the payment. For example, P-00000001.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentGatewayNumber":{"description":"The natural key for the payment gateway.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the payment.\n","type":"string"},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n","type":"string","nullable":true},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or the number of the payment schedule that is linked to the payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-link-payments-with-payment-schedules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link payments to payment schedules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"payoutId":{"description":"The payout ID of the payment from the gateway side.\n","type":"string","nullable":true},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payment is used as a reserved payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"referenceId":{"description":"The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"refundAmount":{"description":"The amount of the payment that is refunded.\n","format":"double","type":"number"},"secondPaymentReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was settled in the payment processor, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This field is used by the Spectrum gateway only and not applicable to other gateways."},"children":[]}]}]}],"type":"string","nullable":true},"softDescriptor":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"standalone":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if the support for standalone payment is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates this is an ordinary payment that is created, processed, and settled in Zuora."},"children":[]}]}]}],"type":"boolean"},"status":{"description":"The status of the payment.\n","enum":["Draft","Processing","Processed","Error","Canceled","Posted"],"type":"string"},"submittedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was submitted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"type":{"description":"The type of the payment.\n","enum":["External","Electronic"],"type":"string"},"unappliedAmount":{"description":"The unapplied amount of the payment.\n","format":"double","type":"number"},"updatedById":{"description":"The ID of the Zuora user who last updated the payment.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentObjectNSFields"},{"$ref":"#/components/schemas/PaymentObjectCustomFields"}],"title":"payments"}},"components/schemas/PaymentCollectionResponseType":{"id":"components/schemas/PaymentCollectionResponseType","kind":"json-schema","title":"PaymentCollectionResponseType","data":{"properties":{"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"payments":{"description":"Container for payments.\n","items":{"$ref":"#/components/schemas/GETARPaymentTypewithSuccess"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PaymentWithCustomRatesType":{"id":"components/schemas/PaymentWithCustomRatesType","kind":"json-schema","title":"customRates","data":{"allOf":[{"properties":{"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency code for either Reporting or Home currency."},"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 only available if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"customFxRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Custom FX conversion rate between Home/Reporting and Transactional currency items."},"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 only available if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"decimal","type":"number"},"rateDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which a particular currency rate is fixed or obtained on."},"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 only available if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["currency","customFxRate"],"type":"object"}],"title":"customRates"}},"components/schemas/PaymentDebitMemoApplicationItemCreateRequestType":{"id":"components/schemas/PaymentDebitMemoApplicationItemCreateRequestType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount of the payment associated with the specific debit memo or taxation item.\n","format":"double","type":"number"},"debitMemoItemId":{"description":"The ID of the specific debit memo item.\n","type":"string"},"taxItemId":{"description":"The ID of the specific taxation item.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/PaymentDebitMemoApplicationCreateRequestType":{"id":"components/schemas/PaymentDebitMemoApplicationCreateRequestType","kind":"json-schema","title":"debitMemos","data":{"properties":{"amount":{"description":"The amount of the payment associated with the debit memo.\n","format":"double","type":"number"},"debitMemoId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the debit memo that the payment is created on."},"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":"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 Payment Cross Account (PCA) feature is in the Early Adopter stage. To gain access to this capability, please create a Zuora support ticket."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body."},"children":[]}]}]}]}],"type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for debit memo items. The maximum number of items is 1,000."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentDebitMemoApplicationItemCreateRequestType"},"type":"array"}},"title":"debitMemos","type":"object"}},"components/schemas/PaymentInvoiceApplicationItemCreateRequestType":{"id":"components/schemas/PaymentInvoiceApplicationItemCreateRequestType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount of the payment associated with the specific invoice or taxation item.\n","format":"double","type":"number"},"invoiceItemId":{"description":"The ID of the specific invoice item.\n","type":"string"},"taxItemId":{"description":"The ID of the specific taxation item.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/PaymentInvoiceApplicationCreateRequestType":{"id":"components/schemas/PaymentInvoiceApplicationCreateRequestType","kind":"json-schema","title":"invoices","data":{"properties":{"amount":{"description":"The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice.\n","format":"double","type":"number"},"invoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the invoice that the payment is created on. The balance of the invoice specified must not be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 Payment Cross Account (PCA) feature is in the Early Adopter stage. To gain access to this capability, please create a Zuora support ticket."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body."},"children":[]}]}]}]}],"type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for invoice items. The maximum number of items is 1,000."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentInvoiceApplicationItemCreateRequestType"},"type":"array"}},"title":"invoices","type":"object"}},"components/schemas/CreatePaymentType":{"id":"components/schemas/CreatePaymentType","kind":"json-schema","title":"CreatePaymentType","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account that the payment is created for.\n","type":"string"},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the customer account that the payment is created for, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A00000001"},"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":"You can specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a customer account. If both of them are specified, they must refer to the same customer account."},"children":[]}]}]}],"type":"string"},"amount":{"description":"The total amount of the payment.\n","format":"double","type":"number"},"authTransactionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authorization transaction ID from the payment gateway. Use this field for electronic payments, such as credit cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/developer/api-references/api/operation/POST_CreateAuthorization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authTransactionId"},"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":"The following payment gateways support this field:"},"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":"Adyen Integration v2.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CyberSource 1.28"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CyberSource 1.97"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CyberSource 2.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chase Paymentech Orbital"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ingenico ePayments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SlimPay"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stripe v2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifi Global Payment Gateway"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WePay Payment Gateway Integration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Worldpay 1.4"},"children":[]}]}]}]}],"maxLength":50,"type":"string"},"comment":{"description":"Additional information related to the payment.\n","maxLength":255,"minLength":0,"type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is not enabled, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI. But if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled, you can have a different payment currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is enabled and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency."},"children":[]}]}]}],"type":"string"},"customRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both)."},"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":":"},"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":"This field is only available if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"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":"You cannot set the custom rates, if both the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically include additional Currency Conversion information in data source exports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fx data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment, PaymentApplication, and PaymentApplicationItem will utilize the provided custom Fx rate to convert amounts from the transactional currency to the home currency."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/PaymentWithCustomRatesType"},"maxItems":2,"type":"array"},"debitMemos":{"description":"Container for debit memos. The maximum number of debit memos is 1,000.\n","items":{"$ref":"#/components/schemas/PaymentDebitMemoApplicationCreateRequestType"},"type":"array"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the payment takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"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":"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":"This field is required for only electronic payments. It's an optional field for external payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When specified, this field must be set to the date of today."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When applying or transferring payments, this field must be later than or equal to the maximum effective date of the payment."},"children":[]}]}]}]}],"format":"date","type":"string"},"financeInformation":{"description":"Container for the finance information related to the payment.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"transferredToAccounting":{"description":"Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"gatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method."},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-gateway-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Gateway Routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled, when creating electronic payments, this field is optional."},"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 field is not specified, gateway routing rules will be invoked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"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":"If Payment Gateway Routing is disabled, when creating electronic payments, this field is required."},"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":"When creating external payments, this field is optional."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the same gateway instance if both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentGatewayNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewayId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are sent in the request."},"children":[]}]}]}],"type":"string"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts."},"children":[]}]}]}],"properties":{"key":{"description":"The name of a gateway-specific parameter.\n","maxLength":255,"type":"string"},"value":{"description":"The value of the gateway-specific parameter.\n","maxLength":255,"type":"string"}},"type":"object"},"gatewayOrderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zuora.com/developer/api-references/api/operation/POST_CreateAuthorization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"maxLength":50,"type":"string"},"invoices":{"description":"Container for invoices. The maximum number of invoices is 1,000.\n","items":{"$ref":"#/components/schemas/PaymentInvoiceApplicationCreateRequestType"},"type":"array"},"mitTransactionSource":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework."},"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":"C_Unscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchant-initiated transaction (MIT) that occurs at regular intervals."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_Unscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_MOTO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-stripe-gateway-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Stripe payment gateway integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"enum":["C_Unscheduled","M_Recurring","M_Unscheduled","M_MOTO"],"type":"string"},"paymentGatewayNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The natural key for the payment gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the same gateway instance if both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentGatewayNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewayId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are sent in the request."},"children":[]}]}]}],"type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the payment. \n\nIf no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs.\n","type":"string"},"paymentMethodType":{"default":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the payment method that the customer used to make the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify this value when you are creating an external payment method. If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are specified, only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is used to create the payment."},"children":[]}]}]}],"type":"string"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewayOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to pass the Gateway Options fields supported by a payment gateway. However, the Gateway Options fields passed through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be stored in the Payment Option object and can be easily retrieved."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or the number of the payment schedule to be linked with the payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-link-payments-with-payment-schedules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link payments to payment schedules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payment will be used as a reserved payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"referenceId":{"description":"The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n","maxLength":100,"minLength":0,"type":"string"},"softDescriptor":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.","maxLength":35,"type":"string"},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.","maxLength":20,"type":"string"},"standalone":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if support for standalone payments is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a standalone payment that will be processed in Zuora through Zuora gateway integration but will be settled outside of Zuora."},"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":"standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"code","inline":true,"attributes":{"content":"accountId"},"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":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Electronic"},"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":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment can be different from the payment currency in the customer account settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount will not be summed up into the account balance and key metrics regardless of the payment currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No settlement data will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either the applied amount or the unapplied amount of the payment is zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The standalone payment cannot be applied, unapplied, or transferred."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create an ordinary payment that will be created, processed, and settled in Zuora. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an ordinary payment must be the same as the currency in the customer account settings."},"children":[]}]}]}],"type":"boolean"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the payment."},"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":":  If you specify the type as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Electronic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["External","Electronic"],"type":"string"}},"required":["amount","currency","type"],"type":"object"},{"$ref":"#/components/schemas/PaymentObjectNSFields"},{"$ref":"#/components/schemas/PaymentObjectCustomFields"}],"example":{"accountId":"8a90b4488e7d5c0f018e7db3892400b2","type":"External","paymentMethodId":"2c92c8f95e2d6ebb015e325df7a70356","amount":14.99,"currency":"USD","invoices":[{"invoiceId":"8a90e5e4914ad4fa01914b25ff2c036e","amount":14.99}]}}},"components/schemas/GETARPaymentTypeWithPaymentOption":{"id":"components/schemas/GETARPaymentTypeWithPaymentOption","kind":"json-schema","title":"GETARPaymentTypeWithPaymentOption","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account that the payment is for.\n","type":"string"},"accountNumber":{"description":"The number of the customer account that the payment is for.\n","type":"string"},"amount":{"description":"The total amount of the payment.\n","format":"double","type":"number"},"appliedAmount":{"description":"The applied amount of the payment.\n","format":"double","type":"number"},"authTransactionId":{"description":"The authorization transaction ID from the payment gateway.\n","type":"string","nullable":true},"bankIdentificationNumber":{"description":"The first six or eight digits of the credit card or debit card used for the payment, when applicable.\n","type":"string","nullable":true},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the payment.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the payment.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditBalanceAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount that the payment transfers to the credit balance. The value is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only for those payments that come from legacy payment operations performed without the Invoice Settlement feature."},"children":[]}]}]}],"format":"double","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is not enabled, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is enabled and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency."},"children":[]}]}]}],"type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"financeInformation":{"description":"Container for the finance information related to the payment.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string","nullable":true},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","type":"string","nullable":true},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n","type":"string","nullable":true}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the payment.\n","type":"string","nullable":true},"gatewayOrderId":{"description":"A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.  If not specified, the payment number will be passed in instead.\n","type":"string","nullable":true},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string","nullable":true},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string","nullable":true},"gatewayResponse":{"description":"The message returned from the payment gateway for the payment. This message is gateway-dependent.\n","type":"string","nullable":true},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the payment. This code is gateway-dependent.\n","type":"string","nullable":true},"gatewayState":{"description":"The status of the payment in the gateway; use for reconciliation.\n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"id":{"description":"The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a payment was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"number":{"description":"The unique identification number of the payment. For example, P-00000001.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentGatewayNumber":{"description":"The natural key for the payment gateway.\n","type":"string","nullable":true},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the payment.\n","type":"string"},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n","type":"string","nullable":true},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or the number of the payment schedule that is linked to the payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-link-payments-with-payment-schedules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link payments to payment schedules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"payoutId":{"description":"The payout ID of the payment from the gateway side.\n","type":"string","nullable":true},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payment is used as a reserved payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"referenceId":{"description":"The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"refundAmount":{"description":"The amount of the payment that is refunded.\n","format":"double","type":"number"},"secondPaymentReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was settled in the payment processor, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This field is used by the Spectrum gateway only and not applicable to other gateways."},"children":[]}]}]}],"type":"string","nullable":true},"softDescriptor":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"standalone":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates this is an ordinary payment that is created, processed, and settled in Zuora."},"children":[]}]}]}],"type":"boolean"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-electronic-payment-processing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous Payment Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is not enabled, possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Posted"},"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 Asynchronous Payment Statuses feature is enabled, when the ACH or Bank Transfer payment is created, it is in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status upon successful network communication with the gateway. To transition from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to another status, use one of our Gateway Reconciliation options or cancel the payment."},"children":[]}]}]}],"enum":["Draft","Processing","Processed","Error","Canceled","Posted","Pending"],"type":"string"},"submittedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was submitted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"type":{"description":"The type of the payment.\n","enum":["External","Electronic"],"type":"string"},"unappliedAmount":{"description":"The unapplied amount of the payment.\n","format":"double","type":"number"},"updatedById":{"description":"The ID of the Zuora user who last updated the payment.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentObjectNSFields"},{"$ref":"#/components/schemas/PaymentObjectCustomFields"}]}},"components/schemas/GETARPaymentType":{"id":"components/schemas/GETARPaymentType","kind":"json-schema","title":"GETARPaymentType","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the customer account that the payment is for.\n","type":"string"},"accountNumber":{"description":"The number of the customer account that the payment is for.\n","type":"string"},"amount":{"description":"The total amount of the payment.\n","format":"double","type":"number"},"appliedAmount":{"description":"The applied amount of the payment.\n","format":"double","type":"number"},"authTransactionId":{"description":"The authorization transaction ID from the payment gateway.\n","type":"string","nullable":true},"bankIdentificationNumber":{"description":"The first six or eight digits of the credit card or debit card used for the payment, when applicable.\n","type":"string","nullable":true},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the payment.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the payment.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditBalanceAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount that the payment transfers to the credit balance. The value is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only for those payments that come from legacy payment operations performed without the Invoice Settlement feature."},"children":[]}]}]}],"format":"double","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is not enabled, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is enabled and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency."},"children":[]}]}]}],"type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"financeInformation":{"description":"Container for the finance information related to the payment.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","type":"string","nullable":true},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n","type":"string","nullable":true}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the payment.\n","type":"string","nullable":true},"gatewayOrderId":{"description":"A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.  If not specified, the payment number will be passed in instead.\n","type":"string","nullable":true},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string","nullable":true},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string","nullable":true},"gatewayResponse":{"description":"The message returned from the payment gateway for the payment. This message is gateway-dependent.\n","type":"string","nullable":true},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the payment. This code is gateway-dependent.\n","type":"string","nullable":true},"gatewayState":{"description":"The status of the payment in the gateway; use for reconciliation.\n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"id":{"description":"The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a payment was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"number":{"description":"The unique identification number of the payment. For example, P-00000001.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentGatewayNumber":{"description":"The natural key for the payment gateway.\n","type":"string","nullable":true},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the payment.\n","type":"string"},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n","type":"string","nullable":true},"paymentScheduleKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or the number of the payment schedule that is linked to the payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-link-payments-with-payment-schedules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link payments to payment schedules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"payoutId":{"description":"The payout ID of the payment from the gateway side.\n","type":"string","nullable":true},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payment is used as a reserved payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"referenceId":{"description":"The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"refundAmount":{"description":"The amount of the payment that is refunded.\n","format":"double","type":"number"},"secondPaymentReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was settled in the payment processor, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This field is used by the Spectrum gateway only and not applicable to other gateways."},"children":[]}]}]}],"type":"string","nullable":true},"softDescriptor":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"standalone":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates this is an ordinary payment that is created, processed, and settled in Zuora."},"children":[]}]}]}],"type":"boolean"},"status":{"description":"The status of the payment.\n","enum":["Draft","Processing","Processed","Error","Canceled","Posted"],"type":"string"},"submittedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was submitted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"type":{"description":"The type of the payment.\n","enum":["External","Electronic"],"type":"string"},"unappliedAmount":{"description":"The unapplied amount of the payment.\n","format":"double","type":"number"},"updatedById":{"description":"The ID of the Zuora user who last updated the payment.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentObjectNSFields"},{"$ref":"#/components/schemas/PaymentObjectCustomFields"}]}},"components/schemas/UpdatePaymentType":{"id":"components/schemas/UpdatePaymentType","kind":"json-schema","title":"UpdatePaymentType","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the payment.\n","maxLength":255,"minLength":0,"type":"string"},"financeInformation":{"description":"Container for the finance information related to the payment.\n\nFor a standalone payment, the finance information cannot be updated.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"transferredToAccounting":{"description":"Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"gatewayState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is mainly used for gateway reconciliation. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-gateway-reconciliation-state-consideration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic payment processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit Payment Gateway Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-payments-roles","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user permission"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update this field."},"children":[]}]}]}],"enum":["NotSubmitted","Submitted","Settled","FailedToSettle"],"type":"string"},"paymentScheduleKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID or the number of the payment schedule to be linked with the payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-link-payments-with-payment-schedules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link payments to payment schedules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"referenceId":{"description":"The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n\nYou can only update the reference ID for external payments.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentObjectNSFields"},{"$ref":"#/components/schemas/PaymentObjectCustomFields"}],"example":{"comment":"Details about this payment"}}},"components/schemas/PaymentDebitMemoApplicationItemApplyRequestType":{"id":"components/schemas/PaymentDebitMemoApplicationItemApplyRequestType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount of the payment that is applied to the specific debit memo or taxation item.\n","format":"double","type":"number"},"debitMemoItemId":{"description":"The ID of the specific debit memo item.\n","type":"string"},"taxItemId":{"description":"The ID of the specific taxation item.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/PaymentDebitMemoApplicationApplyRequestType":{"id":"components/schemas/PaymentDebitMemoApplicationApplyRequestType","kind":"json-schema","title":"debitMemos","data":{"properties":{"amount":{"description":"The amount that is applied from the payment to the debit memo.\n","format":"double","type":"number"},"debitMemoId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the debit memo that the payment is applied to."},"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":"debitMemoId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debitMemoNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"writeOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be set to true. This enables writing off a debit memo at the time of refund."},"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":"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 Payment Cross Account (PCA) feature is in the Early Adopter phase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body."},"children":[]}]}]}]}],"type":"string"},"debitMemoNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the debit memo that the payment is applied to."},"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":"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 Payment Cross Account (PCA) feature is in the Early Adopter phase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body."},"children":[]}]}]}]}],"type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for debit memo items. The maximum number of items is 1,000."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentDebitMemoApplicationItemApplyRequestType"},"type":"array"}},"required":["amount"],"title":"debitMemos","type":"object"}},"components/schemas/PaymentInvoiceApplicationItemApplyRequestType":{"id":"components/schemas/PaymentInvoiceApplicationItemApplyRequestType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount of the payment that is applied to the specific invoice or taxation item.\n","format":"double","type":"number"},"invoiceItemId":{"description":"The ID of the specific invoice item.\n","type":"string"},"taxItemId":{"description":"The ID of the specific taxation item.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/PaymentInvoiceApplicationApplyRequestType":{"id":"components/schemas/PaymentInvoiceApplicationApplyRequestType","kind":"json-schema","title":"invoices","data":{"properties":{"amount":{"description":"The amount that is applied from the payment to the invoice.\n","format":"double","type":"number"},"invoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the invoice that the payment is applied to."},"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":"invoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"writeOff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be set to true. This enables writing off a debit memo at the time of refund."},"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":"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 Payment Cross Account (PCA) feature is in the Early Adopter phase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body."},"children":[]}]}]}]}],"type":"string"},"invoiceNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice that the payment is applied to. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV00000001"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When both the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are specified, the two fields must match with each other."},"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 Payment Cross Account (PCA) feature is in the Early Adopter phase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body."},"children":[]}]}]}]}],"type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for invoice items. The maximum number of items is 1,000."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentInvoiceApplicationItemApplyRequestType"},"type":"array"}},"required":["amount"],"title":"invoices","type":"object"}},"components/schemas/ApplyPaymentType":{"id":"components/schemas/ApplyPaymentType","kind":"json-schema","title":"ApplyPaymentType","data":{"example":{"invoices":[{"invoiceId":"8ad097b490c4e5aa0190c9b931817cef","amount":12}]},"properties":{"debitMemos":{"description":"Container for debit memos. The maximum number of debit memos is 1,000.\n","items":{"$ref":"#/components/schemas/PaymentDebitMemoApplicationApplyRequestType"},"type":"array"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the payment application takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The effective date must be later than or equal to the maximum effective date of the payment."},"children":[]}]}]}],"format":"date","type":"string"},"invoices":{"description":"Container for invoices. The maximum number of invoices is 1,000.\n","items":{"$ref":"#/components/schemas/PaymentInvoiceApplicationApplyRequestType"},"type":"array"}},"type":"object"}},"components/schemas/GETPaymentPartTypewithSuccess":{"id":"components/schemas/GETPaymentPartTypewithSuccess","kind":"json-schema","title":"parts","data":{"properties":{"amount":{"description":"The amount of the payment part.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the payment part.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment part was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"debitMemoId":{"description":"The ID of the debit memo associated with the payment part.\n","type":"string","nullable":true},"id":{"description":"The ID of the payment part.\n","type":"string"},"invoiceId":{"description":"The ID of the invoice associated with the payment part.\n","type":"string","nullable":true},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the payment part.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment part was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"title":"parts","type":"object"}},"components/schemas/GETPaymentPartsCollectionType":{"id":"components/schemas/GETPaymentPartsCollectionType","kind":"json-schema","title":"GETPaymentPartsCollectionType","data":{"properties":{"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"parts":{"description":"Container for payment parts.\n","items":{"$ref":"#/components/schemas/GETPaymentPartTypewithSuccess"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETPaymentPartType":{"id":"components/schemas/GETPaymentPartType","kind":"json-schema","title":"GETPaymentPartType","data":{"properties":{"amount":{"description":"The amount of the payment part.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the payment part.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment part was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"debitMemoId":{"description":"The ID of the debit memo associated with the payment part.\n","type":"string"},"id":{"description":"The ID of the payment part.\n","type":"string"},"invoiceId":{"description":"The ID of the invoice associated with the payment part.\n","type":"string","nullable":true},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"updatedById":{"description":"The ID of the Zuora user who last updated the payment part.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment part was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/GETPaymentItemPartTypewithSuccess":{"id":"components/schemas/GETPaymentItemPartTypewithSuccess","kind":"json-schema","title":"itemParts","data":{"properties":{"amount":{"description":"The amount of the payment part item.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the payment part item.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment part item was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"debitMemoItemId":{"description":"The ID of the debit memo item associated with the payment part item.\n","type":"string","nullable":true},"id":{"description":"The ID of the payment part item.\n","type":"string"},"invoiceItemId":{"description":"The ID of the invoice item associated with the payment part item.\n","type":"string","nullable":true},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"taxItemId":{"description":"The ID of the taxation item associated with the payment part item.\n","type":"string","nullable":true},"updatedById":{"description":"The ID of the Zuora user who last updated the payment part item.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment part item was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"title":"itemParts","type":"object"}},"components/schemas/GETPaymentItemPartCollectionType":{"id":"components/schemas/GETPaymentItemPartCollectionType","kind":"json-schema","title":"GETPaymentItemPartCollectionType","data":{"properties":{"itemParts":{"description":"Container for payment part items.\n","items":{"$ref":"#/components/schemas/GETPaymentItemPartTypewithSuccess"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETPaymentItemPartType":{"id":"components/schemas/GETPaymentItemPartType","kind":"json-schema","title":"GETPaymentItemPartType","data":{"properties":{"amount":{"description":"The amount of the payment part item.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the payment part item.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment part item was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"debitMemoItemId":{"description":"The ID of the debit memo item associated with the payment part item.\n","type":"string"},"id":{"description":"The ID of the payment part item.\n","type":"string"},"invoiceItemId":{"description":"The ID of the invoice item associated with the payment part item.\n","type":"string","nullable":true},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"taxItemId":{"description":"The ID of the taxation item associated with the payment part item.\n","type":"string","nullable":true},"updatedById":{"description":"The ID of the Zuora user who last updated the payment part item.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment part item was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/PostRefundType":{"id":"components/schemas/PostRefundType","kind":"json-schema","title":"PostRefundType","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the refund.\n","maxLength":255,"minLength":0,"type":"string"},"customRates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item, Reporting currency item, or both)."},"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":":"},"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":"This field is only available if you are on the latest Zuora API minor version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"224.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"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":"You cannot set the custom rates, if both the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically include additional Currency Conversion information in data source exports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fx data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature are enabled."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/PaymentWithCustomRatesType"},"maxItems":2,"type":"array"},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts."},"children":[]}]}]}],"properties":{"key":{"description":"The name of a gateway-specific parameter.\n","type":"string"},"value":{"description":"The value of the gateway-specific parameter.\n","type":"string"}},"type":"object"},"methodType":{"description":"How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on an electronic payment.\n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n","type":"string"},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","maxLength":100,"minLength":0,"type":"string"},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The date of the refund cannot be before the payment date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds."},"children":[]}]}]}],"format":"date","type":"string"},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n","maxLength":100,"minLength":0,"type":"string"},"softDescriptor":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.","maxLength":35,"type":"string"},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.","maxLength":20,"type":"string"},"totalAmount":{"description":"The total amount of the refund. The amount cannot exceed the unapplied amount of the associated payment. If the original payment was applied to one or more invoices or debit memos, you have to unapply a full or partial payment from the invoices or debit memos, and then refund the full or partial unapplied payment to your customers. \n","format":"double","type":"number"},"type":{"description":"The type of the refund.\n","enum":["External","Electronic"],"type":"string"},"refundTransactionType":{"description":"The transaction type of the refund.\n","enum":["Chargeback","PaymentReversal"],"type":"string"}},"required":["totalAmount","type"],"type":"object"},{"$ref":"#/components/schemas/RefundObjectNSFields"},{"$ref":"#/components/schemas/RefundObjectCustomFields"}],"example":{"type":"Electronic","totalAmount":10}}},"components/schemas/GETRefundPaymentType":{"id":"components/schemas/GETRefundPaymentType","kind":"json-schema","title":"GETRefundPaymentType","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment.\n","type":"string"},"amount":{"description":"The total amount of the refund.\n","format":"double","type":"number"},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the refund.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the refund.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of the credit memo associated with the refund.\n","type":"string","nullable":true},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","type":"string","nullable":true},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n","type":"string","nullable":true}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the refund.\n","type":"string"},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string","nullable":true},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string","nullable":true},"gatewayResponse":{"description":"The message returned from the payment gateway for the refund. This message is gateway-dependent.\n","type":"string"},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the refund. This code is gateway-dependent.\n","type":"string"},"gatewayState":{"description":"The status of the refund in the gateway.\n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"id":{"description":"The ID of the created refund.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a refund was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"methodType":{"description":"How an external refund was issued to a customer.\n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"number":{"description":"The unique identification number of the refund.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentGatewayNumber":{"description":"The natural key for the payment gateway.\n","type":"string"},"paymentId":{"description":"The ID of the payment that is refunded.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the refund. \n","type":"string"},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.\n","type":"string"},"payoutId":{"description":"The payout ID of the refund from the gateway side.\n","type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction. \n","type":"string","nullable":true},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string","nullable":true},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"refundTransactionTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was issued, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was settled in the payment processor, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This field is used by the Spectrum gateway only and not applicable to other gateways."},"children":[]}]}]}],"type":"string","nullable":true},"softDescriptor":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"status":{"description":"The status of the refund.\n","enum":["Processed","Canceled","Error","Processing"],"type":"string"},"submittedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was submitted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"type":{"description":"The type of the refund.\n","enum":["External","Electronic"],"type":"string"},"updatedById":{"description":"The ID of the the Zuora user who last updated the refund.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/RefundObjectNSFields"},{"$ref":"#/components/schemas/RefundObjectCustomFields"}]}},"components/schemas/PostRefundwithAutoUnapplyType":{"id":"components/schemas/PostRefundwithAutoUnapplyType","kind":"json-schema","title":"PostRefundwithAutoUnapplyType","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the refund.\n","maxLength":255,"minLength":0,"type":"string"},"debitMemos":{"description":"Container for debit memos. The maximum number of debit memos is 1,000.\n","items":{"$ref":"#/components/schemas/PaymentDebitMemoApplicationApplyRequestType"},"type":"array"},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"gatewayOptions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Knowledge Center"},"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":"Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts."},"children":[]}]}]}],"properties":{"key":{"description":"The name of a gateway-specific parameter.\n","type":"string"},"value":{"description":"The value of the gateway-specific parameter.\n","type":"string"}},"type":"object"},"invoices":{"description":"Container for invoices. The maximum number of invoices is 1,000.\n","items":{"$ref":"#/components/schemas/PaymentInvoiceApplicationApplyRequestType"},"type":"array"},"methodType":{"description":"How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on an electronic payment.\n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n","type":"string"},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","maxLength":100,"minLength":0,"type":"string"},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The date of the refund cannot be before the payment date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds."},"children":[]}]}]}],"format":"date","type":"string"},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n","maxLength":100,"minLength":0,"type":"string"},"softDescriptor":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.","maxLength":35,"type":"string"},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.","maxLength":20,"type":"string"},"totalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of the refund. If you do not specify a value, Zuora initiates a full refund of the payment amount, which is the sum of the applied and unapplied payment amounts."},"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":"Full Refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If the refund amount and debit memo/ invoice are not specified, then the payment will be unapplied completely, followed by processing a full refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Partial Refund"},"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 total amount is specified, and the debit memo/invoice is not specified, you can unapply the refund amount from the available debit memo/invoice and refund the unapplied payment to the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the total amount is specified, along with the debit memo and the invoice, you can unapply the applied payments from the mentioned invoices and debit memos, and refund the unapplied payments to customers."},"children":[]}]}]}]}]}]}],"format":"double","type":"number"},"type":{"description":"The type of the refund.\n","enum":["External","Electronic"],"type":"string"},"refundTransactionType":{"description":"The transaction type of the refund.\n","enum":["Chargeback","PaymentReversal"],"type":"string"},"writeOff":{"default":false,"description":"Indicates whether to write off a document.\n","type":"boolean"},"writeOffOptions":{"description":"Container for the write-off information to create credit memo.\n","properties":{"comment":{"description":"Comments about the credit memo which is created as a result of the write off.\n","maxLength":100,"type":"string"},"memoDate":{"description":"The date when the credit memo takes effect.\n","format":"date","type":"string"},"reasonCode":{"description":"A code identifying the reason for the credit memo.\n","type":"string"},"taxAutoCalculation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether taxes are automatically recalculated for the credit memo generated during the write-off process."},"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 fetches the latest tax rates from the tax vendor instead of copying the tax amounts from the original invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"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 feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. Contact Zuora Global Support to enable this feature before using it."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"required":["type"],"type":"object"},{"$ref":"#/components/schemas/RefundObjectNSFields"},{"$ref":"#/components/schemas/RefundObjectCustomFields"}],"example":{"type":"Electronic","totalAmount":10}}},"components/schemas/GETRefundPaymentTypeAutoUnapply":{"id":"components/schemas/GETRefundPaymentTypeAutoUnapply","kind":"json-schema","title":"GETRefundPaymentTypeAutoUnapply","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment.\n","type":"string"},"amount":{"description":"The total amount of the refund.\n","format":"double","type":"number"},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the refund.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the refund.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of the credit memo associated with the refund.\n","type":"string","nullable":true},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","type":"string","nullable":true},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n","type":"string","nullable":true}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the refund.\n","type":"string"},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string","nullable":true},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string","nullable":true},"gatewayResponse":{"description":"The message returned from the payment gateway for the refund. This message is gateway-dependent.\n","type":"string"},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the refund. This code is gateway-dependent.\n","type":"string"},"gatewayState":{"description":"The status of the refund in the gateway.\n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"id":{"description":"The ID of the created refund.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a refund was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"methodType":{"description":"How an external refund was issued to a customer.\n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"number":{"description":"The unique identification number of the refund.\n","type":"string"},"paymentGatewayNumber":{"description":"The natural key for the payment gateway.\n","type":"string"},"paymentId":{"description":"The ID of the payment that is refunded.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the refund. \n","type":"string"},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.\n","type":"string"},"payoutId":{"description":"The payout ID of the refund from the gateway side.\n","type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction. \n","type":"string","nullable":true},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string"},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"refundTransactionTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was issued, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was settled in the payment processor, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This field is used by the Spectrum gateway only and not applicable to other gateways."},"children":[]}]}]}],"type":"string","nullable":true},"softDescriptor":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n","type":"string","nullable":true},"status":{"description":"The status of the refund.\n","enum":["Processed","Canceled","Error","Processing"],"type":"string"},"submittedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was submitted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"type":{"description":"The type of the refund.\n","enum":["External","Electronic"],"type":"string"},"updatedById":{"description":"The ID of the the Zuora user who last updated the refund.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"},"writeOffResults":{"description":"Container for the write-off information of credit memo and apply information.\n","properties":{"errorMessage":{"description":"The error message about write off failed.\n","type":"string"},"transactions":{"description":"The credit memo apply information.\n","properties":{"appliedAmount":{"description":"The credit memo applied amopunt.\n","format":"double","type":"number"},"creditMemoAmount":{"description":"The credit memo amount.\n","type":"string"},"creditMemoNumber":{"description":"The unique identification number of the credit memo.\n","type":"string"},"creditMemoStatus":{"description":"The status of the credit memo. \n","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"type":"string"},"invoiceNumber":{"description":"The unique identification number of the invoice.\n","type":"string"}},"title":"transactions","type":"object"}},"type":"object","nullable":true}},"type":"object"},{"$ref":"#/components/schemas/RefundObjectNSFields"},{"$ref":"#/components/schemas/RefundObjectCustomFields"}]}},"components/schemas/TransferPaymentType":{"id":"components/schemas/TransferPaymentType","kind":"json-schema","title":"TransferPaymentType","data":{"example":{"accountId":"4028905f5a87c0ff015a88889fe500a8"},"properties":{"accountId":{"description":"The ID of the customer account that the payment is transferred to.\nUnassign a payment by setting this field to an empty string. This will automatically transfer the payment to a null account.\n","type":"string"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment takes effect, in "},"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"}},"type":"object"}},"components/schemas/PaymentDebitMemoApplicationItemUnapplyRequestType":{"id":"components/schemas/PaymentDebitMemoApplicationItemUnapplyRequestType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount of the payment that is unapplied from the specific debit mem or taxation item.\n","format":"double","type":"number"},"debitMemoItemId":{"description":"The ID of the specific debit memo item.\n","type":"string"},"taxItemId":{"description":"The ID of the specific taxation item.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/PaymentDebitMemoApplicationUnapplyRequestType":{"id":"components/schemas/PaymentDebitMemoApplicationUnapplyRequestType","kind":"json-schema","title":"debitMemos","data":{"properties":{"amount":{"description":"The amount of the payment that is unapplied from the debit memo.\n","format":"double","type":"number"},"debitMemoId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the debit memo that the payment is unapplied from."},"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":"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 Payment Cross Account (PCA) feature is in the Early Adopter phase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body."},"children":[]}]}]}]}],"type":"string"},"debitMemoNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the debit memo that the payment is unapplied from."},"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":"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 Payment Cross Account (PCA) feature is in the Early Adopter phase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body."},"children":[]}]}]}]}],"type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for debit memo items. The maximum number of items is 1,000."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentDebitMemoApplicationItemUnapplyRequestType"},"type":"array"}},"required":["amount"],"title":"debitMemos","type":"object"}},"components/schemas/PaymentInvoiceApplicationItemUnapplyRequestType":{"id":"components/schemas/PaymentInvoiceApplicationItemUnapplyRequestType","kind":"json-schema","title":"items","data":{"properties":{"amount":{"description":"The amount of the payment that is unapplied from the specific invoice or taxation item.\n","format":"double","type":"number"},"invoiceItemId":{"description":"The ID of the specific invoice item.\n","type":"string"},"taxItemId":{"description":"The ID of the specific taxation item.\n","type":"string"}},"required":["amount"],"title":"items","type":"object"}},"components/schemas/PaymentInvoiceApplicationUnapplyRequestType":{"id":"components/schemas/PaymentInvoiceApplicationUnapplyRequestType","kind":"json-schema","title":"invoices","data":{"properties":{"amount":{"description":"The amount of the payment that is unapplied from the invoice.\n","format":"double","type":"number"},"invoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the invoice that the payment is unapplied from."},"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":"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 Payment Cross Account (PCA) feature is in the Early Adopter phase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body."},"children":[]}]}]}]}],"type":"string"},"invoiceNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the invoice that the payment is unapplied from. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV00000001"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When both the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are specified, the two fields must match with each other."},"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 Payment Cross Account (PCA) feature is in the Early Adopter phase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body."},"children":[]}]}]}]}],"type":"string"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for invoice items. The maximum number of items is 1,000."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentInvoiceApplicationItemUnapplyRequestType"},"type":"array"}},"required":["amount"],"title":"invoices","type":"object"}},"components/schemas/UnapplyPaymentType":{"id":"components/schemas/UnapplyPaymentType","kind":"json-schema","title":"UnapplyPaymentType","data":{"example":{"invoices":[{"invoiceId":"8ad097b490c4e5aa0190c9b931817cef","amount":12}]},"properties":{"debitMemos":{"description":"Container for debit memos. The maximum number of debit memos is 1,000.\n","items":{"$ref":"#/components/schemas/PaymentDebitMemoApplicationUnapplyRequestType"},"type":"array"},"effectiveDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the payment is unapplied, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The effective date must be later than or equal to the maximum effective date of the payment."},"children":[]}]}]}],"format":"date","type":"string"},"invoices":{"description":"Container for invoices. The maximum number of invoice is 1,000.\n","items":{"$ref":"#/components/schemas/PaymentInvoiceApplicationUnapplyRequestType"},"type":"array"}},"type":"object"}},"components/schemas/ProxyGetPaymentTransactionLog":{"id":"components/schemas/ProxyGetPaymentTransactionLog","kind":"json-schema","title":"ProxyGetPaymentTransactionLog","data":{"properties":{"AVSResponseCode":{"description":"The response code returned by the payment gateway referring to the AVS international response of the payment transaction.\n","type":"string"},"BatchId":{"description":"The ID of the batch used to send the transaction if the request was sent in a batch.\n","type":"string"},"CVVResponseCode":{"description":"The response code returned by the payment gateway referring to the CVV international response of the payment transaction.\n","type":"string"},"Gateway":{"description":"The name of the payment gateway used to transact the current payment transaction log.\n","type":"string"},"GatewayReasonCode":{"description":"The code returned by the payment gateway for the payment. This code is gateway-dependent.\n","type":"string"},"GatewayReasonCodeDescription":{"description":"The message returned by the payment gateway for the payment. This message is gateway-dependent. \n","type":"string"},"GatewayState":{"description":"The state of the transaction at the payment gateway.\n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"GatewayTransactionType":{"description":"The type of the transaction, either making a payment, or canceling a payment. \n","enum":["Authorization","Sale","Void","Inquiry","VoidAuth"],"type":"string"},"Id":{"description":"The ID of the payment transaction log.\n","type":"string"},"PaymentId":{"description":"The ID of the payment wherein the payment transaction log was recorded. \n","type":"string"},"RequestString":{"description":"The payment transaction request string sent to the payment gateway. \n","type":"string"},"ResponseString":{"description":"The payment transaction response string returned by the payment gateway. \n","type":"string"},"TransactionDate":{"description":"The transaction date when the payment was performed. \n","format":"date-time","type":"string"},"TransactionId":{"description":"The transaction ID returned by the payment gateway. This field is used to reconcile payment transactions between the payment gateway and records in Zuora.\n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentRunType":{"id":"components/schemas/GETPaymentRunType","kind":"json-schema","title":"paymentRuns","data":{"properties":{"accountId":{"description":"The ID of the customer account associated with the payment run.\n","type":"string"},"applyCreditBalance":{"description":[{"$$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 only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled."},"children":[]}]}]}],"type":"boolean"},"autoApplyCreditMemo":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply a posted credit memo to one or more receivables in the payment run."},"children":[]}]}]}],"type":"boolean"},"autoApplyUnappliedPayment":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply unapplied payments to  one or more receivables in the payment run."},"children":[]}]}]}],"type":"boolean"},"batch":{"description":"The alias name given to a batch.\n","example":"Batch1","type":"string"},"billCycleDay":{"description":"The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. \n","example":1,"type":"string"},"billingRunId":{"description":"The ID of the bill run.\n","format":"uuid","type":"string"},"collectPayment":{"description":"Whether to process electronic payments during the execution of payment runs. \n","type":"boolean"},"completedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment run is completed, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 11:39:58."},"children":[]}]}]}],"type":"string","nullable":true},"consolidatedPayment":{"description":[{"$$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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process Electronic Payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission also needs to be allowed for a Manage Payment Runs role to work. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-payments-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to process a single payment for all receivables that are due on an account."},"children":[]}]}]}],"type":"boolean"},"createdById":{"description":"The ID of the Zuora user who created the payment run.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment run was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"currency":{"description":"A currency defined in the web-based UI administrative settings.\n","example":"USD","type":"string"},"executedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment run is executed, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 11:30:37."},"children":[]}]}]}],"type":"string","nullable":true},"id":{"description":"The ID of the payment run.\n","type":"string"},"number":{"description":"The identification number of the payment run.\n","type":"string"},"organizationLabels":{"description":"The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.\n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"paymentGatewayId":{"description":"The ID of the gateway instance that processes the payment.\n","format":"uuid","type":"string","nullable":true},"processPaymentWithClosedPM":{"description":[{"$$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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process Electronic Payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission also needs to be allowed for a Manage Payment Runs role to work. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-payments-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to process payments even if the default payment method is closed."},"children":[]}]}]}],"type":"boolean"},"runDate":{"description":"The date and time when the scheduled payment run is to be executed for collecting payments.\n","type":"string","nullable":true},"status":{"description":"The status of the created payment run.\n","enum":["Pending","Processing","Completed","Error","Canceled"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"targetDate":{"description":"The target date used to determine which receivables to be collected in the payment run. \n","format":"date","type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the payment run.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment run was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"},"useCustomPaymentMethods":{"description":"Whether to enable payment profiles for a payment run.\n","type":"boolean"}},"title":"paymentRuns","type":"object"}},"components/schemas/GETPaymentRunCollectionType":{"id":"components/schemas/GETPaymentRunCollectionType","kind":"json-schema","title":"GETPaymentRunCollectionType","data":{"properties":{"nextPage":{"description":"The URL for requesting the next page of the response, if it exists; otherwise absent.\n","type":"string"},"paymentRuns":{"description":"Container for payment runs.\n","items":{"$ref":"#/components/schemas/GETPaymentRunType"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/POSTPaymentRunDataElementRequest":{"id":"components/schemas/POSTPaymentRunDataElementRequest","kind":"json-schema","title":"POSTPaymentRunDataElementRequest","data":{"allOf":[{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid account ID associated with the payment run."},"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":"consolidatedPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is used in processing a single payment for invoices/debit memos due on an account."},"children":[]}]}]}],"type":"string"},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the customer account associated with the payment run, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A00000001"},"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":"You can specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a customer account, but not both of them."},"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":"consolidatedPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is used in processing a single payment for invoices, debit memos, and standalone payments due on an account."},"children":[]}]}]}],"type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount to be collected for the specified invoice/debit memo. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a positive numeric value no more than the balance of the specified invoice/debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified, whole balance of the invoice/debit memo is collected."},"children":[]}]}]}],"type":"number"},"comment":{"description":"Additional comments.\n","type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This field is only available if support for standalone payments is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the standalone payment. Specify this field only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The currency of the standalone payment can be different from the payment currency defined in the customer account settings."},"children":[]}]}]}],"type":"string"},"dataItems":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The array of data for each Invoice if you want to collect payment for particular items through one payment method. The grouped items are sent as one data record.  This field is available if the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is another example for a data item:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"accountId\": \"60c81b5bc51649e8a7d1b48303194790\",\n  \"documentId\": \"2c9081a03c63c94c013c6894af5602dd\",\n  \"documentType\": \"Invoice\",\n  \"dataItems\": [\n    {\n        \"documentItemId\": \"8a92ab0e8ab14c53018ac746961c10d1\",\n        \"amount\": 40\n    },\n    {\n        \"taxItemId\": \"8a92ab0e8ab14c53018ac746961c10d2\",\n        \"amount\": 40\n    }\n],\n  \"amount\": 80,\n  \"paymentMethodId\": \"2c9081a03c6d7b51013c6d7e4ada0a1c\",\n  \"paymentGatewayId\": \"d2abe8342e1811ea80e774b9452e17ea\",\n  \"comment\": \"Payment Comments\",\n  \"customField1__c\": \"cf_value1\",\n  \"customField2__c\": \"cf_value2\"\n},\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"accountId\": \"60c81b5bc51649e8a7d1b48303194790\",\n  \"documentId\": \"2c9081a03c63c94c013c6894af5602dd\",\n  \"documentType\": \"Invoice\",\n  \"dataItems\": [\n    {\n        \"documentItemId\": \"8a92ab0e8ab14c53018ac746961c10d1\",\n        \"amount\": 40\n    },\n    {\n        \"taxItemId\": \"8a92ab0e8ab14c53018ac746961c10d2\",\n        \"amount\": 40\n    }\n],\n  \"amount\": 80,\n  \"paymentMethodId\": \"2c9081a03c6d7b51013c6d7e4ada0a1c\",\n  \"paymentGatewayId\": \"d2abe8342e1811ea80e774b9452e17ea\",\n  \"comment\": \"Payment Comments\",\n  \"customField1__c\": \"cf_value1\",\n  \"customField2__c\": \"cf_value2\"\n},\n"},"children":[]}]}],"properties":{"amount":{"description":"The total amount to be collected for the specified invoice/debit memo item. The sum of the item amount should be equal to document amount.\n","type":"number"},"documentItemId":{"description":"The ID of a billing document of the invoice item or debit memo item.\n","type":"string"},"taxItemId":{"description":"The tax ID of the invoice item or debit memo item.\n","type":"string"}},"title":"dataItems","type":"object"},"documentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a billing document associated with the payment run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be valid and match with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"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":"You must either specify both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or specify neither of them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If neither of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, all invoices/debit memos with open balance of the account are collected."},"children":[]}]}]}],"type":"string"},"documentNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of a billing document associated with the payment run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be valid and match with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"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":"You must either specify both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or specify neither of them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If neither of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, all invoices/debit memos with open balance of the account are collected."},"children":[]}]}]}],"type":"string"},"documentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of a billing document associated with the payment run. The value can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DebitMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DebitMemo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only supported if the Invoice Settlement feature is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must either specify both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or specify neither of them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If neither of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, all invoices/debit memos with open balance of the account are collected."},"children":[]}]}]}],"enum":["Invoice","DebitMemo"],"type":"string"},"paymentGatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment gateway for collecting invoices/debit memos. The specified payment gateway must be valid and active."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-gateway-routing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Gateway Routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled:"},"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 field is not specified, gateway routing rules will be invoked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Payment Gateway Routing is disabled:"},"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 field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, the specified gateway will be used to process the payment."},"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":"consolidatedPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is used in processing a single payment for invoices/debit memos due on an account."},"children":[]}]}]}],"type":"string"},"paymentMethodId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment method for collecting invoices/debit memos. The specified payment method must be a valid non-system payment method. If it is not specified, the default payment method of the account is used regardless of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autoPay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of the account."},"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":"processPaymentWithClosedPM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the payment method cannot be closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payment retry rules are enabled, the payment method must meet the rules."},"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":"consolidatedPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is used in processing a single payment for invoices/debit memos due on an account."},"children":[]}]}]}],"type":"string"},"standalone":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This field is only available if support for standalone payments is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate that this is a standalone payment that will be created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount will not be summed up into the account balance and key metrics regardless of the payment currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No settlement data will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either the applied amount or the unapplied amount of the payment is zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The standalone payment cannot be applied, unapplied, or transferred."},"children":[]}]}]}]}],"type":"boolean"}},"type":"object"},{"$ref":"#/components/schemas/PaymentObjectCustomFields"}]}},"components/schemas/POSTPaymentRunRequest":{"id":"components/schemas/POSTPaymentRunRequest","kind":"json-schema","title":"POSTPaymentRunRequest","data":{"example":{"accountId":"8ad09be48db5aba7018db604776d4854","targetDate":"2024-07-24"},"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the customer account associated with the payment run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with each of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"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":"paymentGatewayId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingRunId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields. If there are such conflicts, an error occurs and an error message is returned."},"children":[]}]}]}],"type":"string"},"applyCreditBalance":{"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":"applyCreditBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices."},"children":[]}]}]}],"type":"boolean"},"autoApplyCreditMemo":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply a posted credit memo to one or more receivables in the payment run."},"children":[]}]}]}],"type":"boolean"},"autoApplyUnappliedPayment":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply unapplied payments to  one or more receivables in the payment run."},"children":[]}]}]}],"type":"boolean"},"batch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The alias name given to a batch. The batch name is a string of 50 characters or less."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If they are both specified in the request body, an error occurs and an error message is returned."},"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":": By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=performance-booster-elite","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance Booster Elite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" package."},"children":[]}]}]}],"type":"string"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. The value must be equal to or less then 31, and 31 is mean the EOM."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If they are both specified in the request body, an error occurs and an error message is returned."},"children":[]}]}]}],"type":"string"},"billingRunId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If they are both specified in the request body, an error occurs and an error message is returned."},"children":[]}]}]}],"format":"uuid","type":"string"},"collectPayment":{"description":"Whether to process electronic payments during the execution of payment runs. \n\nIf the Payment user permission \"Process Electronic Payment\" is disabled, this field will be ignored.\n","type":"boolean"},"consolidatedPayment":{"description":[{"$$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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process Electronic Payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission also needs to be allowed for a Manage Payment Runs role to work. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-payments-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to process a single payment for all receivables that are due on an account."},"children":[]}]}]}],"type":"boolean"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A currency defined in the web-based UI administrative settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If they are both specified in the request body, an error occurs and an error message is returned."},"children":[]}]}]}],"type":"string"},"data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The array of data for specifying records of accounts and invoices/debit memos that will be collected and processed by a payment run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you specify the data array, ensure that at least one record is passed in. If an empty array is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"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":"paymentGatewayId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingRunId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields will be used to define the billing documents to be collected. If the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled, you can filter the accounts by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on the customer's billing document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A maximum of 50K records are allowed to be passed into the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  {\n    \"accountId\": \"60c81b5bc51649e8a7d1b48303194790\",\n    \"documentId\": \"2c9081a03c63c94c013c6894af5602dd\",\n    \"documentType\": \"Invoice\",\n    \"amount\": 80,\n    \"paymentMethodId\": \"2c9081a03c6d7b51013c6d7e4ada0a1c\",\n    \"paymentGatewayId\": \"d2abe8342e1811ea80e774b9452e17ea\",\n    \"comment\": \"Payment Comments\",\n    \"customField1__c\": \"cf_value1\",\n    \"customField2__c\": \"cf_value2\"\n  }\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  {\n    \"accountId\": \"60c81b5bc51649e8a7d1b48303194790\",\n    \"documentId\": \"2c9081a03c63c94c013c6894af5602dd\",\n    \"documentType\": \"Invoice\",\n    \"amount\": 80,\n    \"paymentMethodId\": \"2c9081a03c6d7b51013c6d7e4ada0a1c\",\n    \"paymentGatewayId\": \"d2abe8342e1811ea80e774b9452e17ea\",\n    \"comment\": \"Payment Comments\",\n    \"customField1__c\": \"cf_value1\",\n    \"customField2__c\": \"cf_value2\"\n  }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is another example for a standalone payment:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  {\n    \"accountId\": \"account2\",\n    \"amount\": 100,\n    \"currency\": \"GBP\",\n    \"standalone\": true\n  }\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  {\n    \"accountId\": \"account2\",\n    \"amount\": 100,\n    \"currency\": \"GBP\",\n    \"standalone\": true\n  }\n"},"children":[]}]}],"items":{"$ref":"#/components/schemas/POSTPaymentRunDataElementRequest"},"title":"payment run data","type":"array"},"organizationLabels":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organizations that the run is created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each item in the array, either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only required when you have already turned on Multi-Org feature."},"children":[]}]}]}],"items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"paymentGatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the gateway instance that processes the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If they are both specified in the request body, an error occurs and an error message is returned."},"children":[]}]}]}],"format":"uuid","type":"string"},"processPaymentWithClosedPM":{"description":[{"$$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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process Electronic Payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission also needs to be allowed for a Manage Payment Runs role to work. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-payments-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to process payments even if the default payment method is closed."},"children":[]}]}]}],"type":"boolean"},"runDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the scheduled payment run is to be executed, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The backend will ignore mintues and seconds in the field value. For example, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2017-03-01 11:30:37"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this value, this payment run will be run at 2017-03-01 11:00:00."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body. If you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the scheduced payment run is to be executed on the run date. If you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the payment run is executed immediately after it is created."},"children":[]}]}]}],"type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body. If you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the scheduced payment run is to be executed on the run date. If you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the payment run is executed immediately after it is created."},"children":[]}]}]}],"format":"date","type":"string"},"useCustomPaymentMethods":{"description":"Whether to enable payment profiles for a payment run.\n","type":"boolean"}},"type":"object"}},"components/schemas/PUTPaymentRunRequest":{"id":"components/schemas/PUTPaymentRunRequest","kind":"json-schema","title":"PUTPaymentRunRequest","data":{"example":{"autoApplyUnappliedPayment":true},"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the customer account associated with the payment run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with each of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"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":"paymentGatewayId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingRunId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields. If there are such conflicts, an error occurs and an error message is returned."},"children":[]}]}]}],"format":"uuid","type":"string"},"applyCreditBalance":{"description":[{"$$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 only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled."},"children":[]}]}]}],"type":"boolean"},"autoApplyCreditMemo":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply a posted credit memo to one or more receivables in the payment run."},"children":[]}]}]}],"type":"boolean"},"autoApplyUnappliedPayment":{"description":[{"$$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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply unapplied payments to  one or more receivables in the payment run."},"children":[]}]}]}],"type":"boolean"},"batch":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The alias name given to a batch. The batch name is a string of 50 characters or less."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If they are both specified in the request body, an error occurs and an error message is returned."},"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":": By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=performance-booster-elite","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance Booster Elite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" package."},"children":[]}]}]}],"type":"string"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. The value must be equal to or less then 31, and 31 is mean the EOM."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If they are both specified in the request body, an error occurs and an error message is returned."},"children":[]}]}]}],"type":"string"},"billingRunId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If they are both specified in the request body, an error occurs and an error message is returned."},"children":[]}]}]}],"format":"uuid","type":"string"},"collectPayment":{"description":"Whether to process electronic payments during the execution of payment runs. \n\nIf the Payment user permission \"Process Electronic Payment\" is disabled, this field will be ignored.\n","type":"boolean"},"consolidatedPayment":{"description":[{"$$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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process Electronic Payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission also needs to be allowed for a Manage Payment Runs role to work. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-payments-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to process a single payment for all receivables that are due on an account."},"children":[]}]}]}],"type":"boolean"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A currency defined in the web-based UI administrative settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If they are both specified in the request body, an error occurs and an error message is returned."},"children":[]}]}]}],"type":"string"},"organizationLabels":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organizations that the run is created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each item in the array, either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only required when you have already turned on Multi-Org feature."},"children":[]}]}]}],"items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"paymentGatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the gateway instance that processes the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field conflicts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. If they are both specified in the request body, an error occurs and an error message is returned."},"children":[]}]}]}],"format":"uuid","type":"string","nullable":true},"processPaymentWithClosedPM":{"description":[{"$$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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process Electronic Payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission also needs to be allowed for a Manage Payment Runs role to work. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-payments-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to process payments even if the default payment method is closed."},"children":[]}]}]}],"type":"boolean"},"runDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the scheduled payment run is to be executed, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. The backend will ignore mintues and seconds in the field value. For example, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2017-03-01 11:30:37"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this value, this payment run will be run at 2017-03-01 11:00:00."},"children":[]}]}]}],"type":"string"},"targetDate":{"description":"The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date.\n","format":"date","type":"string"}},"type":"object"}},"components/schemas/GETPaymentRunDataTransactionElementResponse":{"id":"components/schemas/GETPaymentRunDataTransactionElementResponse","kind":"json-schema","title":"payment run transaction","data":{"properties":{"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of the newly generated payment."},"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 only available if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"appliedAmount":{"description":"The amount allocated to this data record.\n","type":"number"},"errorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code of the response."},"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 only available if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"errorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The detailed information of the error response."},"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 only available if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"id":{"description":"The ID of the current transaction.\n","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the newly generated payment."},"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 only available if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Processed","Processing","Error"],"type":"string"},"type":{"description":"The type of the current transaction.\n","enum":["Payment","CreditMemo","UnappliedPayment","CreditBalanceAdjustment"],"type":"string"}},"title":"payment run transaction","type":"object"}},"components/schemas/GETPaymentRunDataElementResponse":{"id":"components/schemas/GETPaymentRunDataElementResponse","kind":"json-schema","title":"GETPaymentRunDataElementResponse","data":{"allOf":[{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer account ID specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when creating the payment run."},"children":[]}]}]}],"type":"string"},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer account number specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when creating the payment run."},"children":[]}]}]}],"type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when creating the payment run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned if it was not specified."},"children":[]}]}]}],"type":"number"},"amountCollected":{"description":"The amount that is collected.\n","type":"number"},"amountToCollect":{"description":"The amount to be collected.\n","type":"number"},"comment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The comment specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when creating the payment run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned if it was not specified."},"children":[]}]}]}],"type":"string","nullable":true},"currency":{"description":"This field is only available if support for standalone payments is enabled.\n\nThe currency of the standalone payment. The currency of the standalone payment can be different from the payment currency defined in the customer account settings.\n","type":"string"},"documentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing document ID specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when creating the payment run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned if it was not specified."},"children":[]}]}]}],"type":"string"},"documentNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing document number specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when creating the payment run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned if it was not specified."},"children":[]}]}]}],"type":"string"},"documentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing document type specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when creating the payment run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned if it was not specified."},"children":[]}]}]}],"enum":["Invoice","DebitMemo"],"type":"string"},"errorCode":{"description":"The error code of the response.\n","type":"string"},"errorMessage":{"description":"The detailed information of the error response.\n","type":"string"},"paymentGatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment gateway ID specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when creating the payment run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned if it was not specified."},"children":[]}]}]}],"type":"string","nullable":true},"paymentMethodId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment method ID specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when creating the payment run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned if it was not specified."},"children":[]}]}]}],"type":"string"},"result":{"description":"Indicates whether the data is processed successfully or not.\n","enum":["Processed","Error"],"type":"string"},"standalone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if the support for standalone payment is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred."},"children":[]}]}]}],"type":"boolean"},"transactions":{"description":"Container for transactions that apply to the current request. Each element contains an array of the settlement/payment applied to the record.\n","items":{"$ref":"#/components/schemas/GETPaymentRunDataTransactionElementResponse"},"type":"array"}},"title":"payment run data","type":"object"},{"$ref":"#/components/schemas/PaymentObjectCustomFields"}]}},"components/schemas/GETPaymentRunDataArrayResponse":{"id":"components/schemas/GETPaymentRunDataArrayResponse","kind":"json-schema","title":"GETPaymentRunDataArrayResponse","data":{"properties":{"data":{"description":"Container for payment run data. Each element in the array is a record processed by the payment run.\n","items":{"$ref":"#/components/schemas/GETPaymentRunDataElementResponse"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETPaymentRunSummaryTotalValues":{"id":"components/schemas/GETPaymentRunSummaryTotalValues","kind":"json-schema","title":"totalValues","data":{"properties":{"totalValueOfCreditBalance":{"description":[{"$$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 only available if you have the Credit Balance feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of credit balance after the payment run is completed."},"children":[]}]}]}],"type":"string"},"totalValueOfCreditMemos":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of credit memos that are successfully processed in the payment run."},"children":[]}]}]}],"type":"string"},"totalValueOfDebitMemos":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of debit memos that are picked up for processing in the payment run."},"children":[]}]}]}],"type":"string"},"totalValueOfErrors":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of receivables associated with the payments with the status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"totalValueOfInvoices":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of invoices that are picked up for processing in the payment run."},"children":[]}]}]}],"type":"string"},"totalValueOfPayments":{"description":"The total amount of payments that are successfully processed in the payment run.\n","type":"string"},"totalValueOfReceivables":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of receivables associated with the payment run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field is the sum of the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalValueOfInvoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and that of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalValueOfDebitMemos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"totalValueOfUnappliedPayments":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of unapplied payments that are successfully processed in the payment run."},"children":[]}]}]}],"type":"integer"},"totalValueOfUnprocessedDebitMemos":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of debit memos with remaining positive balances after the payment run is completed."},"children":[]}]}]}],"type":"string"},"totalValueOfUnprocessedInvoices":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of invoices with remaining positive balances after the payment run is completed."},"children":[]}]}]}],"type":"string"},"totalValueOfUnprocessedReceivables":{"description":"The total amount of receivables with remaining positive balances after the payment run is completed.\n","type":"string"}},"title":"totalValues","type":"object"}},"components/schemas/GETPaymentRunSummaryResponse":{"id":"components/schemas/GETPaymentRunSummaryResponse","kind":"json-schema","title":"GETPaymentRunSummaryResponse","data":{"properties":{"numberOfCreditBalanceAdjustments":{"description":[{"$$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 only available if you have the Credit Balance feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of credit balance adjustments that are successfully processed in the payment run."},"children":[]}]}]}],"type":"integer"},"numberOfCreditMemos":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of credit memos that are successfully processed in the payment run."},"children":[]}]}]}],"type":"integer"},"numberOfDebitMemos":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of debit memos that are picked up for processing in the payment run."},"children":[]}]}]}],"type":"integer"},"numberOfErrorInputData":{"description":"The number of input data that are processed with errors.\n","type":"integer"},"numberOfErrors":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of payments with the status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"numberOfInputData":{"description":"The total number of input data.\n","type":"integer"},"numberOfInvoices":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of invoices that are picked up for processing in the payment run."},"children":[]}]}]}],"type":"integer"},"numberOfPayments":{"description":"The number of payments that are successfully processed in the payment run.\n","type":"integer"},"numberOfProcessedInputData":{"description":"The number of input data that are successfully processed.\n","type":"integer"},"numberOfReceivables":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of receivables that are picked up for processing in the payment run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field is the sum of the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfInvoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and that of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOfDebitMemos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"integer"},"numberOfUnappliedPayments":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of unapplied payments that are successfully processed in the payment run."},"children":[]}]}]}],"type":"integer"},"numberOfUnprocessedDebitMemos":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of debit memos with remaining positive balances after the payment run is completed."},"children":[]}]}]}],"type":"integer"},"numberOfUnprocessedInvoices":{"description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of invoices with remaining positive balances after the payment run is completed."},"children":[]}]}]}],"type":"integer"},"numberOfUnprocessedReceivables":{"description":"The number of receivables with remaining positive balances after the payment run is completed.\n","type":"integer"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"totalValues":{"description":"Container for total values.\n","items":{"$ref":"#/components/schemas/GETPaymentRunSummaryTotalValues"},"type":"array"}},"type":"object"}},"components/schemas/POSTRetryPaymentScheduleItemInfo":{"id":"components/schemas/POSTRetryPaymentScheduleItemInfo","kind":"json-schema","title":"POSTRetryPaymentScheduleItemInfo","data":{"description":"Information of the payment schedule items to be retried.\n","properties":{"id":{"description":"Specifies the ID of the payment schedule item to be retried.\n","type":"string"},"paymentGatewayId":{"description":"Specifies the ID of a payment gateway that will be used in the retry.\n","type":"string"},"paymentMethodId":{"description":"Specifies the ID of a payment method that will be used in the retry.\n","type":"string"}},"type":"object"}},"components/schemas/POSTRetryPaymentScheduleItemRequest":{"id":"components/schemas/POSTRetryPaymentScheduleItemRequest","kind":"json-schema","title":"POSTRetryPaymentScheduleItemRequest","data":{"example":{"items":[{"id":"402882e97f24bc36017f2986654f0253"},{"id":"402882e97f24bc36017f298665570254","paymentGatewayId":"402883827d097a28017d09b41f690261","paymentMethodId":"402882e97f24bc36017f258c2ff20076"}]},"properties":{"items":{"description":"The maximum number of items allowable to pass is 10.\n","items":{"$ref":"#/components/schemas/POSTRetryPaymentScheduleItemInfo"},"title":"Payment schedule items to be retried.","type":"array"}},"type":"object"}},"components/schemas/LinkedPaymentID":{"id":"components/schemas/LinkedPaymentID","kind":"json-schema","title":"PaymentID","data":{"properties":{"paymentId":{"description":"ID of the payment.\n","type":"string"}},"title":"PaymentID","type":"object"}},"components/schemas/PaymentScheduleItemCustomFields":{"id":"components/schemas/PaymentScheduleItemCustomFields","kind":"json-schema","title":"paymentScheduleItemFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment Schedule Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case-sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Payment Schedule Item object.\n","title":"paymentScheduleItemFieldsCustom","type":"object"}},"components/schemas/PaymentScheduleItemCommonResponse":{"id":"components/schemas/PaymentScheduleItemCommonResponse","kind":"json-schema","title":"PaymentScheduleItemCommonResponse","data":{"allOf":[{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the customer account that owns the payment schedule item, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402880e741112b310149b7343ef81234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"amount":{"description":"The total amount of the payment schedule.\n","format":"decimal","type":"number","nullable":true},"balance":{"description":"The remaining balance of payment schedule item.\n","format":"decimal","type":"number"},"billingDocument":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the billing document. for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c9890306fb2121e016fb21a6b550041"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of the billing docuemnt, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV00002345"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"type":{"description":"Indicates whether the associated billing document is a debit memo or a invoice.\n","type":"string"}},"type":"object","nullable":true},"createdById":{"description":"The ID of the user who created the payment schedule item.\n","type":"string","nullable":true},"createdDate":{"description":"The date and time when the payment schedule item was created.\n","format":"date","type":"string","nullable":true},"currency":{"description":"The currency of the payment.\n","type":"string","nullable":true},"description":{"description":"The description of the payment schedule item.\n","type":"string","nullable":true},"errorMessage":{"description":"The error message indicating if the error is related to configuration or payment collection.\n","type":"string","nullable":true},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment schedule item. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"412880e749b72b310149b7343ef81346"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":"Number of the payment schedule item.\n","type":"string"},"paymentGatewayId":{"description":"ID of the payment gateway of the payment schedule item.\n","type":"string","nullable":true},"paymentMethodId":{"description":"ID of the payment method of the payment schedule item.\n","type":"string","nullable":true},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment schedule that contains the payment schedule item, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID402880e749b72b310149b7343ef80005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"paymentScheduleNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of the payment schedule that contains the payment schedule item, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID402880e749b72b310149b7343ef80005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"psiPayments":{"description":"Container for payments linked to the payment schedule item. \n","items":{"$ref":"#/components/schemas/LinkedPaymentID"},"type":"array"},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour in the day in the tenant’s timezone this payment will be collected."},"children":[]}]}]}],"type":"integer","nullable":true},"scheduledDate":{"description":"The scheduled date when the payment is processed.\n","format":"date","type":"string","nullable":true},"standalone":{"description":"Indicates if the payment created by the payment schedule item is a standalone payment or not.\n","type":"boolean"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment method of the payment schedule item."},"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":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment schedule item is waiting for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment has been collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Failed to collect the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": After a pending payment schedule item is canceled by the user, the item is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Pending","Processed","Error","Canceled"],"type":"string","nullable":true},"updatedById":{"description":"The ID of the user who updated the payment schedule item.\n","type":"string","nullable":true},"updatedDate":{"description":"The date and time when the payment schedule item was last updated.\n","format":"date","type":"string","nullable":true}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleItemCustomFields"}]}},"components/schemas/POSTRetryPaymentScheduleItemResponse":{"id":"components/schemas/POSTRetryPaymentScheduleItemResponse","kind":"json-schema","title":"POSTRetryPaymentScheduleItemResponse","data":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PaymentScheduleItemCommonResponse"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PUTPaymentScheduleItemResponse":{"id":"components/schemas/PUTPaymentScheduleItemResponse","kind":"json-schema","title":"PUTPaymentScheduleItemResponse","data":{"allOf":[{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the customer account that owns the payment schedule item, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402880e741112b310149b7343ef81234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"amount":{"description":"The amount of the payment schedule item.\n","format":"decimal","type":"number"},"balance":{"description":"The remaining balance of payment schedule item.         \n","format":"decimal","type":"number"},"billingDocument":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the billing document. for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c9890306fb2121e016fb21a6b550041"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the billing docuemnt, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV00002345"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"type":{"description":"Indicates whether the associated billing document is a debit memo or a invoice.\n","type":"string"}},"type":"object"},"cancellationReason":{"description":"The reason for the cancellation of payment schedule item.  \n","type":"string","nullable":true},"createdById":{"description":"The ID of the user who created the payment schedule item.\n","type":"string"},"createdDate":{"description":"The date and time when the payment schedule item was created.\n","format":"date","type":"string"},"currency":{"description":"The currency of the payment.\n","type":"string"},"description":{"description":"The description of the payment schedule item.\n","type":"string","nullable":true},"errorMessage":{"description":"The error message indicating if the error is related to the configuration or the payment collection.\n","type":"string","nullable":true},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment schedule item. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"412880e749b72b310149b7343ef81346"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":"Number of the payment schedule item.\n","type":"string"},"paymentGatewayId":{"description":"ID of the payment gateway of the payment schedule item.\n","type":"string","nullable":true},"paymentMethodId":{"description":"ID of the payment method of the payment schedule item.\n","type":"string"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment schedule that contains the payment schedule item, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID402880e749b72b310149b7343ef80005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]}],"type":"string"},"paymentScheduleNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of the payment schedule that contains the payment schedule item, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID402880e749b72b310149b7343ef80005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]}],"type":"string"},"psiPayments":{"description":"Container for payments linked to the payment schedule item.\n","items":{"$ref":"#/components/schemas/LinkedPaymentID"},"type":"array"},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour in the day in the tenant’s timezone this payment will be collected."},"children":[]}]}]}],"type":"integer"},"scheduledDate":{"description":"The scheduled date when the payment is processed.\n","format":"date","type":"string"},"standalone":{"description":"Indicates if the payment created by the payment schedule item is a standalone payment.\n","type":"boolean"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment method of the payment schedule item."},"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":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment has been collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Failed to collect the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": After a pending payment schedule item is canceled by the user, the item is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Pending","Processed","Error","Canceled"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"updatedById":{"description":"The ID of the user who updated the payment schedule item.\n","type":"string"},"updatedDate":{"description":"The date and time when the payment schedule item was last updated.\n","format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleItemCustomFields"}]}},"components/schemas/PUTSkipPaymentScheduleItemResponse":{"id":"components/schemas/PUTSkipPaymentScheduleItemResponse","kind":"json-schema","title":"PUTSkipPaymentScheduleItemResponse","data":{"allOf":[{"properties":{"amount":{"description":"The amount of the payment.\n","format":"decimal","type":"number"},"billingDocument":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the billing document. for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c9890306fb2121e016fb21a6b550041"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the billing docuemnt, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV00002345"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"type":{"description":"Indicates whether the associated billing document is a debit memo or a invoice.\n","type":"string"}},"type":"object","nullable":true},"cancellationReason":{"description":"The reason for the cancellation of payment schedule item.            \n","type":"string"},"createdById":{"description":"The ID of the user who created the payment schedule item.\n","type":"string"},"createdDate":{"description":"The date and time when the payment schedule item was created.\n","format":"date","type":"string"},"currency":{"description":"The currency of the payment.\n","type":"string"},"description":{"description":"The description of the payment schedule item.\n","type":"string"},"errorMessage":{"description":"The error message indicating if the error is related to the configuration or the payment collection.\n","type":"string","nullable":true},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the newly-created payment schedule item. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"412880e749b72b310149b7343ef81346"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":"Number of the newly-created payment schedule item.\n","type":"string"},"paymentGatewayId":{"description":"ID of the payment gateway of the payment schedule item.\n","type":"string","nullable":true},"paymentMethodId":{"description":"ID of the payment method of the payment schedule item.\n","type":"string"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment schedule that contains the payment schedule item, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID402880e749b72b310149b7343ef80005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]}],"type":"string"},"paymentScheduleNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of the payment schedule that contains the payment schedule item, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID402880e749b72b310149b7343ef80005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]}],"type":"string"},"psiPayments":{"description":"Container for payments linked to the payment schedule item. \n","items":{"$ref":"#/components/schemas/LinkedPaymentID"},"type":"array"},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour in the day in the tenant’s timezone this payment will be collected."},"children":[]}]}]}],"type":"integer"},"scheduledDate":{"description":"The scheduled date when the payment is processed.\n","format":"date","type":"string"},"standalone":{"description":"Indicates if the payment created by the payment schedule item is a standalone payment.\n","type":"boolean"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment method of the payment schedule item."},"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":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment has been collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Failed to collect the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": After a pending payment schedule item is canceled by the user, the item is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Pending","Processed","Error","Canceled"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"updatedById":{"description":"The ID of the user who updated the payment schedule item.\n","type":"string"},"updatedDate":{"description":"The date and time when the payment schedule item was last updated.\n","format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleItemCustomFields"}]}},"components/schemas/GETPaymentScheduleItemResponse":{"id":"components/schemas/GETPaymentScheduleItemResponse","kind":"json-schema","title":"GETPaymentScheduleItemResponse","data":{"allOf":[{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the customer account that owns the payment schedule item, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402880e741112b310149b7343ef81234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"amount":{"description":"The total amount of the payment schedule item.\n","format":"decimal","type":"number"},"balance":{"description":"The remaining balance of payment schedule item.\n","format":"decimal","type":"number"},"billingDocument":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the billing document. for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c9890306fb2121e016fb21a6b550041"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the billing docuemnt, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV00002345"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"type":{"description":"Indicates whether the associated billing document is a debit memo or a invoice.\n","type":"string"}},"type":"object"},"cancellationReason":{"description":"The reason for the cancellation of payment schedule item.\n","nullable":true,"type":"string"},"cancelledById":{"description":"The ID of the user who canceled this payment schedule item.\n","nullable":true,"type":"string"},"cancelledOn":{"description":"The date when the payment schedule item was canceled.\n","nullable":true,"type":"string"},"createdById":{"description":"The ID of the user who created the payment schedule item.\n","type":"string"},"createdDate":{"description":"The date and time when the payment schedule item was created.\n","format":"date","type":"string"},"currency":{"description":"The currency of the payment.\n","type":"string"},"description":{"description":"The description of the payment schedule item.\n","type":"string"},"errorMessage":{"description":"The error message indicating if the error is related to the configuration or the payment collection.\n","type":"string","nullable":true},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment schedule item. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"412880e749b72b310149b7343ef81346"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":"Number of the payment schedule item.\n","type":"string"},"paymentGatewayId":{"description":"ID of the payment gateway of the payment schedule item.\n","type":"string","nullable":true},"paymentMethodId":{"description":"ID of the payment method of the payment schedule item.\n","type":"string"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment schedule that contains the payment schedule item, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID402880e749b72b310149b7343ef80005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]}],"type":"string"},"paymentScheduleNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of the payment schedule that contains the payment schedule item, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID402880e749b72b310149b7343ef80005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]}],"type":"string"},"psiPayments":{"description":"Container for payments linked to the payment schedule item. \n","items":{"$ref":"#/components/schemas/LinkedPaymentID"},"type":"array"},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour in the day in the tenant’s timezone this payment will be collected. If the payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are backdated, the system will collect the payment when the next runHour occurs."},"children":[]}]}]}],"type":"integer"},"scheduledDate":{"description":"The scheduled date when the payment is processed.\n","format":"date","type":"string"},"standalone":{"description":"Indicates if the payment created by the payment schedule item is a standalone payment.\n","type":"boolean"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment method of the payment schedule item."},"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":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment has been collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Failed to collect the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": After a pending payment schedule item is canceled by the user, the item is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Pending","Processed","Error","Canceled"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"updatedById":{"description":"The ID of the user who updated the payment schedule item.\n","type":"string"},"updatedDate":{"description":"The date and time when the payment schedule item was last updated.\n","format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleItemCustomFields"}]}},"components/schemas/PUTPaymentScheduleItemRequest":{"id":"components/schemas/PUTPaymentScheduleItemRequest","kind":"json-schema","title":"PUTPaymentScheduleItemRequest","data":{"example":{"paymentMethodId":"8a90b44890c9bb0d0190d960b9191eea"},"allOf":[{"properties":{"amount":{"description":"The amount of the payment.\n","format":"decimal","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the payment."},"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":"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":"For custom payments, if Multi-currency is enabled, the payment currency can be different from the account currency for custom payment."},"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":"For recurring payments, if Multi-currency is enabled, the payment currency can be different from the account currency but should be the same as billing currency for a recurring payment."},"children":[]}]}]}]}]}],"type":"string"},"description":{"description":"The description of the payment schedule item.\n","type":"string"},"linkPayments":{"description":"Container for payments linked to the payment schedule item.\n","type":"array","items":{"type":"string"}},"paymentGatewayId":{"description":"ID of the payment gateway of the payment schedule item.\n","type":"string","nullable":true},"paymentMethodId":{"description":"ID of the payment method of the payment schedule item.\n","type":"string"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour of the day in the tenant’s timezone this payment will be collected. If the payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are backdated, the system will collect the payment when the next runHour occurs."},"children":[]}]}]}],"type":"integer"},"scheduledDate":{"description":"The scheduled date when the payment is processed.\n","format":"date","type":"string"},"unlinkPayments":{"description":"Container for payments to be unlinked from the payment schedule item.\n","type":"array","items":{"type":"string"}}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleItemCustomFields"}]}},"components/schemas/PaymentScheduleCustomFields":{"id":"components/schemas/PaymentScheduleCustomFields","kind":"json-schema","title":"paymentScheduleFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment Schedule object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case-sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The values will automatically be pushed to payment schedule items level if the same fields exist at the payment schedule item level."},"children":[]}]}]}]},"description":"Container for custom fields of a Payment Schedule object.\n","title":"paymentScheduleFieldsCustom","type":"object"}},"components/schemas/PaymentScheduleCommonResponse":{"id":"components/schemas/PaymentScheduleCommonResponse","kind":"json-schema","title":"PaymentScheduleCommonResponse","data":{"allOf":[{"properties":{"accountId":{"description":"ID of the account that owns the payment schedule.\n","type":"string"},"accountNumber":{"description":"Number of the account that owns the payment schedule.\n","type":"string"},"billingDocument":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the billing document. for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c9890306fb2121e016fb21a6b550041"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the billing docuemnt, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV00002345"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"type":{"description":"Indicates whether the associated billing document is a debit memo or a invoice.\n","type":"string"}},"type":"object","nullable":true},"billingDocuments":{"description":"Container array of the multiple billing documents associated with the payment schedule.\n","items":{"allOf":[{"properties":{"id":{"description":"ID of the billing document.\n","type":"string"},"number":{"description":"Number of the billing document. If the billing document is a debit memo, it contains the debit memo number. If the billing document is an invoice, it contains the invoice number.\n","type":"string"},"type":{"description":"Denotes if the billing document is of the type invoice or debit memo.\n","enum":["Invoice","DebitMemo"],"type":"string"}}}]},"type":"array"},"createdById":{"description":"The ID of the user who created this payment schedule.\n","type":"string"},"createdDate":{"description":"The date and time the payment schedule is created.\n","format":"date","type":"string"},"description":{"description":"The description of the payment schedule.\n","type":"string"},"id":{"description":"ID of the payment schedule.\n","type":"string"},"isCustom":{"description":"Indicates if the payment schedule is a custom payment schedule.\n","type":"boolean"},"items":{"description":"Container for payment schedule items.\n","items":{"$ref":"#/components/schemas/PaymentScheduleItemCommonResponse"},"type":"array"},"nextPaymentDate":{"description":"The date the next payment will be processed.\n","format":"date","type":"string"},"occurrences":{"description":"The number of payment schedule items that are created by this payment schedule.\n","type":"integer"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleNumber":{"description":"Number of the payment schedule.\n","type":"string"},"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring payment schedule only. The period of payment generation. Available values include: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BiWeekly"},"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":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for custom payment schedules."},"children":[]}]}]}],"type":"string","nullable":true},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payments created by the payment schedule are used as a reserved payment. This field is available only if the prepaid cash drawdown permission is enabled. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"recentPaymentDate":{"description":"The date the last payment was processed.\n","format":"date","type":"string","nullable":true},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[0,1,2,~,22,23]"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour in the day in the tenant’s timezone the recurring payment schedule items will be collected."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for custom payment schedules."},"children":[]}]}]}],"type":"integer"},"standalone":{"description":"Indicates if the payments that the payment schedule created are standalone payments or not.\n","type":"boolean"},"startDate":{"description":"The date when the first payment of this payment schedule is proccessed.\n","format":"date","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the payment schedule."},"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":"Active: There is still payment schedule item to process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canceled: After a payment schedule is canceled by the user, the schedule is marked as "},"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":"Completed: After all payment schedule items are processed, the schedule is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Active","Canceled","Completed"],"type":"string"},"totalAmount":{"description":"The total amount that will be collected by the payment schedule.            \n","type":"number"},"totalPaymentsErrored":{"description":"The number of errored payments.\n","type":"integer"},"totalPaymentsProcessed":{"description":"The number of processed payments.\n","type":"integer"},"updatedById":{"description":"The ID of the user who last updated this payment schedule.\n","type":"string"},"updatedDate":{"description":"The date and time the payment schedule is last updated.\n","format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleCustomFields"}]}},"components/schemas/GETPaymentSchedulesResponse":{"id":"components/schemas/GETPaymentSchedulesResponse","kind":"json-schema","title":"GETPaymentSchedulesResponse","data":{"description":"Container for payment schedules.\n","items":{"$ref":"#/components/schemas/PaymentScheduleCommonResponse"},"type":"array"}},"components/schemas/POSTPaymentScheduleRequest":{"id":"components/schemas/POSTPaymentScheduleRequest","kind":"json-schema","title":"POSTPaymentScheduleRequest","data":{"allOf":[{"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the customer account the payment schedule belongs to."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot both be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When both fields are specified, the two values must match each other."},"children":[]}]}]}],"type":"string"},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number of the customer account the payment schedule belongs to."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot both be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When both fields are specified, the two values must match each other."},"children":[]}]}]}],"type":"string"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of each payment schedule item in the payment schedule."},"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":"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":"This field is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will be ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating recurring payment schedules, there are 2 options to specify amounts:"},"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":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"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":" will be calculated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be calculated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Specifying both fields at the same time is not allowed."},"children":[]}]}]}]}]}]}],"type":"number"},"billingDocument":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object of the billing document with which the payment schedule is associated."},"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":"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":"This field is optional. If you have the Standalone Payment feature enabled, you can leave this field blank and set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create standalone payments. You can also choose to create unapplied payments by leaving this object blank and setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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 Standalone Payment is not enabled, leaving this object unspecified will create unapplied payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if you are on the latest Zuora API version, or you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"330.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/v1-api-reference/api-versions/#minor-version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a later available version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the billing document."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a billing document is specified, either "},"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":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the billing document must be specified. You cannot specify both of them or skip both."},"children":[]}]}]}],"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of the billing document."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a billing document is specified, either "},"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":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the billing document must be specified. You cannot specify both of them or skip both."},"children":[]}]}]}],"type":"string"},"type":{"description":"The type of the billing document. \n","enum":["Invoice","DebitMemo"],"default":"Invoice","type":"string"}},"required":["type"],"type":"object"},"billingDocuments":{"description":"Container array of the multiple billing documents associated with the payment schedule.\n\nIf multiple billing documents are associated to a payment schedule, when collecting the payment schedule item, the payment belongs to the payment schedule item will be applied to billing documents based on the due date of the billing document, in the ascending order.\n","items":{"type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the billing document."},"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":" If a billing document is specified, either "},"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":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the billing document must be specified. You cannot specify both of them or skip both."},"children":[]}]}]}],"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of the billing document. If the billing document is a debit memo, it contains the debit memo number. If the billing document is an invoice, it contains the invoice number."},"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":" If a billing document is specified, either "},"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":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the billing document must be specified. You cannot specify both of them or skip both."},"children":[]}]}]}],"type":"string"},"type":{"description":"Denotes if the billing document is of the type invoice or debit memo.\n","enum":["Invoice","DebitMemo"],"type":"string"}},"required":["type"]},"type":"array"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency of the payment schedule."},"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":"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":"This field is optional. The default value is the account's default currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will be ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For custom payments, if Multi-currency is enabled, the payment currency can be different from the account currency for custom payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring payments, if Multi-currency is enabled, the payment currency can be different from the account currency but should be the same as billing currency for a recurring payment."},"children":[]}]}]}]}],"type":"string"},"description":{"description":"Description of the payment schedule. Max length is 255.\n","type":"string"},"items":{"description":"Container array for payment schedule items.\n","items":{"allOf":[{"properties":{"amount":{"description":"The amount that needs to be collected by this payment schedule item.\n","type":"number"},"billingDocument":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object for the billing document with which the payment schedule item is associated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":" You must specify the same billing document for all the payment schedule items in one payment schedule."},"children":[]}]}]}],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the billing document."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a billing document is specified, one of "},"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":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be specified. You cannot specify both of them or or skip both."},"children":[]}]}]}],"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the billing document."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a billing document is specified, one of "},"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":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be specified. You cannot specify both of them or skip both."},"children":[]}]}]}],"type":"string"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the billing document. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Invoice","DebitMemo"],"type":"string"}},"required":["type"],"type":"object"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the payment."},"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":":"},"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":"This field is optional. If not specified, the default value is the currency set for the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For custom payments, if Multi-currency is enabled, the payment currency can be different from the account currency for custom payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring payments, if Multi-currency is enabled, the payment currency can be different from the account currency but should be the same as billing currency for a recurring payment."},"children":[]}]}]}]}],"type":"string"},"description":{"description":"Description of the payment schedule item.\n","type":"string"},"paymentGatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment gateway."},"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":":"},"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":"This field is optional. If not specified, the default value is the payment gateway id set for the account."},"children":[]}]}]}]}],"type":"string"},"paymentMethodId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment method."},"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":":"},"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":"This field is optional. If not specified, the default value is the payment method id set for the account."},"children":[]}]}]}]}],"type":"string"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is only available if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"337.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour in the day in the tenant’s timezone this payment will be collected. Available values:"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[0,1,2,~,22,23]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"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 payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are backdated, the system will collect the payment when the next runHour occurs."},"children":[]}]}]}],"type":"string"},"scheduledDate":{"description":"The date to collect the payment.\n","format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleItemCustomFields"}]},"type":"array"},"occurrences":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of payment schedule item to be created. Maximum value is 1000."},"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":"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":"This field is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will be ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]}]}],"type":"integer"},"paymentGatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment gateway."},"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":"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":"This field is optional. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the cusotmer account level, the default value will be the tenant's default payment gateway ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will be ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]}]}],"type":"string"},"paymentMethodId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment method."},"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":"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":"This field is optional. The default value is the account's default payment method ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will be ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]}]}],"type":"string"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this field to specify the number of the payment schedule."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only characters from the following sets are allowed: A-Z, a-z, 0-9, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"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":"Payment numbers must start with a letter. In addition,"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be used at most once and cannot be placed at the beginning or the end of the payment numbers."},"children":[]}]}]}],"type":"string"},"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The frequency for the payment collection since the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"Thie field is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will be ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when in February, payment schedule will use the last day of February for payment collection."},"children":[]}]}]}]}],"enum":["Monthly","Weekly","BiWeekly"],"type":"string"},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payments created by the payment schedule will be used as reserved payments. This field will only be available if the prepaid cash drawdown permission is enabled. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies at which hour in the day in the tenant’s time zone when this payment will be collected. Available values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[0,1,2,~,22,23]"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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 time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are backdated, the system will collect the payment when the next runHour occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is optional. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"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":"This field will be ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]}]}],"type":"integer"},"standalone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicate whether the payments created by the payment schedule are standalone payments or not. When setting to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", standalone payments will be created. When setting to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can either specify a billing document, or not specifying any billing documents. In the later case, unapplied payments will be created. If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", standalone payment will be created."},"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":":"},"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":"This field is only available if the Standalone Payment is enabled. Do not include this field if Standalone Payment is not enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Standalone Payment is enabled, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"boolean"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date for the first payment collection."},"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":"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":"This field is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field will be ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]}]}],"format":"date","type":"string"},"totalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of that the payment schedule will collect. This field is only available for recurring payment schedules."},"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":":"},"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":"When creating recurring payment schedules, there are 2 options to specify amounts:"},"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":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"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":" will be calculated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be calculated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Specifying both fields at the same time is not allowed."},"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":"If the Standalone Payments feature is enabled and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the payment schedule, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be ignored."},"children":[]}]}]}]}]}],"type":"number"}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleCustomFields"}],"example":{"accountId":"8a90b4488e7d5c0f018e7db3892400b2","amount":14.99,"billingDocument":{"id":"8a90b44890c9bb0d0190d8c048a90da6","type":"Invoice"},"items":[{"scheduledDate":"2024-07-31","amount":14.99}]}}},"components/schemas/POSTPaymentScheduleResponse":{"id":"components/schemas/POSTPaymentScheduleResponse","kind":"json-schema","title":"POSTPaymentScheduleResponse","data":{"allOf":[{"properties":{"accountId":{"description":"ID of the account that owns the payment schedule.\n","type":"string"},"accountNumber":{"description":"Number of the account that owns the payment schedule.\n","type":"string"},"billingDocument":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the billing document. for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c9890306fb2121e016fb21a6b550041"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of the billing docuemnt, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV00002345"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"type":{"description":"Indicates whether the associated billing document is a debit memo or a invoice.\n","type":"string"}},"type":"object"},"billingDocuments":{"description":"Container array of the multiple billing documents associated with the payment schedule.\n","items":{"type":"object","properties":{"id":{"description":"ID of the billing document.\n","type":"string"},"number":{"description":"Number of the billing document. If the billing document is a debit memo, it contains the debit memo number. If the billing document is an invoice, it contains the invoice number.\n","type":"string"},"type":{"description":"Denotes if the billing document is of the type invoice or debit memo.\n","enum":["Invoice","DebitMemo"],"type":"string"}}},"type":"array"},"createdById":{"description":"ID of the user who created this payment schedule.\n","type":"string"},"createdDate":{"description":"The date and time the payment schedule is created.\n","format":"date","type":"string"},"description":{"description":"The description of the payment schedule.\n","type":"string","nullable":true},"id":{"description":"ID of the payment schedule.\n","type":"string"},"isCustom":{"description":"Indicates if the payment schedule is a custom payment schedule.\n","type":"boolean"},"items":{"description":"Container for payment schedule items.\n","items":{"$ref":"#/components/schemas/PaymentScheduleItemCommonResponse"},"type":"array"},"nextPaymentDate":{"description":"The date the next payment will be processed.\n","format":"date","type":"string"},"occurrences":{"description":"The number of payment schedule items that are created by this payment schedule.\n","type":"integer"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleNumber":{"description":"Number of the payment schedule.\n","type":"string"},"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring payment schedule only. The period of payment generation. Available values include: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BiWeekly"},"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":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for custom payment schedules."},"children":[]}]}]}],"type":"string","nullable":true},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payments created by the payment schedule are used as a reserved payment. This field will only be available if the prepaid cash drawdown permission is enabled. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"recentPaymentDate":{"description":"The date the last payment was processed.\n","format":"date","type":"string","nullable":true},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[0,1,2,~,22,23]"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour in the day in the tenant’s timezone this payment will be collected. If the payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are backdated, the system will collect the payment when the next runHour occurs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for custom payment schedules."},"children":[]}]}]}],"type":"integer"},"standalone":{"description":"Indicates if the payments that the payment schedule created are standalone payments or not.\n","type":"boolean"},"startDate":{"description":"The date when the first payment of this payment schedule is proccessed.\n","format":"date","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the payment schedule."},"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":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": There are still pament schedule items to process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": After a payment schedule is canceled by the user, the schedule is marked as "},"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":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": After all payment schedule items are processed, the schedule is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Active","Canceled","Completed"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"totalAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount that will be collected by this payment schedule. This field will contain a null value if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"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":[]}]}]}],"type":"number"},"totalPaymentsErrored":{"description":"The number of errored payments.\n","type":"integer"},"totalPaymentsProcessed":{"description":"The number of processed payments.\n","type":"integer"},"updatedById":{"description":"ID of the user who last updated this payment schedule.\n","type":"string"},"updatedDate":{"description":"The date and time the payment schedule is last updated.\n","format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleCustomFields"}]}},"components/schemas/POSTPaymentSchedulesRequest":{"id":"components/schemas/POSTPaymentSchedulesRequest","kind":"json-schema","title":"POSTPaymentSchedulesRequest","data":{"properties":{"paymentSchedules":{"description":"Container of the payment schedules to be created.\n","items":{"$ref":"#/components/schemas/POSTPaymentScheduleRequest"},"type":"array"}},"type":"object"}},"components/schemas/POSTPaymentSchedulesEach":{"id":"components/schemas/POSTPaymentSchedulesEach","kind":"json-schema","title":"Payment Schedule ID and Number","data":{"properties":{"id":{"description":"The ID of the created payment schedule.\n","type":"string"},"paymentScheduleNumber":{"description":"The number of the created payment schedule.\n","type":"string"}},"title":"Payment Schedule ID and Number","type":"object"}},"components/schemas/POSTPaymentSchedulesResponse":{"id":"components/schemas/POSTPaymentSchedulesResponse","kind":"json-schema","title":"POSTPaymentSchedulesResponse","data":{"description":"Container of the payment schedules that are created.\n","properties":{"paymentSchedules":{"description":"Container for payment parts.\n","items":{"$ref":"#/components/schemas/POSTPaymentSchedulesEach"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/PaymentRunStatistic":{"id":"components/schemas/PaymentRunStatistic","kind":"json-schema","title":"PaymentRunStatistic","data":{"description":"Payment run statistic.","properties":{"completedOn":{"description":"The date and time the payment run is completed.\n","format":"date-time","type":"string"},"executedOn":{"description":"The date and time the payment run is executed.\n","format":"date-time","type":"string","nullable":true},"number":{"description":"Payment run number.\n","type":"string"},"numberOfErrors":{"description":"Number of errored payments\n","type":"integer"},"numberOfPayments":{"description":"Number of processed payments.\n","type":"integer"},"status":{"description":"Payment run status.\n","type":"string"}},"type":"object"}},"components/schemas/GETPaymentScheduleStatisticResponse":{"id":"components/schemas/GETPaymentScheduleStatisticResponse","kind":"json-schema","title":"GETPaymentScheduleStatisticResponse","data":{"description":"The object that contains the payment schedule statistic of the specified date.\n","properties":{"date":{"description":"The specified date.\n","format":"date","type":"string"},"paymentRuns":{"items":{"$ref":"#/components/schemas/PaymentRunStatistic"},"title":"PaymentRunStatistic","type":"array"},"paymentScheduleItems":{"properties":{"error":{"description":"The number of errored payment schedule items.              \n","type":"integer"},"pending":{"description":"The number of pending payment schedule items.\n","type":"integer"},"processed":{"description":"The number of processed payment schedule items. \n","type":"integer"}},"type":"object"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETPaymentScheduleResponse":{"id":"components/schemas/GETPaymentScheduleResponse","kind":"json-schema","title":"GETPaymentScheduleResponse","data":{"allOf":[{"properties":{"accountId":{"description":"ID of the account that owns the payment schedule.\n","type":"string"},"accountNumber":{"description":"Number of the account that owns the payment schedule.\n","type":"string"},"billingDocument":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the billing document. for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2c9890306fb2121e016fb21a6b550041"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the billing docuemnt, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV00002345"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"type":{"description":"Indicates whether the associated billing document is a debit memo or a invoice.\n","type":"string"}},"type":"object","nullable":true},"billingDocuments":{"description":"Container array of the multiple billing documents associated with the payment schedule.\n","items":{"type":"object","properties":{"id":{"description":"ID of the billing document.\n","type":"string"},"number":{"description":"Number of the billing document. If the billing document is a debit memo, it contains the debit memo number. If the billing document is an invoice, it contains the invoice number.\n","type":"string"},"type":{"description":"Denotes if the billing document is of the type invoice or debit memo.\n","enum":["Invoice","DebitMemo"],"type":"string"}}},"type":"array"},"createdById":{"description":"The ID of the user who created this payment schedule.\n","type":"string"},"createdDate":{"description":"The date and time the payment schedule is created.\n","format":"date","type":"string"},"cancellationReason":{"description":"The reason for the cancellation of the payment schedule item.\n","nullable":true,"type":"string"},"cancelledById":{"description":"The ID of the user who canceled this payment schedule.\n","type":"string","nullable":true},"cancelledOn":{"description":"The date when the payment schedule was canceled.\n","type":"string","nullable":true},"cancelDate":{"description":"Specifies the effective date by when the payment schedule will be canceled.\n","format":"date","type":"string","nullable":true},"description":{"description":"The description of the payment schedule.\n","type":"string","nullable":true},"id":{"description":"ID of the payment schedule.\n","type":"string"},"isCustom":{"description":"Indicates if the payment schedule is a custom payment schedule.\n","type":"boolean"},"items":{"description":"Container for payment schedule items.\n","items":{"$ref":"#/components/schemas/PaymentScheduleItemCommonResponse"},"type":"array"},"nextPaymentDate":{"description":"The date the next payment will be processed.\n","format":"date","type":"string"},"occurrences":{"description":"The number of payment schedule items that are created by this payment schedule.\n","type":"integer"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"paymentScheduleNumber":{"description":"Number of the payment schedule.\n","type":"string"},"period":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring payment schedule only. The period of payment generation. Available values include: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BiWeekly"},"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":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for custom payment schedules."},"children":[]}]}]}],"type":"string","nullable":true},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payments created by the payment schedule are used as a reserved payment. This field is available only if the prepaid cash drawdown permission is enabled. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"recentPaymentDate":{"description":"The date the last payment was processed.\n","format":"date","type":"string","nullable":true},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[0,1,2,~,22,23]"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour in the day in the tenant’s timezone this payment will be collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for custom payment schedules."},"children":[]}]}]}],"type":"integer"},"standalone":{"description":"Indicates if the payments that the payment schedule created are standalone payments.\n","type":"boolean"},"startDate":{"description":"The date when the first payment of this payment schedule is proccessed.\n","format":"date","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the payment schedule."},"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":"Active: There is still payment schedule item to process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canceled: After a payment schedule is canceled by the user, the schedule is marked as "},"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":"Completed: After all payment schedule items are processed, the schedule is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Active","Canceled","Completed"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"totalAmount":{"description":"The total amount that will be collected by the payment schedule.\n","type":"number"},"totalPaymentsErrored":{"description":"The number of errored payments.\n","type":"integer"},"totalPaymentsProcessed":{"description":"The number of processed payments.\n","type":"integer"},"updatedById":{"description":"The ID of the user who last updated this payment schedule.\n","type":"string"},"updatedDate":{"description":"The date and time the payment schedule is last updated.\n","format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleCustomFields"}]}},"components/schemas/PUTPaymentScheduleRequest":{"id":"components/schemas/PUTPaymentScheduleRequest","kind":"json-schema","title":"PUTPaymentScheduleRequest","data":{"allOf":[{"properties":{"amount":{"description":"Indicates the updated amount of the pending payment schedule items.\n","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the updated currency of the pending payment schedule items."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"For custom payments, if Multi-currency is enabled, the payment currency can be different from the account currency for custom payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring payments, if Multi-currency is enabled, the payment currency can be different from the account currency but should be the same as billing currency for a recurring payment."},"children":[]}]}]}]}],"type":"string"},"description":{"description":"Description of the payment schedule.\n","maxLength":255,"type":"string"},"occurrences":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the updated number of payment schedule items that are created by the payment schedule."},"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":"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 \"updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\", the following number of pending payment schedule item will be added to the payment schedule: “updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"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 \"existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" >= the number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errored"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment schedule items\", the following number of pending items will be removed by descending order of the schedule dates: \"existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"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 \"updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurrences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" < the number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"erroed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment schedule items\", a validation error will be returned."},"children":[]}]}]}]}],"type":"integer"},"paymentGatewayId":{"description":"Indicates the updated payment gateway ID of the pending payment schedule items.\n","type":"string"},"paymentMethodId":{"description":"Indicates the updated payment method ID of the pending payment schedule items. \n","type":"string"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"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":" To enable this field, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"period":{"description":"Indicates the updated period of the pending payment schedule items.\n","enum":["Monthly","Weekly","BiWeekly"],"type":"string"},"periodStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the updated collection date for the next pending payment schedule item. If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora reschedules all pending payment schedule items using the new date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":" You can set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a date earlier than the payment schedule's original "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when both dates are in the future.  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a future date. If you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to today or an earlier date, the request would fail."},"children":[]}]}]}],"format":"date","type":"string"},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[0,1,2,~,22,23]"},"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 time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are backdated, the system will collect the payment when the next runHour occurs."},"children":[]}]}]}],"format":"date","type":"integer"}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleCustomFields"}],"example":{"description":"Details of this payment schedule"}}},"components/schemas/PUTCancelPaymentScheduleRequest":{"id":"components/schemas/PUTCancelPaymentScheduleRequest","kind":"json-schema","title":"PUTCancelPaymentScheduleRequest","data":{"properties":{"cancelDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when the payment schedule will be canceled."},"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":": If there is no legitimate payment schedule item to cancel, the payment schedule cancel operation will be rejected."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["cancelDate"],"type":"object"}},"components/schemas/PaymentScheduleItemCommon":{"id":"components/schemas/PaymentScheduleItemCommon","kind":"json-schema","title":"PaymentScheduleItemCommon","data":{"allOf":[{"properties":{"amount":{"description":"The amount that needs to be collected by this payment schedule item.\n","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the payment."},"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":":"},"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":"This field is optional. If not specified, the default value is the currency set for the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For custom payments, if Multi-currency is enabled, the payment currency can be different from the account currency for custom payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring payments, if Multi-currency is enabled, the payment currency can be different from the account currency but should be the same as billing currency for a recurring payment."},"children":[]}]}]}]}],"type":"string"},"description":{"description":"Description of the payment schedule item.\n","type":"string"},"paymentGatewayId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment gateway."},"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":":"},"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":"This field is optional. If not specified, the default value is the payment gateway id set for the account."},"children":[]}]}]}]}],"required":["type"],"type":"string"},"paymentMethodId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the payment method."},"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":":"},"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":"This field is optional. If not specified, the default value is the payment method id set for the account."},"children":[]}]}]}]}],"type":"string"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour of the day in the tenant’s timezone this payment will be collected. Available values:"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[0,1,2,~,22,23]"},"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 payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are backdated, the system will collect the payment when the next runHour occurs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"scheduledDate":{"description":"The date to collect the payment.\n","format":"date","type":"string"}},"required":["scheduledDate","amount"],"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleItemCustomFields"}]}},"components/schemas/POSTAddItemsToPaymentScheduleRequest":{"id":"components/schemas/POSTAddItemsToPaymentScheduleRequest","kind":"json-schema","title":"POSTAddItemsToPaymentScheduleRequest","data":{"example":{"items":[{"amount":50,"scheduledDate":"2024-11-22"}]},"description":"Container for the payment schedule items to be added to the payment schedule.\n","properties":{"items":{"items":{"$ref":"#/components/schemas/PaymentScheduleItemCommon"},"title":"paymentScheduleItem","type":"array"}},"type":"object"}},"components/schemas/PUTPreviewPaymentScheduleRequest":{"id":"components/schemas/PUTPreviewPaymentScheduleRequest","kind":"json-schema","title":"PUTPreviewPaymentScheduleRequest","data":{"allOf":[{"properties":{"amount":{"description":"Indicates the updated amount of the pending payment schedule items.\n","type":"number"},"currency":{"description":"Indicates the updated currency of the pending payment schedule items.      \n","type":"string"},"occurrences":{"description":"Indicates the updated number of payment schedule items that are created by the payment schedule.\n","type":"integer"},"paymentGatewayId":{"description":"Indicates the updated payment gateway ID of the pending payment schedule items.\n","type":"string"},"paymentMethodId":{"description":"Indicates the updated payment method ID of the pending payment schedule items. \n","type":"string"},"paymentOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment schedule item."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentSchedulePaymentOptionFields"},"type":"array"},"period":{"description":"Indicates the updated period of the pending payment schedule items.\n","enum":["Monthly","Weekly","BiWeekly"],"type":"string"},"periodStartDate":{"description":"Indicates the updated collection date for the next pending payment schedule item.\n","format":"date","type":"string"},"runHour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[0,1,2,~,22,23]"},"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 time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runHour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are backdated, the system will collect the payment when the next runHour occurs."},"children":[]}]}]}],"format":"date","type":"integer"}},"type":"object"},{"$ref":"#/components/schemas/PaymentScheduleCustomFields"}],"example":{"occurrences":5}}},"components/schemas/GETRefundTypewithSuccess":{"id":"components/schemas/GETRefundTypewithSuccess","kind":"json-schema","title":"refunds","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.\n","type":"string"},"amount":{"description":"The total amount of the refund.\n","format":"double","type":"number"},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the refund.\n","type":"string"},"createdById":{"description":"The ID of the Zuora user who created the refund.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of the credit memo that is refunded.\n","type":"string","nullable":true},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","type":"string","nullable":true},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n","type":"string","nullable":true}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the refund.\n","type":"string","nullable":true},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string","nullable":true},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string","nullable":true},"gatewayResponse":{"description":"The message returned from the payment gateway for the refund. This message is gateway-dependent.\n","type":"string","nullable":true},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the refund. This code is gateway-dependent.\n","type":"string","nullable":true},"gatewayState":{"description":"The status of the refund in the gateway. \n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"id":{"description":"The ID of the refund.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a refund was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"methodType":{"description":"How an external refund was issued to a customer. \n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"number":{"description":"The unique identification number of the refund.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentId":{"description":"The ID of the payment that is refunded.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the refund.\n","type":"string","nullable":true},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.\n","type":"string","nullable":true},"payoutId":{"description":"The payout ID of the refund from the gateway side.\n","type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction.\n","type":"string"},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string","nullable":true},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01."},"children":[]}]}]}],"format":"date","type":"string"},"refundTransactionTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was issued, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was settled in the payment processor, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This field is used by the Spectrum gateway only and not applicable to other gateways."},"children":[]}]}]}],"type":"string","nullable":true},"softDescriptor":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string","nullable":true},"status":{"description":"The status of the refund. \n","enum":["Processed","Canceled","Error","Processing"],"type":"string"},"submittedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was submitted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"type":{"description":"The type of the refund. \n","enum":["External","Electronic"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the refund.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/RefundObjectNSFields"},{"$ref":"#/components/schemas/RefundObjectCustomFields"}],"title":"refunds"}},"components/schemas/GETRefundCollectionType":{"id":"components/schemas/GETRefundCollectionType","kind":"json-schema","title":"GETRefundCollectionType","data":{"properties":{"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"refunds":{"description":"Container for refunds.\n","items":{"$ref":"#/components/schemas/GETRefundTypewithSuccess"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETRefundType":{"id":"components/schemas/GETRefundType","kind":"json-schema","title":"GETRefundType","data":{"allOf":[{"properties":{"accountId":{"description":"The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.\n","type":"string"},"amount":{"description":"The total amount of the refund.\n","format":"double","type":"number"},"cancelledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was cancelled, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"comment":{"description":"Comments about the refund.\n","type":"string","nullable":true},"createdById":{"description":"The ID of the Zuora user who created the refund.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2017-03-01 15:31:10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of the credit memo that is refunded.\n","type":"string","nullable":true},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"bankAccountAccountingCodeType":{"description":"The type of the accounting code that maps to a bank account in your accounting system.\n","type":"string","nullable":true},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","type":"string","nullable":true},"unappliedPaymentAccountingCodeType":{"description":"The type of the accounting code for the unapplied payment.\n","type":"string","nullable":true}},"type":"object"},"gatewayId":{"description":"The ID of the gateway instance that processes the refund.\n","type":"string","nullable":true},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string","nullable":true},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string","nullable":true},"gatewayResponse":{"description":"The message returned from the payment gateway for the refund. This message is gateway-dependent.\n","type":"string","nullable":true},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the refund. This code is gateway-dependent.\n","type":"string","nullable":true},"gatewayState":{"description":"The status of the refund in the gateway.\n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"id":{"description":"The ID of the refund.\n","type":"string"},"markedForSubmissionOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when a refund was marked and waiting for batch submission to the payment process, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"methodType":{"description":"How an external refund was issued to a customer. \n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"number":{"description":"The unique identification number of the refund.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentId":{"description":"The ID of the payment that is refunded.\n","type":"string"},"paymentMethodId":{"description":"The unique ID of the payment method that the customer used to make the refund.\n","type":"string","nullable":true},"paymentMethodSnapshotId":{"description":"The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.\n","type":"string","nullable":true},"payoutId":{"description":"The payout ID of the refund from the gateway side.\n","type":"string","nullable":true},"reasonCode":{"description":"A code identifying the reason for the transaction.\n","type":"string"},"referenceId":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string","nullable":true},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2017-03-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"refundTransactionTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was issued, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string","nullable":true},"settledOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was settled in the payment processor, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This field is used by the Spectrum gateway only and not applicable to other gateways."},"children":[]}]}]}],"type":"string","nullable":true},"softDescriptor":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string","nullable":true},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string","nullable":true},"status":{"description":"The status of the refund. \n","enum":["Processed","Canceled","Error","Processing"],"type":"string"},"submittedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was submitted, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string","nullable":true},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"type":{"description":"The type of the refund. \n","enum":["External","Electronic"],"type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the refund.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string","example":"2017-03-02 15:36:10"}},"type":"object"},{"$ref":"#/components/schemas/RefundObjectNSFields"},{"$ref":"#/components/schemas/RefundObjectCustomFields"}]}},"components/schemas/PUTRefundType":{"id":"components/schemas/PUTRefundType","kind":"json-schema","title":"PUTRefundType","data":{"allOf":[{"properties":{"comment":{"description":"Comments about the refund.\n","maxLength":255,"minLength":0,"type":"string"},"financeInformation":{"description":"Container for the finance information related to the refund.\n","properties":{"bankAccountAccountingCode":{"description":"The accounting code that maps to a bank account in your accounting system.\n","maxLength":100,"minLength":0,"type":"string"},"transferredToAccounting":{"description":"Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"unappliedPaymentAccountingCode":{"description":"The accounting code for the unapplied payment.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n","type":"string"},"referenceId":{"description":"The transaction ID returned by the payment gateway. Use this field to reconcile refunds between your gateway and Zuora Payments.\n\nYou can only update the reference ID for external refunds.\n","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/RefundObjectNSFields"},{"$ref":"#/components/schemas/RefundObjectCustomFields"}],"example":{"reasonCode":"Other"}}},"components/schemas/RefundPartResponseTypewithSuccess":{"id":"components/schemas/RefundPartResponseTypewithSuccess","kind":"json-schema","title":"parts","data":{"properties":{"amount":{"description":"The amount of the refund part.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the refund part.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund part was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of the credit memo associated with the refund part.\n","type":"string","nullable":true},"id":{"description":"The ID of the refund part.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentId":{"description":"The ID of the payment associated with the refund part.\n","type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the refund part.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund part was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"title":"parts","type":"object"}},"components/schemas/GETRefundPartCollectionType":{"id":"components/schemas/GETRefundPartCollectionType","kind":"json-schema","title":"GETRefundPartCollectionType","data":{"properties":{"parts":{"description":"Container for refund parts.\n","items":{"$ref":"#/components/schemas/RefundPartResponseTypewithSuccess"},"type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/RefundPartResponseType":{"id":"components/schemas/RefundPartResponseType","kind":"json-schema","title":"RefundPartResponseType","data":{"properties":{"amount":{"description":"The amount of the refund part.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the refund part.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund part was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoId":{"description":"The ID of the credit memo associated with the refund part.\n","type":"string","nullable":true},"id":{"description":"The ID of the refund part.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"paymentId":{"description":"The ID of the payment associated with the refund part.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"updatedById":{"description":"The ID of the Zuora user who last updated the refund part.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund part was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/GETRefundItemPartTypewithSuccess":{"id":"components/schemas/GETRefundItemPartTypewithSuccess","kind":"json-schema","title":"itemParts","data":{"properties":{"amount":{"description":"The amount of the refund part item.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the refund part item.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund part item was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoItemId":{"description":"The ID of the credit memo item associated with the refund part item.\n","type":"string","nullable":true},"creditTaxItemId":{"description":"The ID of the credit memo taxation item associated with the refund part item.\n","type":"string","nullable":true},"id":{"description":"The ID of the refund part item.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"updatedById":{"description":"The ID of the Zuora user who last updated the refund part item.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund part item was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"title":"itemParts","type":"object"}},"components/schemas/GETRefundItemPartCollectionType":{"id":"components/schemas/GETRefundItemPartCollectionType","kind":"json-schema","title":"GETRefundItemPartCollectionType","data":{"properties":{"itemParts":{"description":"Container for refund part items.\n","items":{"$ref":"#/components/schemas/GETRefundItemPartTypewithSuccess"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETRefundItemPartType":{"id":"components/schemas/GETRefundItemPartType","kind":"json-schema","title":"GETRefundItemPartType","data":{"properties":{"amount":{"description":"The amount of the refund part item.\n","format":"double","type":"number"},"createdById":{"description":"The ID of the Zuora user who created the refund part item.\n","type":"string"},"createdDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund part item was created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01 15:31:10."},"children":[]}]}]}],"type":"string"},"creditMemoItemId":{"description":"The ID of the credit memo item associated with the refund part item.\n","type":"string","nullable":true},"creditTaxItemId":{"description":"The ID of the credit memo taxation item associated with the refund part item.\n","type":"string","nullable":true},"id":{"description":"The ID of the refund part item.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"updatedById":{"description":"The ID of the Zuora user who last updated the refund part item.\n","type":"string"},"updatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the refund part item was last updated, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-02 15:36:10."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/GETCycleElementAttemptResponse":{"id":"components/schemas/GETCycleElementAttemptResponse","kind":"json-schema","title":"RetryAttempt","data":{"type":"object","title":"RetryAttempt","properties":{"attempt_number":{"type":"number","description":"The number of the retry attempt.\n"},"zuora_payment_id":{"type":"string","description":"The ID of the payment in Zuora Payments.\n"},"time_of_execution":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the retry attempt was made, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"source":{"type":"string","description":"The number of the failed payment run.\n"},"cpr_generated":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the first retry attempt was generated by Configurable Payment Retry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the cases of the first retry attempt generated by CPR and the second or later attempt."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the cases that the retry attempt was made by the payment run or an external source during retry cycles."},"children":[]}]}]}]},"success":{"type":"boolean","description":"Indicates whether the retry attempt is successful.\n"},"amount_collected":{"type":"number","description":"The amount collected in this retry attempt.\n"},"action_info":{"type":"object","description":"Information about the action of the retry attempt.\n","properties":{"action":{"type":"string","description":"The action taken in the retry attempt.\n"}}},"retry_info":{"type":"object","description":"Information about the next retry attempt.\n","properties":{"next":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the next retry attempt as determined by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"criteria":{"type":"string","description":"The criteria defined in the retry configuration in the CPR UI, to specify whether the next retry will occur in an incremental time or at a specific time or day.\n"}}},"mapping_info":{"type":"object","description":"Information about the response code mapping for the retry attempt.\n","properties":{"label":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response code label, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Hard Decline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Soft Decline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"System Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or custom labels."},"children":[]}]}]}]},"level":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response code level for the payment gateway, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"customer_group_id":{"type":"number","description":"The ID of the customer group.\n"}}},"gateway_info":{"type":"object","description":"Information about the payment gateway.\n","properties":{"id":{"type":"string","description":"The ID of the payment gateway.\n"},"code":{"type":"string","description":"The response code from the gateway.\n"},"response":{"type":"string","description":"The response message from the gateway.\n"}}}}}},"components/schemas/GETInvoiceCycleElementResponse":{"id":"components/schemas/GETInvoiceCycleElementResponse","kind":"json-schema","title":"RetryCycle","data":{"type":"object","title":"RetryCycle","properties":{"account_id":{"type":"string","description":"The ID of the customer account.\n"},"invoice_id":{"type":"string","description":"The ID of the invoice.\n"},"payment_method_id":{"type":"string","description":"The ID of the payment method.\n"},"currency":{"type":"string","description":"The type of the currency used.\n"},"status":{"type":"string","description":"The status of the retry cycle.\n"},"current_attempt_number":{"type":"number","description":"The number of the current retry attempt.\n"},"next_attempt":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the next retry attempt, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"customer_group":{"type":"string","description":"The name of the customer group.\n"},"attempts":{"type":"array","description":"An array containing information of the retry attempts that have been made. See the schema and example for details.\n","items":{"$ref":"#/components/schemas/GETCycleElementAttemptResponse"}}}}},"components/schemas/GETActiveInvoiceCycleResponse":{"id":"components/schemas/GETActiveInvoiceCycleResponse","kind":"json-schema","title":"GETActiveInvoiceCycleResponse","data":{"type":"object","properties":{"cycles":{"type":"array","items":{"$ref":"#/components/schemas/GETInvoiceCycleElementResponse"},"description":"An array containing information of all active retry cycles for an invoice. See the schema and example for details.\n"}},"example":{"cycles":[{"account_id":"2c92c0f96bd69165016bdccdd6ce2f29","invoice_id":"2c92c0f8778bf8cd017798168cb50e0b","payment_method_id":"2c92c0f9774f2b3e01775f6f06d87b61","currency":"USD","status":"Cycle Incomplete","current_attempt_number":2,"next_attempt":"2021-04-01T19:27:34.648Z","customer_group":"All Remaining Customers","attempts":[{"attempt_number":1,"zuora_payment_id":"2c92c0867849d42301784bc9ca076c21","time_of_execution":"2021-03-19T18:42:20.103Z","source":"PR-00000371","cpr_generated":false,"success":false,"amount_collected":"0.0","action_info":{"action":"Retry"},"retry_info":{"next":"2021-04-01T19:27:34.648-09:00","criteria":"incremental_time"},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}},{"attempt_number":2,"zuora_payment_id":"2c92c09c7849d3c101784bce0d0a06d5","time_of_execution":"2021-03-19T18:52:24.137Z","source":"PR-00000372","cpr_generated":true,"success":false,"amount_collected":"0.0","action_info":{"action":"Retry"},"retry_info":{"next":"2021-03-19T09:53:39.845-09:00","criteria":"incremental_time"},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}}]}]}}},"components/schemas/GETDebitMemoCycleElementResponse":{"id":"components/schemas/GETDebitMemoCycleElementResponse","kind":"json-schema","title":"RetryCycle","data":{"type":"object","title":"RetryCycle","properties":{"account_id":{"type":"string","description":"The ID of the customer account.\n"},"debit_memo_id":{"type":"string","description":"The ID of the debit memo.\n"},"payment_method_id":{"type":"string","description":"The ID of the payment method.\n"},"currency":{"type":"string","description":"The type of the currency used.\n"},"status":{"type":"string","description":"The status of the retry cycle.\n"},"current_attempt_number":{"type":"number","description":"The number of the current retry attempt.\n"},"next_attempt":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the next retry attempt, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"customer_group":{"type":"string","description":"The name of the customer group.\n"},"attempts":{"type":"array","description":"An array containing information of the retry attempts that have been made. See the schema and example for details.\n","items":{"$ref":"#/components/schemas/GETCycleElementAttemptResponse"}}}}},"components/schemas/GETActiveDebitMemoCycleResponse":{"id":"components/schemas/GETActiveDebitMemoCycleResponse","kind":"json-schema","title":"GETActiveDebitMemoCycleResponse","data":{"type":"object","properties":{"cycles":{"type":"array","items":{"$ref":"#/components/schemas/GETDebitMemoCycleElementResponse"},"description":"An array containing information of all active retry cycles for a debit memo. See the schema and example for details.\n"}},"example":{"cycles":[{"account_id":"2c92c0f868e161e70168e25eb51d755f","debit_memo_id":"2c92c0fa7853052701785a38f3bb267f","payment_method_id":"2c92c0f8774f1afe01775f6e533c4c06","currency":"USD","status":"Cycle Incomplete","current_attempt_number":2,"next_attempt":"2021-04-01T10:22:57.464Z","customer_group":"All Remaining Customers","attempts":[{"attempt_number":1,"zuora_payment_id":"2c92c085785305e201785a51af791979","time_of_execution":"2021-03-23T16:50:18.878Z","source":"PR-00000376","cpr_generated":false,"success":false,"amount_collected":"0.0","action_info":{"action":"Retry"},"retry_info":{"next":"2021-03-23T07:51:30.380-09:00","criteria":"incremental_time"},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}},{"attempt_number":2,"zuora_payment_id":"2c92c0857881cf3e01788ee263b0331c","time_of_execution":"2021-04-01T19:21:55.207Z","source":"PR-00000380","cpr_generated":true,"success":false,"amount_collected":"0.0","action_info":{"action":"Retry"},"retry_info":{"next":"2021-04-01T10:22:57.464-09:00","criteria":"incremental_time"},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}}]}]}}},"components/schemas/GETAccountCycleElementResponse":{"id":"components/schemas/GETAccountCycleElementResponse","kind":"json-schema","title":"RetryCycle","data":{"type":"object","title":"RetryCycle","properties":{"account_id":{"type":"string","description":"The ID of the customer account.\n"},"invoice_id":{"type":"string","description":"The ID of the invoice.\n"},"debit_memo_id":{"type":"string","description":"The ID of the debit memo.\n"},"payment_method_id":{"type":"string","description":"The ID of the payment method.\n"},"currency":{"type":"string","description":"The type of the currency used.\n"},"status":{"type":"string","description":"The status of the retry cycle.\n"},"current_attempt_number":{"type":"number","description":"The number of the current retry attempt.\n"},"next_attempt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the next retry attempt, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"customer_group":{"type":"string","description":"The name of the customer group.\n"},"attempts":{"type":"array","description":"An array containing information of the retry attempts that have been made. See the schema and example for details.\n","items":{"$ref":"#/components/schemas/GETCycleElementAttemptResponse"}}}}},"components/schemas/GETActiveAccountCycleResponse":{"id":"components/schemas/GETActiveAccountCycleResponse","kind":"json-schema","title":"GETActiveAccountCycleResponse","data":{"type":"object","properties":{"cycles":{"type":"array","items":{"$ref":"#/components/schemas/GETAccountCycleElementResponse"},"description":"An array containing information of all active retry cycles for an account. See the schema and example for details.\n"}},"example":{"cycles":[{"account_id":"2c92c0f96bd69165016bdccdd6ce2f29","debit_memo_id":"2c92c0fb78532b0001785a38f6427976","payment_method_id":"2c92c0f9774f2b3e01775f6f06d87b61","currency":"USD","status":"Cycle Incomplete","current_attempt_number":1,"next_attempt":"2021-04-01T19:27:34.473Z","customer_group":"All Remaining Customers","attempts":[{"attempt_number":1,"zuora_payment_id":"2c92c085785305e201785a5199a6192d","time_of_execution":"2021-03-23T16:50:18.878Z","source":"PR-00000376","cpr_generated":false,"success":false,"amount_collected":"0.0","action_info":{"action":"Retry"},"retry_info":{"next":"2021-03-23T07:51:27.521-09:00","criteria":"incremental_time"},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}}]},{"account_id":"2c92c0f96bd69165016bdccdd6ce2f29","invoice_id":"2c92c0fa7853052701785a38c6622473","payment_method_id":"2c92c0f9774f2b3e01775f6f06d87b61","currency":"USD","status":"Cycle Incomplete","current_attempt_number":1,"next_attempt":"2021-04-01T19:27:34.436Z","customer_group":"All Remaining Customers","attempts":[{"attempt_number":1,"zuora_payment_id":"2c92c085785305e201785a519d85193b","time_of_execution":"2021-03-23T16:50:18.878Z","source":"PR-00000376","cpr_generated":false,"success":false,"amount_collected":"0.0","action_info":{"action":"Retry"},"retry_info":{"next":"2021-03-23T07:51:28.161-09:00","criteria":"incremental_time"},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}}]}]}}},"components/schemas/GETInvoiceCycleHistoryResponse":{"id":"components/schemas/GETInvoiceCycleHistoryResponse","kind":"json-schema","title":"GETInvoiceCycleHistoryResponse","data":{"type":"object","properties":{"cycles":{"type":"array","items":{"$ref":"#/components/schemas/GETInvoiceCycleElementResponse"},"description":"An array containing information of all completed retry cycles for an invoice. See the example for details.\n"}},"example":{"cycles":[{"account_id":"2c92c0f96bd69165016bdcbf55ad5e62","invoice_id":"2c92c0fa7849b3ff01784bc5e8ee18b5","payment_method_id":"2c92c0f9774f2b3e01775f6cf2fb726a","currency":"USD","status":"Cycle Complete","current_attempt_number":1,"next_attempt":null,"customer_group":"Testing Group","attempts":[{"attempt_number":1,"zuora_payment_id":"2c92c0867849d42301784bc9ce806c31","time_of_execution":"2021-04-01T19:11:21.639Z","source":"PR-00000370","cpr_generated":false,"success":false,"amount_collected":"0.0","action_info":{"action":"Stop"},"retry_info":{},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":5},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}}]},{"account_id":"2c92c0f96bd69165016bdcbf55ad5e62","invoice_id":"2c92c0fa7849b3ff01784bc5e8ee18b5","payment_method_id":"2c92c0f9774f2b3e01775f6cf2fb726a","currency":"USD","status":"Cycle Complete","current_attempt_number":2,"next_attempt":null,"customer_group":"All Remaining Customers","attempts":[{"attempt_number":1,"zuora_payment_id":"2c92c0867849d42301784bc9ce806c31","time_of_execution":"2021-03-19T18:42:20.103Z","source":"PR-00000371","cpr_generated":false,"success":false,"amount_collected":"0.0","action_info":{"action":"Retry"},"retry_info":{"next":"2021-03-19T09:43:28.670-09:00","criteria":"incremental_time"},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}},{"attempt_number":2,"zuora_payment_id":"2c92c09c7849d3c101784bcdfc010671","time_of_execution":"2021-03-19T18:52:24.137Z","source":"PR-00000372","cpr_generated":true,"success":false,"amount_collected":"0.0","action_info":{"action":"Stop"},"retry_info":{},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}}]}]}}},"components/schemas/GETDebitMemoCycleHistoryResponse":{"id":"components/schemas/GETDebitMemoCycleHistoryResponse","kind":"json-schema","title":"GETDebitMemoCycleHistoryResponse","data":{"type":"object","properties":{"cycles":{"type":"array","items":{"$ref":"#/components/schemas/GETDebitMemoCycleElementResponse"},"description":"An array containing information of all completed retry cycles for a debit memo. See the example for details.\n"}},"example":{"cycles":[{"account_id":"2c92c0f868e161e70168e25eb51d755f","debit_memo_id":"2c92c0fa7853052701785a38f3bb267f","payment_method_id":"2c92c0f8774f1afe01775f6e533c4c06","currency":"USD","status":"Cycle Complete","current_attempt_number":2,"next_attempt":null,"customer_group":"All Remaining Customers","attempts":[{"attempt_number":1,"zuora_payment_id":"2c92c085785305e201785a51af791979","time_of_execution":"2021-03-23T16:50:18.878Z","source":"PR-00000376","cpr_generated":false,"success":false,"amount_collected":"0.0","action_info":{"action":"Retry"},"retry_info":{"next":"2021-03-23T07:51:30.380-09:00","criteria":"incremental_time","api_updated_retry_time":"2021-03-26T14:27:21.107-04:00"},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}},{"attempt_number":2,"zuora_payment_id":"2c92c0857881cf3e01788ee263b0331c","time_of_execution":"2021-04-01T19:21:55.207Z","source":"PR-00000378","cpr_generated":true,"success":false,"amount_collected":"0.0","action_info":{"action":"Stop"},"retry_info":{},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}}]}]}}},"components/schemas/GETAccountCycleHistoryResponse":{"id":"components/schemas/GETAccountCycleHistoryResponse","kind":"json-schema","title":"GETAccountCycleHistoryResponse","data":{"type":"object","properties":{"cycles":{"type":"array","items":{"$ref":"#/components/schemas/GETAccountCycleElementResponse"},"description":"An array containing information of all completed retry cycles for an account. See the example for details.\n"}},"example":{"cycles":[{"account_id":"2c92c0f96bd69165016bdcbf55ad5e62","invoice_id":"2c92c0fa7849b3ff01784bc5e8ee18b5","payment_method_id":"2c92c0f9774f2b3e01775f6cf2fb726a","currency":"USD","status":"Cycle Complete","current_attempt_number":3,"next_attempt":"2021-03-19T18:53:39.641Z","customer_group":"All Remaining Customers","attempts":[{"attempt_number":1,"zuora_payment_id":"2c92c0867849d42301784bc9ce806c31","time_of_execution":"2021-03-19T18:42:20.103Z","source":"PR-00000371","cpr_generated":false,"success":false,"amount_collected":"0.0","action_info":{"action":"Retry"},"retry_info":{"next":"2021-03-19T09:43:28.670-09:00","criteria":"incremental_time"},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}},{"attempt_number":2,"zuora_payment_id":"2c92c09c7849d3c101784bcdfc010671","time_of_execution":"2021-03-19T18:52:24.137Z","source":"PR-00000372","cpr_generated":true,"success":false,"amount_collected":"0.0","action_info":{"action":"Stop"},"retry_info":{},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}}]},{"account_id":"2c92c0f96bd69165016bdcbf55ad5e62","invoice_id":"2c92c0fb78532b0f01785a38cede190a","payment_method_id":"2c92c0f9774f2b3e01775f6cf2fb726a","currency":"USD","status":"Cycle Incomplete","current_attempt_number":1,"next_attempt":"2021-03-24T19:34:20.254Z","customer_group":"All Remaining Customers","attempts":[{"attempt_number":1,"zuora_payment_id":"2c92c085785305e201785a51aae41969","time_of_execution":"2021-03-23T16:50:18.878Z","source":"PR-00000376","cpr_generated":false,"success":false,"amount_collected":"0.0","action_info":{"action":"Retry"},"retry_info":{"next":"2021-03-23T07:51:30.316-09:00","criteria":"incremental_time"},"mapping_info":{"label":"Hard Decline","level":"code","customer_group_id":1},"gateway_info":{"id":"2c92c0f85e2d19af015e3a61d8947e5d","code":"insufficient_funds","response":"Your card has insufficient funds."}}]}]}}},"components/schemas/GETBaselineMetricsResponse":{"id":"components/schemas/GETBaselineMetricsResponse","kind":"json-schema","title":"GETBaselineMetricsResponse","data":{"type":"object","properties":{"retry_success_rate":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of successful payment attempts for all customer groups on this Configurable Payment Retry instance so far."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry Success Rate = Number of successful retry payment attempts / Total number of retry payments attempted"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment attempts here are any payment attempts executed by Configurable Payment Retry, excluding the initial payment run."},"children":[]}]}]}]},"retry_success_rate_trend":{"type":"string","description":"The trend of change in Retry Success Rate over the last 30 days.\n"},"document_success_rate":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of billing documents that are successfully collected, for all customer groups on this Configurable Payment Retry instance so far."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document Success Rate = Number of billing documents collected / Total number of billing documents attempted"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing documents collected are any invoices and debit memos that were paid through the payment attempt initiated by Configurable Payment Retry."},"children":[]}]}]}]},"document_success_rate_trend":{"type":"string","description":"The trend of change in Document Success Rate over the last 30 days.\n"},"average_days_outstanding":{"type":"number","description":"The average number of days invoices and debit memos are unpaid before collection, for all customer groups on this Configurable Payment Retry instance so far.\n"},"average_days_outstanding_trend":{"type":"string","description":"The trend of change in Average Days Outstanding over the last 30 days.\n"},"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the metrics are retrieved successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no data is loaded yet, a 200 response code will be returned with the success field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All expected fields will be present but the value will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"example":{"retry_success_rate":"11.90","retry_success_rate_trend":"down","document_success_rate":"13.54","document_success_rate_trend":"neutral","average_days_outstanding":"4.76","average_days_outstanding_trend":"up","success":true}}},"components/schemas/GETAmountRecoveredResponse":{"id":"components/schemas/GETAmountRecoveredResponse","kind":"json-schema","title":"GETAmountRecoveredResponse","data":{"type":"object","properties":{"currency":{"type":"array","items":{"type":"object"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array containing the following information for each available currency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no payment of a given currency has been processed over the last 30 days, the currency will not appear in the array."},"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 total amount recovered to date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount recovered over the last 30 days"},"children":[]}]}]}]}]},"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the metrics are retrieved successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no data is loaded yet, a 200 response code will be returned with the success field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All expected fields will be present but the value will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"example":{"currency":{"USD":{"total_amount":"77515.21","last_30_days":"1100.01"},"EUR":{"total_amount":"337.19","last_30_days":"17.17"},"CAD":{"total_amount":"123954.10","last_30_days":"5132.87"}},"success":true}}},"components/schemas/GETDocumentSuccessRateByCustomerGroupResponse":{"id":"components/schemas/GETDocumentSuccessRateByCustomerGroupResponse","kind":"json-schema","title":"GETDocumentSuccessRateByCustomerGroupResponse","data":{"type":"object","properties":{"customer_groups":{"type":"array","items":{"type":"object"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array containing the Document Success Rate timeseries for each customer group represented by the customer group ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A timeseries over the past 6 months is present in the format of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<month_year>: <document_success_rate>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The data of the current month is not included. For example, if it is April 15th today, the data for April will not be included. Data for March and earlier will be shown."},"children":[]}]}]}]},"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the metrics are retrieved successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no data is loaded yet, a 200 response code will be returned with the success field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All expected fields will be present but the value will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"example":{"customer_groups":{"1":{"05_21":"17.53","04_21":"13.21","03_21":"14.92","02_21":"8.99","01_21":"34.25","12_20":"12.30"},"2":{"05_21":"11.11","04_21":"7.87","03_21":"26.00","02_21":"11.06","01_21":"13.43","12_20":"17.92"},"4":{"05_21":"11.13","04_21":"9.17","03_21":"17.20","02_21":"19.06","01_21":"12.43","12_20":"15.92"}},"success":true}}},"components/schemas/GETCustomerGroupMetricsResponse":{"id":"components/schemas/GETCustomerGroupMetricsResponse","kind":"json-schema","title":"GETCustomerGroupMetricsResponse","data":{"type":"object","properties":{"customer_groups":{"type":"array","items":{"type":"object"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array containing the following information for each customer group."},"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":"Customer group ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer group name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether Smart Retry is enabled for this customer group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document Success Rate indicating the percentage of billing documents that are successfully collected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The trend of change in Document Success Rate over the last 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry Success Rate indicating the percentage of the successful payment attempts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Average Attempts indicating the average number of attempts required to recover funds"},"children":[]}]}]}]}]},"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the metrics are retrieved successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no data is loaded yet, a 200 response code will be returned with the success field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All expected fields will be present but the value will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"example":{"customer_groups":[{"id":1,"name":"batch22","smart_retry":false,"document_success_rate":"17.17","document_success_rate_trend":"up","retry_success_rate":"21.76","average_attempts":"4.11"},{"id":2,"name":"Smart Retry","smart_retry":true,"document_success_rate":"74.17","document_success_rate_trend":"down","retry_success_rate":"81.21","average_attempts":"1.32"},{"id":4,"name":"All Remaining Customers","smart_retry":false,"document_success_rate":"16.35","document_success_rate_trend":"up","retry_success_rate":"15.21","average_attempts":"3.32"}],"success":true}}},"components/schemas/SummaryStatementRunRequestType":{"id":"components/schemas/SummaryStatementRunRequestType","kind":"json-schema","title":"SummaryStatementRunRequestType","data":{"type":"object","properties":{"runType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled type of the run which can either be AdHoc or Scheduled. Currently, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdHoc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]}],"enum":["AdHoc"],"type":"string"},"targetAccountCategory":{"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 account filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the filter type is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllAccounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountsWithOpenInvoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountsWithOpenBalances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountsWithoutInvoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountsWithoutInvoicesAndOpenBalances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can further refine the filter using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"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":"However, these criteria are not applicable when the filter type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SingleAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SingleAccount","AllAccounts","AccountsWithOpenInvoices","AccountsWithOpenBalances","AccountsWithoutInvoices","AccountsWithoutInvoicesAndOpenBalances"],"type":"string"},"accountKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The related account ID or account number when the filter type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SingleAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"batchName":{"description":"The batch name used for filtering accounts, for example, Batch1.\n","type":"string"},"billCycleDay":{"description":"The bill cycle day for filtering accounts, with values ranging from '01' to '31'.\n","nullable":true,"type":"string"},"dateRangeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date range for the statement."},"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":"PreviousThreeCalendarMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PreviousOneCalendarMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, the start and end dates are automatically calculated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PreviousThreeCalendarMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is chosen today (2024-08-20), the dates would be 2024-05-01 to 2024-07-31."},"children":[]}]}]}],"enum":["Custom","PreviousThreeCalendarMonth","PreviousOneCalendarMonth"],"type":"string"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected for the date range. The start date can be set to a maximum of 5 years in the past and must follow the format YYYY-MM-DD."},"children":[]}]}]}],"format":"date","type":"string"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a statement run, this field cannot be manually entered. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, the end date automatically defaults to today’s date in the tenant’s timezone."},"children":[]}]}]}],"format":"date","type":"string"},"autoEmailEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to send an email after a statement is generated. Acceptable values are "},"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":". If unspecified, the default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"description":{"description":"A text description of the statement run.\n","type":"string"}},"required":["runType","targetAccountCategory","dateRangeType"]}},"components/schemas/SummaryStatementRunResponse":{"id":"components/schemas/SummaryStatementRunResponse","kind":"json-schema","title":"SummaryStatementRunResponse","data":{"properties":{"id":{"description":"The unique identifier for the statement run.\n","type":"string"},"statementRunNumber":{"description":"The number of the statement run.\n","type":"string"},"runType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled type of the run which can either be AdHoc or Scheduled. Currently, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdHoc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]}],"enum":["AdHoc"],"type":"string"},"targetAccountCategory":{"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 account filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the filter type is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllAccounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountsWithOpenInvoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountsWithOpenBalances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountsWithoutInvoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountsWithoutInvoicesAndOpenBalances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can further refine the filter using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"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":"However, these criteria are not applicable when the filter type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SingleAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SingleAccount","AllAccounts","AccountsWithOpenInvoices","AccountsWithOpenBalances","AccountsWithoutInvoices","AccountsWithoutInvoicesAndOpenBalances"],"type":"string"},"accountKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the filter type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SingleAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field contains the related account ID."},"children":[]}]}]}],"type":"string","nullable":true},"batchName":{"description":"The name of the batch used for filtering accounts.\n","type":"string"},"billCycleDay":{"description":"The bill cycle day for filtering accounts, with values ranging from '01' to '31'.\n","type":"string","nullable":true},"dateRangeType":{"description":"The date range for the statement.\n","enum":["PreviousThreeCalendarMonth","PreviousOneCalendarMonth","PreviousOneCalendarMonth"],"type":"string"},"startDate":{"description":"The start date.\n","format":"date","type":"string"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date, which defaults to today’s date when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected. This field cannot be manually entered."},"children":[]}]}]}],"format":"date","type":"string"},"autoEmailEnabled":{"description":"Indicates whether to send an email after a statement is generated. \n","type":"boolean"},"description":{"description":"A text description of the statement run.\n","type":"string"},"status":{"description":"The status of the run.\n","enum":["Pending","Processing","Completed","Error","Terminated"],"type":"string"},"createdById":{"description":"The ID of the user who created the statement run.\n","type":"string"},"createdDate":{"description":"The date and time the statement run was created.\n","type":"string","format":"dateTime"},"success":{"description":"Indicates whether the operation was successful.\n","type":"boolean"},"updatedById":{"description":"The ID of the user who last updated the statement run.\n","type":"string"},"updatedDate":{"description":"The date the statement run was last updated.\n","type":"string","format":"dateTime"}},"type":"object"}},"components/schemas/SegmentConstantValuesCustomFields":{"id":"components/schemas/SegmentConstantValuesCustomFields","kind":"json-schema","title":"segmentConstantValues","data":{"description":"Segment constant values. The field is available only if you have GL Segmentation 2.0 enabled.\n\nThis field is additional property.\n","title":"segmentConstantValues","type":"object"}},"components/schemas/AccountingCodeObjectCustomFields":{"id":"components/schemas/AccountingCodeObjectCustomFields","kind":"json-schema","title":"accountingCodeFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Accounting Code object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Accounting Code object.\n","title":"accountingCodeFieldsCustom","type":"object"}},"components/schemas/GETAccountingCodeItemWithoutSuccessType":{"id":"components/schemas/GETAccountingCodeItemWithoutSuccessType","kind":"json-schema","title":"accountingCodes","data":{"allOf":[{"properties":{"category":{"description":"The category associated with the accounting code.\n","enum":["Assets","Liabilities","Equity","Revenue","Expenses"],"type":"string"},"createdBy":{"description":"The ID of the user who created the accounting code.\n","type":"string"},"createdOn":{"description":"Date and time when the accounting code was created.\n","type":"string"},"glAccountName":{"description":"Name of the account in your general ledger.\n\nField only available if you have Zuora Finance enabled.\n","type":"string","nullable":true},"glAccountNumber":{"description":"Account number in your general ledger.\n\nField only available if you have Zuora Finance enabled.\n","type":"string","nullable":true},"id":{"description":"ID of the accounting code.\n","type":"string"},"name":{"description":"Name of the accounting code.\n","type":"string"},"notes":{"description":"Any optional notes for the accounting code.\n","type":"string","nullable":true},"status":{"description":"The accounting code status.\n","enum":["Active","Inactive"],"type":"string"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting code type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnAccountReceivable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available if you enable the Invoice Settlement feature."},"children":[]}]}]}],"enum":["AccountsReceivable","OnAccountReceivable","Cash","OtherAssets","CustomerCashOnAccount","DeferredRevenue","SalesTaxPayable","OtherLiabilities","SalesRevenue","SalesDiscounts","OtherRevenue","OtherEquity","BadDebt","OtherExpenses"],"type":"string"},"updatedBy":{"description":"The ID of the user who last updated the accounting code.\n","type":"string"},"updatedOn":{"description":"Date and time when the accounting code was last updated.\n","type":"string"},"segmentConstantValues":{"$ref":"#/components/schemas/SegmentConstantValuesCustomFields"}},"type":"object"},{"$ref":"#/components/schemas/AccountingCodeObjectCustomFields"}],"title":"accountingCodes"}},"components/schemas/GETAccountingCodesType":{"id":"components/schemas/GETAccountingCodesType","kind":"json-schema","title":"GETAccountingCodesType","data":{"properties":{"accountingCodes":{"description":"An array of all the accounting codes in your chart of accounts. Each accounting code has the following fields.\n","items":{"$ref":"#/components/schemas/GETAccountingCodeItemWithoutSuccessType"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/POSTAccountingCodeType":{"id":"components/schemas/POSTAccountingCodeType","kind":"json-schema","title":"POSTAccountingCodeType","data":{"allOf":[{"properties":{"glAccountName":{"description":"Name of the account in your general ledger.\n\nField only available if you have Zuora Finance enabled. Maximum of 255 characters.\n","type":"string"},"glAccountNumber":{"description":"Account number in your general ledger.\n\nField only available if you have Zuora Finance enabled. Maximum of 255 characters.\n","type":"string"},"name":{"description":"Name of the accounting code.\n\nAccounting code name must be unique. Maximum of 100 characters.\n","type":"string"},"notes":{"description":"Maximum of 2,000 characters.\n","type":"string"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to create multiple accounting codes of the type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountsReceivable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you need to have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-item-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Item Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access the Multiple AR Accounting Codes feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnAccountReceivable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available if you enable the Invoice Settlement feature."},"children":[]}]}]}],"enum":["AccountsReceivable","OnAccountReceivable","Cash","OtherAssets","CustomerCashOnAccount","DeferredRevenue","SalesTaxPayable","OtherLiabilities","SalesRevenue","SalesDiscounts","OtherRevenue","OtherEquity","BadDebt","OtherExpenses"],"type":"string"},"segmentConstantValues":{"$ref":"#/components/schemas/SegmentConstantValuesCustomFields"}},"required":["name","type"],"type":"object"},{"$ref":"#/components/schemas/AccountingCodeObjectCustomFields"}],"example":{"name":"CASH","type":"Cash"}}},"components/schemas/POSTAccountingCodeResponseType":{"id":"components/schemas/POSTAccountingCodeResponseType","kind":"json-schema","title":"POSTAccountingCodeResponseType","data":{"properties":{"id":{"description":"ID of the newly created accounting code.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETAccountingCodeItemType":{"id":"components/schemas/GETAccountingCodeItemType","kind":"json-schema","title":"GETAccountingCodeItemType","data":{"allOf":[{"properties":{"category":{"description":"The category associated with the accounting code.\n","enum":["Assets","Liabilities","Equity","Revenue","Expenses"],"type":"string"},"createdBy":{"description":"The ID of the user who created the accounting code.\n","type":"string"},"createdOn":{"description":"Date and time when the accounting code was created.\n","type":"string"},"glAccountName":{"description":"Name of the account in your general ledger.\n\nField only available if you have Zuora Finance enabled.\n","type":"string","nullable":true},"glAccountNumber":{"description":"Account number in your general ledger.\n\nField only available if you have Zuora Finance enabled.\n","type":"string","nullable":true},"id":{"description":"ID of the accounting code.\n","type":"string"},"name":{"description":"Name of the accounting code.\n","type":"string"},"notes":{"description":"Any optional notes for the accounting code.\n","type":"string","nullable":true},"status":{"description":"The accounting code status.\n","enum":["Active","Inactive"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting code type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnAccountReceivable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available if you enable the Invoice Settlement feature."},"children":[]}]}]}],"enum":["AccountsReceivable","OnAccountReceivable","Cash","OtherAssets","CustomerCashOnAccount","DeferredRevenue","SalesTaxPayable","OtherLiabilities","SalesRevenue","SalesDiscounts","OtherRevenue","OtherEquity","BadDebt","OtherExpenses"],"type":"string"},"updatedBy":{"description":"The ID of the user who last updated the accounting code.\n","type":"string"},"updatedOn":{"description":"Date and time when the accounting code was last updated.\n","type":"string"},"segmentConstantValues":{"$ref":"#/components/schemas/SegmentConstantValuesCustomFields"}},"type":"object"},{"$ref":"#/components/schemas/AccountingCodeObjectCustomFields"}]}},"components/schemas/PUTAccountingCodeType":{"id":"components/schemas/PUTAccountingCodeType","kind":"json-schema","title":"PUTAccountingCodeType","data":{"allOf":[{"properties":{"glAccountName":{"description":"Name of the account in your general ledger.\n\nField only available if you have Zuora Finance enabled. Maximum of 255 characters.\n","type":"string"},"glAccountNumber":{"description":"Account number in your general ledger.\n\nField only available if you have Zuora Finance enabled. Maximum of 255 characters.\n","type":"string"},"name":{"description":"Name of the accounting code.\n\nAccounting code name must be unique. Maximum of 100 characters.\n","type":"string"},"notes":{"description":"Maximum of 2,000 characters.\n","type":"string"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting code type. You cannot change the type of an accounting code from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountsReceivable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a different type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnAccountReceivable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available if you enable the Invoice Settlement feature."},"children":[]}]}]}],"enum":["AccountsReceivable","OnAccountReceivable","Cash","OtherAssets","CustomerCashOnAccount","DeferredRevenue","SalesTaxPayable","OtherLiabilities","SalesRevenue","SalesDiscounts","OtherRevenue","OtherEquity","BadDebt","OtherExpenses"],"type":"string"},"segmentConstantValues":{"$ref":"#/components/schemas/SegmentConstantValuesCustomFields"}},"type":"object"},{"$ref":"#/components/schemas/AccountingCodeObjectCustomFields"}],"example":{"notes":"Details of the accounting code"}}},"components/schemas/AccountingPeriodObjectCustomFields":{"id":"components/schemas/AccountingPeriodObjectCustomFields","kind":"json-schema","title":"accountingPeriodFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Accounting Period object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of an Accounting Period object.\n","title":"accountingPeriodFieldsCustom","type":"object"}},"components/schemas/GETAccountingPeriodWithoutSuccessType":{"id":"components/schemas/GETAccountingPeriodWithoutSuccessType","kind":"json-schema","title":"accountingPeriods","data":{"allOf":[{"properties":{"createdBy":{"description":"ID of the user who created the accounting period.\n","type":"string"},"createdOn":{"description":"Date and time when the accounting period was created.\n","type":"string"},"endDate":{"description":"The end date of the accounting period.\n","format":"date","type":"string","nullable":true},"fileIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File IDs of the reports available for the accounting period. You can retrieve the reports by specifying the file ID in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_Files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" REST API call."},"children":[]}]}]}],"properties":{"accountsReceivableAccountAgingDetailExportFileId":{"description":"File ID of the Accounts Receivable Aging Account Detail report.\n","type":"string","nullable":true},"accountsReceivableInvoiceAgingDetailExportFileId":{"description":"File ID of the Accounts Receivable Aging Invoice Detail report.\n","type":"string","nullable":true},"arRollForwardDetailExportFileId":{"description":"File ID of the Accounts Receivable Detail report.\n","type":"string","nullable":true},"fxRealizedGainAndLossDetailExportFileId":{"description":"File ID of the Realized Gain and Loss Detail report.\n\nReturned only if you have Foreign Currency Conversion enabled.\n","type":"string","nullable":true},"fxUnrealizedGainAndLossDetailExportFileId":{"description":"File ID of the Unrealized Gain and Loss Detail report.\n\nReturned only if you have Foreign Currency Conversion enabled\n","type":"string","nullable":true},"revenueDetailCsvFileId":{"description":"File ID of the Revenue Detail report in CSV format.\n","type":"string","nullable":true},"revenueDetailExcelFileId":{"description":"File ID of the Revenue Detail report in XLSX format.\n","type":"string","nullable":true},"unprocessedChargesFileId":{"description":"File ID of a report containing all unprocessed charges for the accounting period.\n","type":"string","nullable":true}},"type":"object"},"fiscalYear":{"description":"Fiscal year of the accounting period.\n","type":"integer"},"fiscalQuarter":{"description":"Fiscal quarter of the accounting period.","type":"integer"},"id":{"description":"ID of the accounting period.\n","type":"string"},"name":{"description":"Name of the accounting period.\n","type":"string"},"notes":{"description":"Any optional notes about the accounting period.\n","type":"string","nullable":true},"organizationLabels":{"description":"The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.            \n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"runTrialBalanceEnd":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time that the trial balance was completed. If the trial balance status is "},"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":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"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":"."},"children":[]}]}]}],"type":"string","nullable":true},"runTrialBalanceErrorMessage":{"description":"If trial balance status is Error, an error message is returned in this field.\n","type":"string","nullable":true},"runTrialBalanceStart":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time that the trial balance was run. If the trial balance status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"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":"."},"children":[]}]}]}],"type":"string","nullable":true},"runTrialBalanceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the trial balance for the accounting period. Possible 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":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]}]}]}]}],"type":"string"},"startDate":{"description":"The start date of the accounting period.\n","format":"date","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 accounting period. Possible 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":"Open"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PendingClose"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]}]}]}]}],"type":"string"},"updatedBy":{"description":"D of the user who last updated the accounting period.\n","type":"string"},"updatedOn":{"description":"Date and time when the accounting period was last updated.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/AccountingPeriodObjectCustomFields"}],"title":"accountingPeriods"}},"components/schemas/GETAccountingPeriodsType":{"id":"components/schemas/GETAccountingPeriodsType","kind":"json-schema","title":"GETAccountingPeriodsType","data":{"properties":{"accountingPeriods":{"description":"An array of all accounting periods on your tenant. The accounting periods are returned in ascending order of start date; that is, the latest period is returned first.\n","items":{"$ref":"#/components/schemas/GETAccountingPeriodWithoutSuccessType"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/POSTAccountingPeriodType":{"id":"components/schemas/POSTAccountingPeriodType","kind":"json-schema","title":"POSTAccountingPeriodType","data":{"allOf":[{"properties":{"endDate":{"description":"The end date of the accounting period in yyyy-mm-dd format, for example, \"2016-02-19\".\n","format":"date","type":"string"},"fiscalYear":{"description":"Fiscal year of the accounting period in yyyy format, for example, \"2016\".\n","type":"integer"},"fiscalQuarter":{"description":"Fiscal quarter of the accounting period. One number between 1 and 4.","type":"integer","minimum":1,"maximum":4},"name":{"description":"Name of the accounting period.\n\nAccounting period name must be unique. Maximum of 100 characters.\n","type":"string"},"notes":{"description":"Notes about the accounting period.\n\nMaximum of 255 characters.\n","type":"string"},"organizationLabels":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization that the accounting period belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each item in the array, either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only required when you have already turned on Multi-Org feature."},"children":[]}]}]}],"items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"startDate":{"description":"The start date of the accounting period in yyyy-mm-dd format, for example, \"2016-02-19\".\n","format":"date","type":"string"}},"required":["name","startDate","endDate","fiscalYear"],"type":"object"},{"$ref":"#/components/schemas/AccountingPeriodObjectCustomFields"}],"example":{"name":"Jun 2016","fiscalYear":2016,"startDate":"2016-06-01","endDate":"2016-06-30"}}},"components/schemas/POSTAccountingPeriodResponseType":{"id":"components/schemas/POSTAccountingPeriodResponseType","kind":"json-schema","title":"POSTAccountingPeriodResponseType","data":{"properties":{"id":{"description":"ID of the newly-created accounting period.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETAccountingPeriodType":{"id":"components/schemas/GETAccountingPeriodType","kind":"json-schema","title":"GETAccountingPeriodType","data":{"allOf":[{"properties":{"createdBy":{"description":"ID of the user who created the accounting period.\n","type":"string"},"createdOn":{"description":"Date and time when the accounting period was created.\n","type":"string"},"endDate":{"description":"The end date of the accounting period.\n","format":"date","type":"string"},"fileIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File IDs of the reports available for the accounting period. You can retrieve the reports by specifying the file ID in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_Files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" REST API call."},"children":[]}]}]}],"properties":{"accountsReceivableAccountAgingDetailExportFileId":{"description":"File ID of the Accounts Receivable Aging Account Detail report.\n","type":"string"},"accountsReceivableInvoiceAgingDetailExportFileId":{"description":"File ID of the Accounts Receivable Aging Invoice Detail report.\n","type":"string"},"accountsReceivableDebitMemoAgingDetailExportFileId":{"description":"File ID of the Accounts Receivable Aging Debit Memo Detail report.\n","type":"string"},"arRollForwardDetailExportFileId":{"description":"File ID of the Accounts Receivable Detail report.\n","type":"string"},"fxRealizedGainAndLossDetailExportFileId":{"description":"File ID of the Realized Gain and Loss Detail report.\n\nReturned only if you have Foreign Currency Conversion enabled.\n","type":"string"},"fxUnrealizedGainAndLossDetailExportFileId":{"description":"File ID of the Unrealized Gain and Loss Detail report.\n\nReturned only if you have Foreign Currency Conversion enabled\n","type":"string"},"revenueDetailCsvFileId":{"description":"File ID of the Revenue Detail report in CSV format.\n","type":"string"},"revenueDetailExcelFileId":{"description":"File ID of the Revenue Detail report in XLSX format.\n","type":"string"},"unprocessedChargesFileId":{"description":"File ID of a report containing all unprocessed charges for the accounting period.\n","type":"string","nullable":true}},"type":"object"},"fiscalYear":{"description":"Fiscal year of the accounting period.\n","type":"integer"},"fiscalQuarter":{"description":"Fiscal quarter of the accounting period.","type":"integer"},"id":{"description":"ID of the accounting period.\n","type":"string"},"name":{"description":"Name of the accounting period.\n","type":"string"},"notes":{"description":"Any optional notes about the accounting period.\n","type":"string"},"organizationLabels":{"description":"The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.            \n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"runTrialBalanceEnd":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time that the trial balance was completed. If the trial balance status is "},"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":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"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":"."},"children":[]}]}]}],"type":"string"},"runTrialBalanceErrorMessage":{"description":"If trial balance status is Error, an error message is returned in this field.\n","type":"string","nullable":true},"runTrialBalanceStart":{"description":"Date and time that the trial balance was run. If the trial balance status is Pending, this field is null.\n","type":"string"},"runTrialBalanceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the trial balance for the accounting period. Possible 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":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]}]}]}]}],"type":"string"},"startDate":{"description":"The start date of the accounting period.\n","format":"date","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 accounting period. Possible 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":"Open"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PendingClose"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]}]}]}]}],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"updatedBy":{"description":"ID of the user who last updated the accounting period.\n","type":"string"},"updatedOn":{"description":"Date and time when the accounting period was last updated.\n","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/AccountingPeriodObjectCustomFields"}]}},"components/schemas/PUTAccountingPeriodType":{"id":"components/schemas/PUTAccountingPeriodType","kind":"json-schema","title":"PUTAccountingPeriodType","data":{"allOf":[{"properties":{"endDate":{"description":"The end date of the accounting period in yyyy-mm-dd format, for example, \"2016-02-19\".\n","format":"date","type":"string"},"fiscalYear":{"description":"Fiscal year of the accounting period in yyyy format, for example, \"2016\".\n","type":"integer"},"fiscalQuarter":{"description":"Fiscal quarter of the accounting period. One number between 1 and 4.","type":"integer","minimum":1,"maximum":4},"name":{"description":"Name of the accounting period.\n\nAccounting period name must be unique. Maximum of 100 characters.\n","type":"string"},"notes":{"description":"Notes about the accounting period.\n\nMaximum of 255 characters.\n","type":"string"},"startDate":{"description":"The start date of the accounting period in yyyy-mm-dd format, for example, \"2016-02-19\".\n","format":"date","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/AccountingPeriodObjectCustomFields"}],"example":{"notes":"Details of the accounting period"}}},"components/schemas/JournalEntryItemObjectCustomFields":{"id":"components/schemas/JournalEntryItemObjectCustomFields","kind":"json-schema","title":"journalEntryItemFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Journal Entry Item object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Journal Entry Item object.\n","title":"journalEntryItemFieldsCustom","type":"object"}},"components/schemas/POSTJournalEntryItemType":{"id":"components/schemas/POSTJournalEntryItemType","kind":"json-schema","title":"journalEntryItems","data":{"allOf":[{"properties":{"accountingCodeName":{"description":"Name of the accounting code.\n","type":"string"},"accountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting code type. This field is required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountingCodeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not unique."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"On-Account Receivable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available if you enable the Invoice Settlement feature."},"children":[]}]}]}],"enum":["AccountsReceivable","On-Account Receivable","Cash","OtherAssets","CustomerCashOnAccount","DeferredRevenue","SalesTaxPayable","OtherLiabilities","SalesRevenue","SalesDiscounts","OtherRevenue","OtherEquity","BadDebt","OtherExpenses"],"type":"string"},"amount":{"description":"Journal entry item amount in transaction currency.\n","format":"decimal","type":"string"},"homeCurrencyAmount":{"description":"Journal entry item amount in home currency.\n\nThis field is required if you have set your home currency for foreign currency conversion. Otherwise, do not pass this field.\n","format":"decimal","type":"string"},"type":{"description":"Type of journal entry item. ","enum":["Credit","Debit"],"type":"string"}},"required":["accountingCodeName","type","amount"],"type":"object"},{"$ref":"#/components/schemas/JournalEntryItemObjectCustomFields"}],"title":"journalEntryItems"}},"components/schemas/POSTJournalEntrySegmentType":{"id":"components/schemas/POSTJournalEntrySegmentType","kind":"json-schema","title":"segments","data":{"properties":{"segmentName":{"description":"Name of segment. You must use the segment name that has already been specified in the default segment rule. In addition, segments need to be passed in the order where they were defined in the segmentation rule. If multiple segments are configured in the default rule, you need to specify all of them in order. ","type":"string"},"segmentValue":{"description":"Value of segment in this summary journal entry.\n","type":"string"}},"required":["segmentName","segmentValue"],"title":"segments","type":"object"}},"components/schemas/JournalEntryObjectCustomFields":{"id":"components/schemas/JournalEntryObjectCustomFields","kind":"json-schema","title":"journalEntryFieldsCustom","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Journal Entry object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"description":"Container for custom fields of a Journal Entry object.\n","title":"journalEntryFieldsCustom","type":"object"}},"components/schemas/POSTJournalEntryType":{"id":"components/schemas/POSTJournalEntryType","kind":"json-schema","title":"POSTJournalEntryType","data":{"allOf":[{"properties":{"accountingPeriodName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the accounting period. The open-ended accounting period is named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Open-Ended"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"currency":{"description":"The type of currency used. Currency must be active.\n","type":"string"},"journalEntryDate":{"description":"Date of the journal entry.\n","format":"date","type":"string"},"journalEntryItems":{"description":"Key name that represents the list of journal entry items.\n","items":{"$ref":"#/components/schemas/POSTJournalEntryItemType"},"type":"array"},"notes":{"description":"The number associated with the revenue event.\n\nCharacter limit: 2,000\n","type":"string"},"organizationLabel":{"description":"Name of the organization that the journal entry belongs to.  \n\nThis field is only required when you have already turned on Multi-Org feature.    \n","type":"string"},"segments":{"description":"List of segments that apply to the summary journal entry.\n","items":{"$ref":"#/components/schemas/POSTJournalEntrySegmentType"},"type":"array"},"transferredToAccounting":{"description":"Status shows whether the journal entry has been transferred to an accounting system.\n","enum":["No","Processing","Yes","Error","Ignore"],"type":"string"}},"required":["journalEntryDate","accountingPeriodName","currency","journalEntryItems"],"type":"object"},{"$ref":"#/components/schemas/JournalEntryObjectCustomFields"}],"example":{"accountingPeriodName":"2020/02","currency":"USD","journalEntryDate":"2020-01-20","journalEntryItems":[{"accountingCodeName":"Accounts Receivable","amount":400.9,"homeCurrencyAmount":400.9,"type":"Credit"},{"accountingCodeName":"Subscription Revenue","amount":400.9,"homeCurrencyAmount":400.9,"type":"Debit"}]}}},"components/schemas/POSTJournalEntryResponseType":{"id":"components/schemas/POSTJournalEntryResponseType","kind":"json-schema","title":"POSTJournalEntryResponseType","data":{"properties":{"journalEntryNumber":{"description":"Journal entry number in the format JE-00000001.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETJournalEntryItemType":{"id":"components/schemas/GETJournalEntryItemType","kind":"json-schema","title":"journalEntryItems","data":{"allOf":[{"properties":{"accountingCodeName":{"description":"Name of the accounting code.\n","type":"string"},"accountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting code type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"On-Account Receivable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available if you enable the Invoice Settlement feature."},"children":[]}]}]}],"enum":["AccountsReceivable","On-Account Receivable","Cash","OtherAssets","CustomerCashOnAccount","DeferredRevenue","SalesTaxPayable","OtherLiabilities","SalesRevenue","SalesDiscounts","OtherRevenue","OtherEquity","BadDebt","OtherExpenses"],"type":"string"},"amount":{"description":"Journal entry item amount in transaction currency.\n","format":"decimal","type":"string"},"glAccountName":{"description":"The account number in the general ledger (GL) that corresponds to the accounting code.\n","type":"string","nullable":true},"glAccountNumber":{"description":"The account name in the general ledger (GL) that corresponds to the accounting code.\n","type":"string","nullable":true},"homeCurrencyAmount":{"description":"Journal entry item amount in home currency.\n","format":"decimal","type":"string"},"type":{"description":"Type of journal entry item. ","enum":["Credit","Debit"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/JournalEntryItemObjectCustomFields"}],"title":"journalEntryItems"}},"components/schemas/GETJournalEntrySegmentType":{"id":"components/schemas/GETJournalEntrySegmentType","kind":"json-schema","title":"segments","data":{"properties":{"segmentName":{"description":"Name of segment.\n","type":"string"},"segmentValue":{"description":"Value of segment in this summary journal entry.\n","type":"string"}},"title":"segments","type":"object"}},"components/schemas/GETJournalEntryDetailTypeWithoutSuccess":{"id":"components/schemas/GETJournalEntryDetailTypeWithoutSuccess","kind":"json-schema","title":"journalEntries","data":{"allOf":[{"properties":{"accountingPeriodName":{"description":"Name of the accounting period that the journal entry belongs to.\n","type":"string"},"aggregateCurrency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns true if the journal entry is aggregating currencies. That is, if the journal entry was created when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aggregate transactions with different currencies during a JournalRun"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting was configured to \"Yes\". Otherwise, returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"currency":{"description":"Currency used.\n","type":"string"},"homeCurrency":{"description":"Home currency used.\n","type":"string"},"journalEntryDate":{"description":"Date of the journal entry.\n","format":"date","type":"string"},"journalEntryItems":{"description":"Key name that represents the list of journal entry items.\n","items":{"$ref":"#/components/schemas/GETJournalEntryItemType"},"type":"array"},"notes":{"description":"Additional information about this record.\nCharacter limit: 2,000\n","type":"string"},"number":{"description":"Journal entry number in the format JE-00000001.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"segments":{"description":"List of segments that apply to the summary journal entry.\n","items":{"$ref":"#/components/schemas/GETJournalEntrySegmentType"},"type":"array"},"status":{"description":"Status of journal entry. ","enum":["Created","Cancelled"],"type":"string"},"timePeriodEnd":{"description":"End date of time period included in the journal entry.\n","format":"date","type":"string"},"timePeriodStart":{"description":"Start date of time period included in the journal entry.\n","format":"date","type":"string"},"transactionType":{"description":"Transaction type of the transactions included in the summary journal entry.\n","type":"string"},"transferDateTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time that transferredToAccounting was changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is returned only when transferredToAccounting is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"transferredBy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID of the person who changed transferredToAccounting to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is returned only when transferredToAccounting is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"transferredToAccounting":{"description":"Status shows whether the journal entry has been transferred to an accounting system. ","enum":["No","Processing","Yes","Error","Ignore"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/JournalEntryObjectCustomFields"}],"title":"journalEntries"}},"components/schemas/GETJournalEntriesInJournalRunType":{"id":"components/schemas/GETJournalEntriesInJournalRunType","kind":"json-schema","title":"GETJournalEntriesInJournalRunType","data":{"properties":{"journalEntries":{"description":"Key name that represents the list of journal entries.\n","items":{"$ref":"#/components/schemas/GETJournalEntryDetailTypeWithoutSuccess"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETJournalEntryDetailType":{"id":"components/schemas/GETJournalEntryDetailType","kind":"json-schema","title":"GETJournalEntryDetailType","data":{"allOf":[{"properties":{"accountingPeriodName":{"description":"Name of the accounting period that the journal entry belongs to.\n","type":"string"},"aggregateCurrency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns true if the journal entry is aggregating currencies. That is, if the journal entry was created when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aggregate transactions with different currencies during a Journal Run"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting was configured to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"currency":{"description":"Currency used.\n","type":"string"},"homeCurrency":{"description":"Home currency used.\n","type":"string"},"journalEntryDate":{"description":"Date of the journal entry.\n","format":"date","type":"string"},"journalEntryItems":{"description":"Key name that represents the list of journal entry items.\n","items":{"$ref":"#/components/schemas/GETJournalEntryItemType"},"type":"array"},"notes":{"description":"\nAdditional information about this record.\nCharacter limit: 2,000\n","type":"string","nullable":true},"number":{"description":"Journal entry number in the format JE-00000001.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"segments":{"description":"List of segments that apply to the summary journal entry.\n","items":{"$ref":"#/components/schemas/GETJournalEntrySegmentType"},"type":"array"},"status":{"description":"Status of journal entry.\n","enum":["Created","Cancelled"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"timePeriodEnd":{"description":"End date of time period included in the journal entry.\n","format":"date","type":"string"},"timePeriodStart":{"description":"Start date of time period included in the journal entry.\n","format":"date","type":"string"},"transactionType":{"description":"Transaction type of the transactions included in the summary journal entry.\n","type":"string"},"transferDateTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time that transferredToAccounting was changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is returned only when transferredToAccounting is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"transferredBy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID of the person who changed transferredToAccounting to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is returned only when transferredToAccounting is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"transferredToAccounting":{"description":"Status shows whether the journal entry has been transferred to an accounting system. ","enum":["No","Processing","Yes","Error","Ignore"],"type":"string","nullable":true}},"type":"object"},{"$ref":"#/components/schemas/JournalEntryObjectCustomFields"}]}},"components/schemas/PUTJournalEntryItemType":{"id":"components/schemas/PUTJournalEntryItemType","kind":"json-schema","title":"journalEntryItems","data":{"allOf":[{"properties":{"accountingCodeName":{"description":"Name of the accounting code.\n\nIf the Journal Entry Item has a blank accounting code, enter the empty string.\n","type":"string"},"accountingCodeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting code type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"On-Account Receivable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only available if you enable the Invoice Settlement feature."},"children":[]}]}]}],"enum":["AccountsReceivable","On-Account Receivable","Cash","OtherAssets","CustomerCashOnAccount","DeferredRevenue","SalesTaxPayable","OtherLiabilities","SalesRevenue","SalesDiscounts","OtherRevenue","OtherEquity","BadDebt","OtherExpenses"],"type":"string"},"type":{"description":"Type of journal entry item. ","enum":["Credit","Debit"],"type":"string"}},"required":["accountingCodeName","type"],"type":"object"},{"$ref":"#/components/schemas/JournalEntryItemObjectCustomFields"}],"title":"journalEntryItems"}},"components/schemas/PUTBasicSummaryJournalEntryType":{"id":"components/schemas/PUTBasicSummaryJournalEntryType","kind":"json-schema","title":"PUTBasicSummaryJournalEntryType","data":{"allOf":[{"properties":{"journalEntryItems":{"description":"Key name that represents the list of journal entry items.\n","items":{"$ref":"#/components/schemas/PUTJournalEntryItemType"},"type":"array"},"notes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about this record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit:"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 2,000"},"children":[]}]}]}],"type":"string"},"transferredToAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status shows whether the journal entry has been transferred to an accounting system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field cannot be changed after the summary journal entry has been canceled."},"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 Zuora Finance "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override Transferred to Accounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission is required to change "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transferredToAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to any other value."},"children":[]}]}]}],"enum":["No","Processing","Yes","Error","Ignore"],"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/JournalEntryObjectCustomFields"}],"example":{"transferredToAccounting":"Yes"}}},"components/schemas/POSTJournalRunTransactionType":{"id":"components/schemas/POSTJournalRunTransactionType","kind":"json-schema","title":"transactionTypes","data":{"properties":{"type":{"description":"Transaction type. Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead.\n\nIf you enable the Invoice Settlement feature, Debit Memo Item, Credit Memo Item, and Credit Memo Application Item are available, Payment and Refund will be replaced by Payment Application and Refund Application. \n\nIf you enable both the Invoice Settlement feature and the Invoice Item Settlement feature, Payment and Refund will be replaced by Payment Application Item and Refund Application Item. \n","enum":["Invoice Item","Taxation Item","Invoice Item Adjustment (Invoice)","Invoice Item Adjustment (Tax)","Invoice Adjustment","Electronic Payment","External Payment","Electronic Refund","External Refund","Electronic Credit Balance Payment","External Credit Balance Payment","Electronic Credit Balance Refund","External Credit Balance Refund","Credit Balance Adjustment (Applied from Credit Balance)","Credit Balance Adjustment (Transferred to Credit Balance)","Revenue Event Item","Debit Memo Item (Charge)","Debit Memo Item (Tax)","Credit Memo Item (Charge)","Credit Memo Item (Tax)","Credit Memo Application Item","Electronic Payment Application","External Payment Application","Electronic Refund Application","External Refund Application","Electronic Payment Application Item","External Payment Application Item","Electronic Refund Application Item","External Refund Application Item"],"type":"string"}},"required":["type"],"title":"transactionTypes","type":"object"}},"components/schemas/POSTJournalRunType":{"id":"components/schemas/POSTJournalRunType","kind":"json-schema","title":"POSTJournalRunType","data":{"example":{"accountingPeriodName":"Nov-2014","journalEntryDate":"2014-11-04","transactionTypes":[{"type":"Invoice Item"},{"type":"Revenue Event Item"}]},"properties":{"accountingPeriodName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the accounting period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field determines the target start and end dates of the journal run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if you do not include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"journalEntryDate":{"description":"Date of the journal entry.\n","format":"date","type":"string"},"organizationLabels":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization that this run is created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each item in the array, either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only required when you have already turned on Multi-Org"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature."},"children":[]}]}]}],"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"targetEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target end date of the journal run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountingPeriodName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be empty or the same as the end date of the accounting period specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountingPeriodName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"targetStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target start date of the journal run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if you include targetEndDate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountingPeriodName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be empty or the same as the start date of the accounting period specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountingPeriodName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"transactionTypes":{"description":"Transaction types included in the journal run.\n\nYou can include one or more transaction types.\n","items":{"$ref":"#/components/schemas/POSTJournalRunTransactionType"},"type":"array"}},"required":["transactionTypes","journalEntryDate"],"type":"object"}},"components/schemas/POSTJournalRunResponseType":{"id":"components/schemas/POSTJournalRunResponseType","kind":"json-schema","title":"POSTJournalRunResponseType","data":{"properties":{"journalRunNumber":{"description":"Journal run number.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETJournalRunTransactionType":{"id":"components/schemas/GETJournalRunTransactionType","kind":"json-schema","title":"transactionTypes","data":{"properties":{"type":{"description":"Transaction type. Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead.\n\nIf you enable the Invoice Settlement feature, Debit Memo Item, Credit Memo Item, and Credit Memo Application Item are available, Payment and Refund will be replaced by Payment Application and Refund Application. \n\nIf you enable both the Invoice Settlement feature and the Invoice Item Settlement feature, Payment and Refund will be replaced by Payment Application Item and Refund Application Item. \n","enum":["Invoice Item","Taxation Item","Invoice Item Adjustment (Invoice)","Invoice Item Adjustment (Tax)","Invoice Adjustment","Electronic Payment","External Payment","Electronic Refund","External Refund","Electronic Credit Balance Payment","External Credit Balance Payment","Electronic Credit Balance Refund","External Credit Balance Refund","Credit Balance Adjustment (Applied from Credit Balance)","Credit Balance Adjustment (Transferred to Credit Balance)","Revenue Event Item","Debit Memo Item (Charge)","Debit Memo Item (Tax)","Credit Memo Item (Charge)","Credit Memo Item (Tax)","Credit Memo Application Item","Electronic Payment Application","External Payment Application","Electronic Refund Application","External Refund Application","Electronic Payment Application Item","External Payment Application Item","Electronic Refund Application Item","External Refund Application Item"],"type":"string"}},"title":"transactionTypes","type":"object"}},"components/schemas/GETJournalRunType":{"id":"components/schemas/GETJournalRunType","kind":"json-schema","title":"GETJournalRunType","data":{"properties":{"aggregateCurrency":{"description":"","type":"boolean"},"executedOn":{"description":"Date and time the journal run was executed.\n","type":"string"},"journalEntryDate":{"description":"Date of the journal entry.\n","format":"date","type":"string"},"number":{"description":"Journal run number.\n","type":"string"},"organizationLabels":{"description":"The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.\n","items":{"properties":{"organizationId":{"description":"The organization ID.\n","type":"string"},"organizationName":{"description":"The organization name.\n","type":"string"}},"type":"object"},"type":"array"},"segmentationRuleName":{"description":"Name of GL segmentation rule used in the journal run.\n","type":"string"},"status":{"description":"Status of the journal run. \n","enum":["Pending","Processing","Completed","Error","CancelInprogress","Cancelled","DeleteInprogress"],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"targetEndDate":{"description":"The target end date of the journal run.\n","format":"date","type":"string"},"targetStartDate":{"description":"The target start date of the journal run.\n","format":"date","type":"string"},"totalJournalEntryCount":{"description":"Total number of journal entries in the journal run.\n","format":"int64","type":"integer"},"transactionTypes":{"description":"Transaction types included in the journal run.\n","items":{"$ref":"#/components/schemas/GETJournalRunTransactionType"},"type":"array"}},"type":"object"}},"components/schemas/POSTMassUpdateResponseType":{"id":"components/schemas/POSTMassUpdateResponseType","kind":"json-schema","title":"POSTMassUpdateResponseType","data":{"properties":{"bulkKey":{"description":"String of 32 characters that identifies the mass action. The bulkKey is generated before the mass action is processed. You can use the bulkKey to Get the Mass Action Result.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETMassUpdateType":{"id":"components/schemas/GETMassUpdateType","kind":"json-schema","title":"GETMassUpdateType","data":{"properties":{"actionType":{"description":"Type of mass action.\n","type":"string"},"endedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time that the mass action was completed. The format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"errorCount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of failed records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is updated in real time. When the mass action "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Processing, this field returns the number of records that have failed so far. When the mass action "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Pending, this field is null."},"children":[]}]}]}],"type":"string"},"inputSize":{"description":"Size of the input file in bytes.\n","format":"int64","type":"integer"},"outputSize":{"description":"Size of the response file in bytes.\n","format":"int64","type":"integer"},"outputType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of output for the response file. The following table describes the output type."},"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":"Output Type"},"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":"(url:.csv.zip)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL pointing to a zipped .csv file."},"children":[]}]}]}]}]}]}],"type":"string"},"outputURL":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to download the response file. The response file is a zipped .csv file."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response file is identical to the file you uploaded to perform the mass action, with additional columns providing information about the outcome of each record."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field only returns a value when the mass action "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Completed or Stopped. Otherwise, this field is null."},"children":[]}]}]}],"type":"string"},"processedCount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of processed records. This field is equal to the sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"successCount"},"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 field is updated in real time. When the mass action "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Processing, this field returns the number of records that have been processed so far. When the mass action "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Pending, this field is null."},"children":[]}]}]}],"type":"string"},"startedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time that Zuora started processing the mass action. The format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"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 mass action. The following table describes the mass action statuses."},"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":"Status"},"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":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass action has not yet started being processed."},"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":"Processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass action is in progress."},"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":"Stopping"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass action is in the process of stopping, but has not yet stopped."},"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":"Stopped"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass action has stopped."},"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":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass action was successfully completed. There may still be failed records."},"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":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass action failed. No records are processed. No response file is created."},"children":[]}]}]}]}]}]}],"type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"successCount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of successful records."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is updated in real time. When the mass action "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Processing, this field returns the number of records that have succeeded so far. When the mass action "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Pending, this field is null."},"children":[]}]}]}],"type":"string"},"totalCount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of records in the uploaded mass action file."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the mass action "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Pending, this field is null."},"children":[]}]}]}],"type":"string"},"uploadedBy":{"description":"Email of the person who uploaded the mass action file.\n","type":"string"},"uploadedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time that the mass action file was uploaded. The format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/EventType":{"id":"components/schemas/EventType","kind":"json-schema","title":"EventType","data":{"properties":{"description":{"description":"The description of the event type.","maxLength":1000,"type":"string"},"displayName":{"description":"The display name for the event type.","maxLength":500,"minLength":1,"type":"string"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the event. Should be unique, contain no space, and be in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$"},"children":[]}]}]}],"maxLength":200,"minLength":1,"type":"string"}},"required":["name","displayName"],"type":"object"}},"components/schemas/EventTrigger":{"id":"components/schemas/EventTrigger","kind":"json-schema","title":"EventTrigger","data":{"properties":{"active":{"description":"The status of the trigger.","type":"boolean"},"baseObject":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base object that the trigger rule is defined upon. The format of the value in this field depends on the base object type:"},"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":"Standard object: object name, which should follow the pattern ^[A-Z][\\w-]*$. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"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":"Custom object: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default__<custom_object_api_name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default__vehicle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"maxLength":100,"minLength":1,"type":"string"},"condition":{"description":"The JEXL expression to be evaluated against object changes. See above for more information and an example.","maxLength":5000,"minLength":1,"type":"string"},"description":{"description":"The description of the trigger.","maxLength":1000,"type":"string"},"eventType":{"$ref":"#/components/schemas/EventType"},"id":{"format":"uuid","type":"string"}},"type":"object"}},"components/schemas/PostEventTriggerRequest":{"id":"components/schemas/PostEventTriggerRequest","kind":"json-schema","title":"PostEventTriggerRequest","data":{"example":{"active":true,"baseObject":"Invoice","condition":"changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0","eventType":{"name":"LargeInvoicePosted","displayName":"Large Invoice Posted"}},"properties":{"active":{"description":"The status of the event trigger.","type":"boolean"},"baseObject":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base object that the trigger rule is defined upon. The format of the value in this field depends on the base object type:"},"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":"Standard object: object name, which should follow the pattern ^[A-Z][\\w-]*$. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"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":"Custom object: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default__<custom_object_api_name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default__vehicle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"maxLength":100,"minLength":1,"type":"string"},"condition":{"description":"The JEXL expression to be evaluated against object changes. See above for more information and an example.","maxLength":5000,"minLength":1,"type":"string"},"description":{"description":"The description of the event trigger.","maxLength":1000,"type":"string"},"eventType":{"$ref":"#/components/schemas/EventType"}},"required":["baseObject","condition","eventType","active"],"type":"object"}},"components/schemas/PutEventTriggerRequest":{"id":"components/schemas/PutEventTriggerRequest","kind":"json-schema","title":"PutEventTriggerRequest","data":{"example":{"description":"Trigger the event when an invoice is posted with amount over 1000","condition":"changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0"},"properties":{"active":{"description":"The status of the trigger.","type":"boolean"},"condition":{"description":"The JEXL expression to be evaluated against object changes. See above for more information and an example.","maxLength":5000,"minLength":1,"type":"string"},"description":{"description":"The description of the trigger.","maxLength":1000,"type":"string"},"eventType":{"description":"The type of events to be triggered.","properties":{"description":{"description":"The description for the event type.","maxLength":1000,"type":"string"},"displayName":{"description":"The display name for the event type.","maxLength":500,"minLength":1,"type":"string"}},"type":"object"}},"type":"object"}},"components/schemas/GetScheduledEventResponse":{"id":"components/schemas/GetScheduledEventResponse","kind":"json-schema","title":"ScheduledEvent","data":{"example":{"active":true,"apiField":"TermEndDate","apiObject":"Subscription","condition":"Subscription.Status == _SUBSCRIPTION_STATUS","cronExpression":"0 30 10 ? * *","description":"Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects.","displayName":"Term End Date Scheduled Event","id":"d306545b74e445e4bffcf1c7609804be","name":"TermEndDateScheduledEvent","namespace":"user.notification","parameters":{"_SUBSCRIPTION_STATUS":{"description":"The status of the subscription","displayName":"Subscription Status","options":["Draft","Active","Pending","Expired","Cancelled"],"valueType":"STRING"}}},"properties":{"active":{"description":"Indicate whether the scheduled event is active or inactive","type":"boolean"},"apiField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base field of the base object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\\w\\-]*$"},"children":[]}]}]}],"type":"string"},"apiObject":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\\w\\-]*$"},"children":[]}]}]}],"type":"string"},"condition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter rule conditions, written in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://commons.apache.org/proper/commons-jexl/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JEXL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The scheduled event is triggered only if the condition is evaluated as true."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-source-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the base object of the event or from the joined objects of the base object"},"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":"Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice.Amount > 1000.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice.Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the Zuora object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"cronExpression":{"description":"The cron expression defines the time when scheduled event notifications will be sent.","type":"string"},"description":{"description":"The description of the scheduled event.","type":"string"},"displayName":{"description":"The display name of the scheduled event.","type":"string"},"id":{"description":"Scheduled event ID.","format":"uuid","type":"string"},"name":{"description":"The name of the scheduled event.","type":"string"},"namespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the scheduled event name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"parameters":{"additionalProperties":{"description":"Definition of a filter rule parameter.","properties":{"description":{"description":"The description of the parameter.","maxLength":255,"type":"string"},"displayName":{"description":"The display name of the parameter.","maxLength":255,"type":"string"},"options":{"description":"The option values of the parameter.","items":{"type":"string"},"type":"array"},"valueType":{"description":"The type of the value.","type":"string"}},"type":"object"},"description":"The parameter definitions of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated. You should specify all the parameters when creating scheduled event notifications.","type":"object"}},"title":"ScheduledEvent","type":"object"}},"components/schemas/PostScheduledEventRequest":{"id":"components/schemas/PostScheduledEventRequest","kind":"json-schema","title":"PostScheduledEventRequest","data":{"description":"namespace.name pair should be unique universally","example":{"active":true,"apiField":"TermEndDate","apiObject":"Subscription","condition":"Subscription.Status == _SUBSCRIPTION_STATUS","description":"Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects.","displayName":"Term End Date Scheduled Event","hours":10,"minutes":30,"name":"TermEndDateScheduledEvent","parameters":{"_SUBSCRIPTION_STATUS":{"description":"The status of the subscription","displayName":"Subscription Status","options":["Draft","Active","Pending","Expired","Cancelled"],"valueType":"STRING"}}},"properties":{"active":{"default":true,"description":"Indicate whether the scheduled event is active or inactive.","type":"boolean"},"apiField":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base field of the base object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\\w\\-]*$"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-custom-scheduled-event-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Scheduled Events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all available base fields."},"children":[]}]}]}],"type":"string"},"apiObject":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\\w\\-]*$"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-custom-scheduled-event-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Scheduled Events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all available base objects."},"children":[]}]}]}],"type":"string"},"condition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter rule conditions, written in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://commons.apache.org/proper/commons-jexl/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JEXL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The scheduled event is triggered only if the condition is evaluated as true."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-source-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the base object of the event or from the joined objects of the base object"},"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":"Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice.Amount > 1000.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice.Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the Zuora object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":65535,"type":"string"},"description":{"description":"The description of the scheduled event.","maxLength":1000,"type":"string"},"displayName":{"description":"The display name of the scheduled event.","maxLength":500,"minLength":1,"type":"string"},"hours":{"description":"The scheduled time (hour) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant.","maximum":23,"minimum":0,"type":"integer"},"minutes":{"description":"The scheduled time (minute) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant.","maximum":59,"minimum":0,"type":"integer"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the scheduled event. Should be unique, contain no space, and be in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$"},"children":[]}]}]}],"maxLength":200,"minLength":1,"type":"string"},"parameters":{"additionalProperties":{"description":"Definition of a filter rule parameter.","properties":{"description":{"description":"The description of the parameter.","maxLength":255,"type":"string"},"displayName":{"description":"The display name of the parameter.","maxLength":255,"type":"string"},"options":{"description":"The option values of the parameter.","items":{"type":"string"},"type":"array"},"valueType":{"description":"The type of the value.","enum":["STRING","BYTE","SHORT","CHARACTER","INTEGER","LONG","FLOAT","DOUBLE","BOOLEAN","BIG_INTEGER","BIG_DECIMAL","LOCAL_DATE","LOCAL_DATE_TIME","TIMESTAMP","BYTE_ARRAY","SHORT_ARRAY","CHARACTER_ARRAY","INTEGER_ARRAY","FLOAT_ARRAY","DOUBLE_ARRAY","BOOLEAN_ARRAY","STRING_ARRAY","BIG_INTEGER_ARRAY","BIG_DECIMAL_ARRAY","LOCAL_DATE_ARRAY","LOCAL_DATE_TIME_ARRAY","TIMESTAMP_ARRAY"],"type":"string"}},"type":"object"},"description":"The parameter definitions of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated. You should specify all the parameters when creating scheduled event notifications.","type":"object"}},"required":["name","displayName","apiObject","apiField","hours","minutes"],"type":"object"}},"components/schemas/PutScheduledEventRequest":{"id":"components/schemas/PutScheduledEventRequest","kind":"json-schema","title":"PutScheduledEventRequest","data":{"example":{"active":true,"condition":"Subscription.Status == _SUBSCRIPTION_STATUS","description":"Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects.","displayName":"Term End Date Scheduled Event","hours":10,"minutes":30,"parameters":{"_SUBSCRIPTION_STATUS":{"description":"The status of the subscription","displayName":"Subscription Status","options":["Draft","Active","Pending","Expired","Cancelled"],"valueType":"STRING"}}},"properties":{"active":{"description":"Indicate whether the scheduled event is active or inactive","type":"boolean"},"condition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter rule conditions, written in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://commons.apache.org/proper/commons-jexl/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JEXL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The scheduled event is triggered only if the condition is evaluated as true."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-source-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the base object of the event or from the joined objects of the base object"},"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":"Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice.Amount > 1000.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice.Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the Zuora object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":65535,"type":"string"},"description":{"description":"The description of the scheduled event.","maxLength":1000,"type":"string"},"displayName":{"description":"The display name of the scheduled event.","maxLength":500,"minLength":1,"type":"string"},"hours":{"description":"The scheduled time (hour) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant.","maximum":23,"minimum":0,"type":"integer"},"minutes":{"description":"The scheduled time (minute) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant.","maximum":59,"minimum":0,"type":"integer"},"parameters":{"additionalProperties":{"description":"Definition of a filter rule parameter.","properties":{"description":{"description":"The description of the parameter.","maxLength":255,"type":"string"},"displayName":{"description":"The display name of the parameter.","maxLength":255,"type":"string"},"options":{"description":"The option values of the parameter.","items":{"type":"string"},"type":"array"},"valueType":{"description":"The type of the value.","enum":["STRING","BYTE","SHORT","CHARACTER","INTEGER","LONG","FLOAT","DOUBLE","BOOLEAN","BIG_INTEGER","BIG_DECIMAL","LOCAL_DATE","LOCAL_DATE_TIME","TIMESTAMP","BYTE_ARRAY","SHORT_ARRAY","CHARACTER_ARRAY","INTEGER_ARRAY","FLOAT_ARRAY","DOUBLE_ARRAY","BOOLEAN_ARRAY","STRING_ARRAY","BIG_INTEGER_ARRAY","BIG_DECIMAL_ARRAY","LOCAL_DATE_ARRAY","LOCAL_DATE_TIME_ARRAY","TIMESTAMP_ARRAY"],"type":"string"}},"type":"object"},"description":"The parameters of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated.","type":"object"}},"type":"object"}},"components/schemas/CalloutAuth":{"id":"components/schemas/CalloutAuth","kind":"json-schema","title":"CalloutAuth","data":{"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":"requiredAuth"},"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":", this object is required."},"children":[]}]}]}],"properties":{"domain":{"description":"The domain of the callout auth.","type":"string"},"password":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requiredAuth"},"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":[]}]}]}],"type":"string"},"preemptive":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable the preemptive authentication."},"children":[]}]}]}],"type":"boolean"},"username":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requiredAuth"},"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":[]}]}]}],"type":"string"}},"type":"object","nullable":true}},"components/schemas/CalloutMergeFields":{"id":"components/schemas/CalloutMergeFields","kind":"json-schema","title":"calloutParams","data":{"additionalProperties":{"description":"The key is the parameter name. The value is a merge field with angle brackets.\n","type":"string"},"description":"A key-value map of merge fields of this callout.\n","title":"calloutParams","type":"object"}},"components/schemas/FilterRuleParameterDefinition":{"id":"components/schemas/FilterRuleParameterDefinition","kind":"json-schema","title":"parameter","data":{"description":"Definition of a filter rule parameter.\n","properties":{"description":{"maxLength":255,"type":"string"},"displayName":{"description":"The display name of the parameter.\n","maxLength":255,"type":"string"},"options":{"description":"The option values of the parameter.\n","items":{"type":"string"},"type":"array"},"valueType":{"description":"The type of the value.\n","enum":["STRING","BYTE","SHORT","CHARACTER","INTEGER","LONG","FLOAT","DOUBLE","BOOLEAN","BIG_INTEGER","BIG_DECIMAL","LOCAL_DATE","LOCAL_DATE_TIME","TIMESTAMP","BYTE_ARRAY","SHORT_ARRAY","CHARACTER_ARRAY","INTEGER_ARRAY","FLOAT_ARRAY","DOUBLE_ARRAY","BOOLEAN_ARRAY","STRING_ARRAY","BIG_INTEGER_ARRAY","BIG_DECIMAL_ARRAY","LOCAL_DATE_ARRAY","LOCAL_DATE_TIME_ARRAY","TIMESTAMP_ARRAY"],"type":"string"}},"title":"parameter","type":"object"}},"components/schemas/FilterRuleParameterDefinitions":{"id":"components/schemas/FilterRuleParameterDefinitions","kind":"json-schema","title":"parameters","data":{"additionalProperties":{"$ref":"#/components/schemas/FilterRuleParameterDefinition"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parameters of the filter rule and their name must match those in the filter rule. And all parameters must be defined in the event type payload. The name of parameters can't be duplicate. The following reserved keywords should not be used as a parameter name: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AttachmentList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RecipientList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RecipientType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Exceptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OCP_OBJECT_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OCP_OBJECT_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OCP_TRIGGER_BY"},"children":[]}]}]}],"title":"parameters","type":"object"}},"components/schemas/FilterRuleParameterValues":{"id":"components/schemas/FilterRuleParameterValues","kind":"json-schema","title":"filterRuleParams","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following reserved key words should not be used as a parameter name: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AttachmentList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RecipientList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RecipientType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Exceptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OCP_OBJECT_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OCP_OBJECT_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OCP_TRIGGER_BY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Include.Attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a special boolean parameter. By specifying this parameter, you can tell a notification whose event type is based on Invoice to include attachments while sending emails."},"children":[]}]}]}],"type":"string"},"description":"The parameter values used to configure the filter rule.\n","title":"filterRuleParams","type":"object"}},"components/schemas/GETPublicNotificationDefinitionResponse":{"id":"components/schemas/GETPublicNotificationDefinitionResponse","kind":"json-schema","title":"GETPublicNotificationDefinitionResponse","data":{"example":{"id":"838bfafa9b224408809f8ecbdae198ef","createdBy":"8ad084a67f9c7138017fab8a8b511b5a","createdOn":"2024-11-11T03:00:03.000 UTC","updatedBy":"8ad084a67f9c7138017fab8a8b511b5a","updatedOn":"2024-11-11T03:00:03.000 UTC","eventTypeNamespace":"user.notification","eventTypeName":"AccountEdit","name":"Account Edit Notification","description":null,"communicationProfileId":"2c92c0f9446cd49501447539d6a72815","communicationProfileIds":["2c92c0f9446cd49501447539d6a72815"],"active":true,"emailTemplateId":"f11e498862584a10a05b83ea70119659","callout":null,"calloutTemplateIds":[],"filterRule":{"id":"a1efc8cc717e48208b9f0fd5d7bf2a58","createdBy":"8ad084a67f9c7138017fab8a8b511b5a","createdOn":"2024-11-11T03:00:04.000 UTC","updatedBy":null,"updatedOn":null,"description":"Filter rule to test if an account is a VIP account","condition":"Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS","parameters":{"_ACCOUNT_STATUS":{"displayName":"VIP Account Status","description":"The status of the VIP Account","options":["Draft","Active","Canceled"],"valueType":"STRING"},"_VIP_BALANCE_AMOUNT":{"displayName":"VIP Account Balance","description":"The minimum account balance","options":null,"valueType":"BIG_DECIMAL"}},"scheduled":false},"filterRuleParams":{"_ACCOUNT_STATUS":"Active","_VIP_BALANCE_AMOUNT":"100000.0"},"emailActive":true,"calloutActive":false,"associatedAccount":null},"properties":{"active":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the notification definition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"associatedAccount":{"description":"The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from.\n","type":"string","nullable":true},"callout":{"properties":{"active":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the callout. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutAuth":{"$ref":"#/components/schemas/CalloutAuth"},"calloutBaseurl":{"description":"The callout URL. It must start with 'https://'","example":"https://***","format":"url","minLength":10,"type":"string"},"calloutParams":{"$ref":"#/components/schemas/CalloutMergeFields"},"calloutRetry":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specified whether to retry the callout when the callout fails. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"description":{"description":"Description for the callout.","maxLength":255,"type":"string"},"eventTypeName":{"description":"The name of the custom event type.","minLength":1,"type":"string"},"httpMethod":{"description":"The HTTP method of the callout.","enum":["POST","GET","PUT","PATCH","DELETE"],"example":"POST","type":"string"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the callout. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutActive"},"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":", a callout is required. The eventTypeName of the callout MUST be the same as the eventTypeName."},"children":[]}]}]}],"format":"uuid","type":"string"},"name":{"description":"The name of the created callout.","maxLength":255,"type":"string"},"oauth2ProviderId":{"description":"The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout.","type":"string"},"requiredAuth":{"description":"Indicates whether Basic authentication is enabled for the callout.","type":"boolean"},"requiredOauth2":{"description":"Indicates whether OAuth 2.0 authentication is enabled for the callout.","type":"boolean"}},"type":"object","nullable":true},"calloutActive":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the callout action. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutTemplateIds":{"description":"List of callout template IDs that the notification definition is associated with.\n","items":{"type":"string"},"type":"array"},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile that the notification definition is associated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the notification definition is associated with multiple communication profiles, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all associated communication profile IDs."},"children":[]}]}]}],"format":"uuid","type":"string"},"communicationProfileIds":{"description":"List of communication profile IDs that the notification definition is associated with.\n","items":{"type":"string"},"type":"array"},"createdBy":{"description":"The ID of the user who created the notification definition.","format":"uuid","type":"string"},"createdOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the notification definition was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00"},"children":[]}]}]}],"type":"string"},"description":{"description":"Description of the notification definition","maxLength":255,"type":"string","nullable":true},"emailActive":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the email action. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"emailTemplateId":{"description":"The ID of the email template. In the request, there should be at least one email template or callout.","format":"uuid","type":"string"},"eventCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event category code for a standard event, on which the notification definition is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if the notification definition is based on a standard event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the list of supported standard event category codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard event category code for events and notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"eventId":{"description":"The ID of the event that the notification definition is based on.\n\nThis field is available only if the notification definition is based on a standard event.    \n","type":"string","format":"uuid"},"eventTypeName":{"description":"The name of the event that the notification definition is based on.\n\nThis field is available only if the notification definition is based on a Zuora custom event, custom event, or custom scheduled event.\n","minLength":1,"type":"string"},"eventTypeNamespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. It indicates who created the event and which namespace the event is assigned to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values are 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":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": events that are created by Zuora. This value applies to Zuora custom events."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": events that are created by tenant users. This value applies to custom events and custom scheduled events."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if the notification definition is based on a Zuora custom event, custom event, or custom scheduled event."},"children":[]}]}]}],"type":"string","enum":["user.notification","com.zuora.notification"]},"filterRule":{"description":"","properties":{"condition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter rule conditions, written in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://commons.apache.org/proper/commons-jexl/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JEXL"},"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 rule might contain event context merge fields and data source merge fields. Data source merge fields must be from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-source-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the base object of the event or from the joined objects of the base object"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to trigger an event when an invoice is posted with the amount over 1000, you would define the following condition on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are conventions and keywords you need to be aware of. For example:"},"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":"code","inline":true,"attributes":{"content":"changeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a keyword to specify what kind of change happened to the object. Allowed values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSERT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice.Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Zuora object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"A variable with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_old"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix means it’s a previous value of the corresponding object field. The \"_old\" fields are only available on the base objects."},"children":[]}]}]}]}]}],"example":"Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS","type":"string"},"description":{"description":"The description of the filter rule.","maxLength":255,"type":"string"},"eventTypeName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"type":"string"},"id":{"description":"The ID of the filter rule. If not specified or null, the notification definition is always qualified to process events of \"eventType\".","format":"uuid","type":"string"},"parameters":{"$ref":"#/components/schemas/FilterRuleParameterDefinitions"}},"type":"object"},"filterRuleParams":{"$ref":"#/components/schemas/FilterRuleParameterValues"},"id":{"description":"The ID associated with this notification definition.","format":"uuid","type":"string"},"name":{"description":"The name of the notification definition.","maxLength":255,"type":"string"},"updatedBy":{"description":"The ID of the user who updated the notification definition.","format":"uuid","type":"string"},"updatedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the notification was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00"},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/POSTPublicNotificationDefinitionCalloutCommon":{"id":"components/schemas/POSTPublicNotificationDefinitionCalloutCommon","kind":"json-schema","title":"Callout - without authentication","data":{"title":"Callout - without authentication","description":"Common information for callout notifications.\n","properties":{"active":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the callout. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutBaseurl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callout URL. It must start with 'https://'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora uses port 443 to send callout notifications by default. If you want to use other ports, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://***","format":"url","minLength":10,"type":"string"},"calloutParams":{"$ref":"#/components/schemas/CalloutMergeFields"},"calloutRetry":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specified whether to retry the callout when the callout fails. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"description":{"description":"Description for the callout.","maxLength":255,"type":"string"},"eventTypeName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the event type. The value must be the same as the parent-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"minLength":1,"type":"string"},"httpMethod":{"description":"The HTTP method of the callout.","enum":["POST","GET","PUT","PATCH","DELETE"],"example":"POST","type":"string"},"name":{"description":"The name of the callout template that will be created. It must be unique across all callout templates.","maxLength":255,"type":"string"}},"required":["name","calloutBaseurl","httpMethod"],"type":"object"}},"components/schemas/POSTPublicNotificationDefinitionCalloutBasicAuthentication":{"id":"components/schemas/POSTPublicNotificationDefinitionCalloutBasicAuthentication","kind":"json-schema","title":"Callout - Base authentication","data":{"title":"Callout - Base authentication","allOf":[{"$ref":"#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon"},{"type":"object","description":"The Basic Authentication information for callout notifications.\n","properties":{"requiredAuth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether Basic authentication is enabled for the callout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating callout notifications with Basic authentication enabled, you must set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and specify the username and password in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutAuth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutAuth":{"$ref":"#/components/schemas/CalloutAuth"}},"required":["requiredAuth"]}]}},"components/schemas/POSTPublicNotificationDefinitionCalloutOauth2Authentication":{"id":"components/schemas/POSTPublicNotificationDefinitionCalloutOauth2Authentication","kind":"json-schema","title":"Callout - OAuth 2.0 authentication","data":{"title":"Callout - OAuth 2.0 authentication","allOf":[{"$ref":"#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon"},{"type":"object","description":"The OAuth 2.0 Authentication information for callout notifications.\n","properties":{"requiredOauth2":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether OAuth 2.0 authentication is enabled for the callout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating callout notifications with OAuth 2.0 authentication enabled, you must set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and specify the OAuth 2.0 provider ID in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth2ProviderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"oauth2ProviderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. This field is required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requiredOauth2"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about how to get the ID of an OAuth 2.0 provider, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-retrieve-oauth-provider-id","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the ID of an OAuth 2.0 provider"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["requiredOauth2"]}]}},"components/schemas/POSTPublicNotificationDefinitionRequest":{"id":"components/schemas/POSTPublicNotificationDefinitionRequest","kind":"json-schema","title":"POSTPublicNotificationDefinitionRequest","data":{"properties":{"active":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the notification definition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"associatedAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available values are 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":"code","inline":true,"attributes":{"content":"Account.Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ID of the primary customer account related to the notification. It is also the default value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ParentAccount.Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": this option is available only if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled for your tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionOwnerAccount.Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": this option is available if the base object of the notification is Order Action."},"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":" before specifying this field, we recommend that you use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-source-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check the available types of accounts for the current notification."},"children":[]}]}]}],"type":"string"},"callout":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, Zuora will create a new callout template when creating the notification definition and associate the template with the notification definition."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutTemplateIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields at the same 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 about callout templates, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-callout-template-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon"},{"$ref":"#/components/schemas/POSTPublicNotificationDefinitionCalloutBasicAuthentication"},{"$ref":"#/components/schemas/POSTPublicNotificationDefinitionCalloutOauth2Authentication"}]},"calloutActive":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the callout action. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutTemplateIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of callout template IDs that the notification definition is associated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutTemplateIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields at the same 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 about callout templates, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-callout-template-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile that the notification definition is associated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/Action_POSTquery"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Action"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the communication profile Id. See the following request sample:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{     \"queryString\": \"select Id, ProfileName from CommunicationProfile\"  }"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not pass the communicationProfileId, notification service will be automatically added to the 'Default Profile'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to associate the notification definition with multiple communication profiles,  use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, which overrides this field."},"children":[]}]}]}],"type":"string"},"communicationProfileIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of communication profile IDs that the notification definition is associated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field overrides the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"description":{"description":"The description of the notification definition.","maxLength":255,"type":"string"},"emailActive":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the email action. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"emailTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the email template. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailActive"},"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":", an email template is required. And EventType of the email template MUST be the same as the eventType."},"children":[]}]}]}],"format":"uuid","type":"string"},"eventCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event category code for a standard event, on which the notification definition is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required when creating notification definitions for standard events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the list of supported standard event category codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard event category code for events and notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"eventTypeName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the event that the notification definition is based on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required when creating notification definitions for Zuora custom events, custom events, or custom scheduled events."},"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 provided, you can specify the event namespace in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeNamespace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"minLength":1,"type":"string"},"eventTypeNamespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. It indicates who created the event and which namespace the event is assigned to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values are 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":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": events that are created by Zuora. This value applies to Zuora custom events."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you want to create a notification definition on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderActionProcessed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event, which is a Zuora custom event, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field."},"children":[]}]}]}],"type":"string","enum":["user.notification","com.zuora.notification"],"default":"user.notification"},"filterRule":{"description":"","properties":{"condition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter rule conditions, written in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://commons.apache.org/proper/commons-jexl/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JEXL"},"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 rule might contain event context merge fields and data source merge fields. Data source merge fields must be from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-source-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the base object of the event or from the joined objects of the base object"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to filter an invoice posted notification to only invoices with an amount over 1000, you would define the following condition:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice.Amount > 1000.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are conventions and keywords you need to be aware of. For example:"},"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":"code","inline":true,"attributes":{"content":"Invoice.Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the Zuora object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"Unlike Event Triggers, there is no access to variables with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_old"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix. Fields with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_old"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix are only available on Event Trigger conditions."},"children":[]}]}]}]}]}],"example":"Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS","type":"string"},"description":{"description":"The description of the filter rule.","maxLength":255,"type":"string"},"parameters":{"$ref":"#/components/schemas/FilterRuleParameterDefinitions"}},"required":["condition","parameters"],"type":"object"},"filterRuleParams":{"$ref":"#/components/schemas/FilterRuleParameterValues"},"name":{"description":"The name of the notification definition, unique per communication profile.","maxLength":255,"type":"string"}},"required":["name"],"type":"object"}},"components/schemas/PUTPublicNotificationDefinitionCalloutCommon":{"id":"components/schemas/PUTPublicNotificationDefinitionCalloutCommon","kind":"json-schema","title":"Callout - without authentication","data":{"title":"Callout - without authentication","description":"Common information for callout notifications.\n","properties":{"active":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the callout. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutBaseurl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callout URL. It must start with 'https://'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora uses port 443 to send callout notifications by default. If you want to use other ports, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://***","format":"url","minLength":10,"type":"string"},"calloutParams":{"$ref":"#/components/schemas/CalloutMergeFields"},"calloutRetry":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specified whether to retry the callout when the callout fails. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"description":{"description":"Description for the callout.","maxLength":255,"type":"string"},"httpMethod":{"description":"The HTTP method of the callout.","enum":["POST","GET","PUT","PATCH","DELETE"],"example":"POST","type":"string"},"name":{"description":"The name of the callout template that will be created. It must be unique across all callout templates.","maxLength":255,"type":"string"}},"type":"object"}},"components/schemas/PUTPublicNotificationDefinitionCalloutBasicAuthentication":{"id":"components/schemas/PUTPublicNotificationDefinitionCalloutBasicAuthentication","kind":"json-schema","title":"Callout - Base authentication","data":{"title":"Callout - Base authentication","allOf":[{"$ref":"#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon"},{"type":"object","description":"The Basic Authentication information for callout notifications.\n","properties":{"requiredAuth":{"description":"Indicates whether Basic authentication is enabled for the callout.\n","type":"boolean"},"calloutAuth":{"$ref":"#/components/schemas/CalloutAuth"}}}]}},"components/schemas/PUTPublicNotificationDefinitionCalloutOauth2Authentication":{"id":"components/schemas/PUTPublicNotificationDefinitionCalloutOauth2Authentication","kind":"json-schema","title":"Callout - OAuth 2.0 authentication","data":{"title":"Callout - OAuth 2.0 authentication","allOf":[{"$ref":"#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon"},{"type":"object","description":"The OAuth 2.0 Authentication information for callout notifications.\n","properties":{"requiredOauth2":{"description":"Indicates whether OAuth 2.0 authentication is enabled for the callout.\n","type":"boolean"},"oauth2ProviderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about how to get the ID of an OAuth 2.0 provider, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-retrieve-oauth-provider-id","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the ID of an OAuth 2.0 provider"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}]}},"components/schemas/PUTPublicNotificationDefinitionRequest":{"id":"components/schemas/PUTPublicNotificationDefinitionRequest","kind":"json-schema","title":"PUTPublicNotificationDefinitionRequest","data":{"example":{"description":"Details of the notification definition"},"properties":{"active":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the notification definition. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"associatedAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available values are 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":"code","inline":true,"attributes":{"content":"Account.Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ID of the primary customer account related to the notification. It is also the default value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ParentAccount.Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": this option is available only if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled for your tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionOwnerAccount.Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": this option is available if the base object of the notification is Order Action."},"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":" before specifying this field, we recommend that you use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-source-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check the available types of accounts for the current notification."},"children":[]}]}]}],"type":"string"},"callout":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is specified, Zuora will create a new callout template when creating the notification definition and associate the template with the notification definition."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutTemplateIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields at the same 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 about callout templates, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-callout-template-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon"},{"$ref":"#/components/schemas/PUTPublicNotificationDefinitionCalloutBasicAuthentication"},{"$ref":"#/components/schemas/PUTPublicNotificationDefinitionCalloutOauth2Authentication"}]},"calloutActive":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the callout action. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutTemplateIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of callout template IDs that the notification definition is associated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutTemplateIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields at the same 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 about callout templates, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-callout-template-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The profile that notification definition belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to associate the notification definition with multiple communication profiles, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, which overrides this field."},"children":[]}]}]}],"format":"uuid","type":"string"},"communicationProfileIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of communication profile IDs that the notification definition is associated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field overrides the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"description":{"description":"The description of the notification definition.","maxLength":255,"type":"string"},"emailActive":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the email action. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"emailTemplateId":{"description":"The ID of the email template. If emailActive is updated from\nfalse to true, an email template is required, and the EventType of\nthe email template MUST be the same as the EventType of the notification definition.\n","format":"uuid","type":"string"},"filterRule":{"description":"","properties":{"condition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter rule conditions, written in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://commons.apache.org/proper/commons-jexl/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JEXL"},"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 rule might contain event context merge fields and data source merge fields. Data source merge fields must be from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-source-reference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the base object of the event or from the joined objects of the base object"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to trigger an event when an invoice is posted with the amount over 1000, you would define the following condition on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are conventions and keywords you need to be aware of. For example:"},"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":"code","inline":true,"attributes":{"content":"changeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a keyword to specify what kind of change happened to the object. Allowed values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSERT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice.Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Zuora object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"A variable with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_old"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix means it’s a previous value of the corresponding object field. The \"_old\" fields are only available on the base objects."},"children":[]}]}]}]}]}],"example":"Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS","type":"string"},"description":{"description":"The description of the filter rule.","maxLength":255,"type":"string"},"parameters":{"$ref":"#/components/schemas/FilterRuleParameterDefinitions"}},"required":["eventTypeName","condition","parameters"],"type":"object"},"filterRuleParams":{"$ref":"#/components/schemas/FilterRuleParameterValues"},"name":{"description":"The name of the notification definition, which is unique in the profile.","maxLength":255,"type":"string"}},"type":"object"}},"components/schemas/POSTCreateOrUpdateEmailTemplateRequestFormat":{"id":"components/schemas/POSTCreateOrUpdateEmailTemplateRequestFormat","kind":"json-schema","title":"POSTCreateOrUpdateEmailTemplateRequestFormat","data":{"properties":{"active":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the email template. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"bccEmailAddress":{"description":"The email bcc address.","format":"email","type":"string"},"ccEmailAddress":{"description":"The email CC address.","type":"string"},"ccEmailType":{"default":"SpecificEmails","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email CC type."},"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":"When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerSoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerAllContacts"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is tenant-level, such as Bill Run Completion, you can use 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":"text","inline":true,"attributes":{"content":"TenantAdmin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RunOwner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]}]}],"enum":["BillToContact","SoldToContact","ShipToContact","SpecificEmails","TenantAdmin","BillToAndSoldToContacts","RunOwner","AllContacts","InvoiceOwnerBillToContact","InvoiceOwnerSoldToContact","InvoiceOwnerShipToContact","InvoiceOwnerBillToAndSoldToContacts","InvoiceOwnerAllContacts"],"type":"string"},"description":{"description":"The description of the email template.","maxLength":255,"type":"string"},"emailBody":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"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":"You can also embed HTML tags if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isHtml"},"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":[]}]}]}],"type":"string"},"emailHeaders":{"type":"object","title":"emailHeader","description":"Container for custom email headers. Each custom email header consists of a header name and a header value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom email header consists of a name-value pair:"},"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":"Field name: the name of the custom email header."},"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":"Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}},"emailSubject":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"encodingType":{"default":"UTF8","description":"The endcode type of the email body.","enum":["UTF8","Shift_JIS","ISO_2022_JP","EUC_JP","X_SJIS_0213"],"type":"string"},"eventCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify this field, the email template is created based on a standard event. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard Event Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all standard event category codes."},"children":[]}]}]}],"type":"number"},"eventTypeName":{"description":"The name of the custom event or custom scheduled event. If you specify this field, the email template is created based on the corresponding custom event or custom scheduled event.\n","type":"string"},"eventTypeNamespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a standard event type, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace; otherwise, you will get an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you want to create an email template on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderActionProcessed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field."},"children":[]}]}]}],"type":"string"},"fromEmailAddress":{"description":"If fromEmailType is SpecificEmail, this field is required.","type":"string"},"fromEmailType":{"description":"The type of the email.","enum":["TenantEmail","RunOwner","SpecificEmail"],"type":"string"},"fromName":{"description":"The name of the email sender.","type":"string"},"id":{"description":"ID of an existing email template. Specify this field if you want to update an existing email template.\n","type":"string"},"isHtml":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the style of email body is HTML. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"name":{"description":"The name of the email template, a unique name in a tenant.","maxLength":255,"type":"string"},"replyToEmailAddress":{"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":"replyToEmailType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is required."},"children":[]}]}]}],"type":"string"},"replyToEmailType":{"description":"Type of the replyTo email.","enum":["TenantEmail","RunOwner","SpecificEmail"],"type":"string"},"toEmailAddress":{"description":"If toEmailType is SpecificEmail, this field is required.","type":"string"},"toEmailType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email receive type."},"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":"When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerSoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerAllContacts"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is tenant-level, such as Bill Run Completion, you can use 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":"text","inline":true,"attributes":{"content":"TenantAdmin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RunOwner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]}]}],"enum":["BillToContact","SoldToContact","ShipToContact","SpecificEmails","TenantAdmin","BillToAndSoldToContacts","RunOwner","AllContacts","InvoiceOwnerBillToContact","InvoiceOwnerSoldToContact","InvoiceOwnerShipToContact","InvoiceOwnerBillToAndSoldToContacts","InvoiceOwnerAllContacts"],"type":"string"}},"required":["name","fromEmailType","emailSubject","emailBody","toEmailType"],"type":"object"}},"components/schemas/POSTCreateOrUpdateEmailTemplateRequest":{"id":"components/schemas/POSTCreateOrUpdateEmailTemplateRequest","kind":"json-schema","title":"POSTCreateOrUpdateEmailTemplateRequest","data":{"properties":{"allowPartialSuccess":{"description":[{"$$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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the call will fail if one or multiple instances fail to import, and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response is returned if all email templates have been successfully updated."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a success ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") response is returned if one or more instances have imported successfully. All failed instances are also returned in the response."},"children":[]}]}]}],"type":"boolean"},"emailTemplates":{"description":"A container for email templates.\n","items":{"$ref":"#/components/schemas/POSTCreateOrUpdateEmailTemplateRequestFormat"},"type":"array"}},"type":"object"}},"components/schemas/CreateOrUpdateEmailTemplatesResponse":{"id":"components/schemas/CreateOrUpdateEmailTemplatesResponse","kind":"json-schema","title":"CreateOrUpdateEmailTemplatesResponse","data":{"example":{"reasons":[]},"properties":{"reasons":{"description":"Returns an empty array if the request succeeds.\n","items":{"type":"string"},"type":"array"}},"type":"object"}},"components/schemas/GETPublicEmailTemplateResponse":{"id":"components/schemas/GETPublicEmailTemplateResponse","kind":"json-schema","title":"GETPublicEmailTemplateResponse","data":{"example":{"id":"f11e498862584a10a05b83ea70119659","createdBy":"8ad084a67f9c7138017fab8a8b511b5a","createdOn":"2024-11-06T09:24:07.000 UTC","updatedBy":"8ad084a67f9c7138017fab8a8b511b5a","updatedOn":"2024-11-06T09:24:07.000 UTC","eventTypeNamespace":"user.notification","eventTypeName":"AccountEdit","name":"Account Edit Email","description":"","encodingType":"UTF8","fromName":"Company Co. Ltd.","fromEmailType":"TenantEmail","fromEmailAddress":"","replyToEmailType":"TenantEmail","replyToEmailAddress":"","ccEmailType":"SpecificEmails","ccEmailAddress":"","bccEmailAddress":"","toEmailType":"BillToContact","toEmailAddress":"","emailHeaders":{},"emailSubject":"Account {{DataSource.Account.AccountNumber}} has been edited","emailBody":"Dear user,<p>the account {{DataSource.Account.AccountNumber}} has been edited. <p>Company Co. Ltd.","fileId":"","active":true,"isHtml":false,"useAdditionalAddresses":false},"properties":{"active":{"description":"The status of the email template.","type":"boolean"},"bccEmailAddress":{"description":"Email BCC address.","format":"email","type":"string"},"ccEmailAddress":{"description":"Email CC address.","type":"string"},"ccEmailType":{"default":"SpecificEmails","description":"Email cc type.","enum":["BillToContact","SoldToContact","ShipToContact","SpecificEmails","TenantAdmin","BillToAndSoldToContacts","RunOwner","AllContacts","InvoiceOwnerBillToContact","InvoiceOwnerSoldToContact","InvoiceOwnerShipToContact","InvoiceOwnerBillToAndSoldToContacts","InvoiceOwnerAllContacts"],"type":"string"},"createdBy":{"description":"The ID of the user who created the email template.","format":"uuid","type":"string"},"createdOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the email template was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00"},"children":[]}]}]}],"format":"date-time","type":"string"},"description":{"description":"The description of the email template.","maxLength":255,"type":"string"},"emailBody":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"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":"User can also embed html tags if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isHtml"},"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":[]}]}]}],"type":"string"},"emailHeaders":{"type":"object","title":"emailHeader","description":"Container for custom email headers. Each custom email header consists of a header name and a header value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom email header consists of a name-value pair:"},"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":"Field name: the name of the custom email header."},"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":"Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}},"emailSubject":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"encodingType":{"description":"The endcode type of the email body.","enum":["UTF8","Shift_JIS","ISO_2022_JP","EUC_JP","X_SJIS_0213"],"type":"string"},"eventCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event category code for a standard event. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard Event Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all event category codes."},"children":[]}]}]}],"type":"number"},"eventTypeName":{"description":"The name of the custom event or custom scheduled event.","minLength":1,"type":"string"},"eventTypeNamespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for custom events and custom scheduled events."},"children":[]}]}]}],"type":"string"},"fromEmailAddress":{"description":"If formEmailType is SpecificEmail, this field is required.","type":"string"},"fromEmailType":{"description":"The from email type.","enum":["TenantEmail","RunOwner","SpecificEmail"],"type":"string"},"fromName":{"description":"The name of email sender.","maxLength":50,"type":"string"},"id":{"description":"The email template ID.","format":"uuid","type":"string"},"isHtml":{"description":"Indicates whether the style of email body is HTML.","type":"boolean"},"name":{"description":"The name of the email template.","maxLength":255,"type":"string"},"replyToEmailAddress":{"description":"If replyToEmailType is SpecificEmail, this field is required","type":"string"},"replyToEmailType":{"description":"The reply email type.","enum":["TenantEmail","RunOwner","SpecificEmail"],"type":"string"},"toEmailAddress":{"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":"toEmailType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is required."},"children":[]}]}]}],"type":"string"},"toEmailType":{"description":"Email receive type.","enum":["BillToContact","SoldToContact","ShipToContact","SpecificEmails","TenantAdmin","BillToAndSoldToContacts","RunOwner","AllContacts","InvoiceOwnerBillToContact","InvoiceOwnerSoldToContact","InvoiceOwnerShipToContact","InvoiceOwnerBillToAndSoldToContacts","InvoiceOwnerAllContacts"],"type":"string"},"updatedBy":{"description":"The ID of the user who updated the email template.","format":"uuid","type":"string"},"updatedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the email template was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00"},"children":[]}]}]}],"format":"date-time","type":"string"}},"type":"object"}},"components/schemas/POSTPublicEmailTemplateRequest":{"id":"components/schemas/POSTPublicEmailTemplateRequest","kind":"json-schema","title":"POSTPublicEmailTemplateRequest","data":{"example":{"name":"Account Edit Email","eventTypeName":"AccountEdit","active":true,"fromName":"Company Co. Ltd.","fromEmailType":"TenantEmail","toEmailType":"BillToContact","replyToEmailType":"TenantEmail","emailSubject":"Account {{DataSource.Account.AccountNumber}} has been edited","emailBody":"Dear user,<p>the account {{DataSource.Account.AccountNumber}} has been edited. <p>Company Co. Ltd."},"properties":{"active":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the email template. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"bccEmailAddress":{"description":"The email bcc address.","format":"email","type":"string"},"ccEmailAddress":{"description":"The email CC address.","type":"string"},"ccEmailType":{"default":"SpecificEmails","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email CC type."},"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":"When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerSoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerAllContacts"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is tenant-level, such as Bill Run Completion, you can use 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":"text","inline":true,"attributes":{"content":"TenantAdmin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RunOwner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]}]}],"enum":["BillToContact","SoldToContact","ShipToContact","SpecificEmails","TenantAdmin","BillToAndSoldToContacts","RunOwner","AllContacts","InvoiceOwnerBillToContact","InvoiceOwnerSoldToContact","InvoiceOwnerShipToContact","InvoiceOwnerBillToAndSoldToContacts","InvoiceOwnerAllContacts"],"type":"string"},"description":{"description":"The description of the email template.","maxLength":255,"type":"string"},"emailBody":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"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":"You can also embed HTML tags if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isHtml"},"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":[]}]}]}],"type":"string"},"emailHeaders":{"type":"object","title":"emailHeader","description":"Container for custom email headers. Each custom email header consists of a header name and a header value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom email header consists of a name-value pair:"},"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":"Field name: the name of the custom email header."},"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":"Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}},"emailSubject":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"encodingType":{"default":"UTF8","description":"The endcode type of the email body.","enum":["UTF8","Shift_JIS","ISO_2022_JP","EUC_JP","X_SJIS_0213"],"type":"string"},"eventCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify this field, the email template is created based on a standard event. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard Event Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all standard event category codes."},"children":[]}]}]}],"type":"number"},"eventTypeName":{"description":"The name of the custom event or custom scheduled event. If you specify this field, the email template is created based on the corresponding custom event or custom scheduled event.\n","type":"string"},"eventTypeNamespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a standard event type, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace; otherwise, you will get an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you want to create an email template on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderActionProcessed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field."},"children":[]}]}]}],"type":"string"},"fromEmailAddress":{"description":"If fromEmailType is SpecificEmail, this field is required.","type":"string"},"fromEmailType":{"description":"The type of the email.","enum":["TenantEmail","RunOwner","SpecificEmail"],"type":"string"},"fromName":{"description":"The name of the email sender.","type":"string"},"isHtml":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the style of email body is HTML. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"name":{"description":"The name of the email template, a unique name in a tenant.","maxLength":255,"type":"string"},"replyToEmailAddress":{"description":"If replyToEmailType is SpecificEmail, this field is required.","type":"string"},"replyToEmailType":{"description":"Type of the replyTo email.","enum":["TenantEmail","RunOwner","SpecificEmail"],"type":"string"},"toEmailAddress":{"description":"If toEmailType is SpecificEmail, this field is required.","type":"string"},"toEmailType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email receive type."},"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":"When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerSoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerAllContacts"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is tenant-level, such as Bill Run Completion, you can use 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":"text","inline":true,"attributes":{"content":"TenantAdmin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RunOwner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]}]}],"enum":["BillToContact","SoldToContact","ShipToContact","SpecificEmails","TenantAdmin","BillToAndSoldToContacts","RunOwner","AllContacts","InvoiceOwnerBillToContact","InvoiceOwnerSoldToContact","InvoiceOwnerShipToContact","InvoiceOwnerBillToAndSoldToContacts","InvoiceOwnerAllContacts"],"type":"string"}},"required":["name","fromEmailType","emailSubject","emailBody","toEmailType"],"type":"object"}},"components/schemas/PUTPublicEmailTemplateRequest":{"id":"components/schemas/PUTPublicEmailTemplateRequest","kind":"json-schema","title":"PUTPublicEmailTemplateRequest","data":{"example":{"description":"Details of the email template"},"properties":{"active":{"description":"The status of the email template.","type":"boolean"},"bccEmailAddress":{"description":"Email bcc address.","format":"email","type":"string"},"ccEmailAddress":{"description":"Email cc address.","type":"string"},"ccEmailType":{"default":"SpecificEmails","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email CC type."},"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":"When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerSoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerAllContacts"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is tenant-level, such as Bill Run Completion, you can use 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":"text","inline":true,"attributes":{"content":"TenantAdmin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RunOwner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]}]}],"enum":["BillToContact","SoldToContact","ShipToContact","SpecificEmails","TenantAdmin","BillToAndSoldToContacts","RunOwner","AllContacts","InvoiceOwnerBillToContact","InvoiceOwnerSoldToContact","InvoiceOwnerShipToContact","InvoiceOwnerBillToAndSoldToContacts","InvoiceOwnerAllContacts"],"type":"string"},"description":{"description":"The description of the email template.","maxLength":255,"type":"string"},"emailBody":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"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":"User can also embed html tags if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isHtml"},"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":[]}]}]}],"type":"string"},"emailHeaders":{"type":"object","title":"emailHeader","description":"Container for custom email headers. Each custom email header consists of a header name and a header value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom email header consists of a name-value pair:"},"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":"Field name: the name of the custom email header."},"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":"Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}},"emailSubject":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"encodingType":{"description":"The endcode type of the email body.","enum":["UTF8","Shift_JIS","ISO_2022_JP","EUC_JP","X_SJIS_0213"],"type":"string"},"fromEmailAddress":{"description":"If fromEmailType is SpecificEmail, this field is required","type":"string"},"fromEmailType":{"description":"The type of fromEmail.","enum":["TenantEmail","RunOwner","SpecificEmail"],"type":"string"},"fromName":{"description":"The name of email sender.","type":"string"},"isHtml":{"description":"Indicates whether the style of email body is HTML.","type":"boolean"},"name":{"description":"The name of the email template.","maxLength":255,"type":"string"},"replyToEmailAddress":{"description":"If replyToEmailType is SpecificEmail, this field is required.","type":"string"},"replyToEmailType":{"description":"The type of the reply email.","enum":["TenantEmail","RunOwner","SpecificEmail"],"type":"string"},"toEmailAddress":{"description":"If toEmailType is SpecificEmail, this field is required.","type":"string"},"toEmailType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email receive type."},"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":"When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerSoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerBillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InvoiceOwnerAllContacts"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use 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":"text","inline":true,"attributes":{"content":"BillToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SoldToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipToContact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BillToAndSoldToContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AllContacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the related event is tenant-level, such as Bill Run Completion, you can use 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":"text","inline":true,"attributes":{"content":"TenantAdmin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RunOwner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpecificEmails"},"children":[]}]}]}]}]}]}],"enum":["BillToContact","SoldToContact","ShipToContact","SpecificEmails","TenantAdmin","BillToAndSoldToContacts","RunOwner","AllContacts","InvoiceOwnerBillToContact","InvoiceOwnerSoldToContact","InvoiceOwnerShipToContact","InvoiceOwnerBillToAndSoldToContacts","InvoiceOwnerAllContacts"],"type":"string"}},"type":"object"}},"components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon":{"id":"components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon","kind":"json-schema","title":"Callout - without authentication","data":{"title":"Callout - without authentication","description":"Common information for callout templates.\n","properties":{"active":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the callout. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutBaseurl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callout URL. It must start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"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":"Zuora uses port 443 to send callout notifications by default. If you want to use other ports, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"You can add merge fields in the callout URL. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://mywebsite.com/zuora/{{DataSource.Account.Id}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://***","format":"url","minLength":10,"type":"string"},"calloutHeaders":{"type":"object","title":"calloutHeader","description":"Container for custom callout headers. Each custom callout header consists of a header name and a header value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom callout header consists of a key-value pair:"},"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":"Field key: the name of the custom callout header."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: the value of the custom callout header."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields in the field name or value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"calloutParams":{"type":"object","title":"calloutParameter","description":"Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callout parameter consists of a key-value pair:"},"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":"Field key: the name of the callout parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: the value of the callout parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields in the field name or value. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AccountNumber\": \"{{DataSource.Account.AccountNumber}}\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"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":"Alternatively, you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for JSON-formatted callout parameters sent in the callout body."},"children":[]}]}]}]}},"calloutRetry":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specified whether to retry the callout when the callout fails. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"certificate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SSL certificate for the domain of the callout receiver server specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutBaseurl"},"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 value must be in PEM format, which typically starts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-----BEGIN CERTIFICATE-----"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and ends with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-----END CERTIFICATE-----"},"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":"Specifying the SSL certificate can eliminate SSL certificate errors (HTTP status code 495) for callout notifications."},"children":[]}]}]}]},"confirmSuccessFromResponseContent":{"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":"Indicates how Zuora determines whether callout notifications to your system succeed or fail:"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora determines the result based solely on the HTTP response status code. This is the default value."},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the HTTP response status code is 200, Zuora evaluates the callout response and considers the notification successful only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the response body contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},"customRequestBody":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customized request body. This field is available only for callouts whose Content-Type in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value must be in JSON format and double quotes in the value must be escaped."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields to the request body. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\\\"AccountNumber\\\": \\\"{{DataSource.Account.AccountNumber}}\\\",\\\"AccountId\\\": \\\"{{DataSource.Account.Id}}\\\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"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":"You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useCustomRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to customize the callout request body with this field. Alternatively, you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutParams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"description":{"description":"Description for the callout template.","maxLength":255,"type":"string"},"eventCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event category code for a standard event that the callout template relates to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required when creating callout templates for standard events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the list of supported standard event category codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard event category code for events and notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"eventTypeName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a custom event that the callout template relates to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required when creating callout templates for Zuora custom events, custom events, or custom scheduled events."},"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 provided, you can specify the event namespace in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeNamespace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"minLength":1,"type":"string"},"eventTypeNamespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. It indicates who created the event and which namespace the event is assigned to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values are 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":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": events that are created by Zuora. This value applies to Zuora custom events."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you want to create a callout template that relates to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderActionProcessed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event, which is a Zuora custom event, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field."},"children":[]}]}]}],"type":"string","enum":["user.notification","com.zuora.notification"],"default":"user.notification"},"hmacAlgorithm":{"type":"string","description":"The hash function Zuora uses to generate the signed data for HMAC authentication.\n","enum":["MD5","SHA-1","SHA-224","SHA-256","SHA-384","SHA-512"]},"hmacData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message to be authenticated for HMAC authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use merge fields in this value:"},"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":"{{Request.Headers.<header_name>}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refers to the value of a particular request header. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{Request.Headers.Date}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the value of the request header called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Date"},"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":"code","inline":true,"attributes":{"content":"{{Request.Body}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refers to the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other merge fields: See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"hmacKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The header key that Zuora uses to send the header value for HMAC authentication. The header value is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hmacValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and typically contains the signed data."},"children":[]}]}]}]},"hmacOutputFormat":{"type":"string","description":"The format of the signed data for HMAC authentication.\n","enum":["BASE64","HEX"]},"hmacSecret":{"type":"string","description":"The shared secret key that Zuora uses to generate the signed data for HMAC authentication.\n"},"hmacValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The header value for HMAC authentication. The header key is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hmacKey"},"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":"You can use merge fields in this value:"},"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":"{{Request.HMAC.Signed}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refers to the signed data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other merge fields: See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"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 following is a header value example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"The algorithm is SHA-256 and the signed data is {{Request.HMAC.Signed}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"httpMethod":{"description":"The HTTP method of the callout.","enum":["POST","GET","PUT","PATCH","DELETE"],"example":"POST","type":"string"},"id":{"description":"ID of an existing callout template. Specify this field if you want to update an existing callout template.\n","type":"string"},"name":{"description":"The name of the callout template. It must be unique across all callout templates.","maxLength":255,"type":"string"},"useCustomRequestBody":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to enable the customized request body configured in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}},"required":["name","calloutBaseurl","httpMethod"],"type":"object"}},"components/schemas/POSTCreateOrUpdateCalloutTemplateRequestBasicAuthentication":{"id":"components/schemas/POSTCreateOrUpdateCalloutTemplateRequestBasicAuthentication","kind":"json-schema","title":"Callout - Base authentication","data":{"title":"Callout - Base authentication","allOf":[{"$ref":"#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon"},{"type":"object","description":"The Basic Authentication information for callout notifications.\n","properties":{"requiredAuth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether Basic authentication is enabled for the callout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating callout notifications with Basic authentication enabled, you must set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and specify the username and password in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutAuth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutAuth":{"$ref":"#/components/schemas/CalloutAuth"}}}]}},"components/schemas/POSTCreateOrUpdateCalloutTemplateRequestOauth2Authentication":{"id":"components/schemas/POSTCreateOrUpdateCalloutTemplateRequestOauth2Authentication","kind":"json-schema","title":"Callout - OAuth 2.0 authentication","data":{"title":"Callout - OAuth 2.0 authentication","allOf":[{"$ref":"#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon"},{"type":"object","description":"The OAuth 2.0 Authentication information for callout notifications.\n","properties":{"requiredOauth2":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether OAuth 2.0 authentication is enabled for the callout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating callout notifications with OAuth 2.0 authentication enabled, you must set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and specify the OAuth 2.0 provider ID in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth2ProviderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"oauth2ProviderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. This field is required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requiredOauth2"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about how to get the ID of an OAuth 2.0 provider, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-retrieve-oauth-provider-id","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the ID of an OAuth 2.0 provider"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}]}},"components/schemas/POSTCreateOrUpdateCalloutTemplateRequest":{"id":"components/schemas/POSTCreateOrUpdateCalloutTemplateRequest","kind":"json-schema","title":"POSTCreateOrUpdateCalloutTemplateRequest","data":{"example":{"allowPartialSuccess":true,"calloutTemplates":[{"name":"Account Edit","eventTypeName":"AccountEdit","calloutBaseurl":"https://www.example.com/callout/AccountEdit","httpMethod":"POST"},{"name":"Account Delete","eventTypeName":"AccountDelete","calloutBaseurl":"https://www.example.com/callout/AccountDelete","httpMethod":"POST"}]},"properties":{"allowPartialSuccess":{"description":[{"$$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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the call will fail if one or multiple instances fail to import, and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response is returned if all callout templates have been successfully updated."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a success ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") response is returned if one or more instances have imported successfully. All failed instances are also returned in the response."},"children":[]}]}]}],"type":"boolean"},"calloutTemplates":{"description":"A container for callout templates.\n","items":{"oneOf":[{"$ref":"#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon"},{"$ref":"#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestBasicAuthentication"},{"$ref":"#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestOauth2Authentication"}]},"type":"array"}},"type":"object"}},"components/schemas/GETPublicCalloutTemplateResponse":{"id":"components/schemas/GETPublicCalloutTemplateResponse","kind":"json-schema","title":"GETPublicCalloutTemplateResponse","data":{"properties":{"active":{"description":"The status of the callout template.","type":"boolean"},"calloutAuth":{"$ref":"#/components/schemas/CalloutAuth"},"calloutBaseurl":{"description":"The callout URL.","example":"https://***","format":"url","minLength":10,"type":"string"},"calloutHeaders":{"type":"object","title":"calloutHeader","description":"Container for custom callout headers. Each custom callout header consists of a header name and a header value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom callout header consists of a key-value pair:"},"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":"Field name: the name of the custom callout header."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: the value of the custom callout header."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields in the field name or value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"nullable":true},"calloutParams":{"type":"object","title":"calloutParameter","description":"Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callout parameter consists of a key-value pair:"},"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":"Field key: the name of the callout parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: the value of the callout parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields in the field name or value. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AccountNumber\": \"{{DataSource.Account.AccountNumber}}\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"nullable":true},"calloutRetry":{"description":"Indicates whether to retry the callout when the callout fails.","type":"boolean"},"certificate":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SSL certificate for the domain of the callout receiver server specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutBaseurl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"confirmSuccessFromResponseContent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how Zuora determines whether callout notifications to your system succeed or fail:"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora determines the result based solely on the HTTP response status code. This is the default value."},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the HTTP response status code is 200, Zuora evaluates the callout response and considers the notification successful only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the response body contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},"contentType":{"type":"string","description":"The callout body format."},"createdBy":{"description":"The ID of the user who created the callout template.","format":"uuid","type":"string"},"createdOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the callout template was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00"},"children":[]}]}]}],"format":"date-time","type":"string"},"customRequestBody":{"type":"string","description":"Customized request body.\n","nullable":true},"description":{"description":"Description for the callout template.","maxLength":255,"type":"string"},"eventCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event category code for the standard event that the callout template relates to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if the related event of this callout template is a standard event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the list of supported standard event category codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard event category code for events and notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"eventTypeName":{"description":"The name of the custom event that the callout template relates to.\n\nThis field is available only if the related event of this callout template is a Zuora custom event, custom event, or custom scheduled event.\n","minLength":1,"type":"string"},"eventTypeNamespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. It indicates who created the event and which namespace the event is assigned to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values are 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":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": events that are created by Zuora. This value applies to Zuora custom events."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only if the related event of this callout template is a Zuora custom event, custom event, or custom scheduled event."},"children":[]}]}]}],"type":"string","enum":["user.notification","com.zuora.notification"]},"hmacAlgorithm":{"type":"string","nullable":true,"description":"The hash function Zuora uses to generate the signed data for HMAC authentication.\n","enum":["MD5","SHA-1","SHA-224","SHA-256","SHA-384","SHA-512",null]},"hmacData":{"type":"string","nullable":true,"description":"The message to be authenticated for HMAC authentication.\n"},"hmacKey":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The header key that Zuora uses to send the header value for HMAC authentication. The header value is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hmacValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and typically contains the signed data."},"children":[]}]}]}]},"hmacOutputFormat":{"type":"string","nullable":true,"description":"The format of the signed data for HMAC authentication.\n","enum":["BASE64","HEX",null]},"hmacSecret":{"type":"string","nullable":true,"description":"The shared secret key that Zuora uses to generate the signed data for HMAC authentication.\n"},"hmacValue":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The header value for HMAC authentication. The header key is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hmacKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"httpMethod":{"description":"The HTTP method of the callout.","enum":["POST","GET","PUT","PATCH","DELETE"],"example":"POST","type":"string"},"id":{"description":"The ID of the callout template.\n","format":"uuid","type":"string"},"name":{"description":"The name of the callout template.","maxLength":255,"type":"string"},"oauth2ProviderId":{"description":"The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout.","type":"string","nullable":true},"requiredAuth":{"description":"Indicates whether Basic authentication is enabled for the callout.","type":"boolean"},"requiredOauth2":{"description":"Indicates whether OAuth 2.0 authentication is enabled for the callout.","type":"boolean"},"updatedBy":{"description":"The ID of the user who updated the callout template.","format":"uuid","type":"string"},"updatedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the callout template was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00"},"children":[]}]}]}],"format":"date-time","type":"string"},"useCustomRequestBody":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to enable the customized request body configured in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}},"type":"object"}},"components/schemas/POSTPublicCalloutTemplateRequestCommon":{"id":"components/schemas/POSTPublicCalloutTemplateRequestCommon","kind":"json-schema","title":"Callout - without authentication","data":{"title":"Callout - without authentication","description":"Common information for callout templates.\n","properties":{"active":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the callout. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutBaseurl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callout URL. It must start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"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":"Zuora uses port 443 to send callout notifications by default. If you want to use other ports, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"You can add merge fields in the callout URL. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://mywebsite.com/zuora/{{DataSource.Account.Id}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://***","format":"url","minLength":10,"type":"string"},"calloutHeaders":{"type":"object","title":"calloutHeader","description":"Container for custom callout headers. Each custom callout header consists of a header name and a header value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom callout header consists of a key-value pair:"},"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":"Field key: the name of the custom callout header."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: the value of the custom callout header."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields in the field name or value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"calloutParams":{"type":"object","title":"calloutParameter","description":"Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callout parameter consists of a key-value pair:"},"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":"Field key: the name of the callout parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: the value of the callout parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields in the field name or value. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AccountNumber\": \"{{DataSource.Account.AccountNumber}}\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"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":"Alternatively, you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for JSON-formatted callout parameters sent in the callout body."},"children":[]}]}]}]}},"calloutRetry":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specified whether to retry the callout when the callout fails. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"certificate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SSL certificate for the domain of the callout receiver server specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutBaseurl"},"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 value must be in PEM format, which typically starts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-----BEGIN CERTIFICATE-----"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and ends with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-----END CERTIFICATE-----"},"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":"Specifying the SSL certificate can eliminate SSL certificate errors (HTTP status code 495) for callout notifications."},"children":[]}]}]}]},"confirmSuccessFromResponseContent":{"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":"Indicates how Zuora determines whether callout notifications to your system succeed or fail:"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora determines the result based solely on the HTTP response status code. This is the default value."},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the HTTP response status code is 200, Zuora evaluates the callout response and considers the notification successful only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the response body contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},"customRequestBody":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customized request body. This field is available only for callouts whose Content-Type in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value must be in JSON format and double quotes in the value must be escaped."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields to the request body. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\\\"AccountNumber\\\": \\\"{{DataSource.Account.AccountNumber}}\\\",\\\"AccountId\\\": \\\"{{DataSource.Account.Id}}\\\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"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":"You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useCustomRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to customize the callout request body with this field. Alternatively, you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutParams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"description":{"description":"Description for the callout template.","maxLength":255,"type":"string"},"eventCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event category code for a standard event that the callout template relates to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required when creating callout templates for standard events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the list of supported standard event category codes, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-parent-and-event-category-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard event category code for events and notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number"},"eventTypeName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of a custom event that the callout template relates to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required when creating callout templates for Zuora custom events, custom events, or custom scheduled events."},"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 provided, you can specify the event namespace in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeNamespace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"minLength":1,"type":"string"},"eventTypeNamespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventTypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. It indicates who created the event and which namespace the event is assigned to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values are 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":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": events that are created by Zuora. This value applies to Zuora custom events."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you want to create a callout template that relates to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderActionProcessed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event, which is a Zuora custom event, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"com.zuora.notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field."},"children":[]}]}]}],"type":"string","enum":["user.notification","com.zuora.notification"],"default":"user.notification"},"hmacAlgorithm":{"type":"string","description":"The hash function Zuora uses to generate the signed data for HMAC authentication.\n","enum":["MD5","SHA-1","SHA-224","SHA-256","SHA-384","SHA-512"]},"hmacData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message to be authenticated for HMAC authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use merge fields in this value:"},"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":"{{Request.Headers.<header_name>}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refers to the value of a particular request header. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{Request.Headers.Date}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the value of the request header called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Date"},"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":"code","inline":true,"attributes":{"content":"{{Request.Body}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refers to the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other merge fields: See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"hmacKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The header key that Zuora uses to send the header value for HMAC authentication. The header value is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hmacValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and typically contains the signed data."},"children":[]}]}]}]},"hmacOutputFormat":{"type":"string","description":"The format of the signed data for HMAC authentication.\n","enum":["BASE64","HEX"]},"hmacSecret":{"type":"string","description":"The shared secret key that Zuora uses to generate the signed data for HMAC authentication.\n"},"hmacValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The header value for HMAC authentication. The header key is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hmacKey"},"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":"You can use merge fields in this value:"},"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":"{{Request.HMAC.Signed}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refers to the signed data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other merge fields: See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"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 following is a header value example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"The algorithm is SHA-256 and the signed data is {{Request.HMAC.Signed}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"httpMethod":{"description":"The HTTP method of the callout.","enum":["POST","GET","PUT","PATCH","DELETE"],"example":"POST","type":"string"},"name":{"description":"The name of the callout template. It must be unique across all callout templates.","maxLength":255,"type":"string"},"useCustomRequestBody":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to enable the customized request body configured in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}},"required":["name","calloutBaseurl","httpMethod"],"type":"object"}},"components/schemas/POSTPublicCalloutTemplateRequestBasicAuthentication":{"id":"components/schemas/POSTPublicCalloutTemplateRequestBasicAuthentication","kind":"json-schema","title":"Callout - Base authentication","data":{"title":"Callout - Base authentication","allOf":[{"$ref":"#/components/schemas/POSTPublicCalloutTemplateRequestCommon"},{"type":"object","description":"The Basic Authentication information for callout templates.\n","properties":{"requiredAuth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether Basic authentication is enabled for the callout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating callout templates with Basic authentication enabled, you must set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and specify the username and password in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutAuth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"calloutAuth":{"$ref":"#/components/schemas/CalloutAuth"}},"required":["requiredAuth"]}]}},"components/schemas/POSTPublicCalloutTemplateRequestOauth2Authentication":{"id":"components/schemas/POSTPublicCalloutTemplateRequestOauth2Authentication","kind":"json-schema","title":"Callout - OAuth 2.0 authentication","data":{"title":"Callout - OAuth 2.0 authentication","allOf":[{"$ref":"#/components/schemas/POSTPublicCalloutTemplateRequestCommon"},{"type":"object","description":"The OAuth 2.0 Authentication information for callout templates.\n","properties":{"requiredOauth2":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether OAuth 2.0 authentication is enabled for the callout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating callout templates with OAuth 2.0 authentication enabled, you must set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and specify the OAuth 2.0 provider ID in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth2ProviderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"oauth2ProviderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. This field is required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requiredOauth2"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about how to get the ID of an OAuth 2.0 provider, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-retrieve-oauth-provider-id","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the ID of an OAuth 2.0 provider"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["requiredOauth2"]}]}},"components/schemas/POSTPublicCalloutTemplateRequest":{"id":"components/schemas/POSTPublicCalloutTemplateRequest","kind":"json-schema","title":"POSTPublicCalloutTemplateRequest","data":{"oneOf":[{"$ref":"#/components/schemas/POSTPublicCalloutTemplateRequestCommon"},{"$ref":"#/components/schemas/POSTPublicCalloutTemplateRequestBasicAuthentication"},{"$ref":"#/components/schemas/POSTPublicCalloutTemplateRequestOauth2Authentication"}]}},"components/schemas/PUTPublicCalloutTemplateRequestCommon":{"id":"components/schemas/PUTPublicCalloutTemplateRequestCommon","kind":"json-schema","title":"Callout - without authentication","data":{"title":"Callout - without authentication","description":"Common information for callout templates.\n","properties":{"active":{"default":true,"description":"The status of the callout.","type":"boolean"},"calloutBaseurl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callout URL. It must start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"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":"Zuora uses port 443 to send callout notifications by default. If you want to use other ports, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"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":"You can add merge fields in the callout URL. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://mywebsite.com/zuora/{{DataSource.Account.Id}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://***","format":"url","minLength":10,"type":"string"},"calloutHeaders":{"type":"object","title":"calloutHeader","description":"Container for custom callout headers. Each custom callout header consists of a header name and a header value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom callout header consists of a key-value pair:"},"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":"Field key: the name of the custom callout header."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: the value of the custom callout header."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields in the field name or value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"calloutParams":{"type":"object","title":"calloutParameter","description":"Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callout parameter consists of a key-value pair:"},"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":"Field key: the name of the callout parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value: the value of the callout parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields in the field name or value. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"AccountNumber\": \"{{DataSource.Account.AccountNumber}}\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"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":"Alternatively, you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for JSON-formatted callout parameters sent in the callout body."},"children":[]}]}]}]}},"calloutRetry":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specified whether to retry the callout when the callout fails. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"certificate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SSL certificate for the domain of the callout receiver server specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutBaseurl"},"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 value must be in PEM format, which typically starts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-----BEGIN CERTIFICATE-----"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and ends with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-----END CERTIFICATE-----"},"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":"Specifying the SSL certificate can eliminate SSL certificate errors (HTTP status code 495) for callout notifications."},"children":[]}]}]}]},"confirmSuccessFromResponseContent":{"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":"Indicates how Zuora determines whether callout notifications to your system succeed or fail:"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zuora determines the result based solely on the HTTP response status code. This is the default value."},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the HTTP response status code is 200, Zuora evaluates the callout response and considers the notification successful only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the response body contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},"customRequestBody":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customized request body. This field is available only for callouts whose Content-Type in the request body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value must be in JSON format and double quotes in the value must be escaped."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add merge fields to the request body. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\\\"AccountNumber\\\": \\\"{{DataSource.Account.AccountNumber}}\\\",\\\"AccountId\\\": \\\"{{DataSource.Account.Id}}\\\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"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":"You must set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useCustomRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to customize the callout request body with this field. Alternatively, you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calloutParams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"description":{"description":"Description for the callout template.","maxLength":255,"type":"string"},"hmacAlgorithm":{"type":"string","description":"The hash function Zuora uses to generate the signed data for HMAC authentication.\n","enum":["MD5","SHA-1","SHA-224","SHA-256","SHA-384","SHA-512"]},"hmacData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message to be authenticated for HMAC authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use merge fields in this value:"},"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":"{{Request.Headers.<header_name>}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refers to the value of a particular request header. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{Request.Headers.Date}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the value of the request header called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Date"},"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":"code","inline":true,"attributes":{"content":"{{Request.Body}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refers to the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other merge fields: See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"hmacKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The header key that Zuora uses to send the header value for HMAC authentication. The header value is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hmacValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and typically contains the signed data."},"children":[]}]}]}]},"hmacOutputFormat":{"type":"string","description":"The format of the signed data for HMAC authentication.\n","enum":["BASE64","HEX"]},"hmacSecret":{"type":"string","description":"The shared secret key that Zuora uses to generate the signed data for HMAC authentication.\n"},"hmacValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The header value for HMAC authentication. The header key is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hmacKey"},"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":"You can use merge fields in this value:"},"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":"{{Request.HMAC.Signed}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refers to the signed data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other merge fields: See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-merge-field-syntax","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge field syntax for email and callout templates"},"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 following is a header value example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"The algorithm is SHA-256 and the signed data is {{Request.HMAC.Signed}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"httpMethod":{"description":"The HTTP method of the callout.","enum":["POST","GET","PUT","PATCH","DELETE"],"example":"POST","type":"string"},"name":{"description":"The name of the callout template. It must be unique across all callout templates.","maxLength":255,"type":"string"},"useCustomRequestBody":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to enable the customized request body configured in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}},"type":"object"}},"components/schemas/PUTPublicCalloutTemplateRequestBasicAuthentication":{"id":"components/schemas/PUTPublicCalloutTemplateRequestBasicAuthentication","kind":"json-schema","title":"Callout - Base authentication","data":{"title":"Callout - Base authentication","allOf":[{"$ref":"#/components/schemas/PUTPublicCalloutTemplateRequestCommon"},{"type":"object","description":"The Basic Authentication information for callout templates.\n","properties":{"requiredAuth":{"description":"Indicates whether Basic authentication is enabled for the callout.\n","type":"boolean"},"calloutAuth":{"$ref":"#/components/schemas/CalloutAuth"}}}]}},"components/schemas/PUTPublicCalloutTemplateRequestOauth2Authentication":{"id":"components/schemas/PUTPublicCalloutTemplateRequestOauth2Authentication","kind":"json-schema","title":"Callout - OAuth 2.0 authentication","data":{"title":"Callout - OAuth 2.0 authentication","allOf":[{"$ref":"#/components/schemas/PUTPublicCalloutTemplateRequestCommon"},{"type":"object","description":"The OAuth 2.0 Authentication information for callout templates.\n","properties":{"requiredOauth2":{"description":"Indicates whether OAuth 2.0 authentication is enabled for the callout.\n","type":"boolean"},"oauth2ProviderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about how to get the ID of an OAuth 2.0 provider, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-retrieve-oauth-provider-id","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the ID of an OAuth 2.0 provider"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}]}},"components/schemas/PUTPublicCalloutTemplateRequest":{"id":"components/schemas/PUTPublicCalloutTemplateRequest","kind":"json-schema","title":"PUTPublicCalloutTemplateRequest","data":{"oneOf":[{"$ref":"#/components/schemas/PUTPublicCalloutTemplateRequestCommon"},{"$ref":"#/components/schemas/PUTPublicCalloutTemplateRequestBasicAuthentication"},{"$ref":"#/components/schemas/PUTPublicCalloutTemplateRequestOauth2Authentication"}]}},"components/schemas/CreateOrUpdateReusableBlockFormat":{"id":"components/schemas/CreateOrUpdateReusableBlockFormat","kind":"json-schema","title":"CreateOrUpdateReusableBlockFormat","data":{"properties":{"active":{"default":true,"description":"The status of the reusable block. Only active blocks can be embedded into email templates.\n","type":"boolean"},"category":{"description":"The category of the reusable block. You can filter blocks by category when editing email templates in the UI.\n","type":"string","enum":["Headers","Footers","Other"]},"content":{"description":"The content of the reusable block, which is automatically inserted into email templates when sending email notifications.\n","type":"string"},"id":{"description":"ID of an existing reusable block. Specify this field if you want to update an existing reusable block. You must provide all fields when updating an existing reusable block.\n","type":"string"},"name":{"description":"The name of the reusable block. The value must be unique across all blocks.\n","type":"string"},"number":{"description":"The number of the reusable block. The value must be unique across all blocks.\n\nIf not specified, a unique value will be provided by default.\n","type":"string"},"tags":{"description":"List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter.\n","items":{"type":"string"},"type":"array"}},"required":["category","content","name"],"type":"object"}},"components/schemas/CreateOrUpdateReusableBlockRequest":{"id":"components/schemas/CreateOrUpdateReusableBlockRequest","kind":"json-schema","title":"CreateOrUpdateReusableBlockRequest","data":{"properties":{"allowPartialSuccess":{"description":"When set to false, the call will fail if one or multiple instances fail to import, and a 200 response is returned if all reusable blocks have been successfully updated. \nWhen set to true, a success (200) response is returned if one or more instances have imported successfully. All failed instances are also returned in the response.\n","type":"boolean"},"reusableBlocks":{"description":"A container for reusable blocks.\n","maxItems":1000,"minItems":1,"items":{"$ref":"#/components/schemas/CreateOrUpdateReusableBlockFormat"},"type":"array"}},"type":"object"}},"components/schemas/CreateOrUpdateReusableBlockResponse":{"id":"components/schemas/CreateOrUpdateReusableBlockResponse","kind":"json-schema","title":"CreateOrUpdateReusableBlockResponse","data":{"example":{"reasons":[]},"properties":{"reasons":{"description":"Returns an empty array if the request succeeds.\n","items":{"type":"string"},"type":"array"}},"type":"object"}},"components/schemas/GetPublicReusableBlockResponse":{"id":"components/schemas/GetPublicReusableBlockResponse","kind":"json-schema","title":"GetPublicReusableBlockResponse","data":{"example":{"id":"c6af751e4a0041eebb000c51e95e6c2d","createdBy":"8a90e08282f4ed040182f67bab2902ff","createdOn":"2025-04-22T08:17:24.000 UTC","updatedBy":"8a90e08282f4ed040182f67bab2902ff","updatedOn":"2025-04-22T08:17:24.000 UTC","active":true,"name":"Header Block","number":"RB-00000010","category":"Headers","tags":[],"content":"(The content of the block)"},"properties":{"active":{"default":true,"description":"The status of the reusable block. Only active blocks can be embedded into email templates.\n","type":"boolean"},"category":{"description":"The category of the reusable block. You can filter blocks by category when editing email templates in the UI.\n","type":"string","enum":["Headers","Footers","Other"]},"content":{"description":"The content of the reusable block, which is automatically inserted into email templates when sending email notifications.\n","type":"string"},"createdBy":{"description":"The ID of the user who created the reusable block.\n","format":"uuid","type":"string"},"createdOn":{"description":"The time when the reusable block was created.\n","format":"date-time","type":"string"},"id":{"description":"The ID of the reusable block.\n","format":"uuid","type":"string"},"name":{"description":"The name of the reusable block. The value must be unique across all blocks.\n","type":"string"},"number":{"description":"The number of the reusable block. The value must be unique across all blocks.\n\nIf not specified, a unique value will be provided by default.\n","type":"string"},"tags":{"description":"List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter.\n","items":{"type":"string"},"type":"array"},"updatedBy":{"description":"The ID of the user who updated the reusable block.\n","format":"uuid","type":"string"},"updatedOn":{"description":"TThe time when the reusable block was updated.\n","format":"date-time","type":"string"}},"type":"object"}},"components/schemas/CreatePublicReusableBlockRequest":{"id":"components/schemas/CreatePublicReusableBlockRequest","kind":"json-schema","title":"CreatePublicReusableBlockRequest","data":{"example":{"name":"Header Block","category":"Headers","content":"(The content of the block)"},"properties":{"active":{"default":true,"description":"The status of the reusable block. Only active blocks can be embedded into email templates.\n","type":"boolean"},"category":{"description":"The category of the reusable block. You can filter blocks by category when editing email templates in the UI.\n","type":"string","enum":["Headers","Footers","Other"]},"content":{"description":"The content of the reusable block, which is automatically inserted into email templates when sending email notifications.\n","type":"string"},"name":{"description":"The name of the reusable block. The value must be unique across all blocks.\n","type":"string"},"number":{"description":"The number of the reusable block. The value must be unique across all blocks.\n\nIf not specified, a unique value will be provided by default.\n","type":"string"},"tags":{"description":"List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter.\n","items":{"type":"string"},"type":"array"}},"required":["category","content","name"],"type":"object"}},"components/schemas/UpdatePublicReusableBlockRequest":{"id":"components/schemas/UpdatePublicReusableBlockRequest","kind":"json-schema","title":"UpdatePublicReusableBlockRequest","data":{"example":{"tag":["logo"]},"properties":{"active":{"default":true,"description":"The status of the reusable block. Only active blocks can be embedded into email templates.\n","type":"boolean"},"category":{"description":"The category of the reusable block. You can filter blocks by category when editing email templates in the UI.\n","type":"string","enum":["Headers","Footers","Other"]},"content":{"description":"The content of the reusable block, which is automatically inserted into email templates when sending email notifications.\n","type":"string"},"name":{"description":"The name of the reusable block. The value must be unique across all blocks.\n","type":"string"},"number":{"description":"The number of the reusable block. The value must be unique across all blocks.\n","type":"string"},"tags":{"description":"List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter.\n","items":{"type":"string"},"type":"array"}},"type":"object"}},"components/schemas/UpdatePublicReusableBlockResponse":{"id":"components/schemas/UpdatePublicReusableBlockResponse","kind":"json-schema","title":"UpdatePublicReusableBlockResponse","data":{"example":{"id":"c6af751e4a0041eebb000c51e95e6c2d","createdBy":"8a90e08282f4ed040182f67bab2902ff","createdOn":"2025-04-22T08:17:24.000 UTC","updatedBy":"8a90e08282f4ed040182f67bab2902ff","updatedOn":"2025-04-22T08:17:24.000 UTC","active":true,"name":"Header Block","number":"RB-00000010","category":"Headers","tags":["logo"],"content":"(The content of the block)"},"properties":{"active":{"default":true,"description":"The status of the reusable block. Only active blocks can be embedded into email templates.\n","type":"boolean"},"category":{"description":"The category of the reusable block. You can filter blocks by category when editing email templates in the UI.\n","type":"string","enum":["Headers","Footers","Other"]},"content":{"description":"The content of the reusable block, which is automatically inserted into email templates when sending email notifications.\n","type":"string"},"createdBy":{"description":"The ID of the user who created the reusable block.\n","format":"uuid","type":"string"},"createdOn":{"description":"The time when the reusable block was created.\n","format":"date-time","type":"string"},"id":{"description":"The ID of the reusable block.\n","format":"uuid","type":"string"},"name":{"description":"The name of the reusable block. The value must be unique across all blocks.\n","type":"string"},"number":{"description":"The number of the reusable block. The value must be unique across all blocks.\n\nIf not specified, a unique value will be provided by default.\n","type":"string"},"tags":{"description":"List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter.\n","items":{"type":"string"},"type":"array"},"updatedBy":{"description":"The ID of the user who updated the reusable block.\n","format":"uuid","type":"string"},"updatedOn":{"description":"TThe time when the reusable block was updated.\n","format":"date-time","type":"string"}},"type":"object"}},"components/schemas/NotificationsHistoryDeletionTaskResponse":{"id":"components/schemas/NotificationsHistoryDeletionTaskResponse","kind":"json-schema","title":"NotificationsHistoryDeletionTaskResponse","data":{"description":"The notification history deletion task information.","properties":{"accountId":{"description":"The ID of the account whose notification histories are deleted by the current deletion task.","format":"uuid","type":"string"},"createdBy":{"description":"The ID of the user who submits the notification history deletion task.","format":"uuid","type":"string"},"createdOn":{"description":"The timestamp when the notification history deletion task is created.","type":"integer"},"id":{"description":"The ID of the notification history deletion task.","format":"uuid","type":"string"},"status":{"description":"The status of the notification history deletion task.","enum":["RUNNING","FINISHED","FAILED"],"type":"string"},"tenantId":{"description":"The ID of the tenant where the notification history deletion task runs.","type":"string"}},"type":"object"}},"components/schemas/POSTResendCalloutNotifications":{"id":"components/schemas/POSTResendCalloutNotifications","kind":"json-schema","title":"POSTResendCalloutNotifications","data":{"example":["a02ea6d76931475bb73fcd339b5f6ht8g","40dbbc5f2cfb4e2fa236db11ea1dfghht","a3fd8e81c20a4ac0a1eb3747339asdfef","a00000000000000000000000000000000"],"items":{"description":"ID for failed callout notifications. You can resend at most 1000 callout notifications at a time.\n","type":"string"},"type":"array"}},"components/schemas/ResendCalloutNotificationsFailedResponse":{"id":"components/schemas/ResendCalloutNotificationsFailedResponse","kind":"json-schema","title":"ResendCalloutNotificationsFailedResponse","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a fail-to-resend callout notification history object, containing an object with the error code and message."},"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":" Multiple records of this field are allowed in the response. Each of them represents a fail-to-resend callout notification history."},"children":[]}]}]}],"properties":{"code":{"description":"The error code of response.\n","type":"string"},"message":{"description":"The detail information of the error response","type":"string"}},"type":"object"},"type":"object"}},"components/schemas/POSTResendEmailNotifications":{"id":"components/schemas/POSTResendEmailNotifications","kind":"json-schema","title":"POSTResendEmailNotifications","data":{"example":["a02ea6d76931475bb73fcd339b5f6ht8g","40dbbc5f2cfb4e2fa236db11ea1dfghht","a3fd8e81c20a4ac0a1eb3747339asdfef","a00000000000000000000000000000000"],"items":{"description":"ID for failed email notifications. You can resend at most 1000 email notifications at a time.\n","type":"string"},"type":"array"}},"components/schemas/ResendEmailNotificationsFailedResponse":{"id":"components/schemas/ResendEmailNotificationsFailedResponse","kind":"json-schema","title":"ResendEmailNotificationsFailedResponse","data":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a fail-to-resend email notification history object, containing an object with the error code and message."},"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":" Multiple records of this field are allowed in the response. Each of them represents a fail-to-resend email notification history."},"children":[]}]}]}],"properties":{"code":{"description":"The error code of response.\n","type":"string"},"message":{"description":"The detail information of the error response","type":"string"}},"type":"object"},"type":"object"}},"components/schemas/GETCalloutHistoryVOType":{"id":"components/schemas/GETCalloutHistoryVOType","kind":"json-schema","title":"calloutHistories","data":{"properties":{"attemptedNum":{"description":"The number of times the callout was retried.\n","type":"string"},"createTime":{"description":"The time that the calloutHistory record was made.\n","type":"string"},"eventCategory":{"description":"The event category for the callout.\n","type":"string"},"eventContext":{"description":"The context of the callout event.\n","type":"string"},"notification":{"description":"The name of the notification.\n","type":"string"},"requestMethod":{"description":"The request method set in notifications settings.\n","type":"string"},"requestUrl":{"description":"The base url set in notifications settings.\n","type":"string"},"responseCode":{"description":"The responseCode of the request.\n","type":"string"},"responseContent":{"description":"","type":"string"}},"title":"calloutHistories","type":"object"}},"components/schemas/GETCalloutHistoryVOsType":{"id":"components/schemas/GETCalloutHistoryVOsType","kind":"json-schema","title":"GETCalloutHistoryVOsType","data":{"properties":{"calloutHistories":{"description":"A container for callout histories.\n","items":{"$ref":"#/components/schemas/GETCalloutHistoryVOType"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETEmailHistoryVOType":{"id":"components/schemas/GETEmailHistoryVOType","kind":"json-schema","title":"emailHistories","data":{"properties":{"accountId":{"description":"ID of an account.\n","type":"string"},"bcc":{"description":"Blind carbon copy recipients of the email.\n","type":"string"},"cc":{"description":"Carbon Copy recipients of the email.\n","type":"string"},"errorMessage":{"description":"null if the content of result is \"OK\". A description of the error if the content of result is not \"OK\".\n","type":"string","nullable":true},"eventCategory":{"description":"The event category of the email.\n","type":"string"},"fromEmail":{"description":"The sender of the email.\n","type":"string"},"notification":{"description":"The name of the notification.\n","type":"string"},"replyTo":{"description":"The reply-to address as configured in the email template.\n","type":"string"},"result":{"description":"The result from the mail server of sending the email.\n","type":"string"},"sendTime":{"description":"The date and time the email was sent.\n","type":"string"},"subject":{"description":"The subject of the email.\n","type":"string"},"toEmail":{"description":"The intended recipient of the email.\n","type":"string"}},"title":"emailHistories","type":"object"}},"components/schemas/GETEmailHistoryVOsType":{"id":"components/schemas/GETEmailHistoryVOsType","kind":"json-schema","title":"GETEmailHistoryVOsType","data":{"properties":{"emailHistories":{"description":"A container for email histories.\n","items":{"$ref":"#/components/schemas/GETEmailHistoryVOType"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/CustomObjectCustomFieldDefinition":{"id":"components/schemas/CustomObjectCustomFieldDefinition","kind":"json-schema","title":"customObjectCustomFieldDefinition","data":{"description":"The custom field definition in the custom object","properties":{"displayName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to use this field as the display name of the custom object when being linked to another custom object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies only to the Text custom field type:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified."},"children":[]}]}]}]}],"type":"boolean"},"format":{"description":"The data format of the custom field","type":"string"},"label":{"description":"The UI label of the custom field","type":"string"},"maxLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum length of string that can be stored in the custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies only to the following custom field 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":"Text:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified or is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Long Text:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"long-text"},"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":"Picklist:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"multiselect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified or is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Multiselect:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"multiselect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"type":"integer"},"multiselect":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this is a multiselect custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies only to the Picklist or Multiselect custom field 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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]}]}],"type":"boolean"},"origin":{"description":"Specifies that this is a custom field","enum":["custom"],"type":"string"},"type":{"description":"The data type of the custom field","type":"string"}},"title":"customObjectCustomFieldDefinition","type":"object"}},"components/schemas/CustomObjectCustomFieldsDefinition":{"id":"components/schemas/CustomObjectCustomFieldsDefinition","kind":"json-schema","title":"customObjectCustomFieldDefinition","data":{"additionalProperties":{"$ref":"#/components/schemas/CustomObjectCustomFieldDefinition"},"description":"The custom field definition in the custom object definition","title":"customObjectCustomFieldDefinition","type":"object"}},"components/schemas/CustomObjectAllFieldsDefinition":{"id":"components/schemas/CustomObjectAllFieldsDefinition","kind":"json-schema","title":"customObjectFieldDefinition","data":{"allOf":[{"properties":{"CreatedById":{"description":[{"$$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":"CreatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field definition"},"children":[]}]}]}],"properties":{"format":{"description":"The field data format","enum":["uuid"],"type":"string"},"label":{"description":"The UI name of the field","type":"string"},"origin":{"description":"Specifies whether the field is a system field or a custom field","enum":["system"],"type":"string"},"type":{"description":"The field data type","enum":["string"],"type":"string"}},"type":"object"},"CreatedDate":{"description":[{"$$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":"CreatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field definition"},"children":[]}]}]}],"properties":{"format":{"description":"The field data format","enum":["date-time"],"type":"string"},"origin":{"description":"Specifies the field is a system field","enum":["system"],"type":"string"},"type":{"description":"The field data type","enum":["string"],"type":"string"}},"type":"object"},"Id":{"description":[{"$$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":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field definition"},"children":[]}]}]}],"properties":{"format":{"description":"The field data format","enum":["uuid"],"type":"string"},"label":{"description":"The UI name of the field","type":"string"},"origin":{"description":"Specifies whether the field is a system field or a custom field","enum":["system"],"type":"string"},"type":{"description":"The field data type","enum":["string"],"type":"string"}},"type":"object"},"UpdatedById":{"description":[{"$$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":"UpdatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field definition"},"children":[]}]}]}],"properties":{"format":{"description":"The field data format","enum":["uuid"],"type":"string"},"label":{"description":"The UI name of the field","type":"string"},"origin":{"description":"Specifies whether the field is a system field or a custom field","enum":["system"],"type":"string"},"type":{"description":"The field data type","enum":["string"],"type":"string"}},"type":"object"},"UpdatedDate":{"description":[{"$$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":"UpdatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field definition"},"children":[]}]}]}],"properties":{"format":{"description":"The field data format","enum":["date-time"],"type":"string"},"origin":{"description":"Specifies the field is a system field","enum":["system"],"type":"string"},"type":{"description":"The field data type","enum":["string"],"type":"string"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/CustomObjectCustomFieldsDefinition"}],"description":"The definitions of all the fields in the custom object definition","title":"customObjectFieldDefinition"}},"components/schemas/FieldsAdditionalProperties":{"id":"components/schemas/FieldsAdditionalProperties","kind":"json-schema","title":"relationshipFieldMapping","data":{"additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field mappings in the form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<this-object-field-name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<other-object-field-name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"title":"relationshipFieldMapping","type":"object"}},"components/schemas/CustomObjectDefinition":{"id":"components/schemas/CustomObjectDefinition","kind":"json-schema","title":"customObjectDefinition","data":{"example":{"CreatedById":"7b39d73f-22e6-404a-b8e7-894f7620e91c","CreatedDate":"2019-09-29T06:45:23.378Z","Id":"df7f10f9-4ec9-4389-a9eb-a6a3d549bb61","UpdatedById":"7b39d73f-22e6-404a-b8e7-894f7620e91c","UpdatedDate":"2019-09-29T06:45:23.378Z","schema":{"filterable":["last_name__c","email__c"],"label":"Personal Profile","object":"person","properties":{"CreatedById":{"format":"uuid","label":"CreatedById","origin":"system","type":"string"},"CreatedDate":{"format":"date-time","label":"CreatedDate","origin":"system","type":"string"},"Id":{"format":"uuid","label":"Id","origin":"system","type":"string"},"UpdatedById":{"format":"uuid","label":"UpdatedById","origin":"system","type":"string"},"UpdatedDate":{"format":"date-time","label":"UpdatedDate","origin":"system","type":"string"},"age__c":{"description":"Age in years","minimum":0,"origin":"custom","type":"integer"},"email__c":{"format":"email","maxLength":128,"origin":"custom","type":"string"},"home_address__c":{"format":"uuid","origin":"custom","type":"string"},"last_name__c":{"maxLength":128,"origin":"custom","type":"string"},"marital_status__c":{"default":"Unknown","enum":["Single","Married","Unknown"],"origin":"custom","type":"string"},"work_address__c":{"format":"uuid","origin":"custom","type":"string"}},"relationships":[{"cardinality":"manyToOne","fields":{"home_address__c":"Id"},"namespace":"default","object":"address","recordConstraints":{"create":{"enforceValidMapping":false}}},{"cardinality":"manyToOne","fields":{"work_address__c":"Id"},"namespace":"default","object":"address","recordConstraints":{"create":{"enforceValidMapping":false}}},{"cardinality":"oneToMany","fields":{"Id":"person_id__c"},"namespace":"default","object":"car","recordConstraints":{"create":{"enforceValidMapping":false}}},{"cardinality":"oneToMany","fields":{"Id":"person_id__c"},"namespace":"default","object":"device","recordConstraints":{"create":{"enforceValidMapping":false}}}],"required":["last_name__c","marital_status__c"],"type":"object"},"type":"person"},"properties":{"CreatedById":{"description":"The creator's Id","format":"uuid","type":"string"},"CreatedDate":{"description":"The creation time of the custom object definition in date-time format.","format":"date-time","type":"string"},"Id":{"description":"The unique Id of the custom object definition","format":"uuid","type":"string"},"UpdatedById":{"description":"The modifier's Id","format":"uuid","type":"string"},"UpdatedDate":{"description":"The update time of the custom object definition in date-time format.","format":"date-time","type":"string"},"schema":{"description":"The schema of the custom object definition","properties":{"auditable":{"description":"The set of fields which Audit Trail tracks and records changes of.","items":{"type":"string"},"type":"array"},"enableCreateRecordAuditing":{"description":"Indicates whether to audit the creation of custom object records of this custom object definition.","type":"boolean"},"enableDeleteRecordAuditing":{"description":"Indicates whether to audit the deletion of custom object records of this custom object definition.","type":"boolean"},"filterable":{"description":"The set of fields that are allowed to be queried on. Queries on non-filterable fields will be rejected. You can not change a non-filterable field to filterable.","items":{"type":"string"},"type":"array"},"label":{"description":"A label for the custom object","type":"string"},"object":{"description":"The API name of the custom object","type":"string"},"properties":{"$ref":"#/components/schemas/CustomObjectAllFieldsDefinition"},"relationships":{"description":"An array of relationships with Zuora objects or other custom objects","items":{"additionalProperties":false,"properties":{"cardinality":{"default":"manyToOne","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardinality of the relationship from this object to another object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manyToOne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" relationship means this object is the child object (the \"many\" side), and the referenced object (the \"one\" side) is the parent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oneToMany"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" relationship means this object is the parent object (the \"one\" side), and the referenced object (the \"many\" side) is the child."},"children":[]}]}]}],"enum":["manyToOne","oneToMany"],"type":"string"},"fields":{"$ref":"#/components/schemas/FieldsAdditionalProperties"},"namespace":{"description":"The namespace where the related object is located","type":"string"},"object":{"description":"The API name of the related object","type":"string"},"recordConstraints":{"description":"Specifies contraints to apply to custom object records.\n","properties":{"create":{"properties":{"enforceValidMapping":{"description":"Specifies whether Zuora validates the values of mapped fields\nin custom object records.\n","type":"boolean"}},"type":"object"}},"type":"object"}},"type":"object"},"type":"array"},"required":{"description":"The required fields of the custom object definition. You can change required fields to optional. However, you can only change optional fields to required on the custom objects with no records.","items":{"type":"string"},"type":"array"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom object definition type. Can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currently."},"children":[]}]}]}],"enum":["object"],"type":"string"},"unique":{"description":"The fields with unique constraints.","items":{"type":"string"},"type":"array"}},"type":"object"},"type":{"description":"The API name of the custom object","type":"string"}},"title":"customObjectDefinition","type":"object"}},"components/schemas/CustomObjectDefinitions":{"id":"components/schemas/CustomObjectDefinitions","kind":"json-schema","title":"customObjectDefinitions","data":{"additionalProperties":{"$ref":"#/components/schemas/CustomObjectDefinition"},"description":"The custom object definitions. This object maps types to custom object definitions.","title":"customObjectDefinitions","type":"object"}},"components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse":{"id":"components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse","kind":"json-schema","title":"GETAllCustomObjectDefinitionsInNamespaceResponse","data":{"example":{"Id":"f67635c8-094e-4ffc-90be-5dba5c639494","type":"Vehicle","CreatedById":"8ad084a67f9c7138017fab8a8b511b5a","UpdatedById":"8ad084a67f9c7138017fab8a8b511b5a","CreatedDate":"2024-11-15T06:13:27.338Z","UpdatedDate":"2024-11-15T06:13:27.338Z","schema":{"object":"Vehicle","label":"Vehicle","enableCreateRecordAuditing":false,"enableDeleteRecordAuditing":false,"properties":{"DeviceId__c":{"maxLength":20,"label":"Device ID","origin":"custom","type":"string"},"OrderId__c":{"format":"uuid","label":"Order ID","origin":"custom","type":"string"},"Id":{"format":"uuid","label":"Id","origin":"system","type":"string"},"CreatedById":{"label":"CreatedById","origin":"system","type":"string"},"UpdatedById":{"label":"UpdatedById","origin":"system","type":"string"},"CreatedDate":{"format":"date-time","label":"CreatedDate","origin":"system","type":"string"},"UpdatedDate":{"format":"date-time","label":"UpdatedDate","origin":"system","type":"string"}},"required":["Id","CreatedById","UpdatedById","CreatedDate","UpdatedDate"],"filterable":["OrderId__c","Id","CreatedDate","UpdatedDate"],"relationships":[{"cardinality":"manyToOne","namespace":"com_zuora","object":"orders","fields":{"OrderId__c":"Id"},"recordConstraints":{"create":{"enforceValidMapping":true}}},{"cardinality":"manyToOne","namespace":"com_zuora","object":"User","fields":{"CreatedById":"Id"},"recordConstraints":{"create":{"enforceValidMapping":true}}},{"cardinality":"manyToOne","namespace":"com_zuora","object":"User","fields":{"UpdatedById":"Id"},"recordConstraints":{"create":{"enforceValidMapping":true}}}],"enableRecordMigration":false}},"properties":{"count":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of objects in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"definitions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. The value of this field is the number of custom object definitions in the namespace."},"children":[]}]}]}],"type":"integer"},"definitions":{"$ref":"#/components/schemas/CustomObjectDefinitions"}},"type":"object"}},"components/schemas/PostCustomObjectDefinitionFieldDefinitionRequest":{"id":"components/schemas/PostCustomObjectDefinitionFieldDefinitionRequest","kind":"json-schema","title":"customObjectCustomFieldDefinition","data":{"properties":{"displayName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to use this field as the display name of the custom object when being linked to another custom object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies only to the Text custom field type:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified."},"children":[]}]}]}]}],"type":"boolean"},"format":{"description":"The data format of the custom field","type":"string"},"label":{"description":"The UI label of the custom field","type":"string"},"maxLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum length of string that can be stored in the custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies only to the following custom field 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":"Text:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified or is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Long Text:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"long-text"},"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":"Picklist:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"multiselect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified or is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Multiselect:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"multiselect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"type":"integer"},"multiselect":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this is a multiselect custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies only to the Picklist or Multiselect custom field 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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]}]}],"type":"boolean"},"type":{"description":"The data type of the custom field","type":"string"}},"required":["type","label"],"title":"customObjectCustomFieldDefinition","type":"object"}},"components/schemas/PostCustomObjectDefinitionFieldsDefinitionRequest":{"id":"components/schemas/PostCustomObjectDefinitionFieldsDefinitionRequest","kind":"json-schema","title":"customObjectCustomFieldDefinitions","data":{"additionalProperties":{"$ref":"#/components/schemas/PostCustomObjectDefinitionFieldDefinitionRequest"},"title":"customObjectCustomFieldDefinitions","type":"object"}},"components/schemas/FieldsAdditionalPropertiesForPostDefinition":{"id":"components/schemas/FieldsAdditionalPropertiesForPostDefinition","kind":"json-schema","title":"relationshipFieldMapping","data":{"additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field mappings in the form of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<this-object-field-name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<other-object-field-name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Usually the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<other-object-field-name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the related object. Two exceptions are Subscription Name and Rate Plan Charge Number as both of them are unique."},"children":[]}]}]}],"title":"relationshipFieldMapping","type":"object"}},"components/schemas/PostCustomObjectDefinitionsRequestDefinition":{"id":"components/schemas/PostCustomObjectDefinitionsRequestDefinition","kind":"json-schema","title":"customObjectDefinition","data":{"properties":{"auditable":{"description":"The set of fields which Audit Trail tracks and records changes of. You can change auditable fields to non-auditable, and vice versa. One custom object can have a maximum of five auditable fields.","items":{"type":"string"},"type":"array"},"enableCreateRecordAuditing":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to audit the creation of custom object records of this custom object definition."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that you must enable the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Object Definition"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" audit trail setting in your Zuora tenant before auditing custom object record creation. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/administrator-settings/manage-audit-trail-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage audit trail settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"enableDeleteRecordAuditing":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to audit the deletion of custom object records of this custom object definition."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that you must enable the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Object Definition"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" audit trail setting in your Zuora tenant before auditing custom object record deletion. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/administrator-settings/manage-audit-trail-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage audit trail settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"filterable":{"description":"The set of fields that are allowed to be queried on. Queries on non-filterable fields will be rejected. You can not change a non-filterable field to filterable.","items":{"type":"string"},"type":"array"},"label":{"description":"A UI label for the custom object","type":"string"},"object":{"description":"The API name of the custom object","type":"string"},"properties":{"$ref":"#/components/schemas/PostCustomObjectDefinitionFieldsDefinitionRequest"},"relationships":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of relationships with Zuora objects or other custom objects. You can add at most 2 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manyToOne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" relationships when creating a custom field definition."},"children":[]}]}]}],"items":{"additionalProperties":false,"properties":{"cardinality":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardinality of the relationship from this object to another object."},"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":"manyToOne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cardinality can be used when creating relationships.  A relationship with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oneToMany"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cardinality is created implicitly when a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manyToOne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" relationship is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom object definition can have a maximum of 2 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manyToOne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" relationships."},"children":[]}]}]}],"enum":["manyToOne"],"type":"string"},"fields":{"$ref":"#/components/schemas/FieldsAdditionalPropertiesForPostDefinition"},"namespace":{"description":"The namespace where the related object is located","type":"string"},"object":{"description":"The API name of the related object","type":"string"},"recordConstraints":{"description":"Specifies contraints to apply to custom object records.\n","properties":{"create":{"properties":{"enforceValidMapping":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether Zuora validates the values of mapped fields"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in custom object records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora validates the values of mapped fields"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in custom object records. For example, if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom object definition has a field called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountId__c"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that is mapped to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora verifies that the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountId__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a valid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account ID when a custom object record is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountId__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a valid account ID,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the operation fails."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"type":"object"}},"required":["namespace","object","fields"],"type":"object"},"type":"array"},"required":{"description":"The required fields of the custom object. You can change required fields to optional. However, you can only change optional fields to required on the custom objects with no records.","items":{"type":"string"},"type":"array"},"unique":{"description":"The fields with unique constraints. You can remove the unique constraint on a field. However, you can only add a unique constraint to a filterable field if the custom object contains no record. One custom object can have a maximum of five fields with unique constraints.","items":{"type":"string"},"type":"array"}},"required":["object","label"],"title":"customObjectDefinition","type":"object"}},"components/schemas/PostCustomObjectDefinitionsRequestDefinitions":{"id":"components/schemas/PostCustomObjectDefinitionsRequestDefinitions","kind":"json-schema","title":"customObjectDefinitions","data":{"additionalProperties":{"$ref":"#/components/schemas/PostCustomObjectDefinitionsRequestDefinition"},"description":"The custom object definitions. This object maps types to custom object definitions.\n","title":"customObjectDefinitions","type":"object"}},"components/schemas/PostCustomObjectDefinitionsRequest":{"id":"components/schemas/PostCustomObjectDefinitionsRequest","kind":"json-schema","title":"PostCustomObjectDefinitionsRequest","data":{"example":{"definitions":{"Vehicle":{"label":"Vehicle","object":"Vehicle","properties":{"DeviceId__c":{"label":"Device ID","type":"string","maxLength":20},"OrderId__c":{"label":"Order ID","type":"string","format":"uuid"}},"relationships":[{"namespace":"com_zuora","object":"orders","fields":{"OrderId__c":"Id"}}]}}},"properties":{"definitions":{"$ref":"#/components/schemas/PostCustomObjectDefinitionsRequestDefinitions"}},"type":"object"}},"components/schemas/CustomObjectCustomFieldDefinitionUpdate":{"id":"components/schemas/CustomObjectCustomFieldDefinitionUpdate","kind":"json-schema","title":"customObjectCustomFieldDefinition","data":{"description":"The custom field definition in the custom object","properties":{"default":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the action is  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateField"},"children":[]}]}]}],"type":"string"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the action is  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateField"},"children":[]}]}]}],"type":"string"},"displayName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to use this field as the display name of the custom object when being linked to another custom object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies only to the Text custom field type:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified."},"children":[]}]}]}]}],"type":"boolean"},"format":{"description":"The data format of the custom field","type":"string"},"label":{"description":"The UI label of the custom field","type":"string"},"maxLength":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum length of string that can be stored in the custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies only to the following custom field 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":"Text:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified or is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Long Text:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"long-text"},"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":"Picklist:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"multiselect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not specified or is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Multiselect:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"multiselect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"type":"integer"},"multiselect":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this is a multiselect custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies only to the creation of Picklist or Multiselect custom 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":"text","inline":true,"attributes":{"content":"The action "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addField"},"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":"The definition "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is specified."},"children":[]}]}]}]}],"type":"boolean"},"origin":{"description":"Specifies that this is a custom field","enum":["custom"],"type":"string"},"type":{"description":"The data type of the custom field","type":"string"}},"title":"customObjectCustomFieldDefinition","type":"object"}},"components/schemas/UpdateCustomObjectCusotmField":{"id":"components/schemas/UpdateCustomObjectCusotmField","kind":"json-schema","title":"UpdateCustomObjectCusotmField","data":{"description":"A reference to a field.","properties":{"auditable":{"description":"Indicates whether Audit Trail will record changes of this custom field. You can change auditable fields to non-auditable, and vice versa. One custom object can have a maximum of five auditable fields.\n","type":"boolean"},"definition":{"$ref":"#/components/schemas/CustomObjectCustomFieldDefinitionUpdate"},"filterable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the field is filterable or not. Applicable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can change a filterable field to non-filterable and vice versa. You can also add a filterable field. One custom object can have a maximum of 10 filterable fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that changing filterable fields triggers reindexing. It will take 12-24 hours before all your data are reindexed and available to query."},"children":[]}]}]}],"type":"boolean"},"name":{"description":"The name of the custom field to be updated","type":"string"},"required":{"description":"Indicates whether the field is required or optional.\n\nYou can update a required field to optional. On the other hand, you can only update an optional field to required on the custom object with no records.\n\nYou can only add a required field to the custom object with no records.\n","type":"boolean"},"targetName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the action is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renameField"},"children":[]}]}]}],"type":"string"},"unique":{"description":"Indicates whether to specify a unique constraint to the field. You can remove the unique constraint on the field. However, you can only add a unique constraint to a filterable field if the custom object contains no record. One custom object can have a maximum of five fields with unique constraints.\n","type":"boolean"}},"type":"object"}},"components/schemas/CustomObjectDefinitionUpdateActionRequest":{"id":"components/schemas/CustomObjectDefinitionUpdateActionRequest","kind":"json-schema","title":"CustomObjectDefinitionUpdateActionRequest","data":{"example":{"field":{"definition":{"description":"Address zip code","label":"Zip code","maxLength":10,"type":"string"},"name":"zip__c"},"namespace":"default","object":"address","type":"addField"},"properties":{"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional property for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action"},"children":[]}]}]}],"type":"string"},"enableCreateRecordAuditing":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional property for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateObject"},"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":"Indicates whether to audit the creation of custom object records of this custom object definition."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that you must enable the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Object Definition"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" audit trail setting in your Zuora tenant before auditing custom object record creation. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/administrator-settings/manage-audit-trail-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage audit trail settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"enableDeleteRecordAuditing":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional property for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateObject"},"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":"Indicates whether to audit the deletion of custom object records of this custom object definition."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that you must enable the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Object Definition"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" audit trail setting in your Zuora tenant before auditing custom object record deletion. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/system-management/administrator-settings/manage-audit-trail-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage audit trail settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"field":{"$ref":"#/components/schemas/UpdateCustomObjectCusotmField"},"label":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional property for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action"},"children":[]}]}]}],"type":"string"},"namespace":{"description":"The namespace of the custom object definition to be updated","type":"string"},"object":{"description":"The API name of the custom object definition to be updated","type":"string"},"relationship":{"additionalProperties":false,"properties":{"cardinality":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardinality of the relationship from this object to another object."},"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":"manyToOne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cardinality can be used when creating relationships.  A relationship with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oneToMany"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cardinality is created implicitly when a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manyToOne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" relationship is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom object definition can have a maximum of 2 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manyToOne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" relationships."},"children":[]}]}]}],"enum":["manyToOne"],"type":"string"},"fields":{"$ref":"#/components/schemas/FieldsAdditionalProperties"},"namespace":{"description":"The namespace where the related object is located","type":"string"},"object":{"description":"The API name of the related object","type":"string"},"recordConstraints":{"description":"Specifies contraints to apply to custom object records.\n","properties":{"create":{"properties":{"enforceValidMapping":{"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether Zuora validates the values of mapped fields"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in custom object records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Zuora validates the values of mapped fields"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in custom object records. For example, if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom object definition has a field called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountId__c"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that is mapped to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora verifies that the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountId__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a valid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account ID when a custom object record is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountId__c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a valid account ID,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the operation fails."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"type":"object"}},"required":["namespace","object","fields"],"type":"object"},"type":{"description":"The type of the updating action on a custom object definition","enum":["addField","deleteField","updateField","updateObject","renameField","addRelationship","deleteRelationship"],"type":"string"}},"required":["type","namespace","object"],"type":"object"}},"components/schemas/MigrationUpdateCustomObjectDefinitionsRequest":{"id":"components/schemas/MigrationUpdateCustomObjectDefinitionsRequest","kind":"json-schema","title":"MigrationUpdateCustomObjectDefinitionsRequest","data":{"additionalProperties":false,"properties":{"actions":{"description":"The actions of updating custom object definitions, to be performed as parts of the migration.  Currently only one action per migration is supported.","items":{"$ref":"#/components/schemas/CustomObjectDefinitionUpdateActionRequest"},"maxItems":1,"minItems":1,"type":"array"}},"required":["actions"],"type":"object"}},"components/schemas/CustomObjectDefinitionUpdateActionResponse":{"id":"components/schemas/CustomObjectDefinitionUpdateActionResponse","kind":"json-schema","title":"CustomObjectDefinitionUpdateActionResponse","data":{"example":{"field":{"definition":{"description":"Address zip code","label":"Zip code","maxLength":10,"type":"string"},"name":"zip__c"},"namespace":"default","object":"address","type":"addField"},"properties":{"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional property for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action"},"children":[]}]}]}],"type":"string"},"enableCreateRecordAuditing":{"description":"Indicates whether to audit the creation of custom object records of this custom object definition.","type":"boolean"},"enableDeleteRecordAuditing":{"description":"Indicates whether to audit the deletion of custom object records of this custom object definition.","type":"boolean"},"field":{"$ref":"#/components/schemas/UpdateCustomObjectCusotmField"},"label":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional property for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action"},"children":[]}]}]}],"type":"string"},"namespace":{"description":"The namespace of the custom object definition to be updated","type":"string"},"object":{"description":"The API name of the custom object definition to be updated","type":"string"},"relationship":{"additionalProperties":false,"properties":{"cardinality":{"default":"manyToOne","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardinality of the relationship from this object to another object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manyToOne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" relationship means this object is the child object (the \"many\" side), and the referenced object (the \"one\" side) is the parent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oneToMany"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" relationship means this object is the parent object (the \"one\" side), and the referenced object (the \"many\" side) is the child."},"children":[]}]}]}],"enum":["manyToOne","oneToMany"],"type":"string"},"fields":{"$ref":"#/components/schemas/FieldsAdditionalProperties"},"namespace":{"description":"The namespace where the related object is located","type":"string"},"object":{"description":"The API name of the related object","type":"string"},"recordConstraints":{"description":"Specifies contraints to apply to custom object records.\n","properties":{"create":{"properties":{"enforceValidMapping":{"default":true,"description":"Specifies whether Zuora validates the values of mapped fields\nin custom object records.\n","type":"boolean"}},"type":"object"}},"type":"object"}},"type":"object"},"type":{"description":"The type of the updating action on a custom object definition","enum":["addField","deleteField","updateField","updateObject","renameField","addRelationship","deleteRelationship"],"type":"string"}},"type":"object"}},"components/schemas/MigrationUpdateCustomObjectDefinitionsResponse":{"id":"components/schemas/MigrationUpdateCustomObjectDefinitionsResponse","kind":"json-schema","title":"MigrationUpdateCustomObjectDefinitionsResponse","data":{"additionalProperties":false,"properties":{"actions":{"description":"The actions of updating custom object definitions, to be performed as parts of the migration.  Currently only one action per migration is supported.","items":{"$ref":"#/components/schemas/CustomObjectDefinitionUpdateActionResponse"},"maxItems":1,"minItems":1,"type":"array"},"jobId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the asynchronous job. It is available only when updating custom object definitions or advanced custom field definitions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the “Retrieve a custom object bulk job” operation to check whether the asynchronous job is completed."},"children":[]}]}]}]}},"type":"object"}},"components/schemas/CustomObjectRecordWithOnlyCustomFields":{"id":"components/schemas/CustomObjectRecordWithOnlyCustomFields","kind":"json-schema","title":"customObjectRecord","data":{"additionalProperties":{"description":"The field-value pairs for a custom object record"},"example":{"DeviceId__c":"10101011"},"title":"customObjectRecord","type":"object"}},"components/schemas/CustomObjectRecordWithAllFields":{"id":"components/schemas/CustomObjectRecordWithAllFields","kind":"json-schema","title":"customObjectRecord","data":{"allOf":[{"properties":{"CreatedById":{"description":"The creator's Id","type":"string"},"CreatedDate":{"description":"The record creation time in the date-time format","format":"date-time","type":"string"},"Id":{"description":"The unique Id of the custom object record","format":"uuid","maxLength":36,"minLength":36,"type":"string"},"UpdatedById":{"description":"The modifier's Id","type":"string"},"UpdatedDate":{"description":"The record modification time in the date-time format","format":"date-time","type":"string"},"type":{"description":"The type of the custom object record. It is the API name of the custom object definition.","type":"string"}}},{"$ref":"#/components/schemas/CustomObjectRecordWithOnlyCustomFields"}],"description":"Record data from an object","example":{"Id":"e0668230-eb63-40df-be65-08f083ca47b1","type":"Vehicle","CreatedById":"8ad09fc28193c189018194da28be74ba","UpdatedById":"b243314d594646d3b2651aeedd4be47e","CreatedDate":"2024-07-17T03:23:47.698Z","UpdatedDate":"2024-07-17T03:26:28.772Z","DeviceId__c":"10101011","OrderId__c":"c086028c-5df8-427d-a3c8-7a7fb5d32d3d"},"title":"customObjectRecord","type":"object"}},"components/schemas/QueryCustomObjectRecordsResponse":{"id":"components/schemas/QueryCustomObjectRecordsResponse","kind":"json-schema","title":"QueryCustomObjectRecordsResponse","data":{"properties":{"count":{"description":"The record count of the given custom object type","example":1,"type":"integer"},"records":{"example":[{"CreatedById":"58bcc694-0b01-4c38-83d9-679891aee4dc","CreatedDate":"2017-06-07T17:26:47.501Z","Id":"f4f3d0a8-9d45-43d6-956c-4820f2de7559","UpdatedById":"58bcc694-0b01-4c38-83d9-679891aee4dc","UpdatedDate":"2017-06-07T17:26:47.501Z","age__c":32,"email__c":"smith123@example.com","home_address__c":"59b38ad1-27d4-40e8-af66-8c138bc382ee","last_name__c":"Smith","marital_status__c":"Married","type":"person","version":1,"work_address__c":"8a19f16a-2b5e-4a26-bb20-c79cd6984714"}],"items":{"$ref":"#/components/schemas/CustomObjectRecordWithAllFields"},"type":"array"},"cursor":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID of the last record on the current page. Use it in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to retrieve the next page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not available on the last page."},"children":[]}]}]}],"type":"string","format":"uuid"}},"required":["count","records"],"type":"object"}},"components/schemas/PostCustomObjectRecordsRequest":{"id":"components/schemas/PostCustomObjectRecordsRequest","kind":"json-schema","title":"PostCustomObjectRecordsRequest","data":{"properties":{"allowPartialSuccess":{"default":false,"description":"Indicates whether the records that pass the schema validation should be created when not all records in the request pass the schema validation.","example":true,"type":"boolean"},"records":{"description":"A list of custom object records to be created","items":{"$ref":"#/components/schemas/CustomObjectRecordWithOnlyCustomFields"},"type":"array"}},"required":["records"],"type":"object"}},"components/schemas/CustomObjectRecordsWithError":{"id":"components/schemas/CustomObjectRecordsWithError","kind":"json-schema","title":"CustomObjectRecordsWithError","data":{"properties":{"code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-objects/custom-objects-api/custom-objects-api-error-code","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Objects API error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}],"enum":[71012520,71012521,71012522,71012523,71012524,71012525,71012526,71012530],"format":"Int32","type":"integer"},"message":{"example":"Field [last_name__c] cannot accept empty string.","type":"string"},"record":{"$ref":"#/components/schemas/CustomObjectRecordWithAllFields"}},"type":"object"}},"components/schemas/CustomObjectRecordsErrorResponse":{"id":"components/schemas/CustomObjectRecordsErrorResponse","kind":"json-schema","title":"CustomObjectRecordsErrorResponse","data":{"properties":{"code":{"example":"710125XX","format":"Int32","type":"integer"},"details":{"example":[{"code":"710125XX","message":"Field [age__c] is an integer field but received a string value.","record":{"Id":"8a19f16a-2b5e-4a26-bb20-c79cd6984714","age__c":"32","email__c":"smith123@example.com","home_address__c":"59b38ad1-27d4-40e8-af66-8c138bc382ee","last_name__c":"Smith","marital_status__c":"Married","work_address__c":"8a19f16a-2b5e-4a26-bb20-c79cd6984714"}}],"items":{"$ref":"#/components/schemas/CustomObjectRecordsWithError"},"type":"array"},"message":{"example":"Unabled to create object records due to invalid request.","type":"string"}},"type":"object"}},"components/schemas/PostCustomObjectRecordsResponse":{"id":"components/schemas/PostCustomObjectRecordsResponse","kind":"json-schema","title":"PostCustomObjectRecordsResponse","data":{"properties":{"error":{"$ref":"#/components/schemas/CustomObjectRecordsErrorResponse"},"records":{"description":"The custom object records that are succesfully created and stored","items":{"$ref":"#/components/schemas/CustomObjectRecordWithAllFields"},"type":"array"}},"type":"object"}},"components/schemas/Error401":{"id":"components/schemas/Error401","kind":"json-schema","title":"Error401","data":{"properties":{"code":{"example":"7101251X","format":"Int32","type":"integer"},"message":{"example":"Unauthorized Action","type":"string"}},"type":"object"}},"components/schemas/ErrorResponse401Record":{"id":"components/schemas/ErrorResponse401Record","kind":"json-schema","title":"ErrorResponse401Record","data":{"properties":{"code":{"example":"7101251X","format":"Int32","type":"integer"},"details":{"example":[{"code":"7101251X","message":"Unauthorized to view object record."}],"items":{"$ref":"#/components/schemas/Error401"},"type":"array"},"message":{"example":"Unauthorized to process object record.","type":"string"}},"type":"object"}},"components/schemas/CustomObjectRecordsThrottledResponse":{"id":"components/schemas/CustomObjectRecordsThrottledResponse","kind":"json-schema","title":"CustomObjectRecordsThrottledResponse","data":{"properties":{"code":{"example":71012561,"format":"Int32","type":"integer"},"details":{"example":[{"code":71012561,"message":"Unable to process record due to internal error or database throttling.","record":{"Id":"8a19f16a-2b5e-4a26-bb20-c79cd6984714","age__c":32,"email__c":"smith123@example.com","home_address__c":"59b38ad1-27d4-40e8-af66-8c138bc382ee","last_name__c":"Smith","marital_status__c":"Married","work_address__c":"8a19f16a-2b5e-4a26-bb20-c79cd6984714"}}],"items":{"$ref":"#/components/schemas/CustomObjectRecordsWithError"},"type":"array"},"message":{"example":"Unabled to create object records, please try again later.","type":"string"}},"type":"object"}},"components/schemas/CustomObjectRecordBatchUpdateMapping":{"id":"components/schemas/CustomObjectRecordBatchUpdateMapping","kind":"json-schema","title":"updateIdFieldsMapping","data":{"additionalProperties":{"description":"Map of object Id and associated custom fields data to be updated","type":"object"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object records that you want to update. Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"64edb2a5-2796-4e95-9559-846f8636a01b":{"name__c":"elba43","person_id__c\"":"30c52793-8f06-41c6-b623-04829710d7a"}},"title":"updateIdFieldsMapping","type":"object"}},"components/schemas/CustomObjectRecordBatchAction":{"id":"components/schemas/CustomObjectRecordBatchAction","kind":"json-schema","title":"updateDeleteBatchAction","data":{"description":"The batch action on custom object records","properties":{"allowPartialSuccess":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the records that pass the schema validation should be updated when not all records in the request pass the schema validation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true,"type":"boolean"},"ids":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ids of the custom object records that you want to delete. Each ID must be a string of 36 characters. Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["64edb2a5-2796-4e95-9559-846f8636a01b","dbfb35a3-dd2b-42c9-b8f7-eb36fed1a1e1","2c2a1810-bfef-4150-84de-50e769978e42"],"items":{"format":"uuid","type":"string"},"type":"array"},"records":{"$ref":"#/components/schemas/CustomObjectRecordBatchUpdateMapping"},"type":{"description":"The type of the batch action","enum":["delete","update"],"type":"string"}},"required":["type"],"title":"updateDeleteBatchAction","type":"object"}},"components/schemas/CustomObjectRecordBatchRequest":{"id":"components/schemas/CustomObjectRecordBatchRequest","kind":"json-schema","title":"CustomObjectRecordBatchRequest","data":{"description":"Request of processing custom object records in batch.","example":{"action":{"type":"update","records":{"64edb2a5-2796-4e95-9559-846f8636a01b":{"DeviceId__c":"10101011"}}}},"properties":{"action":{"$ref":"#/components/schemas/CustomObjectRecordBatchAction"}},"required":["action"],"type":"object"}},"components/schemas/CustomObjectRecordsBatchUpdatePartialSuccessResponse":{"id":"components/schemas/CustomObjectRecordsBatchUpdatePartialSuccessResponse","kind":"json-schema","title":"CustomObjectRecordsBatchUpdatePartialSuccessResponse","data":{"example":{},"properties":{"error":{"$ref":"#/components/schemas/CustomObjectRecordsErrorResponse"}},"type":"object"}},"components/schemas/CustomObjectBulkJobResponse":{"id":"components/schemas/CustomObjectBulkJobResponse","kind":"json-schema","title":"CustomObjectBulkJobResponse","data":{"example":{"CreatedById":"7b39d73f-22e6-404a-b8e7-894f7620e91c","CreatedDate":"2021-03-15T06:47:18Z","Id":"ed4b9701-bafb-4976-8019-b08269430153","UpdatedById":"7b39d73f-22e6-404a-b8e7-894f7620e91c","UpdatedDate":"2021-03-15T06:47:18Z","error":{"code":71012560,"message":"Service limit reached, please retry later."},"namespace":"default","object":"passenger","operation":"delete","processingTime":1882,"recordsProcessed":500,"status":"failed"},"properties":{"CreatedById":{"description":"The ID of the user who creates the job.","format":"uuid","type":"string"},"CreatedDate":{"description":"The time when the bulk job is created.","format":"date-time","type":"string"},"Id":{"description":"The custom object bulk job ID.","format":"uuid","type":"string"},"UpdatedById":{"description":"The ID of the user who updates the job.","format":"uuid","type":"string"},"UpdatedDate":{"description":"The time when the bulk job is updated.","format":"date-time","type":"string"},"error":{"properties":{"code":{"description":"The error code.","example":71012560,"format":"Int32","type":"integer"},"message":{"description":"The error message.","example":"Service limit reached, please retry later.","type":"string"}},"type":"object"},"namespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the object. Custom objects belong to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace. Zuora standard objects belong to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"com_zuora"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace. Bulk job operations on the following Zuora standard objects 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":"text","inline":true,"attributes":{"content":"SavedQuery"},"children":[]}]}]}]}],"enum":["default","com_zuora"],"type":"string"},"object":{"description":"The object to that the bulk operation performs on.","example":"passenger","type":"string"},"operation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation that the bulk job performs. Only the users that have the \"Delete Custom Objects\" permission can submit a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bulk job request. Only the users that have the \"Edit Custom Objects\" permission can submit a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bulk job request. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-user-role-for-platform"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform Permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["delete","create","update"],"type":"string"},"processingTime":{"description":"The amount of time elapsed, in milliseconds, from the submission to the completion of the bulk job.","example":550,"type":"integer"},"recordsProcessed":{"description":"The number of object records processed by the bulk job.","example":1000,"type":"integer"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk job:"},"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":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The job has been accepted and is ready to process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The job is waiting for your input. You can use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_UploadFileForCustomObjectBulkJob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a file for a custom object bulk job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to upload a file so that the job can start creating records."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The job is processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The job has completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The job was unable to complete. You can use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_CustomObjectBulkJobErrors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all errors for a custom object bulk job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list the errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The job was cancelled by the server."},"children":[]}]}]}]}],"enum":["accepted","pending","in_progress","completed","failed","cancelled"],"example":"failed","type":"string"}},"type":"object"}},"components/schemas/CustomObjectBulkJobResponseCollection":{"id":"components/schemas/CustomObjectBulkJobResponseCollection","kind":"json-schema","title":"CustomObjectBulkJobResponseCollection","data":{"properties":{"count":{"description":"The number of custom object bulk jobs returned in the result page set.","example":2,"type":"integer"},"cursor":{"description":[{"$$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":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" points to the last job record of the current page."},"children":[]}]}]}],"example":"a9e9a58d-0a11-4685-b1ab-99521dbc20a1","type":"string"},"jobs":{"description":"All custom object bulk jobs returned in the result page set.","example":[{"CreatedById":"2c92c0f96a07409d016a0a58ab1172ec","CreatedDate":"2021-03-10T00:05:54.207Z","Id":"5112347a-f7a1-4373-99df-c082984de7be","UpdatedById":"2c92c0f96a07409d016a0a58ab1172ec","UpdatedDate":"2021-03-10T00:08:15.614Z","namespace":"default","object":"vehicle","operation":"create","processingTime":62,"recordsProcessed":3,"status":"completed"},{"CreatedById":"2c92c0f96a07409d016a0a58ab1172ec","CreatedDate":"2021-03-09T22:27:59.503Z","Id":"a9e9a58d-0a11-4685-b1ab-99521dbc20a1","UpdatedById":"2c92c0f96a07409d016a0a58ab1172ec","UpdatedDate":"2021-03-09T22:27:59.503Z","namespace":"default","object":"vehicle","operation":"create","processingTime":0,"recordsProcessed":0,"status":"pending"}],"items":{"$ref":"#/components/schemas/CustomObjectBulkJobResponse"},"type":"array"}},"required":["jobs"],"type":"object"}},"components/schemas/CustomObjectBulkDeleteFilterCondition":{"id":"components/schemas/CustomObjectBulkDeleteFilterCondition","kind":"json-schema","title":"CustomObjectBulkDeleteFilterCondition","data":{"description":"Condition evaluated on a single object field","properties":{"field":{"description":"The object field that is evaluated. Only filterable fields can be evaluated in the filter.","example":"CreatedDate","type":"string"},"operator":{"enum":["EQ","GT","LT","GE","LE"],"example":"LT","type":"string"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value that the filterable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is evaluated against in the filter. The data type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is consistent with that of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2020-01-01T00:00:00.000Z"}},"required":["field","operator","value"],"type":"object"}},"components/schemas/CustomObjectBulkDeleteFilter":{"id":"components/schemas/CustomObjectBulkDeleteFilter","kind":"json-schema","title":"CustomObjectBulkDeleteFilter","data":{"description":"Filters to determine which records to be deleted in the bulk delete operation.","properties":{"conditions":{"description":"Group of field filter conditions that are evaluated in conjunction with each other using the AND operator. The minimum number of conditions is 1 and the maximum is 2.","items":{"$ref":"#/components/schemas/CustomObjectBulkDeleteFilterCondition"},"type":"array"}},"required":["conditions"],"type":"object"}},"components/schemas/CustomObjectBulkJobRequest":{"id":"components/schemas/CustomObjectBulkJobRequest","kind":"json-schema","title":"CustomObjectBulkJobRequest","data":{"example":{"object":"passenger","namespace":"default","operation":"delete","filter":{"conditions":[{"field":"CreatedDate","operator":"LT","value":"2020-01-01T00:00:00.000Z"}]}},"properties":{"filter":{"$ref":"#/components/schemas/CustomObjectBulkDeleteFilter"},"namespace":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The namespace of the object. Custom objects belong to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace. Zuora standard objects belong to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"com_zuora"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" namespace. Bulk job operations on the following Zuora standard objects 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":"text","inline":true,"attributes":{"content":"SavedQuery"},"children":[]}]}]}]}],"enum":["default","com_zuora"],"type":"string"},"object":{"description":"The object that the bulk operation performs on.","example":"passenger","type":"string"},"operation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation that the bulk job performs. Only the users that have the \"Delete Custom Objects\" permission can submit a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bulk job request. Only the users that have the \"Edit Custom Objects\" permission can submit a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bulk job request. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-user-role-for-platform"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform Permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["delete","create","update"],"type":"string"}},"required":["operation","object","namespace"],"type":"object"}},"components/schemas/CustomObjectBulkJobErrorResponse":{"id":"components/schemas/CustomObjectBulkJobErrorResponse","kind":"json-schema","title":"CustomObjectBulkJobErrorResponse","data":{"properties":{"code":{"description":"The error code.","example":71012520,"format":"Int32","type":"integer"},"message":{"description":"The error message.","example":"input string \"123\" is not a valid UUID","type":"string"},"record":{"$ref":"#/components/schemas/CustomObjectRecordWithAllFields"},"row":{"description":"The CSV record row number. The custom object record data starts at the second row because the first row is the CSV header.","example":12,"format":"Int32","type":"integer"}},"type":"object"}},"components/schemas/CustomObjectBulkJobErrorResponseCollection":{"id":"components/schemas/CustomObjectBulkJobErrorResponseCollection","kind":"json-schema","title":"CustomObjectBulkJobErrorResponseCollection","data":{"properties":{"errors":{"description":"All errors for a custom object bulk job.","items":{"$ref":"#/components/schemas/CustomObjectBulkJobErrorResponse"},"type":"array"}},"required":["errors"],"type":"object"}},"components/schemas/ApiVolumeSummaryRecord":{"id":"components/schemas/ApiVolumeSummaryRecord","kind":"json-schema","title":"volumeSummaryRecord","data":{"allOf":[{"properties":{"api":{"description":"The API path name.\n","type":"string"},"error":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The count of failed API requests of above "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"httpMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"httpMethod":{"description":"The http method.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The count of successful API requests of above "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"httpMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"total":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The count of total API requests of above "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"httpMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"}},"type":"object"}],"description":"A volume summary record.\n","title":"volumeSummaryRecord"}},"components/schemas/GetApiVolumeSummaryResponse":{"id":"components/schemas/GetApiVolumeSummaryResponse","kind":"json-schema","title":"GetApiVolumeSummaryResponse","data":{"properties":{"data":{"description":"List of API volume summary records. The records are grouped and ordered by API path name and http method.      \n","items":{"$ref":"#/components/schemas/ApiVolumeSummaryRecord"},"type":"array"}},"type":"object"}},"components/schemas/SystemHealthErrorResponse":{"id":"components/schemas/SystemHealthErrorResponse","kind":"json-schema","title":"SystemHealthErrorResponse","data":{"properties":{"error":{"description":"Error status text.\n","type":"string"},"message":{"description":"The associated reason.\n","type":"string"},"path":{"description":"The system health api path having error.\n","type":"string"},"status":{"description":"Error status code.\n","type":"integer"},"timestamp":{"description":"The time when error happens.\n","format":"date-time","type":"string"}},"type":"object"}},"components/schemas/ApiFailureRecord":{"id":"components/schemas/ApiFailureRecord","kind":"json-schema","title":"FailureRecords","data":{"properties":{"tracing_identifier":{"description":"A unique identifier for tracing the request.\n","type":"string","nullable":true},"latency":{"description":"The time taken to process the request in milliseconds.\n","type":"integer","nullable":false},"ip":{"description":"The IP address from which the request originated.\n","type":"string","nullable":false},"response_body":{"description":"The body of the response returned by the API.\n","type":"string","nullable":false},"request_body":{"description":"The body of the request sent to the API.\n","type":"string","nullable":false},"user_id":{"description":"The ID of the user making the request.\n","type":"string","nullable":false},"track_id":{"description":"A tracking identifier for the request.\n","type":"string","nullable":true},"request_path":{"description":"The complete path of the API request triggered by the user.\n","type":"string","nullable":false},"http_status":{"description":"The HTTP status code returned by the API.\n","type":"string","nullable":false},"zuora_response_code":{"description":"The response code returned by Zuora.\n","type":"string","nullable":false},"api":{"description":"The path of the API request.\n","type":"string","nullable":false},"request_id":{"description":"A unique identifier for the API request.\n","type":"string","nullable":false},"user_agent":{"description":"The user agent string of the client making the request.\n","type":"string","nullable":false},"timestamp":{"description":"The timestamp when the request was made.\n","type":"string","format":"date-time","nullable":false},"status":{"description":"The status of the request.\n","type":"string","nullable":false,"enum":["Error"]},"http_method":{"description":"Type of request method performed for the API endpoint.\n","type":"string","nullable":false}},"type":"object","description":"A list of failure records including additional details about the request and response.\n","title":"FailureRecords"}},"components/schemas/GetApiFailureRecordResponse":{"id":"components/schemas/GetApiFailureRecordResponse","kind":"json-schema","title":"GetApiFailureRecordResponse","data":{"properties":{"data":{"description":"List of Failed API records      \n","items":{"$ref":"#/components/schemas/ApiFailureRecord"},"type":"array"},"nextPage":{"description":"URL to the next page of results for pagination.\n","type":"string","format":"url"}},"type":"object"}},"components/schemas/ApiPerformanceDetail":{"id":"components/schemas/ApiPerformanceDetail","kind":"json-schema","title":"DetailRecords","data":{"properties":{"tracing_identifier":{"description":"A unique identifier for tracing the request.\n","type":"string","nullable":true},"latency":{"description":"The time taken to process the request in milliseconds.\n","type":"integer","nullable":false},"ip":{"description":"The IP address from which the request originated.\n","type":"string","nullable":true},"response_body":{"description":"The body of the response returned by the API.\n","type":"string","nullable":true},"request_body":{"description":"The body of the request sent to the API.\n","type":"string","nullable":true},"user_id":{"description":"The ID of the user making the request.\n","type":"string","nullable":false},"track_id":{"description":"A tracking identifier for the request.\n","type":"string","nullable":true},"request_path":{"description":"The complete path of the API request triggered by the user.\n","type":"string","nullable":false},"http_status":{"description":"The HTTP status code returned by the API.\n","type":"string","nullable":false},"zuora_response_code":{"description":"The response code returned by Zuora.\n","type":"string","nullable":false},"api":{"description":"The path of the API request.\n","type":"string","nullable":false},"request_id":{"description":"A unique identifier for the API request.\n","type":"string","nullable":false},"user_agent":{"description":"The user agent string of the client making the request.\n","type":"string","nullable":false},"timestamp":{"description":"The timestamp when the request was made.\n","type":"string","format":"date-time","nullable":false},"status":{"description":"The status of the request.\n","type":"string","nullable":false,"enum":["Error","Success"]},"http_method":{"description":"Type of request method performed for the API endpoint.\n","type":"string","nullable":false}},"type":"object","description":"A list of failure records including additional details about the request and response.\n","title":"DetailRecords"}},"components/schemas/GetApiPerformanceDetailResponse":{"id":"components/schemas/GetApiPerformanceDetailResponse","kind":"json-schema","title":"GetApiPerformanceDetailResponse","data":{"properties":{"data":{"description":"List of API Records in detail.\n","items":{"$ref":"#/components/schemas/ApiPerformanceDetail"},"type":"array"},"nextPage":{"description":"URL to the next page of results for pagination.\n","type":"string","format":"url"}},"type":"object"}},"components/schemas/BillingDocVolumeSummaryRecord":{"id":"components/schemas/BillingDocVolumeSummaryRecord","kind":"json-schema","title":"volumeSummaryRecord","data":{"allOf":[{"properties":{"totalFailedAccounts":{"description":"The count of total accounts who have failed records.","type":"integer"},"totalGeneratedCreditMemos":{"description":"The count of total generated credit memos.\n","type":"integer"},"totalGeneratedInvoices":{"description":"The count of total generated invoices.\n","type":"integer"}},"type":"object"}],"description":"A volume summary record.\n","title":"volumeSummaryRecord"}},"components/schemas/GetBillingDocVolumeSummaryResponse":{"id":"components/schemas/GetBillingDocVolumeSummaryResponse","kind":"json-schema","title":"GetBillingDocVolumeSummaryResponse","data":{"properties":{"data":{"description":"List of billing documents summary, including total generated invoices and credit memos, also a total number of accounts that failed to process.\n","items":{"$ref":"#/components/schemas/BillingDocVolumeSummaryRecord"},"type":"array"}},"type":"object"}},"components/schemas/PaymentVolumeSummaryRecord":{"id":"components/schemas/PaymentVolumeSummaryRecord","kind":"json-schema","title":"volumeSummaryRecord","data":{"allOf":[{"properties":{"error":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The count of failed payments of above "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentGatewayType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"paymentGatewayType":{"description":"The payment gateway type.\n","type":"string"},"paymentMethodType":{"description":"The payment method type.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The count of successful payments of above "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentGatewayType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"total":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The count of total payments of above "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentGatewayType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"}},"type":"object"}],"description":"A volume summary record.\n","title":"volumeSummaryRecord"}},"components/schemas/GetPaymentVolumeSummaryResponse":{"id":"components/schemas/GetPaymentVolumeSummaryResponse","kind":"json-schema","title":"GetPaymentVolumeSummaryResponse","data":{"properties":{"data":{"description":"List of electronic payments summary.\n","items":{"$ref":"#/components/schemas/PaymentVolumeSummaryRecord"},"type":"array"}},"type":"object"}},"components/schemas/PaymentRecordsDetails":{"id":"components/schemas/PaymentRecordsDetails","kind":"json-schema","title":"PaymentRecord","data":{"properties":{"payment_method_type":{"description":"The type of payment method used for the transaction, such as credit card or bank transfer.\n","type":"string","nullable":false},"amount":{"description":"The total amount of the transaction.\n","type":"number","nullable":false},"payment_status":{"description":"The current status of the payment transaction.\n","type":"string","nullable":false,"enum":["Success","Error"]},"source_type":{"description":"The source from which the payment transaction originated, such as a payment run or manual entry.\n","type":"string","nullable":false},"payment_gateway_response_code":{"description":"The response code returned by the payment gateway.\n","type":"string","nullable":false},"payment_gateway_response_msg":{"description":"The response message returned by the payment gateway, providing additional details about the transaction status.\n","type":"string","nullable":false},"request_duration":{"description":"The time taken to process the payment request, in milliseconds.\n","type":"integer","nullable":false},"payment_number":{"description":"A unique identifier for the payment transaction.\n","type":"string","nullable":false},"payment_id":{"description":"A unique identifier assigned to the payment in the system.\n","type":"string","nullable":false},"zuora_response_code":{"description":"The response code returned by Zuora, indicating the status of the transaction.\n","type":"string","nullable":false},"currency":{"description":"The currency in which the transaction was processed.\n","type":"string","nullable":false},"source_id":{"description":"A unique identifier for the source entity that initiated the payment.\n","type":"string","nullable":false},"payment_gateway_type":{"description":"The type of payment gateway used to process the transaction.\n","type":"string","nullable":false},"payment_date":{"description":"The date the payment transaction was processed.\n","type":"string","format":"date","nullable":false}},"type":"object","description":"A payment record that includes additional details about the transaction and its processing.\n","title":"PaymentRecord"}},"components/schemas/GetPaymentRecordsResponse":{"id":"components/schemas/GetPaymentRecordsResponse","kind":"json-schema","title":"GetPaymentRecordsResponse","data":{"properties":{"data":{"description":"List of Electronic Payment Records\n","items":{"$ref":"#/components/schemas/PaymentRecordsDetails"},"type":"array"},"nextPage":{"description":"URL to the next page of results for pagination.\n","type":"string","format":"url"}},"type":"object"}},"components/schemas/TaxHealthDetailsRecords":{"id":"components/schemas/TaxHealthDetailsRecords","kind":"json-schema","title":"TaxRecords","data":{"properties":{"error_message":{"description":"A detailed error message, if any, associated with the transaction or event.\n","type":"string","nullable":false},"document_number":{"description":"The document number associated with the transaction, such as an invoice number.\n","type":"string","nullable":false},"vendor_name":{"description":"The name of the vendor involved in the transaction.\n","type":"string","nullable":false},"event_source":{"description":"The source of the event, such as a third-party service or system.\n","type":"string","nullable":false},"error_category":{"description":"The main category of the error, if applicable.\n","type":"string","nullable":false},"account_id":{"description":"The unique identifier for the account involved in the event or transaction.\n","type":"string","nullable":false},"event_type":{"description":"The type of event, such as tax generation or another action.\n","type":"string","nullable":false},"total_duration":{"description":"The total time taken to process the event or transaction, in milliseconds.\n","type":"integer","nullable":false},"zuora_request_id":{"description":"A unique identifier for the request to the Zuora system.\n","type":"string","nullable":false},"account_name":{"description":"The name of the account associated with the event or transaction.\n","type":"string","nullable":false},"vendor_duration":{"description":"The time taken by the vendor to process the request, in milliseconds.\n","type":"number","nullable":false},"sub_error_category":{"description":"A more specific subcategory of the error, if applicable.\n","type":"string","nullable":false},"status":{"description":"The current status of the event or transaction.\n","type":"string","nullable":false,"enum":["success","error"]},"timestamp":{"description":"The timestamp of the event or transaction in ISO 8601 format.\n","type":"string","format":"date-time","nullable":false}},"type":"object","description":"A detailed record of an event or transaction, including error details, processing durations, and associated account information.\n","title":"TaxRecords"}},"components/schemas/GetTaxRecordsResponse":{"id":"components/schemas/GetTaxRecordsResponse","kind":"json-schema","title":"GetTaxRecordsResponse","data":{"properties":{"data":{"description":"List of tax record details.\n","items":{"$ref":"#/components/schemas/TaxHealthDetailsRecords"},"type":"array"},"nextPage":{"description":"URL to the next page of results for pagination.\n","type":"string","format":"url"}},"type":"object"}},"components/schemas/AuthProviderCredentials":{"id":"components/schemas/AuthProviderCredentials","kind":"json-schema","title":"AuthProviderCredentials","data":{"title":"AuthProviderCredentials","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credential fields for the selected authentication type. Required fields depend on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"username":{"type":"string","description":"Username for basic authentication or OAuth password credentials.","example":"api-user"},"password":{"type":"string","description":"Password for basic authentication or OAuth password credentials.","format":"password","writeOnly":true,"example":"api-secret-password"},"access_key":{"type":"string","description":"AWS access key ID.","example":"AKIAEXAMPLE"},"secret_key":{"type":"string","description":"AWS secret access key.","writeOnly":true,"example":"your-secret-key"},"region":{"type":"string","description":"AWS region. This field is required when an S3 provider is created.","enum":["us-east-1","us-east-2","us-west-1","us-west-2","af-south-1","ap-east-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-south-1","ap-south-2","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-north-1","eu-south-1","eu-south-2","eu-west-1","eu-west-2","eu-west-3","me-central-1","me-south-1","sa-east-1"],"example":"us-west-2"},"site":{"type":"string","description":"OAuth provider base URL.","format":"uri","example":"https://example.com"},"client_id":{"type":"string","description":"OAuth client ID.","example":"my-client-id"},"client_secret":{"type":"string","description":"OAuth client secret.","writeOnly":true,"example":"my-client-secret"},"token_url":{"type":"string","description":"OAuth token endpoint path.","default":"/oauth/token"},"authorize_url":{"type":"string","description":"OAuth authorization endpoint path.","default":"/oauth/authorize"},"grant_type":{"type":"string","description":"OAuth grant type.","enum":["Client Credentials","Password Credentials","Implicit"],"example":"Client Credentials"},"redirect_uri":{"type":"string","description":"Redirect URI required for the Implicit grant type.","format":"uri","example":"https://example.com/oauth/callback"},"auth_params":{"type":"string","description":"Additional OAuth parameters as a JSON string.","example":"{\"audience\":\"https://example.com\"}"},"auth_header_name":{"type":"string","description":"Custom authorization header name.","example":"X-Custom-Authorization"},"auth_header_value":{"type":"string","description":"Custom authorization header value.","writeOnly":true,"example":"custom-value"},"consumer_key":{"type":"string","description":"OAuth 1.0 consumer key or token-based authentication consumer key.","example":"consumer-key"},"consumer_secret":{"type":"string","description":"OAuth 1.0 consumer secret or token-based authentication consumer secret.","writeOnly":true,"example":"consumer-secret"},"signature_method":{"type":"string","description":"OAuth signature method.","enum":["HMAC-SHA1","RSA-SHA1","PLAINTEXT"],"example":"HMAC-SHA1"},"token":{"type":"string","description":"OAuth access token or token ID.","example":"access-token"},"token_secret":{"type":"string","description":"OAuth token secret.","writeOnly":true,"example":"token-secret"},"ns_account":{"type":"string","description":"NetSuite account ID.","example":"1234567"},"algorithm":{"type":"string","description":"HMAC hash algorithm.","enum":["md5","sha1","sha256","sha384","sha512"],"example":"sha256"},"key":{"type":"string","description":"HMAC key.","writeOnly":true,"example":"hmac-key"},"secret":{"type":"string","description":"HMAC secret.","writeOnly":true,"example":"hmac-secret"},"data":{"type":"string","description":"Data to sign.","example":"payload-to-sign"},"signed_header_key":{"type":"string","description":"Header key for the signature.","example":"X-Signature"},"signed_header_value":{"type":"string","description":"Header value template for the signature.","example":"signed-value"}}}},"components/schemas/CreateAuthProviderRequest":{"id":"components/schemas/CreateAuthProviderRequest","kind":"json-schema","title":"CreateAuthProviderRequest","data":{"title":"CreateAuthProviderRequest","type":"object","properties":{"auth_provider":{"type":"object","description":"Wrapper object containing the authentication provider configuration.","properties":{"name":{"type":"string","description":"Display name for the authentication provider.","example":"billing-basic-auth"},"service_name":{"type":"string","description":"Logical service identifier for the authentication provider.","example":"billing"},"description":{"type":"string","description":"Description of the authentication provider.","example":"Basic authentication for the billing API"},"auth_type":{"type":"string","description":"Authentication type. The available credential fields depend on this value.","enum":["basic_auth","oauth_1.0","oauth_2.0","NetsuiteTBA","hmac","s3"],"example":"basic_auth"},"active":{"type":"boolean","description":"Indicates whether the authentication provider is active.","example":true},"credentials":{"$ref":"#/components/schemas/AuthProviderCredentials"}},"required":["name","service_name","auth_type","credentials"]}},"required":["auth_provider"]}},"components/schemas/CreateAuthProviderResponse":{"id":"components/schemas/CreateAuthProviderResponse","kind":"json-schema","title":"CreateAuthProviderResponse","data":{"title":"CreateAuthProviderResponse","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID of the created authentication provider.","example":"ffdb2cd6-d55d-4401-ac52-38d9e7c1d0cd"},"status":{"type":"string","description":"Result of the create operation.","enum":["created"],"example":"created"}},"required":["id","status"]}},"components/schemas/AuthProviderErrorResponse":{"id":"components/schemas/AuthProviderErrorResponse","kind":"json-schema","title":"AuthProviderErrorResponse","data":{"title":"AuthProviderErrorResponse","type":"object","properties":{"errors":{"type":"array","description":"Error messages returned by the operation.","items":{"title":"Error","type":"string"},"example":["Provider not found"]}},"required":["errors"]}},"components/schemas/UpdateAuthProviderRequest":{"id":"components/schemas/UpdateAuthProviderRequest","kind":"json-schema","title":"UpdateAuthProviderRequest","data":{"title":"UpdateAuthProviderRequest","type":"object","properties":{"auth_provider":{"type":"object","description":"Wrapper object containing the fields to update.","properties":{"name":{"type":"string","description":"Display name for the authentication provider.","example":"prod-s3-updated"},"description":{"type":"string","description":"Description of the authentication provider.","example":"Updated production S3 credentials"},"active":{"type":"boolean","description":"Indicates whether the authentication provider is active.","example":false},"credentials":{"description":"Partial credential updates that are merged with the existing credentials.","allOf":[{"$ref":"#/components/schemas/AuthProviderCredentials"}]}},"additionalProperties":false}},"required":["auth_provider"]}},"components/schemas/UpdateAuthProviderResponse":{"id":"components/schemas/UpdateAuthProviderResponse","kind":"json-schema","title":"UpdateAuthProviderResponse","data":{"title":"UpdateAuthProviderResponse","type":"object","properties":{"status":{"type":"string","description":"Result of the update operation.","enum":["updated"],"example":"updated"}},"required":["status"]}},"components/schemas/DeleteAuthProviderResponse":{"id":"components/schemas/DeleteAuthProviderResponse","kind":"json-schema","title":"DeleteAuthProviderResponse","data":{"title":"DeleteAuthProviderResponse","type":"object","properties":{"status":{"type":"string","description":"Result of the delete operation.","enum":["deleted"],"example":"deleted"}},"required":["status"]}},"components/schemas/DeleteWorkflowSuccess":{"id":"components/schemas/DeleteWorkflowSuccess","kind":"json-schema","title":"DeleteWorkflowSuccess","data":{"properties":{"id":{"description":"The id of the deleted workflow","type":"integer"},"success":{"description":"The indicator for whether the deletion was a success","type":"boolean"}},"type":"object"}},"components/schemas/DeleteWorkflowError":{"id":"components/schemas/DeleteWorkflowError","kind":"json-schema","title":"DeleteWorkflowError","data":{"properties":{"Errors":{"description":"The error messages","items":{"type":"string"},"type":"array"}},"type":"object"}},"components/schemas/Workflow":{"id":"components/schemas/Workflow","kind":"json-schema","title":"workflow","data":{"description":"A workflow.\n","properties":{"calloutTrigger":{"description":"Indicates whether the callout trigger is enabled for the retrieved workflow.\n","type":"boolean"},"createdAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow is created, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","type":"string"},"created_by":{"description":"Information about the user who created the workflow version.\n","properties":{"created_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the user is created. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N/A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the user is no longer available."},"children":[]}]}]}],"type":"string"},"updated_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the user is updated the last time. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N/A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the user is no longer available."},"children":[]}]}]}],"type":"string"},"work_email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The work email of the user. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N/A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the user is no longer available."},"children":[]}]}]}],"format":"email","type":"string"}},"type":"object"},"definitionId":{"description":"The unique ID of the workflow definition that this version belongs to.\n","type":"integer"},"definitionName":{"description":"The name of the workflow definition that this version belongs to.\n","type":"string"},"description":{"description":"The description of the workflow.\n","type":"string","nullable":true},"id":{"description":"The unique ID of the workflow.\n","type":"integer"},"inputFields":{"description":"The input fields that are configured for the workflow version.\n\nThis field is only returned if input fields are configured for the workflow version.\n","items":{"type":"object","additionalProperties":true},"type":"array"},"interval":{"description":"The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.\n","type":"string","nullable":true},"name":{"description":"The name of the workflow.\n","type":"string"},"ondemandTrigger":{"description":"Indicates whether the ondemand trigger is enabled for the workflow.\n","type":"boolean"},"priority":{"description":"The priority of the workflow version.\n","type":"string"},"scheduledTrigger":{"description":"Indicates whether the scheduled trigger is enabled for the workflow.\n","type":"boolean"},"status":{"description":"The status of the workflow version.\n","type":"string","nullable":true},"timezone":{"description":"The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.\n","type":"string","nullable":true},"type":{"description":"The type of the workflow. Currently the only valid value is 'Workflow::Setup'.\n","enum":["Workflow::Setup","Workflow::Instance"],"type":"string"},"updatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow is updated the last time, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","type":"string"},"updated_by":{"description":"Information about the user who updated the workflow version last time.\n","properties":{"created_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the user is created. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N/A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the user is no longer available."},"children":[]}]}]}],"type":"string"},"updated_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the user is updated the last time. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N/A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the user is no longer available."},"children":[]}]}]}],"type":"string"},"work_email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The work email of the user. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N/A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the user is no longer available."},"children":[]}]}]}],"format":"email","type":"string"}},"type":"object"},"version":{"description":"The version number of the workflow. \n","type":"string","nullable":true}},"title":"workflow","type":"object"}},"components/schemas/WorkflowDefinitionAndVersions":{"id":"components/schemas/WorkflowDefinitionAndVersions","kind":"json-schema","title":"a workflow definition with version information","data":{"description":"A workflow.\n","properties":{"active_version":{"allOf":[{"$ref":"#/components/schemas/Workflow"}],"description":"Information of the active version. \n"},"callType":{"description":"The call type of the active version.\n\nThis field is only returned for workflows that are configured as UI actions.\n","type":"string"},"calloutTrigger":{"description":"Indicates whether the callout trigger is enabled for the retrieved workflow.\n","type":"boolean"},"createdAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow is created, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","type":"string"},"description":{"description":"The description of the workflow definition.\n","type":"string"},"id":{"description":"The unique ID of the workflow definition.\n","type":"integer"},"interval":{"description":"The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.\n","type":"string","nullable":true},"latest_inactive_versions":{"description":"The list of inactive workflow versions retrieved. Maximum number of versions retrieved is 10.  \n","items":{"$ref":"#/components/schemas/Workflow"},"type":"array"},"name":{"description":"The name of the workflow definition.\n","type":"string"},"ondemandTrigger":{"description":"Indicates whether the ondemand trigger is enabled for the workflow.\n","type":"boolean"},"priority":{"description":"The priority of the active version.\n","type":"string"},"scheduledTrigger":{"description":"Indicates whether the scheduled trigger is enabled for the workflow.\n","type":"boolean"},"status":{"description":"The status of the workflow definition.\n","type":"string"},"timezone":{"description":"The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.\n","type":"string","nullable":true},"uiPages":{"description":"The UI pages that are configured for the active version.\n\nThis field is only returned for workflows that are configured as UI actions.\n","type":"object"},"ui_page_roles":{"description":"The roles that are allowed to access the UI pages of the workflow definition.\n\nThis field is only returned for workflows that are configured as UI actions.\n","items":{"type":"string"},"type":"array"},"updatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow is updated the last time, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","type":"string"},"zuora_org_ids":{"description":"The IDs of the organizations that the workflow definition belongs to.\n","items":{"type":"string"},"type":"array"}},"title":"a workflow definition with version information","type":"object"}},"components/schemas/GetWorkflowsResponse":{"id":"components/schemas/GetWorkflowsResponse","kind":"json-schema","title":"GetWorkflowsResponse","data":{"properties":{"data":{"description":"The list of workflows retrieved. \n","items":{"$ref":"#/components/schemas/WorkflowDefinitionAndVersions"},"type":"array"},"pagination":{"description":"An object containing pagination information for the list of workflows returned by the api\n","properties":{"next_page":{"description":"A string containing the URL where the next page of data can be retrieved.\n","type":"string"},"page":{"description":"An integer denoting the current page number.\n","type":"integer"},"page_length":{"description":"An integer denoting the number of workflows in this response. The maximum value is 50.\n","type":"integer"}},"type":"object"}},"type":"object"}},"components/schemas/Linkage":{"id":"components/schemas/Linkage","kind":"json-schema","title":"Linkage","data":{"description":"Used to represent the relationship between workflow tasks","properties":{"linkage_type":{"enum":["Start","Success","Failure","Iterate","True","False","Approve","Reject"],"type":"string"},"source_task_id":{"description":"the task that spawned the target task","type":"integer","nullable":true},"source_workflow_id":{"description":"the workflow the target task is associated with","type":"integer"},"target_task_id":{"description":"the task that the source task is linked to.","type":"integer"}},"type":"object"}},"components/schemas/Task":{"id":"components/schemas/Task","kind":"json-schema","title":"Task","data":{"description":"A task.\n","properties":{"action_type":{"description":"The type of the task.\n\nThe available task types depend on the features that are enabled for your tenant, so not every value listed here is selectable in every tenant.\n","enum":["Ai::Llm","Ai::McpCall","Approval","AsynchronousCallout","Attachment","Billing::BillRun","Billing::CurrencyConversion","Billing::CustomBillingDocument","Billing::ReverseInvoice","Callout","Cancel","Create","CustomObject::Create","CustomObject::Delete","CustomObject::Query","CustomObject::Update","Data::Aqua","Data::BillingPreviewRun","Data::Link","Data::Warehouse","Delay","Delete","Download::S3","Download::SFTP","Email","Execute::WorkflowTask","Export","File::BulkDataLoader","File::CustomPDF::CustomDocument","File::DownloadFile","File::FileOperations","File::FileStreamingUpload","File::ZuoraImport","GraphQuery","If","InvoiceGenerate","Iterate","Logic::CSVTranslator","Logic::Case","Logic::JSONTransform","Logic::Lambda","Logic::Liquid","Logic::Merge","Logic::ResponseFormatter","Logic::XMLTransform","Mediation::SendEvents","NewProduct","Notifications::SMS","Payment::GatewayReconciliation","Payment::PaymentRun","Query","RemoveProduct","Reporting::OracleFusionReport","Reporting::RunReport","Resume","Revenue::AllocateAction","Revenue::ApplyImpairment","Revenue::ApplyVc","Revenue::CloseRcTask","Revenue::CreateManualRc","Revenue::DeferCost","Revenue::DeferRevenue","Revenue::EditLine","Revenue::EditPobAttributes","Revenue::ExpireVc","Revenue::GenerateForecast","Revenue::Hold","Revenue::LinkDelink","Revenue::MovePob","Revenue::OpenRcTask","Revenue::ReleaseCost","Revenue::ReleaseRevenue","Revenue::SwitchAllocation","Revenue::SwitchLeadLine","Revenue::UnfreezeRc","Revenue::VoidBilling","Script::JavaScript","Suspend","UI::Page","UI::Stop","UI::WebShare","Update","Upload::FTP","Upload::S3","Upload::SFTP","Usage::ImportUsage","UsageMediation::Filter","UsageMediation::Group","UsageMediation::Map","UsageMediation::Sink","UsageMediation::Source","UsageMediation::Watermark","WriteOff"],"type":"string"},"call_type":{"description":"The type of API used.\n","type":"string"},"assignment":{"description":"The users or groups that the task is assigned to, represented as email\naddresses or usernames.\n","items":{"type":"string"},"type":"array"},"concurrent_limit":{"description":"the number of concurrent tasks that are allowed to run simultaneously","type":"integer"},"created_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the task is created, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","type":"string"},"css":{"description":"The position of the task on the workflow canvas.\n","type":"object"},"data":{"description":"The data payload for the task.\n","type":"object"},"end_time":{"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the end time of the task instance."},"children":[]}]}]}],"type":"string"},"error":{"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the error reason of the task instance failure."},"children":[]}]}]}],"type":"string","nullable":true},"error_class":{"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the error class of the task instance failure."},"children":[]}]}]}],"type":"string","nullable":true},"error_details":{"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the error details of the task instance failure."},"children":[]}]}]}],"type":"string","nullable":true},"id":{"description":"The unique ID of the task.\n","type":"integer"},"instance":{"description":"Indicates whether this task belongs to an instance of a workflow.\n","type":"boolean"},"name":{"description":"The name of the task.\n","type":"string"},"notes":{"description":"The notes of the task.\n","type":"string","nullable":true},"object":{"description":"The selected object for the task.\n","type":"string","nullable":true},"object_id":{"description":"The id of the selected object of the task.\n","type":"string","nullable":true},"original_task_id":{"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the ID of the original task in the original workflow."},"children":[]}]}]}],"type":"integer","nullable":true},"original_workflow_id":{"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the ID of the original workflow."},"children":[]}]}]}],"type":"integer","nullable":true},"parameters":{"description":"The configuration of the task.\n","type":"object"},"priority":{"description":"The priority of the task.\n","type":"string"},"start_time":{"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the start time of the task instance."},"children":[]}]}]}],"type":"string"},"status":{"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the status of the task instance."},"children":[]}]}]}],"enum":["Queued","Processing","Pending","Success","Stopped","Error"],"type":"string","nullable":true},"tags":{"description":"The array of filter tags.\n","items":{"type":"string"},"type":"array"},"task_id":{"description":"the id of this task's parent task. Will be null if this is the first task of the workflow","type":"integer","nullable":true},"transient_fields":{"description":"The transient fields of the task, such as the approval data.\n","type":"object"},"updated_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the task is updated the last time, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","type":"string"},"workflow_id":{"description":"The ID of the workflow that the task belongs to.\n","type":"integer"}},"type":"object"}},"components/schemas/DetailedWorkflow":{"id":"components/schemas/DetailedWorkflow","kind":"json-schema","title":"detailed workflow","data":{"description":"A workflow.\n","properties":{"call_type":{"description":"The call type of the active workflow version.\n","type":"string"},"callout_trigger":{"description":"Indicates whether the callout trigger is enabled for the retrieved workflow.\n","type":"boolean"},"created_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow is created, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","type":"string"},"description":{"description":"The description of the workflow.\n","type":"string"},"finished_at":{"description":"The date and time when the instance of the workflow version finished at.\n","format":"date-time","type":"string","nullable":true},"id":{"description":"The unique ID of the workflow.\n","type":"integer"},"interval":{"description":"The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.\n","type":"string","nullable":true},"name":{"description":"The name of the workflow.\n","type":"string"},"ondemand_trigger":{"description":"Indicates whether the ondemand trigger is enabled for the workflow.\n","type":"boolean"},"original_workflow_id":{"description":"The unique ID of the original workflow version.\n","type":"integer","nullable":true},"priority":{"description":"The priority of the active workflow version. \n","type":"string"},"scheduled_trigger":{"description":"Indicates whether the scheduled trigger is enabled for the workflow.\n","type":"boolean"},"started_at":{"description":"The date and time when the instance of the workflow version started at.\n","format":"date-time","type":"string","nullable":true},"status":{"description":"The status of the active workflow version.\n","type":"string"},"timezone":{"description":"The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.\n","type":"string","nullable":true},"type":{"description":"The type of the workflow. Currently the only valid value is 'Workflow::Setup'.\n","enum":["Workflow::Setup","Workflow::Instance"],"type":"string"},"updated_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow is updated the last time, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","type":"string"},"version":{"description":"The version number of the active workflow version.            \n","type":"string"}},"title":"detailed workflow","type":"object"}},"components/schemas/POSTWorkflowDefinitionImportRequest":{"id":"components/schemas/POSTWorkflowDefinitionImportRequest","kind":"json-schema","title":"POSTWorkflowDefinitionImportRequest","data":{"example":{"workflow":{"id":458,"name":"Checking Workflow","description":"","type":"Workflow::Setup","ondemand_trigger":true,"callout_trigger":false,"scheduled_trigger":false,"interval":"","timezone":"","status":"Active","version":"0.0.1"},"tasks":[{"id":1418,"name":"Checking the Approval Email","parameters":{"emailBody":"<body style=\\font-family: Arial, sans-serif; margin: 20px; line-height: 1.6; color: #333;\\>\\n\\t<p> Hello,</p>\\n\\t<p>You have a pending approval. Please <a href=\\{{Data.Approval.approveLink}}\\>approve</a> or <a href=\\{{Data.Approval.rejectLink}}\\>reject</a>.</p>\\n\\t<p>Thanks</p> \\n</body>","senderName":"Admin","senderEmail":"workflow@zuora.com","approvalNote":"","subjectEmail":"This is the email to check if this email is working","delivery_method":"email","email_approver_emails":["admin@company.com"]},"action_type":"Approval","object":"","object_id":"","call_type":"SOAP","task_id":null,"concurrent_limit":9999999,"tags":[]}],"linkages":[{"source_workflow_id":458,"source_task_id":null,"target_task_id":1418,"linkage_type":"Finish"}]},"properties":{"linkages":{"items":{"$ref":"#/components/schemas/Linkage"},"type":"array"},"tasks":{"items":{"$ref":"#/components/schemas/Task"},"type":"array"},"workflow":{"$ref":"#/components/schemas/DetailedWorkflow"}},"type":"object"}},"components/schemas/WorkflowUsage":{"id":"components/schemas/WorkflowUsage","kind":"json-schema","title":"WorkflowUsage","data":{"description":"The task usage of a particular day.\n","properties":{"date":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the usage record is created, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"},"values":{"properties":{"entities":{"description":"The IDs of the Zuora entities that are associated with the tenant.\n","items":{"type":"string"},"type":"array"},"platformWorkflow":{"description":"The number of platform workflows that have been run in the last 7 days.\n","type":"integer"},"taskCount":{"description":"The amount of task runs that have been used.\n","type":"integer"},"workflowCount":{"description":"The amount of workflow runs that have been used.\n","type":"integer"},"workflowUniq7Days":{"description":"The number of unique workflows that have been run in the last 7 days.\n","type":"integer"}},"type":"object"}},"type":"object"}},"components/schemas/UsagesResponse":{"id":"components/schemas/UsagesResponse","kind":"json-schema","title":"UsagesResponse","data":{"properties":{"metrics":{"description":"The list of tasks retrieved.\n","items":{"$ref":"#/components/schemas/WorkflowUsage"},"type":"array"}},"type":"object"}},"components/schemas/TasksResponse":{"id":"components/schemas/TasksResponse","kind":"json-schema","title":"TasksResponse","data":{"properties":{"data":{"description":"The list of tasks retrieved.\n","items":{"$ref":"#/components/schemas/Task"},"type":"array"},"pagination":{"description":"An object containing pagination information for the list of tasks returned by the API.\n","properties":{"next_page":{"description":"A string containing the URL where the next page of data can be retrieved.\n","type":"string"},"page":{"description":"An integer denoting the current page number.\n","type":"integer","nullable":true},"page_length":{"description":"An integer denoting the number of tasks in this response. The maximum value is 100.\n","type":"integer","nullable":true}},"type":"object"}},"type":"object"}},"components/schemas/UpdateTask":{"id":"components/schemas/UpdateTask","kind":"json-schema","title":"task","data":{"description":"A task.\n","properties":{"action_type":{"description":"The type of task.\n","type":"string"},"call_type":{"description":"The type of the API used.\n","type":"string"},"concurrent_limit":{"description":"The maximum number of this task that can run concurrently.\n","maximum":9999999,"minimum":1,"type":"integer"},"id":{"description":"The unique ID of the task.\n","type":"integer"},"name":{"description":"The name of the task.\n","type":"string"},"object":{"description":"The selected object for the task.\n","type":"string"},"object_id":{"description":"The ID of the selected object of the task.\n","type":"string"},"status":{"description":"The status of the task instance.\n","enum":["Queued","Processing","Pending","Success","Stopped","Error"],"type":"string"},"tags":{"description":"The array of filter tags.\n","items":{"type":"string"},"type":"array"},"workflow_id":{"description":"The ID of the workflow the task belongs to.\n","type":"integer"}},"required":["id"],"title":"task","type":"object"}},"components/schemas/PutTasksRequest":{"id":"components/schemas/PutTasksRequest","kind":"json-schema","title":"PutTasksRequest","data":{"example":{"data":[{"id":2771,"name":"If","action_type":"If","call_type":"SOAP","status":"Success","workflow_id":476}]},"properties":{"data":{"description":"The list of tasks to update.\n","items":{"$ref":"#/components/schemas/UpdateTask"},"maximum":50,"minimum":1,"type":"array"}},"type":"object"}},"components/schemas/BadRequestResponse":{"id":"components/schemas/BadRequestResponse","kind":"json-schema","title":"BadRequestResponse","data":{"properties":{"Errors":{"items":{"properties":{"code":{"description":"The error code.","type":"string"},"status":{"description":"The status of the response.","type":"string"},"title":{"description":"The reason for the error.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/GetWorkflowResponse":{"id":"components/schemas/GetWorkflowResponse","kind":"json-schema","title":"GetWorkflowResponse","data":{"properties":{"cpuTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overall CPU time for the execution of the workflow, in seconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is not returned while the workflow run is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or if no CPU time has been recorded yet."},"children":[]}]}]}],"format":"double","type":"number"},"createdAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow run is created, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM:SS UTC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"definitionId":{"description":"The unique ID of the workflow definition that this workflow run belongs to.\n","type":"integer"},"definitionName":{"description":"The name of the workflow definition that this workflow run belongs to.\n","type":"string"},"finishedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the execution of the workflow completes, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM:SS UTC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only returned after the workflow run has finished."},"children":[]}]}]}],"type":"string","nullable":true},"id":{"description":"The unique ID of the workflow.\n","type":"integer"},"messages":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Messages from tasks."},"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 only returned in Production."},"children":[]}]}]}],"type":"object"},"name":{"description":"The unique run number of the workflow.\n","type":"string"},"originalWorkflowId":{"description":"The ID of the workflow setup.\n","type":"integer"},"runTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution time of the workflow including the waiting time, in seconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is not returned while the workflow run is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"double","type":"number","nullable":true},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the workflow:"},"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":"Queued: The workflow is in queue for being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing: The workflow is in process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending: The workflow is waiting on tasks that are pending for retry or delay."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stopping: The workflow is being stopped through Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stopped: The workflow is stopped through Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finished: The workflow is finished. When a workflow is finished, it might have tasks pending for retry or delay. Pending tasks do not block the onfinish branch of the workflow, but they block the oncomplete branch of the iterate."},"children":[]}]}]}]}],"enum":["Queued","Processing","Pending","Stopping","Stopped","Finished"],"type":"string"},"tasks":{"description":"An object containing task counts.\n","properties":{"error":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of tasks in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"type":"integer"},"expected":{"description":"The total number of tasks that the workflow run is expected to execute.\n","type":"integer"},"pending":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of tasks in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"type":"integer"},"processing":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of tasks in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"type":"integer"},"queued":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of tasks in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Queued"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"type":"integer"},"stopped":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of tasks in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stopped"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"type":"integer"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of tasks in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"type":"integer"},"total":{"description":"The total number of tasks.\n","type":"integer"}},"type":"object"},"tags":{"description":"The array of filter tags of the workflow run.\n","items":{"type":"string"},"type":"array"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the current workflow. Possible 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":"Workflow::Setup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The workflow is a setup and is used for creating workflow instances."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Workflow::Instance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The workflow is an execution that has data."},"children":[]}]}]}]}],"type":"string"},"updatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow run is updated the last time, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM:SS UTC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/WorkflowDefinition":{"id":"components/schemas/WorkflowDefinition","kind":"json-schema","title":"a workflow definition with version information","data":{"description":"A workflow.\n","properties":{"active_version":{"allOf":[{"$ref":"#/components/schemas/Workflow"}],"description":"Information of the active version. \n"},"callType":{"description":"The call type of the active version.\n\nThis field is only returned for workflows that are configured as UI actions.\n","type":"string"},"calloutTrigger":{"description":"Indicates whether the callout trigger is enabled for the retrieved workflow.\n","type":"boolean"},"createdAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow is created, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","type":"string"},"description":{"description":"The description of the workflow definition.\n","type":"string"},"id":{"description":"The unique ID of the workflow definition.\n","type":"integer"},"interval":{"description":"The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.\n","type":"string","nullable":true},"name":{"description":"The name of the workflow definition.\n","type":"string"},"ondemandTrigger":{"description":"Indicates whether the ondemand trigger is enabled for the workflow.\n","type":"boolean"},"priority":{"description":"The priority of the active version.\n","type":"string"},"scheduledTrigger":{"description":"Indicates whether the scheduled trigger is enabled for the workflow.\n","type":"boolean"},"status":{"description":"The status of the workflow definition.\n","type":"string"},"timezone":{"description":"The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.\n","type":"string","nullable":true},"uiPages":{"description":"The UI pages that are configured for the active version.\n\nThis field is only returned for workflows that are configured as UI actions.\n","type":"object"},"ui_page_roles":{"description":"The roles that are allowed to access the UI pages of the workflow definition.\n\nThis field is only returned for workflows that are configured as UI actions.\n","items":{"type":"string"},"type":"array"},"updatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow is updated the last time, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date-time","type":"string"},"zuora_org_ids":{"description":"The IDs of the organizations that the workflow definition belongs to.\n","items":{"type":"string"},"type":"array"}},"title":"a workflow definition with version information","type":"object"}},"components/schemas/ValidationReasons":{"id":"components/schemas/ValidationReasons","kind":"json-schema","title":"ValidationReasons","data":{"properties":{"fieldName":{"description":"The name of the invalid field","type":"string"},"title":{"description":"A description why that field is invalid","type":"string"}},"type":"object"}},"components/schemas/ValidationErrors":{"id":"components/schemas/ValidationErrors","kind":"json-schema","title":"ValidationErrors","data":{"properties":{"reasons":{"description":"The list of reasons that the request was unsuccessful","items":{"$ref":"#/components/schemas/ValidationReasons"},"title":"validation reasons","type":"array"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was not successful."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/ExportWorkflowVersionResponse":{"id":"components/schemas/ExportWorkflowVersionResponse","kind":"json-schema","title":"ExportWorkflowVersionResponse","data":{"properties":{"linkages":{"items":{"$ref":"#/components/schemas/Linkage"},"type":"array"},"tasks":{"items":{"$ref":"#/components/schemas/Task"},"type":"array"},"workflow":{"$ref":"#/components/schemas/DetailedWorkflow"}},"type":"object"}},"components/schemas/WorkflowError":{"id":"components/schemas/WorkflowError","kind":"json-schema","title":"WorkflowError","data":{"properties":{"code":{"description":"A short error code describing the error","enum":["invalid"],"type":"string"},"status":{"description":"The http status code for this error","type":"integer"},"title":{"description":"A human readable description describing the error","type":"string"}},"type":"object"}},"components/schemas/WorkflowInstance":{"id":"components/schemas/WorkflowInstance","kind":"json-schema","title":"WorkflowInstance","data":{"description":"A instance workflow object.","properties":{"createdAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow run is created, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM:SS UTC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"},"definitionId":{"description":"The unique ID of the workflow definition that this instance belongs to.\n","type":"integer"},"definitionName":{"description":"The name of the workflow definition that this instance belongs to.\n","type":"string"},"id":{"description":"The unique ID of the workflow.\n","type":"integer"},"name":{"description":"The run number of this workflow instance\n","type":"string"},"originalWorkflowId":{"description":"The identifier of the workflow template that is used to create this instance.\n","type":"integer"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the current state of this workflow instance:"},"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":"Queued: The workflow is in queue for being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing: The workflow is in process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending: The workflow is waiting on tasks that are pending for retry or delay."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stopping: The workflow is being stopped through Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stopped: The workflow is stopped through Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finished: The workflow is finished."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A newly created workflow run is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the request carries a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Notification-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Request-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header that matches a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"previously created run, the existing run is returned instead, which can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in any of the states above."},"children":[]}]}]}],"enum":["Queued","Processing","Pending","Stopping","Stopped","Finished"],"type":"string"},"tags":{"description":"The array of filter tags of the workflow instance.\n","items":{"type":"string"},"type":"array"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the workflow. For a workflow run, the value is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Workflow::Instance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Workflow::Instance"],"type":"string"},"updatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the workflow run is updated the last time, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM:SS UTC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/GetVersionsResponse":{"id":"components/schemas/GetVersionsResponse","kind":"json-schema","title":"GetVersionsResponse","data":{"properties":{"data":{"description":"The list of workflow versions retrieved. \n","items":{"$ref":"#/components/schemas/Workflow"},"type":"array"}},"type":"object"}},"components/schemas/StopWorkflowRunSuccess":{"id":"components/schemas/StopWorkflowRunSuccess","kind":"json-schema","title":"StopWorkflowRunSuccess","data":{"type":"object","properties":{"success":{"type":"boolean","description":"The indicator for whether the operation to stop a workflow run was a success."}}}},"components/schemas/StopWorkflowRunError":{"id":"components/schemas/StopWorkflowRunError","kind":"json-schema","title":"StopWorkflowRunError","data":{"type":"object","properties":{"errors":{"type":"array","description":"The error messages","items":{"type":"object","properties":{"code":{"type":"string","description":"The error code."},"status":{"type":"number","description":"Status code."},"title":{"type":"string","description":"Error title."}}}}}}},"components/schemas/ExpandedContact":{"id":"components/schemas/ExpandedContact","kind":"json-schema","title":"QueryContactResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the contact.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the contact.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the contact was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the contact.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the contact was last updated.\n"},"accountId":{"description":"The ID of the account associated with the contact.\n","type":"string"},"address1":{"description":"The first line of the contact's address, which is often a street address or business name.\n","maxLength":255,"type":"string"},"address2":{"description":"The second line of the contact's address.\n","maxLength":255,"type":"string"},"asBillTo":{"type":"boolean","description":"Indicates whether the contact can be specified as a bill-to contact.\n"},"asShipTo":{"type":"boolean","description":"Indicates whether the contact can be specified as a ship-to contact.\n"},"asSoldTo":{"type":"boolean","description":"Indicates whether the contact can be specified as a sold-to contact.\n"},"city":{"description":"The city of the contact's address.\n","maxLength":40,"type":"string"},"country":{"description":"The country of the contact's address.\n","maxLength":64,"type":"string"},"county":{"description":"The county. May optionally be used by Zuora Tax to calculate county tax.\n","maxLength":32,"type":"string"},"fax":{"description":"The contact's fax number. \n","maxLength":40,"type":"string"},"description":{"description":"A description for the contact.\n","maxLength":100,"type":"string"},"firstName":{"description":"The contact's first name.\n","maxLength":100,"type":"string"},"homePhone":{"description":"The contact's home phone number.\n","maxLength":40,"type":"string"},"lastName":{"description":"The contact's last name.\n","maxLength":100,"type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact.\n","maxLength":100,"type":"string"},"nickname":{"description":"A nickname for the contact.\n","maxLength":100,"type":"string"},"otherPhone":{"description":"An additional phone number for the contact.\n","maxLength":40,"type":"string"},"otherPhoneType":{"description":"The type of the additional phone number.\n","enum":["Work","Mobile","Home","Other"],"type":"string"},"personalEmail":{"description":"The contact's personal email address.\n","maxLength":80,"type":"string"},"state":{"description":"The state or province of the contact's address.\n","maxLength":40,"type":"string"},"postalCode":{"description":"ZIP code or other postal code of the contact's address.\n","maxLength":20,"type":"string"},"taxRegion":{"description":"If using Zuora Tax, a region string as optionally defined in your tax rules. \n","maxLength":32,"type":"string"},"workEmail":{"description":"The contact's business email address.\n","maxLength":80,"type":"string"},"workPhone":{"description":"The contact's business phone number.\n","maxLength":40,"type":"string"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Contact object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryContactResponse"}},"components/schemas/NestedPaymentMethodOnExpand":{"id":"components/schemas/NestedPaymentMethodOnExpand","kind":"json-schema","title":"QueryPaymentMethodResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the payment method.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment method.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the payment method gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment method.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the payment method gets updated in the system.\n"},"accountId":{"type":"string","description":"The unique identifier of the account that the payment method is\nassociated with.\n"},"achAbaCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nine-digit routing number or ABA number used by banks. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"achAccountName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the account holder, which can be either a person or a company. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"achAccountNumberMask":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked bank account number associated with the ACH payment method. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"achAccountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of bank account associated with the ACH payment method. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"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 creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" preferably."},"children":[]}]}]}],"enum":["BusinessChecking","Checking","Saving"]},"achAddress1":{"type":"string","description":"First address line for the ACH payment method.\n","maxLength":255},"achAddress2":{"type":"string","description":"Second address line for the ACH payment method.\n","maxLength":255},"achBankName":{"type":"string","description":"The name of the bank where the ACH payment account is held.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.\n","maxLength":70},"achCity":{"type":"string","description":"City for the ACH payment method.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","maxLength":40},"achCountry":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country for the ACH payment method. Must be a valid country name or abbreviation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the list of supported country names and abbreviations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing."},"children":[]}]}]}],"type":"string"},"achPostalCode":{"type":"string","description":"Zip code or postal code for the ACH payment method.\n","maxLength":20},"achState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State for the ACH payment method. Must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"active":{"type":"boolean","description":"Indicates whether the payment method type is active. This field is for Zuora internal use and does not impact customer integration or use cases.\n"},"isSystem":{"type":"boolean","description":"Indicates whether the payment method is a system-generated payment method. This field is for Zuora internal use and does not impact customer integration or use cases.\n"},"bankBranchCode":{"type":"string","description":"The branch code of the bank used for Direct Debit.  \n"},"bankCheckDigit":{"description":"The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods.","type":"string"},"bankCity":{"type":"string","description":"The city of the direct debit bank."},"bankCode":{"type":"string","description":"The sort code or number that identifies the bank. This is also known as the sort code. \n"},"bankIdentificationNumber":{"type":"string","description":"The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method."},"bankName":{"type":"string","description":"The name of the direct debit bank."},"bankPostalCode":{"type":"string","description":"The zip code or postal code of the direct debit bank."},"bankStreetName":{"type":"string","description":"The name of the street of the direct debit bank."},"bankStreetNumber":{"type":"string","description":"The number of the direct debit bank."},"bankTransferAccountName":{"type":"string","description":"The name on the direct debit bank account."},"bankTransferAccountNumberMask":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a masked displayable version of the bank account number, used for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"security purposes. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"XXXXXXXXX54321"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"bankTransferAccountType":{"type":"string","description":"The type of the customer's bank account. Applicable to direct debit\npayment methods.\n"},"bankTransferType":{"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 direct debit transfer. The value of this field is dependent on the country of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible Values:"},"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":"code","inline":true,"attributes":{"content":"AutomatischIncasso"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (NL)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Germany)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Austria)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DemandeDePrelevement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (FR)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DirectDebitUK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UK)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Domicil"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Belgium)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (CH)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Italy)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrdenDeDomiciliacion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Spain)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Autogiro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Sweden)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Betalingsservice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Denmark)"},"children":[]}]}]}]}]}],"enum":["AutomatischIncasso","LastschriftDE","LastschriftAT","DemandeDePrelevement","DirectDebitUK","Domicil","LastschriftCH","RID","OrdenDeDomiciliacion","Autogiro","Betalingsservice"],"type":"string"},"businessIdentificationCode":{"type":"string","description":"The business identification code for Swiss direct payment methods that use\nthe Global Collect payment gateway. Only applicable to direct debit\npayment methods in Switzerland with Global Collect.\n"},"city":{"description":"The city of the customer's address. Applicable to debit payment methods.\n","type":"string"},"country":{"type":"string","description":"The two-letter country code of the customer's address. Applicable to direct debit payment methods."},"creditCardAddress1":{"type":"string","description":"The first line of the card holder's address, which is often a street\naddress or business name. Applicable to credit card and direct debit\npayment methods.\n"},"creditCardAddress2":{"type":"string","description":"The second line of the card holder's address. Applicable to credit card\nand direct debit payment methods.\n"},"creditCardCity":{"type":"string","description":"The city of the card holder's address. Applicable to credit card and\ndirect debit payment methods.\n"},"creditCardCountry":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country where the credit card holder stays."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regardless of the country texts selected when creating the payment method, only the supported country name returns in this field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a complete list of supported country names, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"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":"Internationalization is not supported for the API field value."},"children":[]}]}]}],"type":"string"},"creditCardExpirationMonth":{"type":"integer","format":"int32","description":"One or two digits expiration month.\n","minimum":1,"maximum":12},"creditCardExpirationYear":{"type":"integer","format":"int32","description":"Four-digit expiration year.\n"},"creditCardHolderName":{"type":"string","description":"The full name of the credit card holder.\n"},"creditCardMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked credit card number, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*********1112"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"creditCardPostalCode":{"type":"string","description":"The postal code for the address of the credit card holder.\n"},"creditCardState":{"type":"string","description":"The state where the credit card holder stays.\n"},"creditCardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the credit card or debit card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JCB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Diners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about credit card types supported by different payment gateways, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Payment Gateways"},"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":"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 only returned for the Credit Card and Debit Card payment types."},"children":[]}]}]}],"type":"string"},"deviceSessionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The session ID of the user when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created or updated."},"children":[]}]}]}],"type":"string"},"existingMandate":{"description":"Indicates whether the mandate is an existing mandate.\n","enum":["Yes","No"],"type":"string"},"email":{"description":"The email address of the payment method holder.\n","type":"string"},"firstName":{"type":"string","description":"The customer's first name. Only applicable to direct debit payment methods.\n"},"iBAN":{"type":"string","description":"The International Bank Account Number used to create the SEPA payment method. The value is masked.\n"},"iPAddress":{"type":"string","description":"The IP address of the user when the payment method was created or updated.\n"},"identityNumber":{"type":"string","description":"The identity number of the account holder or the cardholder.\n"},"companyName":{"type":"string","description":"The name of the company.\n"},"isCompany":{"type":"boolean","description":"Whether the customer account is a company.\n"},"lastFailedSaleTransactionDate":{"type":"string","format":"date","description":"The date of the last failed attempt to collect payment with this payment\nmethod.\n"},"lastName":{"type":"string","description":"The customer's last name. Only applicable to direct debit payment methods.\n"},"lastTransactionDateTime":{"type":"string","description":"The date and time of the most recent transaction.\n","format":"date-time"},"lastTransactionStatus":{"type":"string","description":"The status of the most recent transaction."},"mandateCreationDate":{"description":"The date on which the mandate was created.\n","format":"date","type":"string"},"mandateId":{"description":"The mandate ID.\n","type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","type":"string"},"mandateReceived":{"type":"string","description":"Indicates whether the mandate is received from the gateway.\n","enum":["Yes","No"]},"mandateStatus":{"type":"string","description":"The status of the mandate from the gateway side.\n"},"mandateUpdateDate":{"type":"string","format":"date","description":"The date on which the mandate was updated.\n"},"maxConsecutivePaymentFailures":{"type":"integer","format":"int32","description":"The number of allowable consecutive failures Zuora attempts with the payment method before stopping.\n"},"name":{"type":"string","description":"The name of the payment method.\n"},"numConsecutiveFailures":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of consecutive failed payments for this payment method. It is reset to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" upon successful payment."},"children":[]}]}]}]},"paymentMethodStatus":{"type":"string","description":"The status of the payment method.\n","enum":["Active","Closed","Scrubbed"]},"paymentRetryWindow":{"type":"integer","format":"int32","description":"The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.\n"},"paypalBaid":{"type":"string","description":"ID of a PayPal billing agreement. \n","example":"I-1TJ3GAGG82Y9"},"paypalEmail":{"type":"string","description":"Email address associated with the PayPal payment method. \n"},"paypalPreapprovalKey":{"type":"string","description":"The PayPal preapproval key.\n"},"paypalType":{"type":"string","description":"The type of the PayPal payment method.\n"},"phone":{"type":"string","description":"The phone number that the account holder registered with the bank. This\nfield is used for credit card validation when passing to a gateway.\n"},"postalCode":{"type":"string","description":"The zip code of the customer's address. Only applicable to direct debit\npayment methods.\n"},"secondTokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A gateway unique identifier that replaces sensitive payment method data."},"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 only returned for the Credit Card Reference Transaction payment type."},"children":[]}]}]}],"type":"string"},"state":{"type":"string","description":"The state of the customer's address. Only applicable to direct debit\npayment methods.\n"},"streetName":{"type":"string","description":"The street name of the customer's address. Only applicable to direct debit\npayment methods.\n"},"streetNumber":{"type":"string","description":"The street number of the customer's address. Only applicable to direct\ndebit payment methods.\n"},"tokenId":{"type":"string","description":"A gateway unique identifier that replaces sensitive payment method data or\nrepresents a gateway's unique customer profile. Applicable to CC Reference\nTransaction payment methods.\n"},"totalNumberOfErrorPayments":{"type":"integer","format":"int32","description":"The number of error payments that used this payment method."},"totalNumberOfProcessedPayments":{"type":"integer","format":"int32","description":"The number of successful payments that used this payment method."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the payment method. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"useDefaultRetryRule":{"type":"boolean","description":"Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.\n"},"methodReferenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query."},"children":[]}]}]}]},"userReferenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the user or customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}]},"subType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference indicating the subtype of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}]},"methodSpecificData":{"type":"string","description":"Other method-specific data of the payment method.\n"},"cardBrand":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card brand, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"cardClass":{"description":"The type of the card.\n","type":"string","enum":["ChargeCard","Credit","Debit","DeferredDebit","Prepaid"]},"cardIssuingBank":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The issuer bank of the card, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JPMORGAN CHASE BANK N.A."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cardIssuingCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The issuing country code of the card, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cardProductType":{"type":"string","description":"The product type of the card.\n","enum":["Commercial_or_Corporate_Card","Consumer_Card"]},"account":{"type":"object","description":"The account to which the payment method belongs.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment Method object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPaymentMethodResponse"}},"components/schemas/NestedSubscriptionOnExpand":{"id":"components/schemas/NestedSubscriptionOnExpand","kind":"json-schema","title":"QuerySubscriptionResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the subscription.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the subscription.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the subscription was created in the Zuora\nsystem.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the subscription.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the subscription was last updated.\n"},"accountId":{"type":"string","description":"The ID of the account associated with this subscription."},"autoRenew":{"type":"boolean","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription automatically renews at the end of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"term."},"children":[]}]}]}],"default":false},"cancelledDate":{"type":"string","format":"date","description":"The date on which the subscription was canceled.\n"},"contractAcceptanceDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the customer accepts the contract, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"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 not set:"},"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":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set, the value of this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field is set to be the contract effective date."},"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":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set, the value of this field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is set to be the service activation date."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractEffectiveDate <= serviceActivationDate <="},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractAcceptanceDate"},"children":[]}]}]}]},"contractEffectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription is activated, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify a Service Activation date if the Customer Acceptance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date is set. If the Customer Acceptance date is not set, the value of"},"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":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field defaults to be the Contract"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Effective Date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractEffectiveDate <= serviceActivationDate <="},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractAcceptanceDate"},"children":[]}]}]}]},"creatorAccountId":{"type":"string","description":"The ID of the account that created the subscription. This field is\nautomatically populated with the ID of the account that creates the\nsubscription.\n"},"creatorInvoiceOwnerId":{"type":"string","description":"The account ID that owns the invoices associated with the subscription or the amended subscription.\n"},"currentTerm":{"type":"integer","format":"int64","description":"The length of the period for the current subscription term.\n"},"currentTermPeriodType":{"type":"string","description":"The period type for the current subscription term.\n","enum":["Month","Year","Day","Week"],"default":"Month"},"initialTerm":{"type":"integer","format":"int64","description":"The length of the period for the initial subscription term.\n"},"initialTermPeriodType":{"type":"string","description":"The period type for the first subscription term.\n","enum":["Month","Year","Day","Week"],"default":"Month"},"invoiceOwnerId":{"type":"string","description":"The account ID that owns the invoices associated with the subscription. \n"},"isInvoiceSeparate":{"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":"Determines if the subscription is invoiced separately."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then all charges for this subscription are collected into the subscription's own invoice."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the subscription.\n"},"notes":{"type":"string","description":"Additional information about the subscription.\n","maxLength":65535},"originalCreatedDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription was originally created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is the same as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value until the subscription is amended."},"children":[]}]}]}]},"originalId":{"type":"string","description":"The original rate plan charge ID. Only available for update\nsubscription.\n"},"previousSubscriptionId":{"type":"string","description":"The ID of the previous subscription. This field is only available if\nthe subscription is a renewal subscription.\n"},"renewalSetting":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether a termed subscription will remain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or change to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it is renewed."},"children":[]}]}]}],"enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"default":"RENEW_WITH_SPECIFIC_TERM"},"renewalTerm":{"type":"integer","format":"int64","description":"The length of the period for the subscription renewal term.\n"},"renewalTermPeriodType":{"type":"string","description":"The period type for the subscription renewal term.\n","enum":["Month","Year","Day","Week"],"default":"Month"},"revision":{"type":"string","description":"An auto-generated decimal value uniquely tagged with a subscription.\nThe value always contains one decimal place, for example, the revision\nof a new subscription is 1.0. If a further version of the subscription\nis created, the revision value will be increased by 1. Also, the\nrevision value is always incremental regardless of deletion of\nsubscription versions.\n"},"serviceActivationDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the services or products within a subscription have been activated and access has been provided to the customer, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"status":{"type":"string","description":"Subscription status.\n","enum":["Draft","Pending Activation","Pending Acceptance","Active","Cancelled","Suspended"]},"isLatestVersion":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current subscription object is the latest version."},"children":[]}]}]}],"type":"boolean"},"subscriptionEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription term ends, where the subscription ends"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at midnight the day before."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 12/31/2016, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptions ends at midnight (00:00:00 hours) on 12/30/2016."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This date is the same as the term end date or the cancelation date, as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"appropriate."},"children":[]}]}]}]},"subscriptionStartDate":{"type":"string","format":"date","description":"Date the subscription becomes effective.\n"},"subscriptionVersionAmendmentId":{"type":"string","description":"The ID of the amendment made to this subscription version.\n"},"termEndDate":{"type":"string","format":"date","description":"Date the subscription term ends. If the subscription is evergreen,\nthis is null or is the cancellation date (if one has been set).\n"},"termStartDate":{"type":"string","format":"date","description":"Date the subscription term begins. If this is a renewal subscription,\nthis date is different from the subscription start date.\n"},"termType":{"type":"string","description":"The type of the subscription term.\n","enum":["TERMED","EVERGREEN"]},"version":{"type":"integer","format":"int64","description":"This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment."},"cMRR":{"type":"number","description":"Monthly recurring revenue of the subscription.\n"},"billToContactSnapshotId":{"type":"string","description":"The ID of the bill-to contact snapshot.\n"},"billToContactId":{"type":"string","description":"The ID of the bill-to contact for the subscription.\n"},"invoiceTemplateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}]},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"shipToContactId":{"type":"string","description":"The ID of the ship-to contact for the subscription.\n"},"shipToContactSnapshotId":{"type":"string","description":"The ID of the ship-to contact snapshot.\n"},"soldToContactId":{"type":"string","description":"The ID of the sold-to contact for the subscription.\n"},"soldToContactSnapshotId":{"type":"string","description":"The ID of the sold-to contact snapshot.\n"},"externallyManagedBy":{"type":"string","description":"An enum field on the Subscription object to indicate the name of a\nthird-party store. This field is used to represent subscriptions created\nthrough third-party stores.\n","enum":["Amazon","Apple","Google","Roku"]},"lastBookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last booking date of the subscription object. This field is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"writable only when the subscription is newly created as a first"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"version subscription. You can override the date value when creating a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription through the Subscribe and Amend API or the subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creation UI (non-Orders). Otherwise, the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per the user's timezone. The value of this field is as follows:"},"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":"For a new subscription created by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-apis-subscribe-and-amend"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs"},"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 field has the value of the subscription creation date."},"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":"For a subscription changed by an amendment, this field has the value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the amendment booking date."},"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":"For a subscription created or changed by an order, this field has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the value of the order date."},"children":[]}]}]}]}]}],"format":"date","type":"string"},"invoiceScheduleId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple invoice schedules are created for different terms of a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription, this field stores the latest invoice schedule."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"cancelReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for a subscription cancellation copied from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of a Cancel Subscription order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains valid value only if a subscription is cancelled"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"through the Orders UI or API. Otherwise, the value for this field will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"prepayment":{"type":"boolean","description":"Whether the subscription is prepaid.\n"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"orderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the order associated with the subscription."},"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 available only for orders that exist after the end of June 2023."},"children":[]}]}]}],"type":"string"},"rampId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ramp object associated with the subscription."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramp"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"paymentTerm":{"type":"string","description":"Name of the payment term associated with the account. For example,\n\"Net 30\". The payment term determines the due dates of invoices.\n"},"quoteNumber__QT":{"type":"string","description":"The unique identifier of the Quote. This field is used in Zuora data\nsources to report on Subscription metrics. If the subscription originated\nfrom Zuora Quotes, the value is populated with the value from Zuora\nQuotes.\n","maxLength":32},"quoteType__QT":{"description":"The Quote type that represents the subscription lifecycle stage such as\nNew, Amendment, Renew or Cancel. This field is used in Zuora data sources\nto report on Subscription metrics. If the subscription originated from\nZuora Quotes, the value is populated with the value from Zuora Quotes.\n","maxLength":32,"type":"string"},"quoteBusinessType__QT":{"type":"string","description":"The specific identifier for the type of business transaction the Quote\nrepresents such as New, Upsell, Downsell, Renewal or Churn. This field is\nused in Zuora data sources to report on Subscription metrics. If the\nsubscription originated from Zuora Quotes, the value is populated with the\nvalue from Zuora Quotes.\n","maxLength":32},"opportunityName__QT":{"type":"string","description":"The unique identifier of the Opportunity. This field is used in Zuora data\nsources to report on Subscription metrics. If the subscription originated\nfrom Zuora Quotes, the value is populated with the value from Zuora\nQuotes.\n","maxLength":100},"opportunityCloseDate__QT":{"type":"string","format":"date"},"cpqBundleJsonId__QT":{"description":"The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.\n","maxLength":32,"type":"string"},"account":{"type":"object","description":"The subscription owner account associated with the subscription.\n"},"invoiceOwner":{"type":"object","description":"The invoice owner account associated with the subscription.\n"},"invoiceItems":{"type":"array","items":{"type":"object"},"description":"The invoice items associated with the subscription.\n"},"ratePlans":{"type":"array","items":{"type":"object"},"description":"The rate plans associated with the subscription.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Subscription object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QuerySubscriptionResponse"}},"components/schemas/NestedPaymentOnExpand":{"id":"components/schemas/NestedPaymentOnExpand","kind":"json-schema","title":"QueryPaymentResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the payment.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the payment gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the payment gets updated in the system.\n"},"accountId":{"description":"The ID of the customer account that the payment is for.\n","type":"string"},"accountingCode":{"type":"string","description":"The accounting code for the charge. Accounting codes group\ntransactions that contain similar accounting attributes.\n"},"amount":{"description":"The total amount of the payment.\n","format":"double","type":"number"},"appliedAmount":{"description":"The applied amount of the payment.\n","format":"double","type":"number"},"authTransactionId":{"description":"The authorization transaction ID from the payment gateway.\n","type":"string"},"appliedCreditBalanceAmount":{"type":"number","description":"The amount of the payment to apply to a credit balance. \n"},"bankIdentificationNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first six or eight digits of the credit card or debit card used for the payment, when applicable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-reconcile-payments-with-merchant-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reconcile payments between the gateway and merchant banks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cancelledOn":{"type":"string","description":"The date when the payment was canceled.\n","format":"date-time"},"comment":{"type":"string","description":"Comments about the payment.\n","nullable":true},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is not enabled, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is enabled and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency."},"children":[]}]}]}],"type":"string","example":"USD"},"effectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"gatewayOrderId":{"description":"A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.\n","type":"string"},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string"},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string"},"gatewayResponse":{"description":"The message returned from the payment gateway for the payment. This message is gateway-dependent.\n","type":"string"},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the payment. This code is gateway-dependent.\n","type":"string"},"gatewayState":{"description":"The status of the payment in the gateway; use for reconciliation. \n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"gatewayTransactionState":{"type":"string"},"isStandalone":{"type":"boolean","description":"Indicates whether the payment is a standalone payment. A standalone\npayment is a payment that is not associated with any invoice or\nsubscription.\n"},"markedForSubmissionOn":{"type":"string","format":"date-time","description":"The date and time when a charge was marked and waiting for batch\nsubmission to the payment process.\n"},"paymentMethodId":{"type":"string","description":"The unique ID of the payment method that the customer used to make the payment.\n"},"paymentMethodSnapshotId":{"type":"string","description":"The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"},"paymentOptionId":{"type":"string","description":"ID of the paymentOption object, which describe the transactional level rules for processing payments. \n"},"paymentNumber":{"type":"string","description":"The unique identification number of a payment. \n","example":"P-00000028."},"payoutId":{"type":"string","description":"The payout ID of the payment from the gateway side.\n"},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payment is used as a reserved payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"referencedPaymentID":{"type":"string","description":"The ID of a referenced payment. \n"},"referenceId":{"description":"The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string"},"refundAmount":{"type":"number","description":"The amount of the payment that is refunded.\n","format":"double"},"secondPaymentReferenceId":{"type":"string","description":"The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.\n"},"settledOn":{"type":"string","format":"date-time","description":"The date and time when the payment was settled in the payment processor. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"},"softDescriptor":{"type":"string","description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"},"softDescriptorPhone":{"type":"string","description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"},"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how the payment was created, whether through API, manually, import, payment run, or Checkout."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checkout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is automatically assigned when a payment is created through a Hosted Payment Method (HPM) flow, such as UPI."},"children":[]}]}]}],"enum":["PaymentRun","Import","Manually","API","Checkout"]},"sourceName":{"type":"string","description":"Name of the source. It can be a payment run number or a file name.\n"},"status":{"description":"The status of the payment.\n","enum":["Draft","Processing","Processed","Error","Canceled","Posted"],"type":"string"},"submittedOn":{"description":"The date and time when the payment was submitted.\n","format":"date-time","type":"string"},"type":{"description":"The type of the payment.\n","enum":["External","Electronic"],"type":"string"},"transferredToAccounting":{"description":"Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"transactionSource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework."},"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":"C_Unscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchant-initiated transaction (MIT) that occurs at regular intervals."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_Unscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_MOTO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-stripe-gateway-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Stripe payment gateway integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"enum":["C_Unscheduled","M_Recurring","M_Unscheduled","M_MOTO"]},"unappliedAmount":{"type":"number","description":"The unapplied amount of the payment.\n"},"lastEmailDateTime":{"type":"string","description":"The date and time when the last email was sent to the customer for the payment.\n"},"gateway":{"type":"string","description":"Name of the gateway instance that processes the payment. \n"},"account":{"type":"object","description":"The account associated with the payment.\n"},"paymentMethod":{"type":"object","description":"The payment method used for this payment.\n"},"paymentApplications":{"type":"array","items":{"type":"object"},"description":"The payment applications associated with the payment.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPaymentResponse"}},"components/schemas/NestedRefundOnExpand":{"id":"components/schemas/NestedRefundOnExpand","kind":"json-schema","title":"QueryRefundResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the refund.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the refund.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the refund was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the refund.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the refund was last updated.\n"},"accountId":{"description":"The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.\n","type":"string"},"amount":{"description":"The total amount of the refund.\n","format":"double","type":"number"},"cancelledOn":{"description":"The date and time when the refund was cancelled.\n","format":"date-time","type":"string"},"comment":{"description":"Comments about the refund.\n","type":"string","nullable":true},"paymentMethodSnapshotId":{"type":"string","description":"The unique ID of the payment method snapshot which is a copy of the particular payment method used in a transaction.\n"},"accountingCode":{"type":"string","description":"The accounting code that maps to this refund transaction in your accounting\nsystem.\n"},"currency":{"type":"string","description":"The currency of the refund.\n"},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string"},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string"},"gatewayResponse":{"description":"The message returned from the payment gateway for the refund. This\nmessage is gateway-dependent.\n","type":"string"},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the refund. This code\nis gateway-dependent.\n","type":"string"},"gatewayState":{"description":"The status of the refund in the gateway. \n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"markedForSubmissionOn":{"description":"The date and time when a refund was marked and waiting for batch submission to the payment process.\n","format":"date-time","type":"string"},"methodType":{"description":"How an external refund was issued to a customer. \n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"paymentMethodId":{"type":"string","description":"The unique ID of the payment method that the customer used to make the refund.\n"},"payoutId":{"type":"string","description":"The payout ID of the refund from the gateway side.\n"},"reasonCode":{"type":"string","description":"A code identifying the reason for the transaction.\n"},"refundNumber":{"type":"string","description":"The number of the refund.\n"},"referenceID":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string"},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01."},"children":[]}]}]}],"format":"date","type":"string"},"refundTransactionTime":{"description":"The date and time when the refund was issued.\n","format":"date-time","type":"string"},"sourceType":{"type":"string","description":"Specifies whether the refund is a refund payment or a credit balance. \n","enum":["Payment","CreditBalance","CreditMemo"]},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string"},"settledOn":{"description":"The date and time when the refund was settled in the payment processor. This field is used by the Spectrum gateway only and not applicable to other gateways.\n","format":"date-time","type":"string"},"softDescriptor":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string"},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string"},"status":{"description":"The status of the refund. \n","enum":["Processed","Canceled","Error","Processing"],"type":"string"},"submittedOn":{"type":"string","description":"The date and time when the refund was submitted.\n","format":"date-time"},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"type":{"type":"string","description":"The type of the refund. \n","enum":["External","Electronic"]},"associatedTransactionNumber":{"type":"string","description":"The number of the associated transactions, such as payments.\n"},"gateway":{"type":"string","description":"The gateway that processed the original payment. A gateway is an online service provider that connects an online shopping cart to a payment processor.\nZuora uses this same gateway for the corresponding refund. \nIf this payment gateway is no longer active, then the electronic refund fails. \n"},"account":{"type":"object","description":"The account associated with the refund.\n"},"paymentMethod":{"type":"object","description":"The payment method to which the refund is returned.\n"},"refundApplications":{"type":"array","items":{"type":"object"},"description":"The refund applications associated with the refund.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Refund object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryRefundResponse"}},"components/schemas/NestedCreditMemoOnExpand":{"id":"components/schemas/NestedCreditMemoOnExpand","kind":"json-schema","title":"QueryCreditMemoResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the credit memo.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the credit memo.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the credit memo.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo was last updated.\n"},"appliedAmount":{"description":"The applied amount of the credit memo.\n","format":"double","type":"number"},"balance":{"type":"number","description":"The remaining balance of credit memo.\n"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string"},"billToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact snapshot associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if the bill rule "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-billing-rules-billing-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preserve snapshot of bill-to and sold-to contacts when billing documents are posted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is disabled."},"children":[]}]}]}],"type":"string","nullable":true},"cancelledById":{"description":"The ID of the Zuora user who cancelled the credit memo.\n","type":"string","nullable":true},"cancelledOn":{"description":"The date and time when the credit memo was cancelled.\n","format":"date-time","type":"string","nullable":true},"comment":{"description":"Comments about the credit memo.\n","type":"string","nullable":true},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the credit memo."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"discountAmount":{"type":"number","description":"The amount of the discount on the credit memo.\n"},"einvoiceErrorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceErrorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceFileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the e-invoice file generated for the credit memo."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the e-invoice file generation for the 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":"If e-invoice file generation succeeds, this field is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both the error code and message are empty, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eInvoiceFileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field stores the ID of the generated e-invoice file."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a failure occurs during e-invoice file generation, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If e-invoice file generation conditionally succeeds, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConditionalSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are  returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the e-invoice file has been approved by the tax authority, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The next status will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"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 e-invoice file has been rejected by the government, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot resend this e-invoice; you must create a new invoice instead."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"enum":["Processing","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string"},"excludeFromAutoApplyRules":{"description":"Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.\n","type":"boolean"},"exchangeRateDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the exchange rate used. The date is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"Corresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater."},"children":[]}]}]}]},"autoApplyUponPosting":{"description":"Whether the credit memo automatically applies to the invoice upon\nposting.\n","type":"boolean"},"memoDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the credit memo takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"memoNumber":{"description":"The unique identification number of the credit memo.\n","type":"string"},"postedById":{"description":"The ID of the Zuora user who posted the credit memo.\n","type":"string","nullable":true},"postedOn":{"description":"The date and time when the credit memo was posted.\n","format":"date-time","type":"string"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value\nmust be an existing reason code or empty.\n","type":"string"},"refundAmount":{"description":"The amount of the refund on the credit memo.\n","format":"double","type":"number"},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice."},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"reversed":{"description":"Whether the credit memo is reversed.\n","type":"boolean"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source of the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"BillRun"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is generated by a bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice and collect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, or by calling the Orders, Order Line Items, or Fulfillments API operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiSubscribe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiAmend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromPrpc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created from a product rate plan charge through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a credit memo from a charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create credit memo from invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverse invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}],"type":"string","enum":["BillRun","API","ApiSubscribe","ApiAmend","AdhocFromPrpc","AdhocFromInvoice"]},"sourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the credit memo source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a credit memo is generated from a bill run, the value is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number of the corresponding bill run. Otherwise, the value is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"sourceType":{"description":"The type of the credit memo source.\n","enum":["Subscription","Standalone","Invoice","Order","CreditMemo","Consolidation"],"type":"string"},"status":{"description":"The status of the credit memo.\n","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the credit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxMessage":{"description":"The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of tax calculation related to the credit memo."},"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 only applicable to tax calculation by third-party tax engines. Also, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side.  If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string"},"shipToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact snapshot associated with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit memo."},"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":": If you have the Flexible Billing Attributes feature"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disabled, 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":[]}]}]}],"type":"string","nullable":true},"soldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit memo."},"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":": If you have the Flexible Billing Attributes feature"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disabled, 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":[]}]}]}],"type":"string","nullable":true},"taxAutoCalculation":{"default":true,"description":"Whether to automatically calculate taxes in the credit memo.\n","type":"boolean"},"totalAmount":{"type":"number","format":"double","description":"The total amount of the credit memo, including taxes.\n"},"totalAmountWithoutTax":{"type":"number","format":"double","description":"The total amount of the credit memo, excluding taxes.\n"},"totalTaxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"transferredToAccounting":{"description":"Whether the credit memo was transferred to an external\naccounting system. This field is used for integration with\naccounting systems such as NetSuite.\n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"invoiceId":{"description":"The ID of a referred invoice.\n","type":"string"},"accountId":{"description":"The ID of the customer account associated with the credit memo.\n","type":"string"},"account":{"type":"object","description":"The account associated with the credit memo.\n"},"billToContact":{"type":"object","description":"The bill-to contact on the account.\n"},"creditMemoItems":{"type":"array","items":{"type":"object"},"description":"The credit memo items on the current credit memo.\n"},"creditMemoApplications":{"type":"array","items":{"type":"object"},"description":"The credit memo applications associated with the current credit memo.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Credit Memo object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryCreditMemoResponse"}},"components/schemas/NestedDebitMemoOnExpand":{"id":"components/schemas/NestedDebitMemoOnExpand","kind":"json-schema","title":"QueryDebitMemoResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the debit memo.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the debit memo.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the debit memo was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the debit memo.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the debit memo was last updated.\n"},"autoPay":{"description":"Whether debit memos are automatically picked up for processing in the\ncorresponding payment run.\n\n\nBy default, debit memos are automatically picked up for processing in\nthe corresponding payment run.\n","type":"boolean"},"creditMemoId":{"type":"string","description":"The ID of the credit memo from which the debit memo was created.\n","nullable":true},"balance":{"type":"number","description":"The remaining balance of debit memo.\n"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string"},"billToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact snapshot associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if the bill rule "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-billing-rules-billing-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preserve snapshot of bill-to and sold-to contacts when billing documents are posted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is disabled."},"children":[]}]}]}],"type":"string","nullable":true},"cancelledById":{"description":"The ID of the Zuora user who cancelled the debit memo.\n","type":"string","nullable":true},"cancelledOn":{"description":"The date and time when the debit memo was cancelled.\n","format":"date-time","type":"string","nullable":true},"comments":{"description":"Comments about the debit memo.\n","type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the debit memo."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"discountAmount":{"type":"number","description":"The amount of the discount on the debit memo.\n"},"dueDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for the debit memo is due, in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"einvoiceErrorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceErrorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceFileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the e-invoice file generated for the debit memo."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the e-invoice file generation for the 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":"If e-invoice file generation succeeds, this field is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both the error code and message are empty, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eInvoiceFileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field stores the ID of the generated e-invoice file."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a failure occurs during e-invoice file generation, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If e-invoice file generation conditionally succeeds, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConditionalSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are  returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the e-invoice file has been approved by the tax authority, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The next status will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"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 e-invoice file has been rejected by the government, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot resend this e-invoice; you must create a new invoice instead."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"enum":["Processing","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string"},"exchangeRateDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the exchange rate used. The date is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"Corresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater."},"children":[]}]}]}]},"memoDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the debit memo takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"memoNumber":{"description":"The unique identification number of the debit memo.\n","type":"string"},"postedById":{"description":"The ID of the Zuora user who posted the debit memo.\n","type":"string","nullable":true},"postedOn":{"description":"The date and time when the debit memo was posted.\n","format":"date-time","type":"string"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value\nmust be an existing reason code or empty.\n","type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source of the debit memo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"BillRun"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The debit memo is generated by a bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiSubscribe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The debit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiAmend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The debit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromPrpc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The debit memo is created from a product rate plan charge through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromPrpc/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a debit memo from a charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The debit memo is created from an invoice or created by reversing an invoice. You can create a debit memo from an invoice through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromInvoice/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a debit memo from an invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}],"type":"string","enum":["BillRun","API","ApiSubscribe","ApiAmend","AdhocFromPrpc","AdhocFromInvoice"]},"sourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the debit memo source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a debit memo is generated from a bill run, the value is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number of the corresponding bill run. Otherwise, the value is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"sourceType":{"description":"The type of the debit memo source.\n","enum":["Subscription","Standalone","Order","Consolidation","Invoice","CreditMemo"],"type":"string"},"status":{"description":"The status of the debit memo.\n","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the debit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxMessage":{"description":"The message about the status of tax calculation related to the\ndebit memo. If tax calculation fails in one debit memo, this\nfield displays the reason for the failure.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of tax calculation related to the debit memo."},"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 only applicable to tax calculation by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"third-party tax engines. Also, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string"},"shipToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact snapshot associated with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debit memo."},"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":": If you have the Flexible Billing Attributes feature"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disabled, 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":[]}]}]}],"type":"string","nullable":true},"soldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debit memo."},"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":": If you have the Flexible Billing Attributes feature"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disabled, 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":[]}]}]}],"type":"string","nullable":true},"taxAutoCalculation":{"default":true,"description":"Whether to automatically calculate taxes in the debit memo.\n","type":"boolean"},"totalAmount":{"type":"number","format":"double","description":"The total amount of the debit memo, including taxes.\n"},"totalAmountWithoutTax":{"type":"number","format":"double","description":"The total amount of the debit memo, excluding taxes.\n"},"totalTaxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"transferredToAccounting":{"description":"Whether the debit memo was transferred to an external\naccounting system. This field is used for integration with\naccounting systems such as NetSuite.\n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"invoiceId":{"description":"The ID of a referred invoice.\n","type":"string"},"accountId":{"description":"The ID of the customer account associated with the debit memo.\n","type":"string"},"paymentTerm":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term assoicated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature disabled."},"children":[]}]}]}]},"account":{"type":"object","description":"The account associated with the debit memo.\n"},"billToContact":{"type":"object","description":"The bill-to contact associated with the debit memo.\n"},"debitMemoItems":{"type":"array","items":{"type":"object"},"description":"The debit memo items associated with the debit memo.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Debit Memo object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryDebitMemoResponse"}},"components/schemas/NestedInvoiceOnExpand":{"id":"components/schemas/NestedInvoiceOnExpand","kind":"json-schema","title":"QueryInvoiceResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the invoice.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the invoice.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the invoice gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the invoice.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the invoice gets updated in the system.\n"},"accountId":{"description":"The ID of the customer account associated with the invoice.\n","type":"string"},"adjustmentAmount":{"description":"The amount of the invoice adjustments associated with the invoice.\n","format":"double","type":"number"},"amount":{"description":"The total amount of the invoice.\n","format":"double","type":"number"},"amountWithoutTax":{"description":"The invoice amount excluding tax.\n","format":"double","type":"number"},"autoPay":{"description":"Whether invoices are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"balance":{"description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n","type":"number","format":"double"},"billToContactId":{"description":"The ID of the bill-to contact associated with the invoice.\n","type":"string"},"billToContactSnapshotId":{"description":"The ID of the bill-to contact snapshot associated with the invoice.\n","type":"string","nullable":true},"comments":{"type":"string","description":"Comments about the invoice.\n"},"creditBalanceAdjustmentAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency amount of the adjustment applied to the customer's credit balance."},"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 only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled."},"children":[]}]}]}],"format":"double","type":"number"},"creditMemoAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency amount of all credit memos applied to this invoice."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"double","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the invoice."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"dueDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for this invoice is due, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"includesOneTime":{"description":"Specifies whether the invoice includes one-time charges.\n","type":"boolean"},"includesRecurring":{"description":"Specifies whether the invoice includes recurring charges.\n","type":"boolean"},"includesUsage":{"description":"Specifies whether the invoice includes usage charges.\n","type":"boolean"},"invoiceDate":{"description":"The date that appears on the invoice being created.\n","format":"date","type":"string"},"invoiceNumber":{"description":"The unique identification number of the invoice.\n","type":"string"},"lastEmailSentDate":{"description":"The date when the invoice was last emailed.\n","type":"string","nullable":true},"organizationId":{"type":"string","description":"ID of the organization this object belongs to.\n"},"paymentAmount":{"description":"The amount of payments applied to the invoice.\n","format":"double","type":"number"},"postedBy":{"description":"The user ID of the person who moved the invoice to Posted status.\n","type":"string","nullable":true},"postedDate":{"description":"The date when the invoice was posted.\n","format":"date-time","type":"string"},"refundAmount":{"description":"Specifies the amount of a refund that was applied against an earlier payment on the invoice.\n","format":"double","type":"number"},"sequenceSetId":{"description":"The ID of the sequence set associated with the invoice.\n","type":"string"},"communicationProfileId":{"description":"The ID of the communication profile associated with the invoice.\n","type":"string","nullable":true},"shipToContactId":{"description":"The ID of the ship-to contact associated with the invoice.\n","type":"string"},"shipToContactSnapshotId":{"description":"The ID of the ship-to contact snapshot associated with the invoice.\n","type":"string","nullable":true},"soldToContactId":{"description":"The ID of the sold-to contact associated with the invoice.\n","type":"string"},"soldToContactSnapshotId":{"description":"The ID of the sold-to contact snapshot associated with the invoice.\n","type":"string","nullable":true},"source":{"description":"The source of the invoice.\n","enum":["BillRun","API","ApiSubscribe","ApiAmend"],"type":"string"},"sourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice source."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an invoice is generated from a bill run, the value is the number of the corresponding bill run.Otherwise, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"reversed":{"type":"boolean","description":"Whether the invoice is reversed.\n"},"sourceType":{"description":"The type of the invoice source.\n","enum":["Subscription","Standalone","Order","Consolidation"],"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the invoice."},"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":"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status is applicable only when you use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/invoice-management/split-invoices/split-invoices-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Invoice feature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"When an invoice is split, its status changes from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the newly created invoices retain a reference to the original invoice."},"children":[]}]}]}]}]}],"enum":["Draft","Posted","Split"],"type":"string"},"targetDate":{"description":"This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.\n","format":"date","type":"string"},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"taxMessage":{"description":"The message that the tax engine return if it calculates the taxes of this invoice fails.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status that the tax engine return after it calculates the taxes of this invoice."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side.  If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string"},"templateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template."},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled, the value of this field depends on the configuration of the invoice template."},"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 you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription."},"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 specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]}],"type":"string"},"transferredToAccounting":{"description":"Whether the invoice was transferred to an external accounting system.\n","enum":["Processing","Error","Ignore","Yes","No"],"type":"string","nullable":true},"eInvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It could be Processing, RetrieveTimeOut, Generated, Success, ConditionalSuccess, ApprovedByAuthority, Failed, or Rejected. If it’s Failed, it will have an error code and message. If it’s Generated or Success, both error code and message are empty, and eInvoiceFileId stores the file id of e-invoice."},"children":[]}]}]}],"enum":["Processing","RetrieveTimeOut","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string"},"eInvoiceFileId":{"type":"string","description":"The ID of the e-invoice file.\n"},"eInvoiceErrorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This code can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor."},"children":[]}]}]}]},"eInvoiceErrorMessage":{"type":"string","description":"The error message when status is \"Failed\". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n"},"paymentLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to the Payment Link page where the customer can pay the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The link is generated only if the invoice is posted after enabling the Payment Link feature on your tenant."},"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 Payment Link feature is in the Early Adopter phase."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can enable the Payment Link feature through a self-service configuration in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting for Zuora Payments."},"children":[]}]}]}]},"paymentTerm":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment term associated with the invoice. For"},"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":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoices."},"children":[]}]}]}]},"account":{"type":"object","description":"The account associated with the invoice.\n"},"billToContact":{"type":"object","description":"The bill-to contact who pays the invoice.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Invoice object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryInvoiceResponse"}},"components/schemas/NestedUsageOnExpand":{"id":"components/schemas/NestedUsageOnExpand","kind":"json-schema","title":"QueryUsageResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the usage.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the usage.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the usage was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the usage.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the usage was last updated.\n"},"accountId":{"type":"string","description":"The ID of the customer account associated with the usage.\n"},"accountNumber":{"type":"string","description":"The number of the customer account associated with the usage.\n"},"ratePlanChargeId":{"type":"string","description":"ID of the rate plan charge that pays for this usage.\n"},"endDateTime":{"type":"string","description":"End date of the time period in which usage is tracked. Zuora uses\nthis field value to determine the usage date.\n","format":"date-time"},"productRatePlanChargeId":{"type":"string","description":"The product rate plan charge number that you use for a dynamic usage charge.\n"},"quantity":{"type":"number","description":"Number of units used.\n"},"rbeStatus":{"type":"string","description":"Indicates if the rating and billing engine (RBE) processed usage data for an invoice.\n","enum":["Importing","Pending","Processed"]},"sourceType":{"type":"string","description":"Indicates if the usage records were imported from the web-based UI or the API.\n","enum":["API","Import"]},"startDateTime":{"description":"Start date of the time period in which usage is tracked. Zuora uses\nthis field value to determine the usage date.\n","format":"date-time","type":"string"},"subscriptionId":{"type":"string","description":"The original ID of the subscription that contains the fees related to the usage data.\n"},"submissionDateTime":{"type":"string","format":"date-time","description":"The date and time when the usage was submitted.\n"},"uOM":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":{"type":"string","description":"A description of the usage record.\n"},"importId":{"type":"string","description":"The unique identifier of the import.\n"},"uniqueKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a customer-defined specific identifier of a usage record."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature or the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload usage record with unique"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"key"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"type":"string"},"fileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File ID of the uploaded usage records file. You can use this file ID with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_Files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to download the file."},"children":[]}]}]}],"type":"string"},"fileName":{"type":"string","description":"The name of the import file when the usage record is imported from the file.\n"},"account":{"type":"object","description":"The account associated with the usage.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Usage object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryUsageResponse"}},"components/schemas/ExpandedAccount":{"id":"components/schemas/ExpandedAccount","kind":"json-schema","title":"QueryAccountResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the account.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the account.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the account was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the account.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the account was last updated.\n"},"accountNumber":{"type":"string","description":"The account number that identifies the account.\n"},"additionalEmailAddresses":{"type":"string","description":"An additional email addresse to receive email notifications.\n"},"allowInvoiceEdit":{"type":"boolean","description":"Indicates whether associated invoices can be edited.\n","default":false},"autoPay":{"type":"boolean","description":"Indicates whether future payments are automatically collected when they are due\nduring a payment run.\n"},"balance":{"type":"number","format":"double","description":"The customer's total invoice balance minus credit balance.\n"},"batch":{"type":"string","description":"The alias name given to a batch. A string of 50 characters or less.\n"},"bcdSettingOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill cycle day setting option. Indicates whether the account’s bill cycle day is managed manually or automatically."},"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":"ManualSet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The bill cycle day is explicitly set to a specific day of the month (1–31)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AutoSet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The bill cycle day is automatically determined by Zuora. The bill cycle day is assigned when the first subscription is created for the account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is system-derived and read-only. Its value is automatically determined based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billCycleDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string","enum":["ManualSet","AutoSet"]},"billCycleDay":{"type":"integer","format":"int64","description":"Billing cycle day (BCD), the day of the month when a bill run\ngenerates invoices for the account.\n"},"billToId":{"type":"string","description":"The unique identifier of the bill-to contact associated with the account.\n"},"communicationProfileId":{"type":"string","description":"The unique identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.\n"},"creditBalance":{"type":"number","format":"double","description":"The current credit balance on the account.\n"},"crmId":{"description":"External identifier of the account in a CRM system.\n","maxLength":100,"type":"string"},"currency":{"type":"string","description":"A currency defined in the web-based UI administrative settings.\n"},"customerServiceRepName":{"description":"Name of the account's customer service representative, if applicable.\n","maxLength":50,"type":"string"},"defaultPaymentMethodId":{"type":"string","description":"ID of the default payment method for the account.\n"},"eInvoiceProfileId":{"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 e-invoice profile for this account."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},"invoiceDeliveryPrefsEmail":{"description":"Indicates whether the customer wants to receive invoices through email. \n","type":"boolean"},"invoiceDeliveryPrefsPrint":{"description":"Whether the customer wants to receive printed invoices, such as through postal mail.\n","type":"boolean"},"invoiceTemplateId":{"description":"Invoice template ID, configured in Billing Settings in the Zuora UI.\n","type":"string"},"lastInvoiceDate":{"type":"string","format":"date","description":"Date of the most recent invoice for the account; null if no invoice has ever been generated.\n"},"lastMetricsUpdate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when account metrics are last updated, if the account is a partner account."},"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":":"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you ever set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an account, the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastMetricsUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is the time when the account metrics are last updated."},"children":[]}]}]}]}],"format":"date-time","type":"string"},"name":{"type":"string","description":"The name of the account.\n"},"notes":{"type":"string","description":"A string of up to 65,535 characters.\n"},"organizationId":{"type":"string","description":"The unique identifier of the organization to which the account belongs.\n"},"parentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the parent customer account for this Account object. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"length is 32 characters. Use this field if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}],"type":"string"},"partnerAccount":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer account is a partner, distributor, or reseller."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"paymentMethodCascadingConsent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent from your customer to use the Cascading Payment Method feature was collected."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent was not collected and the Cascading Payment Method feature is not enabled."},"children":[]}]}]}]},"purchaseOrderNumber":{"type":"string","description":"The purchase order number provided by your customer for services,\nproducts, or both purchased.\n"},"salesRepName":{"type":"string","description":"Name of the account's sales representative, if applicable.\n"},"sequenceSetId":{"type":"string","nullable":true,"description":"The ID of the billing document sequence set to assign to the customer account. \nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\nIf a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.\n"},"shipToId":{"type":"string","description":"The unique identifier of the ship-to contact associated with the account.\n"},"soldToId":{"type":"string","description":"The unique identifier of the sold-to contact associated with the account.\n"},"status":{"description":"The account status.\n","type":"string","enum":["Active","Draft","Canceled"]},"taxCompanyCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique code that identifies a company account in Avalara."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":50},"taxExemptCertificateID":{"type":"string","description":"ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.\n","maxLength":32},"taxExemptCertificateType":{"type":"string","description":"Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n","maxLength":32},"taxExemptDescription":{"type":"string","description":"Description of the tax exemption certificate that the customer holds.\nApplicable if you use Zuora Tax or Connect tax engines.\n","maxLength":500},"taxExemptEffectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the customer tax exemption starts, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Applicable if you use Zuora Tax or Connect tax engines."},"children":[]}]}]}]},"taxExemptEntityUseCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique entity use code to apply exemptions in Avalara AvaTax. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.avalara.com/avatax/handling-tax-exempt-customers/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exempt Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}],"maxLength":64},"taxExemptExpirationDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the customer tax exemption expires, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Applicable if you use Zuora Tax or Connect tax engines."},"children":[]}]}]}]},"taxExemptIssuingJurisdiction":{"type":"string","description":"Jurisdiction in which the customer tax exemption certificate was issued.\n","maxLength":32},"taxExemptStatus":{"type":"string","default":"No","description":"Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. \n","enum":["No","Yes","PendingVerification"]},"totalInvoiceBalance":{"type":"number","description":"Total balance of all posted invoices.\n","format":"double"},"unappliedBalance":{"type":"number","description":"Total unapplied balance in this currency.\n"},"vATId":{"type":"string","description":"EU Value Added Tax ID."},"mrr":{"type":"number","description":"Monthly recurring revenue for the account.\n"},"totalDebitMemoBalance":{"type":"number","description":"Total balance of all posted debit memos.\n","format":"double"},"unappliedCreditMemoAmount":{"type":"number","description":"The total unapplied amount of all posted credit memos in this currency.\n","format":"double"},"creditMemoTemplateId":{"type":"string","description":"ID of the credit memo template that is used to generate credit memos for the account.\n"},"debitMemoTemplateId":{"type":"string","description":"ID of the debit memo template that is used to generate debit memos for the account.\n"},"paymentGateway":{"type":"string","description":"The name of the payment gateway instance. If null or left unassigned,\nthe account will use the default gateway.\n"},"paymentTerm":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment-terms indicator defined in the web-based UI administrative"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settings, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"billTo":{"$ref":"#/components/schemas/ExpandedContact"},"shipTo":{"$ref":"#/components/schemas/ExpandedContact"},"soldTo":{"$ref":"#/components/schemas/ExpandedContact"},"defaultPaymentMethod":{"$ref":"#/components/schemas/NestedPaymentMethodOnExpand"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/NestedSubscriptionOnExpand"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/NestedPaymentOnExpand"}},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/NestedRefundOnExpand"}},"creditMemos":{"type":"array","items":{"$ref":"#/components/schemas/NestedCreditMemoOnExpand"}},"debitMemos":{"type":"array","items":{"$ref":"#/components/schemas/NestedDebitMemoOnExpand"}},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/NestedInvoiceOnExpand"}},"usages":{"type":"array","items":{"$ref":"#/components/schemas/NestedUsageOnExpand"}},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/NestedPaymentMethodOnExpand"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Account object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryAccountResponse"}},"components/schemas/CommonOQErrorResponse":{"id":"components/schemas/CommonOQErrorResponse","kind":"json-schema","title":"CommonOQErrorResponse","data":{"properties":{"reasons":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The container of the error code and message. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"properties":{"code":{"description":"The error code of response.\n","type":"integer"},"message":{"description":"The detail information of the error response\n","type":"string"}},"type":"object"},"type":"array"},"requestId":{"description":"The unique identifier of the request.\n","format":"uuid","maxLength":36,"minLength":36}},"type":"object"}},"components/schemas/ExpandedAmendment":{"id":"components/schemas/ExpandedAmendment","kind":"json-schema","title":"QueryAmendmentResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the amendment.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the amendment.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the amendment gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the amendment.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the amendment gets updated in the system.\n"},"autoRenew":{"type":"boolean","description":"Indicates whether the amendment is automatically renewed.\n"},"code":{"type":"string","description":"The amendment code.\n"},"contractEffectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the amendment becomes effective for billing purposes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currentTerm":{"type":"integer","format":"int64","description":"The length of the period for the current subscription term.\n"},"currentTermPeriodType":{"type":"string","description":"The period type for the current subscription term.\n","enum":["Month","Year","Day","Week"]},"customerAcceptanceDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the customer accepts the amendment changes to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the subscription, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":{"type":"string","description":"Description of the amendment.\n"},"effectiveDate":{"type":"string","format":"date","description":"The date when the amendment changes take effective.\n"},"effectivePolicy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Effective Policy for the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value depends on the following conditions:"},"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 rate plan change (from old to new) is an upgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveImmediately"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the rate plan change (from old to new) is a downgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"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 feature is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["EffectiveImmediately","EffectiveEndOfBillingPeriod","SpecificDate"]},"name":{"type":"string","description":"The name of the amendment.\n"},"newRatePlanId":{"type":"string","description":"The ID of the rate plan charge on which amendment is made. Only\nthe Add or Update amendment returns a new rate plan ID.\n"},"removedRatePlanId":{"type":"string","description":"The ID of the rate plan charge that is removed from the subscription. Only\nthe Remove Product amendment returns a removed rate plan ID.\n"},"renewalSetting":{"type":"string","description":"Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.\n","enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"]},"renewalTerm":{"description":"The term of renewal for the amended subscription.\n","format":"int64","type":"integer"},"renewalTermPeriodType":{"description":"The period type for the subscription renewal term.\n","type":"string","enum":["Month","Year","Day","Week"]},"resumeDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription resumption takes effect, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"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":"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"serviceActivationDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when service is activated, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"specificUpdateDate":{"type":"string","format":"date","description":"The date when the Update Product amendment takes effect.\n\nOnly for the Update Product amendments if there is already \na future-dated Update Product amendment on the subscription.\n"},"status":{"type":"string","description":"The status of the amendment.\n","enum":["Draft","Pending Activation","Pending Acceptance","Completed"]},"subscriptionId":{"type":"string","description":"The ID of the subscription based on which the amendment is created.\n"},"suspendDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription suspension takes effect, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"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":"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 feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date"},"termStartDate":{"type":"string","format":"date","description":"The date when the new terms and conditions take effect.\n"},"termType":{"type":"string","description":"Indicates if the subscription is termed or evergreen.\n","enum":["TERMED","EVERGREEN"]},"type":{"description":"Type of the amendment.\n","type":"string","enum":["Cancellation","NewProduct","OwnerTransfer","RemoveProduct","Renewal","UpdateProduct","TermsAndConditions","ChangePlan","Composite"]},"subType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sub type for the change plan order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field was not set by user, the field is automatically generated by the system according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are within the same Grading catalog group:"},"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 grade of new plan is greater than that of the old plan, this is an \"Upgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan is less than that of the old plan, this is a \"Downgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan equals that of the old plan, this is a \"Crossgrade\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\"."},"children":[]}]}]}],"enum":["Upgrade","Downgrade","Crossgrade","PlanChanged"]},"bookingDate":{"type":"string","format":"date"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Amendment object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryAmendmentResponse"}},"components/schemas/ExpandedBillingRun":{"id":"components/schemas/ExpandedBillingRun","kind":"json-schema","title":"QueryBillingRunResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the bill run.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the bill run.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the bill run was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the bill run.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the bill run was last updated.\n"},"billingRunNumber":{"type":"string","description":"The number of the bill run.\n"},"billingRunType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the bill run."},"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":"You can use this field only if the Catch-Up Bill Run feature is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled."},"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":"You must specify this field to create a catch up bill run."},"children":[]}]}]}]}]}],"enum":["Regular","CatchUp"],"default":"Regular"},"endDate":{"type":"string","format":"date-time","description":"The end date and time when the bill run completes.\n"},"errorMessage":{"type":"string","description":"The error message generated by a failed billing run.\n"},"executedDate":{"type":"string","format":"date-time","description":"The date and time when the bill run was executed.\n"},"invoiceDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that appears on the invoice being created, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"The value cannot fall in a closed accounting period."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the bill run.\n"},"numberOfAccounts":{"type":"integer","format":"int64","description":"The number of accounts included in this bill run processing.\n"},"numberOfInvoices":{"type":"integer","format":"int64","description":"The number of invoices generated from this bill run.\n"},"numberOfCreditMemos":{"type":"integer","format":"int64","description":"The number of credit memos generated from this bill run.\n"},"postedDate":{"type":"string","format":"date-time","description":"The date when the bill run was posted.\n"},"startDate":{"type":"string","format":"date-time","description":"The start date and time of the bill run.\n"},"status":{"description":"The status of the bill run.\n","enum":["Pending","Processing","Completed","Error","Canceled","Posted","PostInProgress","CancelInProgress","RemoveInProgress","Paused"],"type":"string"},"targetDate":{"type":"string","format":"date","description":"The target date for this bill run, only valid for ad-hoc bill runs.\n"},"targetType":{"type":"string","description":"The target type for this bill run.\n","enum":["SingleAccount","AllAccount"]},"totalTime":{"type":"integer","format":"int64","description":"The total time in milliseconds for the bill run to complete.\n"},"accountId":{"type":"string","description":"The unique identifier of the account included in the bill run.\n"},"batches":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch of accounts for this bill run, this field can not exist with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billRunFilters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" together."},"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":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllBatches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Batch"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"n"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number between 1 and 50, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Batch7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"billCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of the bill cycle. This field is only valid when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified."},"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":"Values:"},"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":"code","inline":true,"attributes":{"content":"AllBillCycleDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or one of numbers 1 - 31 for an ad-hoc bill run"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllBillCycleDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", one of numbers 1 - 31, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AsRunDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a scheduled bill run"},"children":[]}]}]}]}]}],"type":"string","enum":["AllBillCycleDays","AsRunDay"]},"noEmailForZeroAmountInvoice":{"description":"Whether to suppress emails for invoices with zero total amount\ngenerated in this bill run after the bill run is complete. \n","type":"boolean"},"autoEmail":{"description":"Whether to automatically send emails after Auto-Post is complete.\n","type":"boolean"},"autoPost":{"description":"Whether to automatically post the bill run after the bill run is created.\n","type":"boolean"},"autoRenewal":{"description":"Whether to automatically renew auto-renew subscriptions that are up for renewal.\n","type":"boolean"},"invoicesEmailed":{"type":"boolean","description":"Whether the invoices have been emailed after the bill run is complete.\n"},"lastEmailSentTime":{"type":"string","format":"date-time","description":"The date and time when the last email was sent.\n"},"targetDateOffSet":{"type":"integer","format":"int32","description":"The offset compared to bill run execution date, only valid for scheduled bill runs.\n"},"invoiceDateOffSet":{"type":"integer","format":"int32","description":"The offset compared to bill run execution date, only valid for scheduled bill runs.\n"},"chargeTypeToExclude":{"description":"The types of the charges to be excluded from the generation of billing\ndocuments.\n","enum":["OneTime","Recurring","Usage"],"type":"string"},"scheduledExecutionTime":{"description":"The scheduled execution time for a bill run.\n","format":"date-time","type":"string"},"repeatType":{"description":"The repeat type of the bill run.\n","enum":["None","Daily","Weekly","Monthly"],"type":"string"},"repeatFrom":{"description":"The start date of the scheduled bill run.\n","format":"date","type":"string"},"repeatTo":{"description":"The end date of of the scheduled bill run.\n","format":"date","type":"string"},"runTime":{"type":"integer","format":"int32","description":"The scheduled run time (hour) of day.\n","maximum":23,"minimum":0},"timeZone":{"type":"string","description":"Timezone of the scheduled bill run.\n"},"monthlyOnDay":{"type":"string","description":"The repeat day in a month.\n"},"weeklyOnDay":{"description":"The repeat day in a week.\n","enum":["Mon","Tue","Wed","Thu","Fri","Sat","Sun"],"type":"string"},"includeSubscriptions":{"default":true,"description":"Indicates whether to bill subscriptions in the bill run.\n","type":"boolean"},"includeOrderLineItems":{"default":true,"description":"Indicates whether to bill order line items in the bill run.\n","type":"boolean"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Bill Run object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryBillingRunResponse"}},"components/schemas/NestedAccountOnExpand":{"id":"components/schemas/NestedAccountOnExpand","kind":"json-schema","title":"QueryAccountResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the account.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the account.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the account was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the account.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the account was last updated.\n"},"accountNumber":{"type":"string","description":"The account number that identifies the account.\n"},"additionalEmailAddresses":{"type":"string","description":"An additional email address to receive email notifications.\n"},"allowInvoiceEdit":{"type":"boolean","description":"Indicates whether associated invoices can be edited.\n","default":false},"autoPay":{"type":"boolean","description":"Indicates whether future payments are automatically collected when they are due\nduring a payment run.\n"},"balance":{"type":"number","format":"double","description":"The customer's total invoice balance minus credit balance.\n"},"batch":{"type":"string","description":"The alias name given to a batch. A string of 50 characters or less.\n"},"bcdSettingOption":{"type":"string","description":"The billing cycle day setting option for the account.\n","enum":["ManualSet","AutoSet"]},"billCycleDay":{"type":"integer","format":"int64","description":"Billing cycle day (BCD), the day of the month when a bill run\ngenerates invoices for the account.\n"},"billToId":{"type":"string","description":"The unique identifier of the bill-to contact associated with the account.\n"},"communicationProfileId":{"type":"string","description":"The unique identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.\n"},"creditBalance":{"type":"number","format":"double","description":"The current credit balance on the account.\n"},"crmId":{"description":"External identifier of the account in a CRM system.\n","maxLength":100,"type":"string"},"currency":{"type":"string","description":"A currency defined in the web-based UI administrative settings.\n"},"customerServiceRepName":{"description":"Name of the account's customer service representative, if applicable.\n","maxLength":50,"type":"string"},"defaultPaymentMethodId":{"type":"string","description":"ID of the default payment method for the account.\n"},"eInvoiceProfileId":{"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 e-invoice profile for this account."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}]},"invoiceDeliveryPrefsEmail":{"description":"Indicates whether the customer wants to receive invoices through email. \n","type":"boolean"},"invoiceDeliveryPrefsPrint":{"description":"Whether the customer wants to receive printed invoices, such as through postal mail.\n","type":"boolean"},"invoiceTemplateId":{"description":"Invoice template ID, configured in Billing Settings in the Zuora UI.\n","type":"string"},"lastInvoiceDate":{"type":"string","format":"date","description":"Date of the most recent invoice for the account; null if no invoice has ever been generated.\n"},"lastMetricsUpdate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when account metrics are last updated, if the account is a partner account."},"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":":"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you ever set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partnerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an account, the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastMetricsUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is the time when the account metrics are last updated."},"children":[]}]}]}]}],"format":"date-time","type":"string"},"name":{"type":"string","description":"The name of the account.\n"},"notes":{"type":"string","description":"A string of up to 65,535 characters.\n"},"organizationId":{"type":"string","description":"The unique identifier of the organization to which the account belongs.\n"},"parentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the parent customer account for this Account object. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"length is 32 characters. Use this field if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled."},"children":[]}]}]}],"type":"string"},"partnerAccount":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer account is a partner, distributor, or reseller."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-reseller-account","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reseller Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"paymentMethodCascadingConsent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent from your customer to use the Cascading Payment Method feature was collected."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the consent was not collected and the Cascading Payment Method feature is not enabled."},"children":[]}]}]}]},"purchaseOrderNumber":{"type":"string","description":"The purchase order number provided by your customer for services,\nproducts, or both purchased.\n"},"salesRepName":{"type":"string","description":"Name of the account's sales representative, if applicable.\n"},"sequenceSetId":{"type":"string","nullable":true,"description":"The ID of the billing document sequence set to assign to the customer account. \nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\nIf a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.\n"},"shipToId":{"type":"string","description":"The unique identifier of the ship-to contact associated with the account.\n"},"soldToId":{"type":"string","description":"The unique identifier of the sold-to contact associated with the account.\n"},"status":{"description":"The account status.\n","type":"string","enum":["Active","Draft","Canceled"]},"taxCompanyCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique code that identifies a company account in Avalara."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 feature is in Limited Availability. If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":50},"taxExemptCertificateID":{"type":"string","description":"ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.\n","maxLength":32},"taxExemptCertificateType":{"type":"string","description":"Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n","maxLength":32},"taxExemptDescription":{"type":"string","description":"Description of the tax exemption certificate that the customer holds.\nApplicable if you use Zuora Tax or Connect tax engines.\n","maxLength":500},"taxExemptEffectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the customer tax exemption starts, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Applicable if you use Zuora Tax or Connect tax engines."},"children":[]}]}]}]},"taxExemptEntityUseCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique entity use code to apply exemptions in Avalara AvaTax. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.avalara.com/avatax/handling-tax-exempt-customers/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exempt Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}],"maxLength":64},"taxExemptExpirationDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the customer tax exemption expires, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Applicable if you use Zuora Tax or Connect tax engines."},"children":[]}]}]}]},"taxExemptIssuingJurisdiction":{"type":"string","description":"Jurisdiction in which the customer tax exemption certificate was issued.\n","maxLength":32},"taxExemptStatus":{"type":"string","default":"No","description":"Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. \n","enum":["No","Yes","PendingVerification"]},"totalInvoiceBalance":{"type":"number","description":"Total balance of all posted invoices.\n","format":"double"},"unappliedBalance":{"type":"number","description":"Total unapplied balance in this currency.\n"},"vATId":{"type":"string","description":"EU Value Added Tax ID."},"mrr":{"type":"number","description":"Monthly recurring revenue for the account.\n"},"totalDebitMemoBalance":{"type":"number","description":"Total balance of all posted debit memos.\n","format":"double"},"unappliedCreditMemoAmount":{"type":"number","description":"The total unapplied amount of all posted credit memos in this currency.\n","format":"double"},"creditMemoTemplateId":{"type":"string","description":"ID of the credit memo template that is used to generate credit memos for the account.\n"},"debitMemoTemplateId":{"type":"string","description":"ID of the debit memo template that is used to generate debit memos for the account.\n"},"paymentGateway":{"type":"string","description":"The name of the payment gateway instance. If null or left unassigned,\nthe account will use the default gateway.\n"},"paymentTerm":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment-terms indicator defined in the web-based UI administrative"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settings, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"billTo":{"type":"object","description":"The bill-to contact on this account.\n"},"shipTo":{"type":"object","description":"The ship-to contact on the account.\n"},"soldTo":{"type":"object","description":"The sold-to contact on the account.\n"},"defaultPaymentMethod":{"type":"object","description":"The default payment method associated with the account.\n"},"subscriptions":{"type":"array","items":{"type":"object"},"description":"The subscriptions associated with the account.\n"},"payments":{"type":"array","items":{"type":"object"},"description":"The payments associated with the account.  \n"},"refunds":{"type":"array","items":{"type":"object"},"description":"The refunds associated with the account.  \n"},"creditMemos":{"type":"array","items":{"type":"object"},"description":"The credit memos associated with the account.  \n"},"debitMemos":{"type":"array","items":{"type":"object"},"description":"The debit memos associated with the account.  \n"},"invoices":{"type":"array","items":{"type":"object"},"description":"The invoices associated with the account.  \n"},"usages":{"type":"array","items":{"type":"object"},"description":"The usage records associated with the account.        \n"},"paymentMethods":{"type":"array","items":{"type":"object"},"description":"The payment methods associated with the account.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Account object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryAccountResponse"}},"components/schemas/NestedCreditMemoItemOnExpand":{"id":"components/schemas/NestedCreditMemoItemOnExpand","kind":"json-schema","title":"QueryCreditMemoItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the credit memo item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the credit memo item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo item was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the credit memo item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo item was last updated.\n"},"amount":{"type":"number","description":"The amount of the credit memo item. For tax-inclusive credit memo\nitems, the amount indicates the credit memo item amount including tax.\nFor tax-exclusive credit memo items, the amount indicates the credit\nmemo item amount excluding tax.\n"},"amountWithoutTax":{"description":"The credit memo item amount excluding tax.\n","format":"double","type":"number"},"appliedToItemId":{"description":"The unique ID of the credit memo item that the discount charge is applied to.\n","type":"string"},"appliedToOthersAmount":{"type":"number","description":"The amount of the credit memo that is applied to other credit memo\nitems.\n"},"beAppliedByOthersAmount":{"type":"number"},"chargeDate":{"type":"string","description":"The date when the credit memo item is charged.\n","format":"date-time"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the credit memo item."},"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 only available if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the credit memo item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"fulfillmentId":{"description":"The reference ID of the fulfillment associated with the credit memo item.\n","type":"string"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the credit memo item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"invoiceScheduleItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"itemShipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"itemSoldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"itemSoldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string","nullable":true},"itemType":{"type":"string","description":"The type of the credit memo item.\n"},"orderLineItemId":{"type":"string","description":"The ID of the order line item associated with the credit memo item, if applicable.\n"},"processingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the charge for the credit memo item."},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Charge - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Discount"},"children":[]}]}]}]}],"type":"string","enum":["0","1"]},"quantity":{"description":"The number of units for the credit memo item.\n","format":"double","type":"number"},"purchaseOrderNumber":{"type":"string","description":"The purchase order number associated the credit memo item.\n"},"creditFromItemSource":{"description":"The type of the credit from item.\n","enum":["InvoiceItem","CreditMemoItem"],"type":"string"},"creditFromItemId":{"type":"string","description":"The ID of the credit from item.\n"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"serviceEndDate":{"description":"The service end date of the credit memo item. \n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the credit memo item.\n","format":"date","type":"string"},"sku":{"description":"The SKU for the product associated with the credit memo item.\n","type":"string"},"sourceItemType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the source item."},"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 credit memo is not created from an invoice or a product rate plan charge or a return order line item, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionComponent"},"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 a credit memo is created from an invoice, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceDetail"},"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 a credit memo is created from a product rate plan charge, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"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 a credit memo is created from a return order line item, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderLineItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["SubscriptionComponent","InvoiceDetail","ProductRatePlanCharge","OrderLineItem"],"type":"string"},"subscriptionId":{"description":"The ID of the subscription associated with the credit memo item.\n","type":"string"},"taxMode":{"description":"The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"chargeName":{"type":"string","description":"The name of the charge associated with the credit memo item. \n"},"chargeNumber":{"type":"string","description":"The number of the product rate plan charge that the credit memo is created from.\n"},"commitmentChargeSegmentNumber":{"type":"string"},"commitmentChargeNumber":{"type":"string"},"taxAmount":{"description":"The amount of the tax applied to the credit memo item.\n","format":"double","type":"number"},"taxCodeName":{"type":"string","description":"The tax code identifies which tax rules and tax rates to apply to a specific credit memo item.\n"},"taxExemptAmount":{"type":"number","description":"The calculated tax amount excluded due to the exemption.\n"},"unappliedAmount":{"description":"The unapplied amount of the credit memo item.\n","format":"double","type":"number"},"unitOfMeasure":{"description":"The units to measure usage.\n","type":"string"},"unitPrice":{"description":"The per-unit price of the credit memo item.\n","format":"double","type":"number"},"subscriptionNumber":{"type":"string","description":"The number of the subscription associated with the credit memo item.\n"},"invoiceItemId":{"type":"string","description":"The ID of the invoice item associated with the credit memo item.\n"},"productRatePlanChargeId":{"type":"string","description":"The ID of the product rate plan charge that the credit memo is created\nfrom.\n"},"ratePlanChargeId":{"type":"string","description":"The ID of the rate plan charge associated with the credit memo item.\n"},"revenueRecognitionRuleName":{"type":"string","description":"The name of the revenue recognition rule governing the revenue schedule.\n"},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice."},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"creditMemoId":{"type":"string","description":"The ID of the credit memo to which this credit memo item belongs.\n"},"numberOfDeliveries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, 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":"For the credit memo generated by a bill run, this field has a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the credit memo generated from an invoice, this field is blank."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the Delivery Pricing feature enabled."},"children":[]}]}]}]}],"type":"number"},"recognizedRevenueAccountingCodeId":{"type":"string","description":"The Recognized Revenue accounting code for the credit memo item.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The Account Receivable accounting code for the credit memo item.\n"},"onAccountAccountingCodeId":{"type":"string","description":"The On Account accounting code for the credit memo item.\n"},"deferredRevenueAccountingCodeId":{"type":"string","description":"The Deferred Revenue accounting code for the credit memo item.\n"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this transaction.\n"},"shipToContactSnapshotId":{"description":"The ID of the ship-to contact snapshot associated with the credit memo.\n","type":"string","nullable":true},"soldToContactSnapshotId":{"description":"The ID of the sold-to contact snapshot associated with the credit memo.\n","type":"string","nullable":true},"billToContactSnapshotId":{"description":"The ID of the bill-to contact snapshot associated with the credit memo.\n","type":"string","nullable":true},"subscription":{"type":"object","description":"The subscription associated with the credit memo item.\n"},"ratePlanCharge":{"type":"object","description":"The rate plan charge associated with the credit memo item.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Credit Memo Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryCreditMemoItemResponse"}},"components/schemas/NestedCreditMemoApplicationOnExpand":{"id":"components/schemas/NestedCreditMemoApplicationOnExpand","kind":"json-schema","title":"QueryCreditMemoApplicationResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the credit memo application.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the credit memo application.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo application was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the credit memo application.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo application was last updated.\n"},"amount":{"type":"number","format":"double","description":"The application amount of the credit memo.\n"},"effectiveDate":{"type":"string","format":"date","description":"The date when the credit memo application becomes effective.\n"},"creditMemoId":{"type":"string","description":"The ID of the credit memo associated with the credit memo application.\n"},"accountId":{"type":"string","description":"The ID of the customer account associated with the credit memo.\n"},"applicationGroupId":{"type":"string","description":"The ID of the application group to which this credit memo application belongs.\n"},"debitMemoId":{"type":"string","description":"The ID of the debit memo to which the credit memo is applied.\n"},"invoiceId":{"type":"string","description":"The ID of the invoice to which the credit memo is applied.\n"},"creditMemo":{"type":"object","description":"The credit memo associated with the credit memo application.\n"}},"type":"object","title":"QueryCreditMemoApplicationResponse","additionalProperties":false}},"components/schemas/NestedContactSnapshotOnExpand":{"id":"components/schemas/NestedContactSnapshotOnExpand","kind":"json-schema","title":"QueryContactSnapshotResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the contact snapshot.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the snapshot.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the contact snapshot was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the snapshot.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the contact snapshot was last updated.\n"},"accountId":{"type":"string","description":"The unique identifier of the associated billing account.\n"},"contactId":{"type":"string","description":"The unique identifier of the original contact.\n"},"firstName":{"type":"string","description":"The first name of the contact.\n"},"lastName":{"type":"string","description":"The last name of the contact.\n"},"nickName":{"type":"string","description":"The nickname of the contact.\n"},"address1":{"type":"string","description":"The first line of the address.\n"},"address2":{"type":"string","description":"The second line of the address.\n"},"city":{"type":"string","description":"The city of the contact's address.\n"},"state":{"type":"string","description":"The state or province of the contact's address.\n"},"postalCode":{"type":"string","description":"The postal or ZIP code.\n"},"county":{"type":"string","description":"The county or region of the contact.\n"},"country":{"type":"string","description":"The county or region of the contact.\n"},"taxRegion":{"type":"string","description":"The tax region applicable to the contact.\n"},"description":{"type":"string","description":"The free-form description of the contact snapshot.\n"},"homePhone":{"type":"string","description":"The home phone number.\n"},"otherPhone":{"type":"string","description":"Any other phone number.\n"},"otherPhoneType":{"type":"string","description":"The type of the other phone number.\n"},"fax":{"type":"string","description":"The fax number.\n"},"personalEmail":{"type":"string","description":"The personal email address.\n"},"workEmail":{"type":"string","description":"The personal email address.\n"},"deleted":{"type":"boolean","description":"Indicates whether the contact snapshot is marked as deleted.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the ContactSnapshot object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryContactSnapshotResponse"}},"components/schemas/ExpandedCreditMemo":{"id":"components/schemas/ExpandedCreditMemo","kind":"json-schema","title":"QueryCreditMemoResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the credit memo.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the credit memo.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the credit memo.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo was last updated.\n"},"appliedAmount":{"description":"The applied amount of the credit memo.\n","format":"double","type":"number"},"balance":{"type":"number","description":"The remaining balance of credit memo.\n"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string"},"billToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact snapshot associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if the bill rule "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-billing-rules-billing-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preserve snapshot of bill-to and sold-to contacts when billing documents are posted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is disabled."},"children":[]}]}]}],"type":"string"},"cancelledById":{"description":"The ID of the Zuora user who cancelled the credit memo.\n","type":"string","nullable":true},"cancelledOn":{"description":"The date and time when the credit memo was cancelled.\n","format":"date-time","type":"string","nullable":true},"comment":{"description":"Comments about the credit memo.\n","type":"string","nullable":true},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the credit memo."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true,"example":"USD"},"discountAmount":{"type":"number","description":"The amount of the discount on the credit memo.\n"},"einvoiceErrorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceErrorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceFileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the e-invoice file generated for the credit memo."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the e-invoice file generation for the credit memo."},"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":"If e-invoice file generation succeeds, this field is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both the error code and message are empty, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eInvoiceFileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field stores the ID of the generated e-invoice file."},"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":"If the responses from tax vendors such as Sovos or Avalara are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taking too long, this field becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vendor responds successfully, you can use the 'Resync E-Invoice Status'"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action to update the status automatically.  You can view these updates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in System Health telemetry."},"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":"If a failure occurs during e-invoice file generation, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If e-invoice file generation conditionally succeeds, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConditionalSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are  returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If the e-invoice file has been approved by the tax authority, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The next status will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"If the e-invoice file has been rejected by the government, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot resend this e-invoice; you must create a new invoice instead."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"enum":["Processing","RetrieveTimeOut","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string"},"excludeFromAutoApplyRules":{"description":"Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.\n","type":"boolean"},"exchangeRateDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the exchange rate used. The date is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"Corresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater."},"children":[]}]}]}]},"autoApplyUponPosting":{"description":"Whether the credit memo automatically applies to the invoice upon\nposting.\n","type":"boolean"},"memoDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the credit memo takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"memoNumber":{"description":"The unique identification number of the credit memo.\n","type":"string"},"postedById":{"description":"The ID of the Zuora user who posted the credit memo.\n","type":"string"},"postedOn":{"description":"The date and time when the credit memo was posted.\n","format":"date-time","type":"string"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value\nmust be an existing reason code or empty.\n","type":"string"},"refundAmount":{"description":"The amount of the refund on the credit memo.\n","format":"double","type":"number"},"reversed":{"description":"Whether the credit memo is reversed.\n","type":"boolean"},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice"},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source of the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"BillRun"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is generated by a bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice and collect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, or by calling the Orders, Order Line Items, or Fulfillments API operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiSubscribe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiAmend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromPrpc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created from a product rate plan charge through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a credit memo from a charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create credit memo from invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverse invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}],"type":"string","enum":["BillRun","API","ApiSubscribe","ApiAmend","AdhocFromPrpc","AdhocFromInvoice"]},"sourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the credit memo source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a credit memo is generated from a bill run, the value is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number of the corresponding bill run. Otherwise, the value is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"sourceType":{"description":"The type of the credit memo source.\n","enum":["Subscription","Standalone","Invoice","Order","CreditMemo","Consolidation"],"type":"string"},"status":{"description":"The status of the credit memo.\n","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the credit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxMessage":{"description":"The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of tax calculation related to the credit memo."},"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 only applicable to tax calculation by third-party tax engines. Also, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side.  If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string"},"shipToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact snapshot associated with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit memo."},"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":": If you have the Flexible Billing Attributes feature"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disabled, 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":[]}]}]}],"type":"string"},"soldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit memo."},"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":": If you have the Flexible Billing Attributes feature"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disabled, 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":[]}]}]}],"type":"string"},"taxAutoCalculation":{"default":true,"description":"Whether to automatically calculate taxes in the credit memo.\n","type":"boolean"},"totalAmount":{"type":"number","format":"double","description":"The total amount of the credit memo, including taxes.\n"},"totalAmountWithoutTax":{"type":"number","format":"double","description":"The total amount of the credit memo, excluding taxes.\n"},"totalTaxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"transferredToAccounting":{"description":"Whether the credit memo was transferred to an external\naccounting system. This field is used for integration with\naccounting systems such as NetSuite.\n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"invoiceId":{"description":"The ID of a referred invoice.\n","type":"string"},"accountId":{"description":"The ID of the customer account associated with the credit memo.\n","type":"string"},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"billToContact":{"$ref":"#/components/schemas/ExpandedContact"},"creditMemoItems":{"type":"array","items":{"$ref":"#/components/schemas/NestedCreditMemoItemOnExpand"}},"creditMemoApplications":{"type":"array","items":{"$ref":"#/components/schemas/NestedCreditMemoApplicationOnExpand"}},"billToContactSnapshot":{"$ref":"#/components/schemas/NestedContactSnapshotOnExpand"},"soldToContactSnapshot":{"$ref":"#/components/schemas/NestedContactSnapshotOnExpand"},"shipToContactSnapshot":{"$ref":"#/components/schemas/NestedContactSnapshotOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Credit Memo object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryCreditMemoResponse"}},"components/schemas/ExpandedCreditMemoApplication":{"id":"components/schemas/ExpandedCreditMemoApplication","kind":"json-schema","title":"QueryCreditMemoApplicationResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the credit memo application.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the credit memo application.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo application was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the credit memo application.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo application was last updated.\n"},"amount":{"type":"number","format":"double","description":"The application amount of the credit memo.\n"},"effectiveDate":{"type":"string","format":"date","description":"The date when the credit memo application becomes effective.\n"},"creditMemoId":{"type":"string","description":"The ID of the credit memo associated with the credit memo application.\n"},"accountId":{"type":"string","description":"The ID of the customer account associated with the credit memo.\n"},"applicationGroupId":{"type":"string","description":"The ID of the application group to which this credit memo application belongs.\n"},"debitMemoId":{"type":"string","description":"The ID of the debit memo to which the credit memo is applied.\n"},"invoiceId":{"type":"string","description":"The ID of the invoice to which the credit memo is applied.\n"},"creditMemo":{"$ref":"#/components/schemas/NestedCreditMemoOnExpand"}},"type":"object","title":"QueryCreditMemoApplicationResponse","additionalProperties":false}},"components/schemas/NestedRatePlanChargeOnExpand":{"id":"components/schemas/NestedRatePlanChargeOnExpand","kind":"json-schema","title":"QueryRatePlanChargeResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the rate plan charge.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the rate plan charge.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the rate plan charge was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the rate plan charge.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the rate plan charge was last updated.\n"},"ratePlanId":{"type":"string","description":"The unique identifier of the rate plan to which this rate plan charge belongs.\n"},"productRatePlanChargeId":{"type":"string","description":"The unique identifier of the product rate plan charge associated with this product rate plan charge.\n"},"accountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the charge. Accounting codes group transactions that contain similar accounting 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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.AccountingCode"},"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 value changes if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.AccountingCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated. The values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not change when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.AccountingCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]}]}]}],"type":"string"},"applyDiscountTo":{"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 charges a specific discount applies to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.ApplyDiscountTo"},"children":[]}]}]}],"type":"string"},"billCycleDay":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the charge's billing cycle day (BCD), which is when bill runs generate invoices for charges associated with the product rate plan charge or the account."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.BillCycleDay"},"children":[]}]}]}]},"billCycleType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to determine the billing day for the charge.\\n\\"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.BillCycleType"},"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":" You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment."},"children":[]}]}]}]},"billingPeriod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows billing period to be overridden on rate plan charge."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": **inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.BillingPeriod"},"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":" You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment."},"children":[]}]}]}]},"billingPeriodAlignment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aligns charges within the same subscription if multiple charges begin on different dates."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.BillingPeriodAlignment"},"children":[]}]}]}]},"billingTiming":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types."},"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":" You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type."},"children":[]}]}]}],"enum":["In Advance","In Arrears"]},"chargedThroughDate":{"type":"string","format":"date","description":"The date through which a customer has been billed for the charge.\n","maxLength":29},"chargeModel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to evaluate charges. Charge models must be individually activated in the web-based UI."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.ChargeModel"},"children":[]}]}]}]},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique number that identifies the charge. This number is returned as a string."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 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":"automatically generated if left "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a unique number of 50 characters or fewer"},"children":[]}]}]}]}],"type":"string"},"chargeType":{"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 type of charge."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.ChargeType"},"children":[]}]}]}]},"description":{"type":"string","description":"A description of the rate plan charge. \n"},"discountLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account"]},"dMRC":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A delta monthly recurring charge is the change in monthly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recurring revenue caused by an amendment or a new subscription."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"dTCV":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After an Amendment, the change in the total contract value (TCV) amount for this charge, compared with its previous value."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"effectiveEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date when the rate plan charge becomes active, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"effectiveStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final date the rate plan is active, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"endDateCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become inactive."},"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 value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge is active for a predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"SpecificEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes inactive."},"children":[]}]}]}]}],"enum":["SubscriptionEnd","FixedPeriod","SpecificEndDate","OneTime"],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both the following features are enabled in your tenant, you must ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in an Create Subscription or Add Product order action is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this order action to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Prepaid with Drawdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both the following features are enabled in your tenant, you must ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set consistently for a prepayment charge and the corresponding drawdown charge."},"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":"Prepaid with Drawdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"invoiceScheduleId":{"type":"string","description":"The unique identifier of the invoice schedule associated with the subscription.\n"},"isLastSegment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the segment of the rate plan charge is the most recent segment. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated."},"children":[]}]}]}]},"isPrepaid":{"type":"boolean","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this charge is a prepayment (topup) charge or a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge."},"children":[]}]}]}]},"isRollover":{"type":"boolean","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It determines whether the rollover fields are needed."},"children":[]}]}]}]},"rolloverPeriods":{"type":"integer","format":"int64","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}]},"rolloverPeriodLength":{"type":"integer","format":"int32","nullable":true,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year."},"children":[]}]}]}]},"rolloverApply":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"]},"isProcessed":{"type":"boolean","description":"Indicates whether the rate plan charge has been processed.\n"},"listPriceBase":{"type":"string","description":"The list price base for the product rate plan charge.\n","enum":["Per Billing Period","Per Month","Per Week","Per Year","Per Specific Months"]},"specificListPriceBase":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"maximum":200,"minimum":1,"nullable":true},"priceUpsellQuantityStacked":{"type":"boolean"},"commitmentType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the type of commitment. A prepaid charge can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A minimum commitment(in-arrears) charge can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. For topup(recurring or one-time) charges, this field indicates what type of funds are created."},"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 UNIT, it will create a fund with given prepaidUom."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If CURRENCY, it will create a fund with the currency amount calculated in list price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"],"type":"string"},"isCommitted":{"type":"boolean","description":"Indicates whether the rate plan charge is commited.\n"},"mRR":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly recurring revenue (MRR) is the amount of recurring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges in a given month. The MRR calculation doesn't include one-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges nor usage charges. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated"},"children":[]}]}]}]},"name":{"type":"string","maxLength":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the rate plan charge. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"numberOfPeriods":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.NumberOfPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"originalId":{"type":"string","maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original ID of the rate plan charge. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated."},"children":[]}]}]}]},"overageCalculationOption":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when to calculate overage charges. If the value of the SmoothingMode field is null (not specified and not inherited from ProductRatePlanCharge.SmoothingMode), the value of this field is ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.OverageCalculationOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"overageUnusedUnitsCreditOption":{"type":"string","maxLength":20,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to credit the customer with unused units of usage. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.OverageUnusedUnitsCreditOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"prepaidOperationType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this charge. It is either a prepayment (topup) charge or a drawdown charge."},"children":[]}]}]}],"enum":["topup","drawdown",null],"type":"string","nullable":true},"prepaidQuantity":{"type":"number","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"nullable":true},"prepaidTotalQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of units that end customers can use during a validity period when they subscribe to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","nullable":true},"priceChangeOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies an automatic price change when a termed subscription is renewed."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 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":"code","inline":true,"attributes":{"content":"NoChange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UseLatestProductCatalogPricing"},"children":[]}]}]}]}]},"priceIncreasePercentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of renewed subscriptions. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a decimal value between -100 and 100."},"children":[]}]}]}]},"processedThroughDate":{"type":"string","format":"date","maxLength":29,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargedThroughDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. This date is the earliest date when a charge can be amended."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated."},"children":[]}]}]}]},"prorationOption":{"type":"string","description":"Determines how to prorate charges when a subscription is created or amended.\n"},"quantity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid quantity value."},"children":[]}]}]}]},"numberOfDeliveries":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of deliveries in the billing period for the charge segment."},"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":"numberOfDeliveries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for the Delivery Pricing charge model only."},"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 Delivery Pricing charge model is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable billing features by yourself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center. You can check "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable Charge Types / Models"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"ratingGroup":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rating group based on which usage records are rated. Only applicable to Usage charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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://docs.zuora.com?resourceId=billing-usage-rating-by-group"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage rating by group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload","ByGroupId"]},"revenueRecognitionRuleName":{"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 Revenue Recognition Rule that you want the Rate Plan Charge to use. This field can be updated when "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"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":"By default, the Revenue Recognition Rule is inherited from the Product Rate Plan Charge. For Amend calls, you can use this field only for NewProduct amendments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Update calls, you can use this field only to update subscriptions in draft status. Note that if you use this field to specify a Revenue Recognition Rule for the Rate Plan Charge,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the rule will remain as specified even if you later change the rule used by the corresponding Product Rate Plan Charge."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevenueRecognitionRuleName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the name of an active Revenue Recognition Rule"},"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":": Unless overridden, this value changes if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevenueRecognitionRuleName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not change when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevenueRecognitionRuleName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]}]}]}]},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"revRecCode":{"type":"string","maxLength":70,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associates this product rate plan charge with a specific revenue recognition code."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a valid revenue recognition code"},"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":": Unless overridden, this value changes if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated. The values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not change when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]}]}]}]},"revRecTriggerCondition":{"type":"string","maxLength":22,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when revenue recognition begins."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecTriggerCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or 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":"code","inline":true,"attributes":{"content":"ContractEffectiveDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivationDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptanceDate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Unless overridden, this value changes if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecTriggerCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated. The values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not change when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecTriggerCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]}]}]}]},"segment":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"specificBillingPeriod":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Weeks"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.BillingPeriod"},"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":" You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment."},"children":[]}]}]}]},"specificEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date on which the charge ends, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"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":":"},"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":"This field is only applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificEndDate"},"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 subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date."},"children":[]}]}]}]}]},"tCV":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total contract value (TCV) is the value of a single rate plan charge in a subscription over the lifetime of the subscription. This value does not represent all charges on the subscription. The TCV includes recurring charges and one-time charges, but it doesn't include usage charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"format":"double","type":"number"},"triggerDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the charge becomes effective and billing begins, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This field is required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TriggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"**Note: **This field can be passed through the Subscribe and Amend calls and will override the default value set on the Product Rate Plan Charge."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.TriggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and can be 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":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid only on the RatePlanCharge."},"children":[]}]}]}]}],"type":"string","maxLength":18},"uOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units to measure usage."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.UOM"},"children":[]}]}]}],"type":"string","maxLength":25},"upToPeriods":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"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":":"},"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":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period. This field is only applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"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":"You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to override the value in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.UpToPeriod"},"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 you override the value in this field, enter a whole number between 0 and 65535, exclusive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end."},"children":[]}]}]}]}]},"upToPeriodsType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the charge ends. This field can be updated when "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Billing Periods","Days","Weeks","Months","Years"],"default":"Billing Periods"},"version":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the rate plan charge. Each time a charge is amended, Zuora creates a new version of the rate plan charge. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated."},"children":[]}]}]}]},"weeklyBillCycleDay":{"description":"Specifies which day of the week as the bill cycle day (BCD) for the charge.\n","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"subscriptionId":{"type":"string","description":"The unique identifier of the subscription to which the rate plan charge belongs.\n"},"subscriptionOwnerId":{"type":"string","description":"ID of the account that owns the subscription.\n"},"invoiceOwnerId":{"type":"string","description":"ID of the account that will pay the billing documents for the subscription.\n"},"originalOrderDate":{"type":"string","format":"date","description":"The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue.\n"},"amendedByOrderOn":{"type":"string","format":"date","description":"The date when the rate plan charge is amended through an order\nor amendment. This field is to standardize the booking date\ninformation to increase audit ability and traceability of data\nbetween Zuora Billing and Zuora Revenue. It is mapped as the\nbooking date for a sale order line in Zuora Revenue.\n"},"validityPeriodType":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period in which the prepayment units are valid to use as defined in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"]},"creditOption":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"]},"applyToBillingPeriodPartially":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow the discount duration to be aligned with the billing period partially."},"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":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}]},"productChargeDefinitionId":{"type":"string","description":"The unique ID of the product charge definition.\n"},"accountReceivableAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the accountReceivableAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the deferredRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"recognizedRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the recognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"prepaidUOM":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"drawdownUom":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"ratePlan":{"type":"object","description":"The rate plan to which this charge belongs.\n"},"productRatePlanCharge":{"type":"object","description":"The product rate plan charge associated with this rate plan charge.\n"},"salesPrice":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sales price associated with the rate plan charge expressed as a decimal."},"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":"Notes"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available to subscriptions that are created through orders and exist after 2023-01-10."},"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":"This field applies to the following charge models, and the values vary with the charge models:"},"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":"Flat fee: the value equals the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"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":"text","inline":true,"attributes":{"content":"Per unit: the value equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"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":"Fixed amount discount: the value equals the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"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":"text","inline":true,"attributes":{"content":"Volume: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit."},"children":[]}]}]}]}]}]}]},"taxable":{"type":"boolean","description":"Indicates whether the rate plan charge is taxable.\n"},"reverted":{"type":"boolean","description":"Indicates whether the rate plan charge has been reverted.\n"},"reflectDiscountInNetAmount":{"type":"boolean","description":"Indicates whether the discount is reflected in the net amount.\n    \n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan Charge object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryRatePlanChargeResponse"}},"components/schemas/NestedCreditTaxationItemOnExpand":{"id":"components/schemas/NestedCreditTaxationItemOnExpand","kind":"json-schema","title":"QueryCreditTaxationItemResponse","data":{"properties":{"appliedAmount":{"description":"The applied amount of the taxation item.\n","format":"double","type":"number"},"axemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. \n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"name":{"description":"The name of the taxation item.\n","type":"string"},"refundAmount":{"description":"The amount of the refund on the taxation item.\n","format":"double","type":"number"},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific credit memo.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":"The date that the tax is applied to the credit memo, in yyyy-mm-dd format.\n","type":"string","format":"date"},"taxMode":{"description":"The tax mode of the credit memo, indicating whether the amount of the credit memo includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"taxRate":{"description":"The tax rate applied to the credit memo.\n","format":"decimal","type":"string"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate.\n","enum":["Percentage","FlatFee"],"type":"string"},"unappliedAmount":{"description":"The unapplied amount of the taxation item.\n","format":"double","type":"number"},"creditMemoItemId":{"description":"The ID of the credit memo item.\n","type":"string"},"taxableItemSnapshotId":{"type":"string","description":"The unique identifier of the taxable item snapshot.\n"},"id":{"type":"string","description":"The unique identifier of the taxation item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the taxation item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the taxation item was created in the Zuora\nsystem.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the taxation item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the taxation item was last updated. \n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The accounting code for Account Receivable.\n"}},"type":"object","title":"QueryCreditTaxationItemResponse"}},"components/schemas/ExpandedCreditMemoItem":{"id":"components/schemas/ExpandedCreditMemoItem","kind":"json-schema","title":"QueryCreditMemoItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the credit memo item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the credit memo item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo item was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the credit memo item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the credit memo item was last updated.\n"},"amount":{"type":"number","description":"The amount of the credit memo item. For tax-inclusive credit memo\nitems, the amount indicates the credit memo item amount including tax.\nFor tax-exclusive credit memo items, the amount indicates the credit\nmemo item amount excluding tax.\n"},"amountWithoutTax":{"description":"The credit memo item amount excluding tax.\n","format":"double","type":"number"},"appliedToItemId":{"description":"The unique ID of the credit memo item that the discount charge is applied to.\n","type":"string"},"appliedToOthersAmount":{"type":"number","description":"The amount of the credit memo that is applied to other credit memo\nitems.\n"},"beAppliedByOthersAmount":{"type":"number"},"chargeDate":{"type":"string","description":"The date when the credit memo item is charged.\n","format":"date-time"},"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the credit memo item."},"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 only available if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"257.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the credit memo item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For credit memo items generated by a bill run from returned or fulfillment-related order line items,  this value is inherited from the source order line item's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value.  When the source value is true, the credit memo item is excluded from revenue accounting and is not sent  to Zuora Revenue as revenue-impacting."},"children":[]}]}]}],"type":"boolean"},"fulfillmentId":{"description":"The reference ID of the fulfillment associated with the credit memo item.\n","type":"string"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the credit memo item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"invoiceScheduleItemId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"itemShipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"itemSoldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"itemSoldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the credit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"itemType":{"type":"string","description":"The type of the credit memo item.\n"},"orderLineItemId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the order line item associated with the credit memo item, if applicable."},"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":" For a credit memo item generated from a returned or fulfillment-related order line item,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this field contains the ID of the source order line item. Use this field to trace the credit memo"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item to the order line item that generated it."},"children":[]}]}]}]},"processingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the charge for the credit memo item."},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Charge - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Discount"},"children":[]}]}]}]}],"type":"string","enum":["0","1"]},"revenueImpacting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this write off operation impacts the revenue. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the deferred revenue accounting code will be automatically selected from the associated invoice."},"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":"revenueImpacting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can select an accounting code such as bad-debt expense accounting code for the write off operation."},"children":[]}]}]}],"enum":["Yes","No"],"default":"Yes","type":"string"},"quantity":{"description":"The number of units for the credit memo item.\n","format":"double","type":"number"},"purchaseOrderNumber":{"type":"string","description":"The purchase order number associated the credit memo item.\n"},"creditFromItemSource":{"description":"The type of the credit from item.\n","enum":["InvoiceItem","CreditMemoItem"],"type":"string"},"creditFromItemId":{"type":"string","description":"The ID of the credit from item.\n"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"serviceEndDate":{"description":"The service end date of the credit memo item. \n","format":"date","type":"string"},"serviceStartDate":{"description":"The service start date of the credit memo item.\n","format":"date","type":"string"},"sku":{"description":"The SKU for the product associated with the credit memo item.\n","type":"string"},"sourceItemType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the source item."},"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 credit memo is not created from an invoice or a product rate plan charge or a return order line item, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubscriptionComponent"},"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 a credit memo is created from an invoice, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvoiceDetail"},"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 a credit memo is created from a product rate plan charge, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge"},"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 a credit memo is created from a return order line item, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderLineItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["SubscriptionComponent","InvoiceDetail","ProductRatePlanCharge","OrderLineItem"],"type":"string"},"subscriptionId":{"description":"The ID of the subscription associated with the credit memo item.\n","type":"string"},"taxMode":{"description":"The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"chargeName":{"type":"string","description":"The name of the charge associated with the credit memo item. \n"},"chargeNumber":{"type":"string","description":"The number of the product rate plan charge that the credit memo is created from.\n"},"commitmentChargeSegmentNumber":{"type":"string"},"commitmentChargeNumber":{"type":"string"},"taxAmount":{"description":"The amount of the tax applied to the credit memo item.\n","format":"double","type":"number"},"taxCodeName":{"type":"string","description":"The tax code identifies which tax rules and tax rates to apply to a specific credit memo item.\n"},"taxExemptAmount":{"type":"number","description":"The calculated tax amount excluded due to the exemption.\n"},"unappliedAmount":{"description":"The unapplied amount of the credit memo item.\n","format":"double","type":"number"},"unitOfMeasure":{"description":"The units to measure usage.\n","type":"string"},"unitPrice":{"description":"The per-unit price of the credit memo item.\n","format":"double","type":"number"},"subscriptionNumber":{"type":"string","description":"The number of the subscription associated with the credit memo item.\n"},"invoiceItemId":{"type":"string","description":"The ID of the invoice item associated with the credit memo item.\n"},"productRatePlanChargeId":{"type":"string","description":"The ID of the product rate plan charge that the credit memo is created\nfrom.\n"},"ratePlanChargeId":{"type":"string","description":"The ID of the rate plan charge associated with the credit memo item.\n"},"revenueRecognitionRuleName":{"type":"string","description":"The name of the revenue recognition rule governing the revenue schedule.\n"},"creditMemoId":{"type":"string","description":"The ID of the credit memo to which this credit memo item belongs.\n"},"numberOfDeliveries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, 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":"For the credit memo generated by a bill run, this field has a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the credit memo generated from an invoice, this field is blank."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the Delivery Pricing feature enabled."},"children":[]}]}]}]}],"type":"number"},"recognizedRevenueAccountingCodeId":{"type":"string","description":"The Recognized Revenue accounting code for the credit memo item.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The Account Receivable accounting code for the credit memo item.\n"},"onAccountAccountingCodeId":{"type":"string","description":"The On Account accounting code for the credit memo item.\n"},"deferredRevenueAccountingCodeId":{"type":"string","description":"The Deferred Revenue accounting code for the credit memo item.\n"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this credit memo item.\n"},"shipToContactSnapshotId":{"description":"The ID of the ship-to contact snapshot associated with the credit memo.\n","type":"string"},"soldToContactSnapshotId":{"description":"The ID of the sold-to contact snapshot associated with the credit memo.\n","type":"string"},"billToContactSnapshotId":{"description":"The ID of the bill-to contact snapshot associated with the credit memo.\n","type":"string"},"subscription":{"$ref":"#/components/schemas/NestedSubscriptionOnExpand"},"ratePlanCharge":{"$ref":"#/components/schemas/NestedRatePlanChargeOnExpand"},"subscriptionOwner":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"creditTaxationItems":{"$ref":"#/components/schemas/NestedCreditTaxationItemOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Credit Memo Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryCreditMemoItemResponse"}},"components/schemas/ExpandedDailyConsumptionSummary":{"id":"components/schemas/ExpandedDailyConsumptionSummary","kind":"json-schema","title":"QueryDailyConsumptionSummaryResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the daily consumption summary."},"originChargeId":{"type":"string","description":"The unique identifier of the charge."},"chargeSegmentNumber":{"type":"integer","format":"int32","description":"The charge segment number.\n"},"fundId":{"type":"string","description":"The unique identifier of the fund.\n"},"dailyConsumptionAmount":{"type":"number","description":"The daily consumption amount.\n"},"dailyTotalQuantity":{"type":"number","description":"The total quantity consumed daily.\n"},"transactionDate":{"type":"string","format":"date","description":"The date of the transaction.\n"},"ratingResultId":{"type":"string","description":"The unique identifier of the rating result.\n"},"dailyGroupSummaryId":{"type":"string","description":"The unique identifier of the daily group summary.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the daily consumption summary.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the daily consumption summary was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the daily consumption summary.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the daily consumption summary was last updated.\n"},"drawdownOriginChargeId":{"type":"string","description":"The unique identifier of the original drawdown charge.\n"},"drawdownChargeSegmentNumber":{"type":"integer","format":"int32","description":"The charge segment number of the drawdown charge.\n"},"drawdownRecognizedRevenueGlAccountNumber":{"type":"string","description":"The GL account number of the recognized revenue for the drawdown charge.\n"},"drawdownAdjustmentRevenueGlAccountNumber":{"type":"string","description":"The GL account number of the adjusted revenue for the drawdown charge.\n"},"usageChargeName":{"type":"string","description":"The name of the usage charge.\n"},"usageChargeNumber":{"type":"string","description":"The number of the usage charge.\n"}},"type":"object","title":"QueryDailyConsumptionSummaryResponse"}},"components/schemas/NestedDebitMemoItemOnExpand":{"id":"components/schemas/NestedDebitMemoItemOnExpand","kind":"json-schema","title":"QueryDebitMemoItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the debit memo item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the debit memo item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the debit memo item was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the debit memo item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the debit memo item was last updated.\n"},"amount":{"description":"The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.\n","format":"double","type":"number"},"amountWithoutTax":{"description":"The debit memo item amount excluding tax.\n","format":"double","type":"number"},"appliedToItemId":{"type":"string","description":"The parent debit memo item that this debit memo items is applied to if this item is discount.\n"},"appliedToOthersAmount":{"type":"number"},"beAppliedByOthersAmount":{"type":"number"},"chargeDate":{"type":"string","description":"The date when the debit memo item is charged.\n","format":"date-time"},"creditMemoItemId":{"type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the debit memo item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"description":{"type":"string","description":"The description of the debit memo item.\n"},"itemShipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the debit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]},"itemSoldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the debit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"itemSoldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the debit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"processingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the charge for the debit memo item."},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": discount"},"children":[]}]}]}]}],"type":"string","enum":["0","1"]},"quantity":{"description":"The number of units for the debit memo item.\n","format":"double","type":"number"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"serviceEndDate":{"description":"The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge.\n","format":"date","type":"string"},"sku":{"type":"string","description":"The SKU for the product associated with the debit memo item.\n"},"sourceItemType":{"description":"The type of the source item.\n","enum":["CreditMemoItem","SubscriptionComponent","InvoiceDetail","ProductRatePlanCharge"],"type":"string"},"chargeName":{"type":"string","description":"The name of the charge associated with the debit memo item.\n"},"chargeNumber":{"type":"string","description":"The number of the charge associated with the debit memo item.\n"},"taxAmount":{"type":"number","description":"The amount of tax on this debit memo.\n","format":"double"},"taxCodeName":{"type":"string","description":"Name of the tax code identifies which tax rules and tax rates to apply to a specific debit memo item.\n"},"taxExemptAmount":{"type":"number","description":"The calculated tax amount excluded due to the exemption.\n","format":"double"},"taxMode":{"description":"The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"unitOfMeasure":{"description":"The units to measure usage.\n","type":"string"},"unitPrice":{"description":"The per-unit price of the debit memo item.\n","format":"double","type":"number"},"subscriptionId":{"type":"string","description":"The ID of the subscription associated with the debit memo item.\n"},"subscriptionNumber":{"type":"string","description":"The number of the subscription associated with the debit memo item.\n"},"invoiceItemId":{"type":"string","description":"The ID of the invoice item associated with the debit memo item.\n"},"productRatePlanChargeId":{"type":"string","description":"The ID of the product rate plan charge based on which the debit memo item is created.\n"},"ratePlanChargeId":{"type":"string","description":"The ID of the rate plan charge associated with the debit memo item.\n"},"debitMemoId":{"type":"string","description":"The ID of the debit memo to which this debit memo item belongs.\n"},"balance":{"type":"number","description":"The balance of the debit memo item.\n","format":"double"},"recognizedRevenueAccountingCodeId":{"type":"string","description":"The Recognized Revenue accounting code for the credit memo item.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The Account Receivable accounting code for the credit memo item.\n"},"deferredRevenueAccountingCodeId":{"type":"string","description":"The Deferred Revenue accounting code for the credit memo item.\n"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this transaction.\n"},"soldToContactSnapshotId":{"description":"The ID of the sold-to contact snapshot associated with the credit memo.\n","type":"string"},"billToContactSnapshotId":{"description":"The ID of the bill-to contact snapshot associated with the credit memo.\n","type":"string"},"subscription":{"type":"object","description":"The subscription associated with the debit memo item.\n"},"ratePlanCharge":{"type":"object","description":"The rate plan charge associated with the debit memo item.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Debit Memo Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryDebitMemoItemResponse"}},"components/schemas/ExpandedDebitMemo":{"id":"components/schemas/ExpandedDebitMemo","kind":"json-schema","title":"QueryDebitMemoResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the debit memo.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the debit memo.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the debit memo was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the debit memo.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the debit memo was last updated.\n"},"autoPay":{"description":"Whether debit memos are automatically picked up for processing in the\ncorresponding payment run.\n\n\nBy default, debit memos are automatically picked up for processing in\nthe corresponding payment run.\n","type":"boolean"},"creditMemoId":{"type":"string","description":"The ID of the credit memo from which the debit memo was created.\n","nullable":true},"balance":{"type":"number","description":"The remaining balance of debit memo.\n"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string"},"billToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact snapshot associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if the bill rule "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-billing-rules-billing-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preserve snapshot of bill-to and sold-to contacts when billing documents are posted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is disabled."},"children":[]}]}]}],"type":"string"},"cancelledById":{"description":"The ID of the Zuora user who cancelled the debit memo.\n","type":"string","nullable":true},"cancelledOn":{"description":"The date and time when the debit memo was cancelled.\n","format":"date-time","type":"string","nullable":true},"comments":{"description":"Comments about the debit memo.\n","type":"string"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the debit memo."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"discountAmount":{"type":"number","description":"The amount of the discount on the debit memo.\n"},"dueDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for the debit memo is due, in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"einvoiceErrorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceErrorMessage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message returned when the e-invoice file status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceFileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the e-invoice file generated for the debit memo."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"type":"string"},"einvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the e-invoice file generation for the credit memo."},"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":"If e-invoice file generation succeeds, this field is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both the error code and message are empty, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eInvoiceFileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field stores the ID of the generated e-invoice file."},"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":"If the responses from tax vendors such as Sovos or Avalara are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taking too long, this field becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RetrieveTimeOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vendor responds successfully, you can use the 'Resync E-Invoice Status'"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action to update the status automatically.  You can view these updates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in System Health telemetry."},"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":"If a failure occurs during e-invoice file generation, this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If e-invoice file generation conditionally succeeds, this field is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConditionalSuccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an error code and an error message are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned respectively in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"einvoiceErrorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If the e-invoice file has been approved by the tax authority, this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApprovedByAuthority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The next status will be either"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"If the e-invoice file has been rejected by the government, this field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot resend this e-invoice; you must create a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new invoice instead."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-Invoicing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase enabled."},"children":[]}]}]}],"enum":["Processing","RetrieveTimeOut","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string"},"exchangeRateDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the exchange rate used. The date is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"Corresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater."},"children":[]}]}]}]},"memoDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the debit memo takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"memoNumber":{"description":"The unique identification number of the debit memo.\n","type":"string"},"postedById":{"description":"The ID of the Zuora user who posted the debit memo.\n","type":"string"},"postedOn":{"description":"The date and time when the debit memo was posted.\n","format":"date-time","type":"string"},"reasonCode":{"description":"A code identifying the reason for the transaction. The value\nmust be an existing reason code or empty.\n","type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled."},"children":[]}]}]}],"type":"string","nullable":true},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source of the debit memo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"BillRun"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The debit memo is generated by a bill run."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiSubscribe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The debit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_Account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiAmend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The debit memo is created by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/PUT_Subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromPrpc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The debit memo is created from a product rate plan charge through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromPrpc/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a debit memo from a charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdhocFromInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The debit memo is created from an invoice or created by reversing an invoice. You can create a debit memo from an invoice through the Zuora UI or by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromInvoice/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a debit memo from an invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}],"type":"string","enum":["BillRun","API","ApiSubscribe","ApiAmend","AdhocFromPrpc","AdhocFromInvoice"]},"sourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the debit memo source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a debit memo is generated from a bill run, the value is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number of the corresponding bill run. Otherwise, the value is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"sourceType":{"description":"The type of the debit memo source.\n","enum":["Subscription","Standalone","Order","Consolidation","Invoice","CreditMemo"],"type":"string"},"status":{"description":"The status of the debit memo.\n","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"type":"string"},"targetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the debit memo, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxMessage":{"description":"The message about the status of tax calculation related to the\ndebit memo. If tax calculation fails in one debit memo, this\nfield displays the reason for the failure.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of tax calculation related to the debit memo."},"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 only applicable to tax calculation by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"third-party tax engines. Also, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string"},"shipToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact snapshot associated with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debit memo."},"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":": If you have the Flexible Billing Attributes feature"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disabled, 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":[]}]}]}],"type":"string"},"soldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"debit memo."},"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":": If you have the Flexible Billing Attributes feature"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disabled, 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":[]}]}]}],"type":"string"},"taxAutoCalculation":{"default":true,"description":"Whether to automatically calculate taxes in the debit memo.\n","type":"boolean"},"totalAmount":{"type":"number","format":"double","description":"The total amount of the debit memo, including taxes.\n"},"totalAmountWithoutTax":{"type":"number","format":"double","description":"The total amount of the debit memo, excluding taxes.\n"},"totalTaxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"transferredToAccounting":{"description":"Whether the debit memo was transferred to an external\naccounting system. This field is used for integration with\naccounting systems such as NetSuite.\n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"invoiceId":{"description":"The ID of a referred invoice.\n","type":"string"},"accountId":{"description":"The ID of the customer account associated with the debit memo.\n","type":"string"},"paymentTerm":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term assoicated with the debit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature disabled."},"children":[]}]}]}]},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"billToContact":{"$ref":"#/components/schemas/ExpandedContact"},"debitMemoItems":{"type":"array","items":{"$ref":"#/components/schemas/NestedDebitMemoItemOnExpand"}},"billToContactSnapshot":{"$ref":"#/components/schemas/NestedContactSnapshotOnExpand"},"soldToContactSnapshot":{"$ref":"#/components/schemas/NestedContactSnapshotOnExpand"},"shipToContactSnapshot":{"$ref":"#/components/schemas/NestedContactSnapshotOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Debit Memo object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryDebitMemoResponse"}},"components/schemas/NestedDebitTaxationItemOnExpand":{"id":"components/schemas/NestedDebitTaxationItemOnExpand","kind":"json-schema","title":"QueryDebitTaxationItemResponse","data":{"properties":{"balance":{"description":"The balance of the taxation item.\n","format":"double","type":"number"},"creditAmount":{"description":"The amount of credit memos applied to the debit memo.\n","format":"double","type":"number"},"exemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"jurisdiction":{"description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. \n","type":"string"},"locationCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"string"},"name":{"description":"The name of the taxation item.\n","type":"string"},"paymentAmount":{"description":"The amount of payments applied to the debit memo.\n","format":"double","type":"number"},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxCode":{"description":"The tax code identifies which tax rules and tax rates to apply to a specific debit memo.\n","type":"string"},"taxCodeDescription":{"description":"The description of the tax code.\n","type":"string"},"taxDate":{"description":"The date that the tax is applied to the debit memo, in yyyy-mm-dd format.\n","type":"string","format":"date"},"taxMode":{"description":"The tax mode of the debit memo, indicating whether the amount of the debit memo includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"taxRate":{"description":"The tax rate applied to the debit memo.\n","format":"decimal","type":"string"},"taxRateDescription":{"description":"The description of the tax rate.\n","type":"string"},"taxRateType":{"description":"The type of the tax rate.\n","enum":["Percentage","FlatFee"],"type":"string"},"debitMemoItemId":{"description":"The ID of the debit memo item.\n","type":"string"},"taxableItemSnapshotId":{"type":"string","description":"The unique identifier of the taxable item snapshot.\n"},"taxationItemId":{"description":"The Id of the taxation item.\n","type":"string"},"id":{"type":"string","description":"The unique identifier of the taxation item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the taxation item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the taxation item was created in the Zuora\nsystem.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the taxation item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the taxation item was last updated. \n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The accounting code for Account Receivable.\n"}},"type":"object","title":"QueryDebitTaxationItemResponse"}},"components/schemas/ExpandedDebitMemoItem":{"id":"components/schemas/ExpandedDebitMemoItem","kind":"json-schema","title":"QueryDebitMemoItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the debit memo item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the debit memo item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the debit memo item was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the debit memo item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the debit memo item was last updated.\n"},"amount":{"description":"The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.\n","format":"double","type":"number"},"amountWithoutTax":{"description":"The debit memo item amount excluding tax.\n","format":"double","type":"number"},"appliedToItemId":{"type":"string","description":"The parent debit memo item that this debit memo items is applied to if this item is discount.\n"},"appliedToOthersAmount":{"type":"number"},"beAppliedByOthersAmount":{"type":"number"},"chargeDate":{"type":"string","description":"The date when the debit memo item is charged.\n","format":"date-time"},"creditMemoItemId":{"type":"string"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the debit memo item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"boolean"},"description":{"type":"string","description":"The description of the debit memo item.\n"},"itemShipToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the debit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"itemSoldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the debit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"itemSoldToContactSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the debit memo item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}],"type":"string"},"processingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the charge for the debit memo item."},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": discount"},"children":[]}]}]}]}],"type":"string","enum":["0","1"]},"quantity":{"description":"The number of units for the debit memo item.\n","format":"double","type":"number"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"serviceEndDate":{"description":"The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.\n","format":"date","type":"string"},"serviceStartDate":{"description":"The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge.\n","format":"date","type":"string"},"sku":{"type":"string","description":"The SKU for the product associated with the debit memo item.\n"},"sourceItemType":{"description":"The type of the source item.\n","enum":["CreditMemoItem","SubscriptionComponent","InvoiceDetail","ProductRatePlanCharge"],"type":"string"},"chargeName":{"type":"string","description":"The name of the charge associated with the debit memo item.\n"},"chargeNumber":{"type":"string","description":"The number of the charge associated with the debit memo item.\n"},"taxAmount":{"type":"number","description":"The amount of tax on this debit memo.\n","format":"double"},"taxCodeName":{"type":"string","description":"Name of the tax code identifies which tax rules and tax rates to apply to a specific debit memo item.\n"},"taxExemptAmount":{"type":"number","description":"The calculated tax amount excluded due to the exemption.\n","format":"double"},"taxMode":{"description":"The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"unitOfMeasure":{"description":"The units to measure usage.\n","type":"string"},"unitPrice":{"description":"The per-unit price of the debit memo item.\n","format":"double","type":"number"},"subscriptionId":{"type":"string","description":"The ID of the subscription associated with the debit memo item.\n"},"subscriptionNumber":{"type":"string","description":"The number of the subscription associated with the debit memo item.\n"},"invoiceItemId":{"type":"string","description":"The ID of the invoice item associated with the debit memo item.\n"},"productRatePlanChargeId":{"type":"string","description":"The ID of the product rate plan charge based on which the debit memo item is created.\n"},"ratePlanChargeId":{"type":"string","description":"The ID of the rate plan charge associated with the debit memo item.\n"},"debitMemoId":{"type":"string","description":"The ID of the debit memo to which this debit memo item belongs.\n"},"balance":{"type":"number","description":"The balance of the debit memo item.\n","format":"double"},"recognizedRevenueAccountingCodeId":{"type":"string","description":"The Recognized Revenue accounting code for the debit memo item.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The Account Receivable accounting code for the debit memo item.\n"},"deferredRevenueAccountingCodeId":{"type":"string","description":"The Deferred Revenue accounting code for the debit memo item.\n"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this debit memo item.\n"},"shipToContactSnapshotId":{"description":"The ID of the ship-to contact snapshot associated with the debit memo.\n","type":"string"},"soldToContactSnapshotId":{"description":"The ID of the sold-to contact snapshot associated with the debit memo.\n","type":"string"},"billToContactSnapshotId":{"description":"The ID of the bill-to contact snapshot associated with the debit memo.\n","type":"string"},"subscription":{"$ref":"#/components/schemas/NestedSubscriptionOnExpand"},"ratePlanCharge":{"$ref":"#/components/schemas/NestedRatePlanChargeOnExpand"},"subscriptionOwner":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"debitTaxationItems":{"$ref":"#/components/schemas/NestedDebitTaxationItemOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Debit Memo Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryDebitMemoItemResponse"}},"components/schemas/ExpandedDeliveryAdjustment":{"id":"components/schemas/ExpandedDeliveryAdjustment","kind":"json-schema","title":"QueryDeliveryAdjustmentResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the delivery adjustment.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the delivery adjustment.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the delivery adjustment was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the delivery adjustment.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the delivery adjustment was last updated.\n"},"adjustmentNumber":{"type":"string","description":"The system-generated delivery adjustment number.\n"},"creditMemoNumber":{"type":"string","description":"Number of the credit memo generated for the delivery adjustment.\n"},"debitMemoNumber":{"description":"The Debit Memo generated to write off the Credit Memo for the delivery adjustment.    \n","type":"string"},"creditMemoId":{"type":"string","description":"The ID of the credit memo generated for the delivery adjustment.\n"},"segmentId":{"type":"string","description":"The ID of the segment on the subscription for which the delivery adjustment is created.\n"},"chargeId":{"type":"string","description":"The charge ID in the subscription for which the delivery\nadjustment is created.\n"},"chargeNumber":{"description":"The charge number in the subscription for which the delivery\nadjustment is created.\n","type":"string"},"subscriptionId":{"type":"string","description":"The ID of the subscription for which the delivery\nadjustment is created.\n"},"subscriptionNumber":{"description":"The number of the subscription for which the delivery adjustment is created.\n","type":"string"},"originalSubId":{"type":"string","description":"The original subscription ID.\n"},"status":{"description":"The status of the delivery adjustment.              \n","type":"string","enum":["Billed","Cancelled"]},"numberOfDeliveries":{"description":"The total number of all delivery adjustments.\n","type":"number"},"amountPerUnit":{"type":"number","description":"The actual charged amount per unit for the delivery adjustment.\n"},"amount":{"description":"The amount of the delivery adjustment.\n","type":"number"},"date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The delivery adjustment date, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date"},"deliveryDay":{"type":"string","description":"The delivery adjustment day of the week.\n"},"reason":{"description":"The reason for the delivery adjustment.\n","type":"string"},"type":{"type":"string","description":"The type of delivery adjustment.\n","enum":["DeliveryCredit"]},"accountId":{"type":"string","description":"The ID of the account who owns the delivery adjustment.\n"},"invoiceOwnerAccountId":{"type":"string","description":"The account ID of the invoice owner who owns the delivery adjustment.\n"},"accountingCode":{"type":"string","description":"The accounting code associated with the delivery adjustment.\n"},"deferredAccountingCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the deferred revenue, such as Monthly Recurring Liability."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}]},"recognizedRevenueAccountingCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the recognized revenue, such as Monthly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring Charges or Overage Charges."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}]},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the revenue recognition rule governing the revenue"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule."},"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":": For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge."},"children":[]}]}]}],"type":"string"},"billingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing date is same as the delivery date of the delivery adjustment, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"format":"date","type":"string"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Delivery Adjustment object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryDeliveryAdjustmentResponse"}},"components/schemas/ExpandedFulfillment":{"id":"components/schemas/ExpandedFulfillment","kind":"json-schema","title":"QueryFulfillmentResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the fulfillment.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the fulfillment.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the fulfillment was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the fulfillment.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the fulfillment was last updated.\n"},"orderLineItemId":{"type":"string","description":"ID of the order line item.\n"},"fulfillmentNumber":{"description":"The sytem generated number for the fulfillment.","type":"string"},"fulfillmentType":{"description":"The type of the fulfillment. \n","enum":["Delivery","Return"],"type":"string"},"fulfillmentDate":{"description":"The date of the fulfillment.\n","format":"date","type":"string"},"quantity":{"description":"The quantity of the fulfillment.\n","type":"number"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the fulfillment. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Line Item states, Order states, and state transitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["Executing","Booked","SentToBilling","Complete","Cancelled"],"type":"string"},"trackingNumber":{"description":"The tracking number of the fulfillment.\n","type":"string"},"billTargetDate":{"description":"The target date for the fulfillment to be picked up by bill run for billing.\n","format":"date","type":"string"},"description":{"description":"The description of the fulfillment.","type":"string"},"carrier":{"description":"The carrier of the fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.\n","type":"string"},"fulfillmentLocation":{"description":"The location of the fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.\n","type":"string"},"fulfillmentSystem":{"description":"The system of the fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.\n","type":"string"},"externalId":{"description":"The external ID of the fulfillment.\n","type":"string"},"excludeItemBookingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude fulfillment item from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBillingFromRevenueAccounting":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude fulfillment item from revenue accounting."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Fulfillment object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryFulfillmentResponse"}},"components/schemas/NestedInvoiceItemOnExpand":{"id":"components/schemas/NestedInvoiceItemOnExpand","kind":"json-schema","title":"QueryInvoiceItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the invoice item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the invoice item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the invoice item was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the invoice item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the invoice item was last updated.\n"},"invoiceId":{"type":"string","description":"The unique identifier of the invoice to which this invoice item belongs.\n"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the rate plan charge on the subscription."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"invoiceScheduleItemId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule item that generates this invoice item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"ratePlanChargeId":{"type":"string","description":"The ID of the rate plan charge associated with the invoice item.\n"},"accountingCode":{"description":"The accounting code associated with the invoice item.","type":"string"},"appliedToInvoiceItemId":{"description":"The unique ID of the invoice item that the discount charge is applied\nto.\n","type":"string"},"chargeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the charge."},"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 amount does not include taxes regardless if the charge's tax mode is inclusive or exclusive. This is the discount amount actually applied when the invoice item is a discount charge."},"children":[]}]}]}],"format":"double","type":"number"},"chargeDate":{"description":"The date when the invoice item is charged.\n","format":"date-time","type":"string"},"chargeName":{"description":"The name of the charge.","type":"string"},"chargeNumber":{"type":"string","description":"Number of the charge.\n"},"commitmentChargeNumber":{"type":"string"},"commitmentChargeSegmentNumber":{"type":"string"},"description":{"description":"The description of the invoice item.","type":"string"},"discountAmount":{"type":"number","description":"The amount of the discount.\n"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the invoice item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"fulfillmentId":{"type":"string","description":"The reference ID of the fulfillment associated with the invoice item.\n"},"itemShipToContactId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the invoice item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]},"itemSoldToContactId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the invoice item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]},"itemSoldToContactSnapshotId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the invoice item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]},"processingType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of the charge for the invoice item."},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": discount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": prepayment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": tax"},"children":[]}]}]}]}],"enum":["0","1","2","3"]},"quantity":{"type":"number","description":"The quantity of this item, in the configured unit of measure for the\ncharge.\n"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"revRecStartDate":{"type":"string","format":"date"},"serviceEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the service period for this item, i.e., the last day"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the service period, as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"serviceStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the service period for this item, as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd"},"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 a one-time fee item, the date of the charge."},"children":[]}]}]}],"format":"date","type":"string"},"sKU":{"type":"string","description":"The SKU of the product associated with the invoice item.\n"},"sourceItemType":{"description":"The type of the source item.\n","enum":["SubscriptionComponent","Rounding","ProductRatePlanCharge","None","OrderLineItem"],"type":"string"},"subscriptionId":{"type":"string","description":"ID of the subscription associated with the invoice item.\n"},"subscriptionNumber":{"type":"string","description":"Number of the subscription associated with the invoice item.\n"},"taxAmount":{"description":"The amount of tax applied to the charge.\n","format":"double","type":"number"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code of the invoice item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":" Only when taxation feature is enabled, this field can be presented."},"children":[]}]}]}],"type":"string"},"taxExemptAmount":{"type":"number"},"taxMode":{"description":"The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"unitPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The per-unit price of the invoice item."},"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":": For discount charges, this represents the discount percentage (for percentage-based discounts)  or the discount amount (for fixed-amount discounts)."},"children":[]}]}]}],"format":"double","type":"number"},"uOM":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure (UOM) that is configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the product rate plan charge."},"children":[]}]}]}]},"balance":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The balance of the invoice item."},"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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]},"numberOfDeliveries":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of deliveries dedicated to the Delivery Pricing charges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the Delivery Pricing feature enabled."},"children":[]}]}]}]},"accountReceivableAccountingCodeId":{"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 account receivable accounting code associated with the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}]},"recognizedRevenueAccountingCodeId":{"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 recognized revenue accounting code associated with the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}]},"deferredRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the deferred revenue accounting code associated with the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the accounting code for contract asset."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCodeId":{"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 accounting code for contract liability."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"contractRecognizedRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the accounting code for contract recognized revenue."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"unbilledReceivablesAccountingCodeId":{"type":"string"},"adjustmentRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the accounting code for adjustment liability."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this invoice item.\n"},"accountId":{"type":"string","description":"The ID of the account associated with the invoice item.\n"},"billToContactSnapshotId":{"description":"The ID of the bill-to contact snapshot associated with the invoice.\n","type":"string"},"shipToContactSnapshotId":{"description":"The ID of the ship-to contact snapshot associated with the invoice.\n","type":"string"},"soldToContactSnapshotId":{"description":"The ID of the sold-to contact snapshot associated with the invoice.\n","type":"string"},"parentAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parent account of the account associated with the invoice."},"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 available only if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled for your tenant."},"children":[]}]}]}]},"billToContactId":{"type":"string","description":"The ID of the bill-to contact associated with the invoice.\n"},"shipToContactId":{"type":"string","description":"The ID of the ship-to contact associated with the invoice.\n"},"soldToContactId":{"type":"string","description":"The ID of the sold-to contact associated with the invoice.\n"},"defaultPaymentMethodId":{"type":"string","description":"The ID of the default payment method on the associated account.\n"},"ratePlanId":{"type":"string","description":"The ID of the rate plan that the invoice is created from.\n"},"amendmentId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the amendment associated with the subscription."},"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 available only if you do not have Orders enabled for your tenant."},"children":[]}]}]}]},"productRatePlanChargeId":{"description":"The ID of the product rate plan charge that the invoice item is created from.\n","type":"string"},"productRatePlanId":{"description":"The ID of the product rate plan that the invoice item is created from.\n","type":"string"},"productId":{"description":"The ID of the product that the invoice item is created from.\n","type":"string"},"bookingReference":{"type":"string","description":"The booking reference of the invoice item.\n"},"itemType":{"type":"string","description":"The type of the invoice item.\n"},"purchaseOrderNumber":{"description":"The purchase order number associated with the invoice item.\n","type":"string"},"revRecCode":{"description":"The revenue recognition code.\n","type":"string"},"revRecTriggerCondition":{"description":"The date when revenue recognition is triggered.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate"],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue recognition rule of the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"subscriptionOwnerId":{"description":"The ID of the subscription owner associated with the invoice item.\n","type":"string"},"orderLineItemId":{"description":"The reference ID of the oder line item associated with the invoice item.\n","type":"string"},"invoice":{"type":"object","description":"The invoices to which the invoice item belongs.\n"},"subscription":{"type":"object","description":"The invoice to which the invoice item belongs.\n"},"ratePlanCharge":{"type":"object","description":"The rate plan charge associated with the invoice item.\n"},"orderLineItem":{"type":"object","description":"The order line item associated with the invoice item.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Invoice Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryInvoiceItemResponse"}},"components/schemas/ExpandedInvoice":{"id":"components/schemas/ExpandedInvoice","kind":"json-schema","title":"QueryInvoiceResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the invoice.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the invoice.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the invoice gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the invoice.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the invoice gets updated in the system.\n"},"accountId":{"description":"The ID of the customer account associated with the invoice.\n","type":"string"},"adjustmentAmount":{"description":"The amount of the invoice adjustments associated with the invoice.\n","format":"double","type":"number"},"amount":{"description":"The total amount of the invoice.\n","format":"double","type":"number"},"amountWithoutTax":{"description":"The invoice amount excluding tax.\n","format":"double","type":"number"},"autoPay":{"description":"Whether invoices are automatically picked up for processing in the corresponding payment run.\n","type":"boolean"},"balance":{"description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n","type":"number","format":"double"},"billToContactId":{"description":"The ID of the bill-to contact associated with the invoice.\n","type":"string"},"billToContactSnapshotId":{"description":"The ID of the bill-to contact snapshot associated with the invoice.\n","type":"string"},"comments":{"type":"string","description":"Comments about the invoice.\n"},"creditBalanceAdjustmentAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency amount of the adjustment applied to the customer's credit balance."},"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 only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled."},"children":[]}]}]}],"format":"double","type":"number"},"creditMemoAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency amount of all credit memos applied to this invoice."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and Checklist Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"double","type":"number"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the invoice."},"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":" By default, the currency on a billing document matches the default currency set on the associated account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"dueDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date by which the payment for this invoice is due, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"includesOneTime":{"description":"Specifies whether the invoice includes one-time charges.\n","type":"boolean"},"includesRecurring":{"description":"Specifies whether the invoice includes recurring charges.\n","type":"boolean"},"includesUsage":{"description":"Specifies whether the invoice includes usage charges.\n","type":"boolean"},"invoiceDate":{"description":"The date that appears on the invoice being created.\n","format":"date","type":"string"},"invoiceNumber":{"description":"The unique identification number of the invoice.\n","type":"string"},"lastEmailSentDate":{"description":"The date when the invoice was last emailed.\n","type":"string"},"organizationId":{"type":"string","description":"ID of the organization this object belongs to.\n"},"paymentAmount":{"description":"The amount of payments applied to the invoice.\n","format":"double","type":"number"},"postedBy":{"description":"The user ID of the person who moved the invoice to Posted status.\n","type":"string"},"postedDate":{"description":"The date when the invoice was posted.\n","format":"date-time","type":"string"},"refundAmount":{"description":"Specifies the amount of a refund that was applied against an earlier payment on the invoice.\n","format":"double","type":"number"},"sequenceSetId":{"description":"The ID of the sequence set associated with the invoice.\n","type":"string","nullable":true},"communicationProfileId":{"description":"The ID of the communication profile associated with the invoice.\n","type":"string","nullable":true},"shipToContactId":{"description":"The ID of the ship-to contact associated with the invoice.\n","type":"string"},"shipToContactSnapshotId":{"description":"The ID of the ship-to contact snapshot associated with the invoice.\n","type":"string"},"soldToContactId":{"description":"The ID of the sold-to contact associated with the invoice.\n","type":"string"},"soldToContactSnapshotId":{"description":"The ID of the sold-to contact snapshot associated with the invoice.\n","type":"string"},"source":{"description":"The source of the invoice.\n","enum":["BillRun","API","ApiSubscribe","ApiAmend"],"type":"string"},"sourceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice source."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an invoice is generated from a bill run, the value is the number of the corresponding bill run.Otherwise, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"reversed":{"type":"boolean","description":"Whether the invoice is reversed.\n"},"sourceType":{"description":"The type of the invoice source.\n","enum":["Subscription","Standalone","Order","Consolidation"],"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the invoice."},"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":"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status is applicable only when you use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/invoice-management/split-invoices/split-invoices-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Invoice feature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"When an invoice is split, its status changes from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the newly created invoices retain a reference to the original invoice."},"children":[]}]}]}]}]}],"enum":["Draft","Posted","Split"],"type":"string"},"targetDate":{"description":"This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.\n","format":"date","type":"string"},"taxAmount":{"description":"The amount of taxation.\n","format":"double","type":"number"},"taxExemptAmount":{"description":"The calculated tax amount excluded due to the exemption.\n","format":"double","type":"number"},"taxMessage":{"description":"The message that the tax engine return if it calculates the taxes of this invoice fails.\n","type":"string","nullable":true},"taxStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status that the tax engine return after it calculates the taxes of this invoice. Also, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Voided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status indicates that the tax transaction is successfully canceled on the tax vendor's side.  If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side."},"children":[]}]}]}],"enum":["Complete","Error","UnknownError","DuplicateDoc","InvalidRequest","InvalidResponse","TaxEngineError","ConcurrentModify","InternalServerError","TaxCodeTemplateError","Voided"],"type":"string"},"templateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template."},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled, the value of this field depends on the configuration of the invoice template."},"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 you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription."},"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 specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]}],"type":"string"},"transferredToAccounting":{"description":"Whether the invoice was transferred to an external accounting system.\n","enum":["Processing","Error","Ignore","Yes","No"],"type":"string"},"eInvoiceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It could be Processing, RetrieveTimeOut, Generated, Success, ConditionalSuccess, ApprovedByAuthority, Failed, and Rejected. If it’s Failed, it will have an error code and message. If it’s Generated or Success, both error code and message are empty, and eInvoiceFileId stores the file id of e-invoice."},"children":[]}]}]}],"enum":["Processing","RetrieveTimeOut","Generated","Success","Failed","ConditionalSuccess","ApprovedByAuthority","Rejected"],"type":"string"},"eInvoiceFileId":{"type":"string","description":"The ID of the e-invoice file.\n"},"eInvoiceErrorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This code can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor."},"children":[]}]}]}]},"eInvoiceErrorMessage":{"type":"string","description":"The error message when status is \"Failed\". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n"},"paymentLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to the Payment Link page where the customer can pay the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The link is generated only if the invoice is posted after enabling the Payment Link feature on your tenant."},"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 Payment Link feature is in the Early Adopter phase."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can enable the Payment Link feature through a self-service configuration in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting for Zuora Payments."},"children":[]}]}]}]},"paymentTerm":{"type":"string","description":"The payment term associated with the invoice. The payment term determines the due dates of\ninvoices.\n","example":"Net 30"},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"billToContact":{"$ref":"#/components/schemas/ExpandedContact"},"invoiceItems":{"type":"array","items":{"$ref":"#/components/schemas/NestedInvoiceItemOnExpand"}},"billToContactSnapshot":{"$ref":"#/components/schemas/NestedContactSnapshotOnExpand"},"soldToContactSnapshot":{"$ref":"#/components/schemas/NestedContactSnapshotOnExpand"},"shipToContactSnapshot":{"$ref":"#/components/schemas/NestedContactSnapshotOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Invoice object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryInvoiceResponse"}},"components/schemas/ExpandedTaxationItem":{"id":"components/schemas/ExpandedTaxationItem","kind":"json-schema","title":"QueryTaxationItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the taxation item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the taxation item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the taxation item was created in the Zuora\nsystem.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the taxation item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the taxation item was last updated. \n"},"creditAmount":{"type":"number","description":"The amount of credit memos applied to the taxation item. \n","format":"double"},"accountingCode":{"type":"string","description":"The accounting code that maps to the taxation item in your accounting system.\n"},"exemptAmount":{"type":"number","description":"The calculated tax amount excluded due to the exemption.\n","format":"double"},"invoiceItemId":{"type":"string","description":"The unique identifier of the invoice item to which the taxation item belongs.\n"},"jurisdiction":{"type":"string","description":"The jurisdiction that applies the tax or VAT. This value is typically\na state, province, county, or city.\n"},"locationCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the location based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the taxation item. \n"},"paymentAmount":{"type":"number","description":"The amount of payment applied to the invoice or debit memo. \n","format":"double"},"taxAmount":{"type":"number","description":"The amount of the tax applied to the billing document.\n","format":"double"},"taxAmountUnrounded":{"type":"number","description":"The amount of the tax applied to the billing document before rounding.\n"},"countryCode":{"type":"string","description":"The code of country to which the taxation item.\n"},"taxCodeDescription":{"type":"string","description":"The description of the tax code.\n"},"customerCode":{"type":"string","description":"The customer code. This field is only available if you are using one of the Vertex Tax Connector apps.\n"},"exemptCertificate":{"type":"string","description":"The tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n"},"sellerRegistration":{"type":"string","description":"Your seller registration code. This field is only available if you are using the OneSource Determination app.\n"},"taxDescription":{"type":"string","description":"The description of the tax.\n"},"taxRuleId":{"type":"string","description":"The unique identifier of the tax rule.\n"},"taxCode":{"type":"string","description":"The tax code identifies which tax rules and tax rates to apply to a\nspecific billing document.\n"},"taxMode":{"type":"string","description":"The mode of the tax.\n","enum":["TaxExclusive","TaxInclusive"]},"taxDate":{"type":"string","format":"date","description":"The date when the tax is applied to the billing document.\n"},"taxRate":{"type":"number","description":"The tax rate applied to the billing document.\n","format":"double"},"taxRateDescription":{"type":"string","description":"The description of the tax rate.\n"},"taxRateType":{"type":"string","description":"The type of the tax rate applied to the billing document.\n","enum":["Percentage","FlatFee"]},"balance":{"type":"number","description":"The remaining balance on the taxation item.\n"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this transaction.\n"},"salesTaxPayableAccountingCodeId":{"type":"string","description":"The accounting code for Sales Tax Payable.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The accounting code for Account Receivable.\n"},"taxableItemSnapshotId":{"type":"string","description":"The unique identifier of the taxable item snapshot.\n"},"periodEndDate":{"type":"string","format":"date","description":"The end date of the period to which the taxation item belongs.\n"},"periodStartDate":{"type":"string","format":"date","description":"The start date of the period to which the taxation item belongs.\n"},"taxableAmount":{"type":"number","format":"double","description":"The taxable amount of the taxation item.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Taxation Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryTaxationItemResponse"}},"components/schemas/NestedOrderLineItemOnExpand":{"id":"components/schemas/NestedOrderLineItemOnExpand","kind":"json-schema","title":"QueryOrderLineItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the order line item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the order line item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the order line item gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the order line item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the order line item was last updated.\n"},"accountingCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accountingCode for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"nullable":true},"billTargetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the Order Line Item (OLI) to be picked up by bill run for generating billing documents."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate billing documents for an OLI, you must set this field and set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"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":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","type":"string"},"amountPerUnit":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual charged amount per unit for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"description":{"description":"The description of the Order Line Item.\n","type":"string"},"amount":{"type":"number","description":"The total amount for the Order Line Item (OLI).\n"},"amountWithoutTax":{"type":"number","description":"The total amount for the Order Line Item (OLI) excluding tax.\n"},"itemName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"itemNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"itemState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the Order Line Item (OLI). See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State transitions for an order, order line item, and fulfillment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate invoice for an OLI, you must set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billTargetDate"},"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":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or 'Booked' or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["Executing","Booked","SentToBilling","Complete","Cancelled"],"type":"string"},"itemType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["Product","Fee","Services"],"type":"string"},"listPricePerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price per unit for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"number"},"listPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The extended list price for an order line item, calculated by the formula:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"listPrice = listPricePerUnit * quantity"},"children":[]}]}]}],"type":"number"},"orderId":{"type":"string","description":"The ID of the order that the order line item belongs to.\n"},"productCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product code for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"purchaseOrderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used by customers to specify the Purchase Order Number provided by the buyer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quantity of units, such as the number of authors in a hosted wiki service."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"number"},"revenueRecognitionRule":{"type":"string","description":"The Revenue Recognition rule for the Order Line Item.\n"},"productRatePlanChargeId":{"description":"ID of a Product Rate Plan Charge. Only one-time charges are supported.\n","type":"string"},"billToId":{"description":"The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.\n","type":"string"},"billToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the bill-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"shipTo":{"description":"The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the ship-to contact of an order line item.\n","type":"string"},"shipToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the ship-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"soldTo":{"description":"The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item.\n","type":"string"},"soldToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"soldToOrderContactId":{"type":"string","description":"The ID of the sold-to contact for the order.\n"},"ownerAccountId":{"description":"The account ID of the owner of the order line item.\n","type":"string"},"invoiceOwnerAccountId":{"description":"The account ID of the invoice owner of the order line item.\n","type":"string"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["TaxInclusive","TaxExclusive"],"type":"string"},"transactionDate":{"type":"string","format":"date","description":"The date when the transaction occurs.\n"},"uOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units to measure usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"relatedSubscriptionNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to relate an order line item to an subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"transactionEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionStartDate"},"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":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","type":"string"},"transactionStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date a transaction starts. The default value of this field is the order date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","type":"string"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related rate plan charges and order line items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"originalOrderDate":{"type":"string","format":"date","description":"The date of the original sale order for a return order line item.\n"},"amendedByOrderOn":{"type":"string","format":"date","description":"The date of the amended order for a return order line item.\n"},"itemCategory":{"default":"Sales","description":"The category of the Order Line Item, to indicate a product sale or return.\n","enum":["Sales","Return"],"type":"string"},"originalOrderId":{"description":"The ID of the original sale order for a return order line item. \n","type":"string"},"originalOrderLineItemId":{"description":"The ID of the original sale order line item for a return order line item. \n","type":"string"},"originalOrderLineItemNumber":{"description":"The number of the original sale order line item for a return order line item. \n","type":"string"},"originalOrderNumber":{"description":"The number of the original sale order for a return order line item. \n","type":"string"},"quantityAvailableForReturn":{"description":"The quantity that can be returned for an order line item. \n","type":"number"},"quantityFulfilled":{"description":"The fulfilled quantity for an order line item.\n","type":"number"},"quantityPendingFulfillment":{"description":"The quantity to fulfill for an order line item. \n","type":"number"},"requiresFulfillment":{"description":"The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.\n","type":"boolean"},"billingRule":{"description":"The billing rule of the Order Line Item.\n","enum":["TriggerWithoutFulfillment","TriggerAsFulfillmentOccurs"],"type":"string"},"inlineDiscountPerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used in accordance with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, in the following manner:"},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount percentage is 5%."},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount amount on each unit of the order line item is 10."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"type":"number"},"inlineDiscountType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to specify the inline discount type, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"None"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"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 field is used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"enum":["Percentage","FixedAmount","None"],"type":"string"},"discount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field shows the total discount amount that is applied to an order line item after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The inline discount is applied to the list price of an order line item."},"children":[]}]}]}]},"recognizedRevenueAccountingCodeId":{"type":"string","description":"The recognized revenue accounting code for the Order Line Item.\n"},"deferredRevenueAccountingCodeId":{"description":"The deferred revenue accounting code for the Order Line Item.\n","type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"unbilledReceivablesAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"invoiceItems":{"type":"array","items":{"type":"object"},"description":"The invoice item associated with the order line item."}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order Line Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryOrderLineItemResponse"}},"components/schemas/ExpandedInvoiceItem":{"id":"components/schemas/ExpandedInvoiceItem","kind":"json-schema","title":"QueryInvoiceItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the invoice item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the invoice item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the invoice item was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the invoice item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the invoice item was last updated.\n"},"invoiceId":{"type":"string","description":"The unique identifier of the invoice to which this invoice item belongs.\n"},"invoiceScheduleId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the rate plan charge on the subscription."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"invoiceScheduleItemId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule item that generates this invoice item."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"ratePlanChargeId":{"type":"string","description":"The ID of the rate plan charge associated with the invoice item.\n"},"accountingCode":{"description":"The accounting code associated with the invoice item.","type":"string"},"appliedToInvoiceItemId":{"description":"The unique ID of the invoice item that the discount charge is applied\nto.\n","type":"string"},"chargeAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the charge."},"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 amount does not include taxes regardless if the charge's tax mode is inclusive or exclusive. This is the discount amount actually applied when the invoice item is a discount charge."},"children":[]}]}]}],"format":"double","type":"number"},"chargeDate":{"description":"The date when the invoice item is charged.\n","format":"date-time","type":"string"},"chargeName":{"description":"The name of the charge.","type":"string"},"chargeNumber":{"type":"string","description":"Number of the charge.\n"},"commitmentChargeNumber":{"type":"string"},"commitmentChargeSegmentNumber":{"type":"string"},"description":{"description":"The description of the invoice item.","type":"string"},"discountAmount":{"type":"number","description":"The amount of the discount.\n"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude the invoice item from revenue accounting."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"fulfillmentId":{"type":"string","description":"The reference ID of the fulfillment associated with the invoice item.\n"},"itemShipToContactId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ship-to contact associated with the invoice item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]},"itemSoldToContactId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the invoice item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]},"itemSoldToContactSnapshotId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact snapshot associated with the invoice item."},"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":": If you have the Flexible Billing Attributes feature disabled, 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":[]}]}]}]},"processingType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of the charge for the invoice item."},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": discount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": prepayment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": tax"},"children":[]}]}]}]}],"enum":["0","1","2","3"]},"quantity":{"type":"number","description":"The quantity of this item, in the configured unit of measure for the\ncharge.\n"},"reflectDiscountInNetAmount":{"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":"When you apply percentage discounts to either of the following charges, you need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on your discount charge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to enable calculating and displaying the net amount of the following charges in Zuora Revenue."},"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":"delivery pricing charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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":"If you are an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, when you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 you are a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reflectDiscountInNetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"revRecStartDate":{"type":"string","format":"date"},"serviceEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the service period for this item, i.e., the last day"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the service period, as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"serviceStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the service period for this item, as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yyyy-mm-dd"},"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 a one-time fee item, the date of the charge."},"children":[]}]}]}],"format":"date","type":"string"},"sKU":{"type":"string","description":"The SKU of the product associated with the invoice item.\n"},"sourceItemType":{"description":"The type of the source item.\n","enum":["SubscriptionComponent","Rounding","ProductRatePlanCharge","None","OrderLineItem"],"type":"string"},"subscriptionId":{"type":"string","description":"ID of the subscription associated with the invoice item.\n"},"subscriptionNumber":{"type":"string","description":"Number of the subscription associated with the invoice item.\n"},"taxAmount":{"description":"The amount of tax applied to the charge.\n","format":"double","type":"number"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code of the invoice item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":" Only when taxation feature is enabled, this field can be presented."},"children":[]}]}]}],"type":"string"},"taxExemptAmount":{"type":"number"},"taxMode":{"description":"The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n","enum":["TaxExclusive","TaxInclusive"],"type":"string"},"unitPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The per-unit price of the invoice item."},"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":": For discount charges, this represents the discount percentage (for percentage-based discounts)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the discount amount (for fixed-amount discounts)."},"children":[]}]}]}],"format":"double","type":"number"},"uOM":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure (UOM) that is configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the product rate plan charge."},"children":[]}]}]}]},"balance":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The balance of the invoice item."},"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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]},"numberOfDeliveries":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of deliveries dedicated to the Delivery Pricing charges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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 available only if you have the Delivery Pricing feature enabled."},"children":[]}]}]}]},"accountReceivableAccountingCodeId":{"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 account receivable accounting code associated with the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}]},"recognizedRevenueAccountingCodeId":{"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 recognized revenue accounting code associated with the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}]},"deferredRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the deferred revenue accounting code associated with the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"contractAssetAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the accounting code for contract asset."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCodeId":{"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 accounting code for contract liability."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"contractRecognizedRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the accounting code for contract recognized revenue."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"unbilledReceivablesAccountingCodeId":{"type":"string"},"adjustmentRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for adjustment revenue."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the accounting code for adjustment liability."},"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 only available if you have the Billing - Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this invoice item.\n"},"accountId":{"type":"string","description":"The ID of the account associated with the invoice item.\n"},"billToContactSnapshotId":{"description":"The ID of the bill-to contact snapshot associated with the invoice.\n","type":"string"},"shipToContactSnapshotId":{"description":"The ID of the ship-to contact snapshot associated with the invoice.\n","type":"string"},"soldToContactSnapshotId":{"description":"The ID of the sold-to contact snapshot associated with the invoice.\n","type":"string"},"parentAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parent account of the account associated with the invoice."},"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 available only if you have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-customer-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled for your tenant."},"children":[]}]}]}]},"billToContactId":{"type":"string","description":"The ID of the bill-to contact associated with the invoice.\n"},"shipToContactId":{"type":"string","description":"The ID of the ship-to contact associated with the invoice.\n"},"soldToContactId":{"type":"string","description":"The ID of the sold-to contact associated with the invoice.\n"},"defaultPaymentMethodId":{"type":"string","description":"The ID of the default payment method on the associated account.\n"},"ratePlanId":{"type":"string","description":"The ID of the rate plan that the invoice is created from.\n"},"amendmentId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the amendment associated with the subscription."},"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 available only if you do not have Orders enabled for your tenant."},"children":[]}]}]}]},"productRatePlanChargeId":{"description":"The ID of the product rate plan charge that the invoice item is created from.\n","type":"string"},"productRatePlanId":{"description":"The ID of the product rate plan that the invoice item is created from.\n","type":"string"},"productId":{"description":"The ID of the product that the invoice item is created from.\n","type":"string"},"bookingReference":{"type":"string","description":"The booking reference of the invoice item.\n"},"itemType":{"type":"string","description":"The type of the invoice item.\n"},"purchaseOrderNumber":{"description":"The purchase order number associated with the invoice item.\n","type":"string"},"revRecCode":{"description":"The revenue recognition code.\n","type":"string"},"revRecTriggerCondition":{"description":"The date when revenue recognition is triggered.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate"],"type":"string"},"revenueRecognitionRuleName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue recognition rule of the invoice item."},"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 only available if you have Zuora Finance enabled."},"children":[]}]}]}],"type":"string"},"orderLineItemId":{"description":"The reference ID of the oder line item associated with the invoice item.\n","type":"string"},"subscriptionOwnerId":{"description":"The ID of the subscription owner associated with the invoice item.\n","type":"string"},"invoice":{"$ref":"#/components/schemas/NestedInvoiceOnExpand"},"subscription":{"$ref":"#/components/schemas/NestedSubscriptionOnExpand"},"taxationItems":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedTaxationItem"}},"ratePlanCharge":{"$ref":"#/components/schemas/NestedRatePlanChargeOnExpand"},"orderLineItem":{"$ref":"#/components/schemas/NestedOrderLineItemOnExpand"},"subscriptionOwner":{"$ref":"#/components/schemas/NestedAccountOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Invoice Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryInvoiceItemResponse"}},"components/schemas/NestedInvoiceScheduleItemOnExpand":{"id":"components/schemas/NestedInvoiceScheduleItemOnExpand","kind":"json-schema","title":"QueryInvoiceScheduleItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the invoice schedule item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the invoice schedule item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the invoice schedule item was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the invoice schedule item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the invoice schedule item was last updated.\n"},"amount":{"type":"string","format":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the invoice generated during the processing of the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in one request."},"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":"If you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the corresponding response."},"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":"If you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returned in the corresponding response is calculated based on the percentage of the total amount."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field keeps unchanged once invoice schedule items are created."},"children":[]}]}]}]},"percentage":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of the total amount to be billed during the processing of the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only specify either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in one request."},"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":"If you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the corresponding response."},"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":"If you choose to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returned in the corresponding response is calculated based on the percentage of the total amount."},"children":[]}]}]}]}]}]},"actualAmount":{"type":"string","format":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual amount that needs to be billed during the processing of the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field keeps unchanged. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actualAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field reflects the actual amount to be billed."},"children":[]}]}]}]},"runDate":{"type":"string","format":"date","description":"The date in the tenant's time zone when the invoice schedule item is processed to generate an invoice.\n"},"invoiceScheduleId":{"type":"string","description":"The ID of the invoice schedule that the invoice schedule item belongs to.\n"},"invoiceId":{"type":"string","description":"The ID of the invoice that is generated during the processing of the invoice schedule item.\n"},"creditMemoId":{"type":"string","description":"The ID of the credit memo that is generated during the processing of the invoice schedule item.\n"},"status":{"type":"string","description":"The status of the invoice schedule item.\n","enum":["Pending","Executing","Processed"]},"name":{"type":"string","maxLength":100,"description":"The name of the invoice schedule item.\n"},"sequenceNumber":{"type":"string","description":"The sequence number of the invoice schedule item.\n"},"targetDateForAdditionalSubscriptions":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The regular charges must come from the subscriptions specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalSubscriptionsToBill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on the associated invoice schedule."},"children":[]}]}]}]}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Invoice Schedule Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryInvoiceScheduleItemResponse"}},"components/schemas/NestedInvoiceScheduleBookingOnExpand":{"id":"components/schemas/NestedInvoiceScheduleBookingOnExpand","kind":"json-schema","title":"QueryInvoiceScheduleBookingResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the invoice schedule booking.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the invoice schedule booking.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the invoice schedule booking was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the invoice schedule booking.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the invoice schedule booking was last updated.\n"},"invoiceScheduleId":{"type":"string","description":"The ID of the invoice schedule that the invoice schedule booking belongs to.\n"},"orderId":{"type":"string","description":"The ID of the order associated with the invoice schedule.\n"},"orderNumber":{"type":"string","description":"The number of the order associated with the invoice schedule.\n"},"subscriptionId":{"type":"string","description":"The ID of the subscription contained in the order associated with the invoice schedule.\n"},"subscriptionNumber":{"type":"string","description":"The number of the subscription contained in the order associated with the invoice schedule.\n"},"chargeNumbers":{"type":"string","description":"A list of charges in the subscription that are chosen to be included in the invoice schedule.\n"}},"type":"object","title":"QueryInvoiceScheduleBookingResponse"}},"components/schemas/ExpandedInvoiceSchedule":{"id":"components/schemas/ExpandedInvoiceSchedule","kind":"json-schema","title":"QueryInvoiceScheduleResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the invoice schedule.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the invoice schedule.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the invoice schedule was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the invoice schedule.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the invoice schedule was last updated.\n"},"totalAmount":{"type":"number","description":"The total amount that needs to be billed during the processing of the invoice schedule. \n\nThe value of this field keeps unchanged once invoice schedule items are created.\n"},"actualAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual amount that needs to be billed during the processing of the invoice schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field keeps unchanged. The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actualAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field reflects the actual amount to be billed."},"children":[]}]}]}]},"billedAmount":{"type":"number","description":"The amount that has been billed during the processing of the invoice schedule.\n"},"unbilledAmount":{"type":"number","description":"The amount that is waiting to be billed during the processing of the invoice schedule.\n"},"nextRunDate":{"type":"string","format":"date","description":"The run date of the next execution of invoice schedule. By default, the next run date is the same as run date of next pending invoice schedule item. \nIt can be overwritten with a different date other than the default value. When the invoice schedule has completed the execution, the next run date is null.\n"},"number":{"type":"string","description":"The sequence number of the invoice schedule. \n"},"notes":{"type":"string","maxLength":255,"description":"Comments on the invoice schedule.\n"},"accountId":{"type":"string","description":"The ID of the customer account that the invoice schedule belongs to.\n"},"status":{"type":"string","description":"The status of the invoice schedule.\n","enum":["Pending","PartiallyProcessed","Paused","FullyProcessed"]},"additionalSubscriptionsToBill":{"type":"string","description":"A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. \n\nOne invoice schedule can have at most 600 additional subscriptions.\n"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the billing documents generated during the processing of the invoice schedule."},"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":":"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"If you have the Multiple Currencies feature disabled, the corresponding account's default currency is always used."},"children":[]}]}]}]}]}]},"invoiceScheduleItems":{"type":"array","items":{"$ref":"#/components/schemas/NestedInvoiceScheduleItemOnExpand"}},"invoiceScheduleBookings":{"type":"array","items":{"$ref":"#/components/schemas/NestedInvoiceScheduleBookingOnExpand"}},"ratePlanCharges":{"type":"array","items":{"$ref":"#/components/schemas/NestedRatePlanChargeOnExpand"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Invoice Schedule object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryInvoiceScheduleResponse"}},"components/schemas/NestedOrderActionOnExpand":{"id":"components/schemas/NestedOrderActionOnExpand","kind":"json-schema","title":"QueryOrderActionResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the order action.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the order action.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the order action gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the order action.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the order action was last updated.\n"},"contractEffectiveDate":{"type":"string","format":"date","description":"Effective contract date for this subscription, as yyyy-mm-dd.\n"},"customerAcceptanceDate":{"type":"string","format":"date","description":"The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n"},"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 order action."},"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 change plan type of order action is supported for the  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. However, it is currently not supported for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing."},"children":[]}]}]}],"enum":["CreateSubscription","TermsAndConditions","AddProduct","UpdateProduct","RemoveProduct","RenewSubscription","CancelSubscription","OwnerTransfer","Suspend","Resume","ChangePlan"],"type":"string"},"sequence":{"type":"integer","format":"int32","description":"The sequence of the order actions processed in the order.\n"},"subscriptionVersionAmendmentId":{"type":"string","description":"The unique identifier of the amendment that changes the version of the subscription.\n"},"orderId":{"type":"string","description":"The unique identifier of the order that the order action belongs to.\n"},"subscriptionId":{"type":"string","description":"The unique identifier of the subscription associated with the order action.\n"},"subscriptionNumber":{"type":"string","description":"The number of the subscription associated with the order action.\n"},"serviceActivationDate":{"type":"string","format":"date","description":"The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.\n"},"autoRenew":{"type":"boolean","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription automatically renews at the end of the term."},"children":[]}]}]}],"default":false},"renewSetting":{"description":"Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.\n","type":"string","enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"default":"RENEW_WITH_SPECIFIC_TERM"},"renewalTerm":{"type":"integer","format":"int64","description":"The length of the period for the subscription renewal term. \n","default":0},"renewalTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the subscription renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the subscription renewal term."},"children":[]}]}]}],"type":"string","enum":["Month","Year","Day","Week"],"default":"Month"},"termStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the subscription term begins, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this is a renewal subscription, this date is different from the subscription start date."},"children":[]}]}]}]},"termType":{"type":"string","enum":["TERMED","EVERGREEN"],"description":"The type of the subscription term.\n"},"currentTerm":{"type":"integer","format":"int64","description":"The length of the period for the current subscription term.\n"},"currentTermPeriodType":{"description":"The period type for the current subscription term.\n","type":"string","enum":["Month","Year","Day","Week"],"default":"Month"},"suspendDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when subscription suspension takes effect, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"resumeDate":{"type":"string","format":"date","description":"The resume date when the resumption takes effect.\n"},"cancellationEffectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the cancellation takes effect, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Used only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancellationPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced."},"children":[]}]}]}]},"cancellationPolicy":{"type":"string","description":"Cancellation method. \n","enum":["EndOfCurrentTerm","EndOfLastInvoicePeriod","SpecificDate"]},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For"},"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":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"shipToContactId":{"description":"The ID of the ship-to contact associated with the subscription.\n","type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"clearingExistingPaymentTerm":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTerm"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingBillToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingInvoiceTemplate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSequenceSet":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingShipToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSoldToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the subscription."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string","nullable":true},"clearingExistingCommunicationProfile":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing communication profile at the subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"subType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sub type for the change plan order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field was not set by user, the field is automatically generated by the system according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are within the same Grading catalog group:"},"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 grade of new plan is greater than that of the old plan, this is an \"Upgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan is less than that of the old plan, this is a \"Downgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan equals that of the old plan, this is a \"Crossgrade\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\"."},"children":[]}]}]}],"enum":["Upgrade","Downgrade","Crossgrade","PlanChanged"],"type":"string"},"effectivePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectivePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field 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":"If the rate plan change (from old to new) is an upgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveImmediately"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the rate plan change (from old to new) is a downgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"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":"Notes"},"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":"When setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you cannot set the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-trigger-dates-updation-for-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing trigger dates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the subscription as the system will automatically set the trigger dates to the end of billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contractEffectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}],"enum":["EffectiveImmediately","EffectiveEndOfBillingPeriod","SpecificDate"],"type":"string"},"subscription":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subscription associated with this order action."},"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":": For draft and scheduled orders, information on the subscription, rate plan, and rate plan charges is not available nor displayed until the following conditions are met:"},"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":"A scheduled order is executed and its status is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"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":"A draft order is activated and its status is changed to "},"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":"completed"},"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 example, if an order is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, information on the subscription, rate plan, and rate plan charges is not displayed."},"children":[]}]}]}]}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order Action object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryOrderActionResponse"}},"components/schemas/NestedOrderOnExpand":{"id":"components/schemas/NestedOrderOnExpand","kind":"json-schema","title":"QueryOrdersResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the order.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the order.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the order gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the order.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the order was last updated.\n"},"description":{"type":"string","description":"The description of the order.\n"},"orderDate":{"type":"string","format":"date","description":"The date when the order is signed. All the order actions under this\norder will use this order date as the contract effective date if no\nadditinal contractEffectiveDate is provided.\n"},"orderNumber":{"type":"string","description":"The unique identifier of the order.\n"},"accountId":{"type":"string","description":"The unique identifier of the customer account associated with the\norder.\n"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the order. If the order contains any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription, the order status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; If the order is in draft status, the order status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; otherwise the order status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"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 available order statuses are as follow:"},"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":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in draft status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in pending status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in completed status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The draft or scheduled order is cancelled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in scheduled status and it is only valid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if the Scheduled Orders feature is enabled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The scheduled order is executed by a scheduler and it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is only valid if the Scheduled Orders feature is enabled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The scheduled order has failed."},"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":": To manage and access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-scheduled-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature from the self-service"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interface, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable billing features by yourself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Draft","Pending","Completed","Cancelled","Scheduled","Executing","Failed"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the bill-to address. The value is a valid subregion (state"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"createdByMigration":{"type":"boolean","description":"Indicates whether the order is created by migration.\n"},"category":{"type":"string"},"invoiceScheduleId":{"type":"string","description":"The unique identifier of the invoice schedule associated with the\norder.\n"},"scheduledDate":{"type":"string","format":"date","description":"The date for the order scheduled.\n"},"scheduledDatePolicy":{"description":"Date policy of the scheduled order.","enum":["SpecificDate"],"type":"string"},"errorCode":{"type":"string","description":"The error code of the error response.\n"},"errorMessage":{"type":"string","description":"The error message of the error response.\n"},"response":{"type":"string"},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"orderLineItems":{"type":"array","items":{"$ref":"#/components/schemas/NestedOrderLineItemOnExpand"}},"orderActions":{"type":"array","items":{"$ref":"#/components/schemas/NestedOrderActionOnExpand"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryOrdersResponse"}},"components/schemas/ExpandedOrderAction":{"id":"components/schemas/ExpandedOrderAction","kind":"json-schema","title":"QueryOrderActionResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the order action.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the order action.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the order action gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the order action.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the order action was last updated.\n"},"contractEffectiveDate":{"type":"string","format":"date","description":"Effective contract date for this subscription, as yyyy-mm-dd.\n"},"customerAcceptanceDate":{"type":"string","format":"date","description":"The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n"},"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 order action."},"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 change plan type of order action is supported for the  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. However, it is currently not supported for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing."},"children":[]}]}]}],"enum":["CreateSubscription","TermsAndConditions","AddProduct","UpdateProduct","RemoveProduct","RenewSubscription","CancelSubscription","OwnerTransfer","Suspend","Resume","ChangePlan"],"type":"string"},"sequence":{"type":"integer","format":"int32","description":"The sequence of the order actions processed in the order.\n"},"subscriptionVersionAmendmentId":{"type":"string","description":"The unique identifier of the amendment that changes the version of the subscription.\n"},"orderId":{"type":"string","description":"The unique identifier of the order that the order action belongs to.\n"},"subscriptionId":{"type":"string","description":"The unique identifier of the subscription associated with the order action.\n"},"subscriptionNumber":{"type":"string","description":"The number of the subscription associated with the order action.\n"},"serviceActivationDate":{"type":"string","format":"date","description":"The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.\n"},"autoRenew":{"type":"boolean","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription automatically renews at the end of the term."},"children":[]}]}]}],"default":false},"renewSetting":{"description":"Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.\n","type":"string","enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"default":"RENEW_WITH_SPECIFIC_TERM"},"renewalTerm":{"type":"integer","format":"int64","description":"The length of the period for the subscription renewal term. \n","default":0},"renewalTermPeriodType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type for the subscription renewal term."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTerm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the subscription renewal term."},"children":[]}]}]}],"type":"string","enum":["Month","Year","Day","Week"],"default":"Month"},"termStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the subscription term begins, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this is a renewal subscription, this date is different from the subscription start date."},"children":[]}]}]}]},"termType":{"type":"string","enum":["TERMED","EVERGREEN"],"description":"The type of the subscription term.\n"},"currentTerm":{"type":"integer","format":"int64","description":"The length of the period for the current subscription term.\n"},"currentTermPeriodType":{"description":"The period type for the current subscription term.\n","type":"string","enum":["Month","Year","Day","Week"],"default":"Month"},"suspendDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when subscription suspension takes effect, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"resumeDate":{"type":"string","format":"date","description":"The resume date when the resumption takes effect.\n"},"cancellationEffectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the cancellation takes effect, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Used only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancellationPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced."},"children":[]}]}]}]},"cancellationPolicy":{"type":"string","description":"Cancellation method. \n","enum":["EndOfCurrentTerm","EndOfLastInvoicePeriod","SpecificDate"]},"paymentTerm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the payment term associated with the subscription. For"},"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":"Net 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The payment term determines the due dates of invoices."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Term from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"billToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bill-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"invoiceTemplateId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"shipToContactId":{"description":"The ID of the ship-to contact associated with the subscription.\n","type":"string"},"soldToContactId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sold-to contact associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Contact from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string"},"clearingExistingPaymentTerm":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTerm"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingBillToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingInvoiceTemplate":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoiceTemplateId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSequenceSet":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequenceSetId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingShipToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"clearingExistingSoldToContact":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToContactId"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]}],"type":"boolean"},"communicationProfileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the communication profile associated with the subscription."},"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 available in the request body only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature turned on. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body without this feature turned on."},"children":[]}]}]}],"type":"string","nullable":true},"clearingExistingCommunicationProfile":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to clear the existing communication profile at the subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"level. This field is mutually exclusive with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communicationProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"boolean"},"subType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sub type for the change plan order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field was not set by user, the field is automatically generated by the system according to the following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are within the same Grading catalog group:"},"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 grade of new plan is greater than that of the old plan, this is an \"Upgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan is less than that of the old plan, this is a \"Downgrade\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the grade of new plan equals that of the old plan, this is a \"Crossgrade\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\"."},"children":[]}]}]}],"enum":["Upgrade","Downgrade","Crossgrade","PlanChanged"],"type":"string"},"effectivePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectivePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field 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":"If the rate plan change (from old to new) is an upgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveImmediately"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the rate plan change (from old to new) is a downgrade, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, the effective policy is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"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":"Notes"},"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":"When setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EffectiveEndOfBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you cannot set the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-trigger-dates-updation-for-subscriptions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing trigger dates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the subscription as the system will automatically set the trigger dates to the end of billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When setting this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contractEffectiveDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}],"enum":["EffectiveImmediately","EffectiveEndOfBillingPeriod","SpecificDate"],"type":"string"},"subscription":{"$ref":"#/components/schemas/NestedSubscriptionOnExpand"},"order":{"$ref":"#/components/schemas/NestedOrderOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order Action object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryOrderActionResponse"}},"components/schemas/ExpandedOrderLineItem":{"id":"components/schemas/ExpandedOrderLineItem","kind":"json-schema","title":"QueryOrderLineItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the order line item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the order line item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the order line item gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the order line item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the order line item was last updated.\n"},"accountingCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accountingCode for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"nullable":true},"billTargetDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target date for the Order Line Item (OLI) to be picked up by bill run for generating billing documents."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate billing documents for an OLI, you must set this field and set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"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":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","type":"string"},"amountPerUnit":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual charged amount per unit for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"description":{"description":"The description of the Order Line Item.\n","type":"string"},"amount":{"type":"number","description":"The total amount for the Order Line Item (OLI).\n"},"amountWithoutTax":{"type":"number","description":"The total amount for the Order Line Item (OLI) excluding tax.\n"},"itemName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"itemNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"itemState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the Order Line Item (OLI). See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State transitions for an order, order line item, and fulfillment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate invoice for an OLI, you must set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billTargetDate"},"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":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or 'Booked' or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SentToBilling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["Executing","Booked","SentToBilling","Complete","Cancelled"],"type":"string"},"itemType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["Product","Fee","Services"],"type":"string"},"listPricePerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list price per unit for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"number"},"listPrice":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The extended list price for an order line item, calculated by the formula:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"listPrice = listPricePerUnit * quantity"},"children":[]}]}]}],"type":"number"},"orderId":{"type":"string","description":"The ID of the order that the order line item belongs to.\n"},"orderNumber":{"description":"The number of the order that the order line item belongs to.\n","type":"string"},"productCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product code for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"purchaseOrderNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used by customers to specify the Purchase Order Number provided by the buyer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quantity of units, such as the number of authors in a hosted wiki service."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"number"},"revenueRecognitionRule":{"type":"string","description":"The Revenue Recognition rule for the Order Line Item.\n"},"productRatePlanChargeId":{"description":"ID of a Product Rate Plan Charge. Only one-time charges are supported.\n","type":"string"},"billToId":{"description":"The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.\n","type":"string"},"billToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the bill-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"shipTo":{"description":"The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the ship-to contact of an order line item.\n","type":"string"},"shipToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the ship-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"soldTo":{"description":"The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item.\n","type":"string"},"soldToSnapshotId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToSnapshotId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is exposed while retrieving the order line item details."},"children":[]}]}]}],"type":"string"},"soldToOrderContactId":{"type":"string","description":"The ID of the sold-to contact for the order.\n"},"ownerAccountId":{"description":"The account ID of the owner of the order line item.\n","type":"string"},"invoiceOwnerAccountId":{"description":"The account ID of the invoice owner of the order line item.\n","type":"string"},"taxCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax code for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"taxMode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax mode for the Order Line Item (OLI)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["TaxInclusive","TaxExclusive"],"type":"string"},"transactionDate":{"type":"string","format":"date","description":"The date when the transaction occurs.\n"},"uOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units to measure usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"relatedSubscriptionNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to relate an order line item to an subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field only for a sales OLI and only when the sales OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string"},"transactionEndDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionStartDate"},"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":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","type":"string"},"transactionStartDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date a transaction starts. The default value of this field is the order date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update this field for a sales or return OLI only when the OLI is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state (when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","type":"string"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related rate plan charges and order line items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"originalOrderDate":{"type":"string","format":"date","description":"The date of the original sale order for a return order line item.\n"},"amendedByOrderOn":{"type":"string","format":"date","description":"The date of the amended order for a return order line item.\n"},"itemCategory":{"default":"Sales","description":"The category of the Order Line Item, to indicate a product sale or return.\n","enum":["Sales","Return"],"type":"string"},"originalOrderId":{"description":"The ID of the original sale order for a return order line item. \n","type":"string"},"originalOrderLineItemId":{"description":"The ID of the original sale order line item for a return order line item. \n","type":"string"},"originalOrderLineItemNumber":{"description":"The number of the original sale order line item for a return order line item. \n","type":"string"},"originalOrderNumber":{"description":"The number of the original sale order for a return order line item. \n","type":"string"},"quantityAvailableForReturn":{"description":"The quantity that can be returned for an order line item. \n","type":"number"},"quantityFulfilled":{"description":"The fulfilled quantity for an order line item.\n","type":"number"},"quantityPendingFulfillment":{"description":"The quantity to fulfill for an order line item. \n","type":"number"},"requiresFulfillment":{"description":"The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.\n","type":"boolean"},"billingRule":{"description":"The billing rule of the Order Line Item.\n","enum":["TriggerWithoutFulfillment","TriggerAsFulfillmentOccurs"],"type":"string"},"inlineDiscountPerUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used in accordance with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, in the following manner:"},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount percentage is 5%."},"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":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this field, the discount amount on each unit of the order line item is 10."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"type":"number"},"inlineDiscountType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is used to specify the inline discount type, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"None"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Percentage"},"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 field is used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPricePerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields, the system will automatically generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. You shall not set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field by yourself."},"children":[]}]}]}],"enum":["Percentage","FixedAmount","None"],"type":"string"},"discount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field shows the total discount amount that is applied to an order line item after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineDiscountPerUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The inline discount is applied to the list price of an order line item."},"children":[]}]}]}]},"recognizedRevenueAccountingCodeId":{"type":"string","description":"The recognized revenue accounting code for the Order Line Item.\n"},"deferredRevenueAccountingCodeId":{"description":"The deferred revenue accounting code for the Order Line Item.\n","type":"string"},"contractAssetAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"contractLiabilityAccountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"contractRecognizedRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"unbilledReceivablesAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"adjustmentRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"adjustmentLiabilityAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code on the Order Line Item object for customers using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"billTo":{"$ref":"#/components/schemas/ExpandedContact"},"invoiceItems":{"type":"array","items":{"$ref":"#/components/schemas/NestedInvoiceItemOnExpand"}},"invoiceOwnerAccount":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"ownerAccount":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"soldToInfo":{"$ref":"#/components/schemas/ExpandedContact"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order Line Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryOrderLineItemResponse"}},"components/schemas/ExpandedOrders":{"id":"components/schemas/ExpandedOrders","kind":"json-schema","title":"QueryOrdersResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the order.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the order.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the order gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the order.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the order was last updated.\n"},"description":{"type":"string","description":"The description of the order.\n"},"orderDate":{"type":"string","format":"date","description":"The date when the order is signed. All the order actions under this\norder will use this order date as the contract effective date if no\nadditinal contractEffectiveDate is provided.\n"},"orderNumber":{"type":"string","description":"The unique identifier of the order.\n"},"accountId":{"type":"string","description":"The unique identifier of the customer account associated with the\norder.\n"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the order. If the order contains any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Activation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending Acceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription, the order status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; If the order is in draft status, the order status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; otherwise the order status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"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 available order statuses are as follow:"},"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":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in draft status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in pending status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in completed status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The draft or scheduled order is cancelled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The order is in scheduled status and it is only valid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if the Scheduled Orders feature is enabled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The scheduled order is executed by a scheduler and it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is only valid if the Scheduled Orders feature is enabled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The scheduled order has failed."},"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":": To manage and access the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-scheduled-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature from the self-service"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interface, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable billing features by yourself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Draft","Pending","Completed","Cancelled","Scheduled","Executing","Failed"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the bill-to address. The value is a valid subregion (state"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"createdByMigration":{"type":"boolean","description":"Indicates whether the order is created by migration.\n"},"category":{"type":"string"},"invoiceScheduleId":{"type":"string","description":"The unique identifier of the invoice schedule associated with the\norder.\n"},"scheduledDate":{"type":"string","format":"date","description":"The date for the order scheduled.\n"},"scheduledDatePolicy":{"description":"Date policy of the scheduled order.","enum":["SpecificDate"],"type":"string"},"errorCode":{"type":"string","description":"The error code of the error response.\n"},"errorMessage":{"type":"string","description":"The error message of the error response.\n"},"response":{"type":"string"},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"orderLineItems":{"type":"array","items":{"$ref":"#/components/schemas/NestedOrderLineItemOnExpand"}},"orderActions":{"type":"array","items":{"$ref":"#/components/schemas/NestedOrderActionOnExpand"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Order object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-custom-field-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryOrdersResponse"}},"components/schemas/ExpandedPaymentApplication":{"id":"components/schemas/ExpandedPaymentApplication","kind":"json-schema","title":"QueryPaymentApplicationResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the payment application.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment application.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the payment application was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment application.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the payment application was last updated.\n"},"applyAmount":{"type":"number","format":"double","description":"The applied amount of the payment.\n"},"effectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the payment application takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-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":"The effective date is later than or equal to the maximum effective date of the payment."},"children":[]}]}]}]},"paymentApplicationStatus":{"type":"string","description":"The status of the payment application.\n","enum":["Processing","Processed","Cancelled"]},"accountId":{"type":"string","description":"The ID of the customer account associated with the payment application.\n"},"paymentId":{"type":"string","description":"The unique ID of the created payment. \n","example":"4028905f5a87c0ff015a87eb6b75007f"},"invoiceId":{"type":"string","description":"The ID of the invoice to which the payment is applied.\n"},"applicationGroupId":{"type":"string","description":"The ID of the application group to which this payment application belongs.\n"},"debitMemoId":{"type":"string","description":"The ID of the debit memo to which the payment is applied.\n"},"billingDocumentOwnerId":{"type":"string","description":"The ID of the billing document owner. \n"},"accountReceivableAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accountReceivableAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}]},"unappliedPaymentAccountingCodeId":{"type":"string","description":"The accounting code for the unapplied payment.\n"},"cashAccountingCodeId":{"type":"string","description":"The accounting code for cash payments.\n"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this transaction.\n"},"payment":{"$ref":"#/components/schemas/NestedPaymentOnExpand"}},"type":"object","title":"QueryPaymentApplicationResponse","additionalProperties":false}},"components/schemas/ExpandedPayment":{"id":"components/schemas/ExpandedPayment","kind":"json-schema","title":"QueryPaymentResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the payment.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the payment gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the payment gets updated in the system.\n"},"accountId":{"description":"The ID of the customer account that the payment is for.\n","type":"string"},"accountingCode":{"type":"string","description":"The accounting code for the charge. Accounting codes group\ntransactions that contain similar accounting attributes.\n"},"amount":{"description":"The total amount of the payment.\n","format":"double","type":"number"},"appliedAmount":{"description":"The applied amount of the payment.\n","format":"double","type":"number"},"authTransactionId":{"description":"The authorization transaction ID from the payment gateway.\n","type":"string"},"appliedCreditBalanceAmount":{"type":"number","description":"The amount of the payment to apply to a credit balance. \n"},"bankIdentificationNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first six or eight digits of the credit card or debit card used for the payment, when applicable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=payments-reconcile-payments-with-merchant-accounts","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reconcile payments between the gateway and merchant banks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cancelledOn":{"type":"string","description":"The date when the payment was canceled.\n","format":"date-time"},"comment":{"type":"string","description":"Comments about the payment.\n","nullable":true},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is not enabled, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Standalone Payment is enabled and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency."},"children":[]}]}]}],"type":"string","example":"USD"},"effectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the payment takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"gatewayOrderId":{"description":"A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.\n","type":"string"},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string"},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string"},"gatewayResponse":{"description":"The message returned from the payment gateway for the payment. This message is gateway-dependent.\n","type":"string"},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the payment. This code is gateway-dependent.\n","type":"string"},"gatewayState":{"description":"The status of the payment in the gateway; use for reconciliation. \n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"gatewayTransactionState":{"type":"string"},"isStandalone":{"type":"boolean","description":"Indicates whether the payment is a standalone payment. A standalone\npayment is a payment that is not associated with any invoice or\nsubscription.\n"},"markedForSubmissionOn":{"type":"string","format":"date-time","description":"The date and time when a charge was marked and waiting for batch\nsubmission to the payment process.\n"},"paymentMethodId":{"type":"string","description":"The unique ID of the payment method that the customer used to make the payment.\n"},"paymentMethodSnapshotId":{"type":"string","description":"The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"},"paymentOptionId":{"type":"string","description":"ID of the paymentOption object, which describe the transactional level rules for processing payments. \n"},"paymentNumber":{"type":"string","description":"The unique identification number of a payment. \n","example":"P-00000028."},"payoutId":{"type":"string","description":"The payout ID of the payment from the gateway side.\n"},"prepayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payment is used as a reserved payment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"referencedPaymentID":{"type":"string","description":"The ID of a referenced payment. \n"},"referenceId":{"description":"The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string"},"refundAmount":{"type":"number","description":"The amount of the payment that is refunded.\n","format":"double"},"secondPaymentReferenceId":{"type":"string","description":"The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.\n"},"settledOn":{"type":"string","format":"date-time","description":"The date and time when the payment was settled in the payment processor. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"},"softDescriptor":{"type":"string","description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"},"softDescriptorPhone":{"type":"string","description":"A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"},"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how the payment was created, whether through API, manually, import, payment run, or Checkout."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checkout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is automatically assigned when a payment is created through a Hosted Payment Method (HPM) flow, such as UPI."},"children":[]}]}]}],"enum":["PaymentRun","Import","Manually","API","Checkout"]},"sourceName":{"type":"string","description":"Name of the source. It can be a payment run number or a file name.\n"},"status":{"description":"The status of the payment.\n","enum":["Draft","Processing","Processed","Error","Canceled","Posted"],"type":"string"},"submittedOn":{"description":"The date and time when the payment was submitted.\n","format":"date-time","type":"string"},"type":{"description":"The type of the payment.\n","enum":["External","Electronic"],"type":"string"},"transferredToAccounting":{"description":"Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"transactionSource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework."},"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":"C_Unscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_Recurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchant-initiated transaction (MIT) that occurs at regular intervals."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_Unscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M_MOTO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-stripe-gateway-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of Stripe payment gateway integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"enum":["C_Unscheduled","M_Recurring","M_Unscheduled","M_MOTO"]},"unappliedAmount":{"type":"number","description":"The unapplied amount of the payment.\n"},"lastEmailDateTime":{"type":"string","description":"The date and time when the last email was sent to the customer for the payment.\n"},"gateway":{"type":"string","description":"Name of the gateway instance that processes the payment. \n"},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"paymentMethod":{"$ref":"#/components/schemas/NestedPaymentMethodOnExpand"},"paymentApplications":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPaymentApplication"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPaymentResponse"}},"components/schemas/ExpandedPaymentMethod":{"id":"components/schemas/ExpandedPaymentMethod","kind":"json-schema","title":"QueryPaymentMethodResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the payment method.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment method.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the payment method gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment method.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the payment method gets updated in the system.\n"},"accountId":{"type":"string","description":"The unique identifier of the account that the payment method is\nassociated with.\n"},"achAbaCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nine-digit routing number or ABA number used by banks. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"achAccountName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the account holder, which can be either a person or a company. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"achAccountNumberMask":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked bank account number associated with the ACH payment method. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"achAccountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of bank account associated with the ACH payment method. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"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 creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" preferably."},"children":[]}]}]}],"enum":["BusinessChecking","Checking","Saving"]},"achAddress1":{"type":"string","description":"First address line for the ACH payment method.\n","maxLength":255},"achAddress2":{"type":"string","description":"Second address line for the ACH payment method.\n","maxLength":255},"achBankName":{"type":"string","description":"The name of the bank where the ACH payment account is held.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.\n","maxLength":70},"achCity":{"type":"string","description":"City for the ACH payment method.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","maxLength":40},"achCountry":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country for the ACH payment method. Must be a valid country name or abbreviation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the list of supported country names and abbreviations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing."},"children":[]}]}]}],"type":"string"},"achPostalCode":{"type":"string","description":"Zip code or postal code for the ACH payment method.\n","maxLength":20},"achState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State for the ACH payment method. Must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"active":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the payment method was loaded by the system or created by the customer."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - System-loaded payment method"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Customer-created payment method"},"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":"paymentMethodStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine whether you can use a payment method for payments."},"children":[]}]}]}]}]},"isSystem":{"type":"boolean","description":"Indicates whether the payment method is a system-generated payment method. This field is for Zuora internal use and does not impact customer integration or use cases.\n"},"accountVerificationService":{"description":"Displays the name of the service provider. For example, Plaid.\n","type":"string"},"accountVerificationStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the status of the account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"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":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access token is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access token has expired and must be linked again."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expiring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Access token will expire in few days(7 days for Plaid) and must be linked again"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The end customer has revoked the account pemission. The end customer can login again and select the same method for the access token to be linked again."},"children":[]}]}]}]}],"enum":["Active","Expired","Expiring","Inactive"],"type":"string"},"bankBranchCode":{"type":"string","description":"The branch code of the bank used for Direct Debit.  \n"},"bankCheckDigit":{"description":"The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods.","type":"string"},"bankCity":{"type":"string","description":"The city of the direct debit bank."},"bankCode":{"type":"string","description":"The sort code or number that identifies the bank. This is also known as the sort code. \n"},"bankIdentificationNumber":{"type":"string","description":"The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method."},"bankName":{"type":"string","description":"The name of the direct debit bank."},"bankPostalCode":{"type":"string","description":"The zip code or postal code of the direct debit bank."},"bankStreetName":{"type":"string","description":"The name of the street of the direct debit bank."},"bankStreetNumber":{"type":"string","description":"The number of the direct debit bank."},"bankTransferAccountName":{"type":"string","description":"The name on the direct debit bank account."},"bankTransferAccountNumberMask":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a masked displayable version of the bank account number, used for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"security purposes. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"XXXXXXXXX54321"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"bankTransferAccountType":{"type":"string","description":"The type of the customer's bank account. Applicable to direct debit\npayment methods.\n"},"bankTransferType":{"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 direct debit transfer. The value of this field is dependent on the country of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible Values:"},"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":"code","inline":true,"attributes":{"content":"AutomatischIncasso"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (NL)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Germany)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Austria)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DemandeDePrelevement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (FR)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DirectDebitUK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UK)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Domicil"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Belgium)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (CH)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Italy)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrdenDeDomiciliacion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Spain)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Autogiro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Sweden)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Betalingsservice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Denmark)"},"children":[]}]}]}]}]}],"enum":["AutomatischIncasso","LastschriftDE","LastschriftAT","DemandeDePrelevement","DirectDebitUK","Domicil","LastschriftCH","RID","OrdenDeDomiciliacion","Autogiro","Betalingsservice"],"type":"string"},"businessIdentificationCode":{"type":"string","description":"The business identification code for Swiss direct payment methods that use\nthe Global Collect payment gateway. Only applicable to direct debit\npayment methods in Switzerland with Global Collect.\n"},"city":{"description":"The city of the customer's address. Applicable to debit payment methods.\n","type":"string"},"country":{"type":"string","description":"The two-letter country code of the customer's address. Applicable to direct debit payment methods."},"creditCardAddress1":{"type":"string","description":"The first line of the card holder's address, which is often a street\naddress or business name. Applicable to credit card and direct debit\npayment methods.\n"},"creditCardAddress2":{"type":"string","description":"The second line of the card holder's address. Applicable to credit card\nand direct debit payment methods.\n"},"creditCardCity":{"type":"string","description":"The city of the card holder's address. Applicable to credit card and\ndirect debit payment methods.\n"},"creditCardCountry":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country where the credit card holder stays."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regardless of the country texts selected when creating the payment method, only the supported country name returns in this field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a complete list of supported country names, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"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":"Internationalization is not supported for the API field value."},"children":[]}]}]}],"type":"string"},"creditCardExpirationMonth":{"type":"integer","format":"int32","description":"One or two digits expiration month.\n","minimum":1,"maximum":12},"creditCardExpirationYear":{"type":"integer","format":"int32","description":"Four-digit expiration year.\n"},"creditCardHolderName":{"type":"string","description":"The full name of the credit card holder.\n"},"creditCardMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked credit card number, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*********1112"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"creditCardPostalCode":{"type":"string","description":"The postal code for the address of the credit card holder.\n"},"creditCardState":{"type":"string","description":"The state where the credit card holder stays.\n"},"creditCardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the credit card or debit card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JCB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Diners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about credit card types supported by different payment gateways, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Payment Gateways"},"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":"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 only returned for the Credit Card and Debit Card payment types."},"children":[]}]}]}],"type":"string"},"deviceSessionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The session ID of the user when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created or updated."},"children":[]}]}]}],"type":"string"},"existingMandate":{"description":"Indicates whether the mandate is an existing mandate.\n","enum":["Yes","No"],"type":"string"},"email":{"description":"The email address of the payment method holder.\n","type":"string"},"firstName":{"type":"string","description":"The customer's first name. Only applicable to direct debit payment methods.\n"},"iBAN":{"type":"string","description":"The International Bank Account Number used to create the SEPA payment method. The value is masked.\n"},"iPAddress":{"type":"string","description":"The IP address of the user when the payment method was created or updated.\n"},"identityNumber":{"type":"string","description":"The identity number of the account holder or the cardholder.\n"},"companyName":{"type":"string","description":"The name of the company.\n"},"isCompany":{"type":"boolean","description":"Whether the customer account is a company.\n"},"lastFailedSaleTransactionDate":{"type":"string","format":"date","description":"The date of the last failed attempt to collect payment with this payment\nmethod.\n"},"lastName":{"type":"string","description":"The customer's last name. Only applicable to direct debit payment methods.\n"},"lastTransactionDateTime":{"type":"string","description":"The date and time of the most recent transaction.\n","format":"date-time"},"lastTransactionStatus":{"type":"string","description":"The status of the most recent transaction."},"mandateCreationDate":{"description":"The date on which the mandate was created.\n","format":"date","type":"string"},"mandateId":{"description":"The mandate ID.\n","type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","type":"string"},"mandateReceived":{"type":"string","description":"Indicates whether the mandate is received from the gateway.\n","enum":["Yes","No"]},"mandateStatus":{"type":"string","description":"The status of the mandate from the gateway side.\n"},"mandateUpdateDate":{"type":"string","format":"date","description":"The date on which the mandate was updated.\n"},"maxConsecutivePaymentFailures":{"type":"integer","format":"int32","description":"The number of allowable consecutive failures Zuora attempts with the payment method before stopping.\n"},"name":{"type":"string","description":"The name of the payment method.\n"},"numConsecutiveFailures":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of consecutive failed payments for this payment method. It is reset to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" upon successful payment."},"children":[]}]}]}]},"paymentMethodStatus":{"type":"string","description":"The status of the payment method.\n","enum":["Active","Closed","Scrubbed"]},"paymentRetryWindow":{"type":"integer","format":"int32","description":"The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.\n"},"paypalBaid":{"type":"string","description":"ID of a PayPal billing agreement. \n","example":"I-1TJ3GAGG82Y9"},"paypalEmail":{"type":"string","description":"Email address associated with the PayPal payment method. \n"},"paypalPreapprovalKey":{"type":"string","description":"The PayPal preapproval key.\n"},"paypalType":{"type":"string","description":"The type of the PayPal payment method.\n"},"phone":{"type":"string","description":"The phone number that the account holder registered with the bank. This\nfield is used for credit card validation when passing to a gateway.\n"},"postalCode":{"type":"string","description":"The zip code of the customer's address. Only applicable to direct debit\npayment methods.\n"},"secondTokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A gateway unique identifier that replaces sensitive payment method data."},"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 only returned for the Credit Card Reference Transaction payment type."},"children":[]}]}]}],"type":"string"},"state":{"type":"string","description":"The state of the customer's address. Only applicable to direct debit\npayment methods.\n"},"streetName":{"type":"string","description":"The street name of the customer's address. Only applicable to direct debit\npayment methods.\n"},"streetNumber":{"type":"string","description":"The street number of the customer's address. Only applicable to direct\ndebit payment methods.\n"},"tokenId":{"type":"string","description":"A gateway unique identifier that replaces sensitive payment method data or\nrepresents a gateway's unique customer profile. Applicable to CC Reference\nTransaction payment methods.\n"},"totalNumberOfErrorPayments":{"type":"integer","format":"int32","description":"The number of error payments that used this payment method."},"totalNumberOfProcessedPayments":{"type":"integer","format":"int32","description":"The number of successful payments that used this payment method."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the payment method. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"useDefaultRetryRule":{"type":"boolean","description":"Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.\n"},"methodReferenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query."},"children":[]}]}]}]},"userReferenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the user or customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}]},"subType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference indicating the subtype of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}]},"methodSpecificData":{"type":"string","description":"Other method-specific data of the payment method.\n"},"cardBrand":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card brand, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"cardClass":{"description":"The type of the card.\n","type":"string","enum":["ChargeCard","Credit","Debit","DeferredDebit","Prepaid"]},"cardIssuingBank":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The issuer bank of the card, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JPMORGAN CHASE BANK N.A."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cardIssuingCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The issuing country code of the card, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cardProductType":{"type":"string","description":"The product type of the card.\n","enum":["Commercial_or_Corporate_Card","Consumer_Card"]},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment Method object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPaymentMethodResponse"}},"components/schemas/ExpandedPaymentMethodSnapshot":{"id":"components/schemas/ExpandedPaymentMethodSnapshot","kind":"json-schema","title":"QueryPaymentMethodSnapshotResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the payment method snapshot.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment method snapshot.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the payment method snapshot gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment method snapshot.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the payment method snapshot gets updated in the system.\n"},"accountId":{"type":"string","description":"The unique identifier of the account that the payment method snapshot is\nassociated with.\n"},"achAbaCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nine-digit routing number or ABA number used by banks. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"achAccountName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the account holder, which can be either a person or a company. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"achAccountNumberMask":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked bank account number associated with the ACH payment method. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"achAccountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of bank account associated with the ACH payment method. This field is only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"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 creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" preferably."},"children":[]}]}]}],"enum":["BusinessChecking","Checking","Saving"]},"achAddress1":{"type":"string","description":"First address line for the ACH payment method.\n","maxLength":255},"achAddress2":{"type":"string","description":"Second address line for the ACH payment method.\n","maxLength":255},"achBankName":{"type":"string","description":"The name of the bank where the ACH payment account is held.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.\n","maxLength":70},"achCity":{"type":"string","description":"City for the ACH payment method.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n","maxLength":40},"achCountry":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country for the ACH payment method. Must be a valid country name or abbreviation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the list of supported country names and abbreviations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing."},"children":[]}]}]}],"type":"string"},"achPostalCode":{"type":"string","description":"Zip code or postal code for the ACH payment method.\n","maxLength":20},"achState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State for the ACH payment method. Must be a valid subregion (state or province) name or code. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View subregions of a specific country or region"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"active":{"type":"boolean","description":"Indicates whether the payment method type is active. This field is for Zuora internal use and does not impact customer integration or use cases.\n"},"isSystem":{"type":"boolean","description":"Indicates whether the payment method is a system-generated payment method. This field is for Zuora internal use and does not impact customer integration or use cases.\n"},"bankBranchCode":{"type":"string","description":"The branch code of the bank used for Direct Debit.  \n"},"bankCheckDigit":{"description":"The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods.","type":"string"},"bankCity":{"type":"string","description":"The city of the direct debit bank."},"bankCode":{"type":"string","description":"The sort code or number that identifies the bank. This is also known as the sort code. \n"},"bankIdentificationNumber":{"type":"string","description":"The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method."},"bankName":{"type":"string","description":"The name of the direct debit bank."},"bankPostalCode":{"type":"string","description":"The zip code or postal code of the direct debit bank."},"bankStreetName":{"type":"string","description":"The name of the street of the direct debit bank."},"bankStreetNumber":{"type":"string","description":"The number of the direct debit bank."},"bankTransferAccountName":{"type":"string","description":"The name on the direct debit bank account."},"bankTransferAccountNumberMask":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a masked displayable version of the bank account number, used for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"security purposes. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"XXXXXXXXX54321"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"bankTransferAccountType":{"type":"string","description":"The type of the customer's bank account. Applicable to direct debit\npayment methods.\n"},"bankTransferType":{"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 direct debit transfer. The value of this field is dependent on the country of the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible Values:"},"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":"code","inline":true,"attributes":{"content":"AutomatischIncasso"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (NL)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Germany)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Austria)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DemandeDePrelevement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (FR)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DirectDebitUK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UK)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Domicil"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Belgium)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LastschriftCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (CH)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Italy)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrdenDeDomiciliacion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Spain)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Autogiro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Sweden)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Betalingsservice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Denmark)"},"children":[]}]}]}]}]}],"enum":["AutomatischIncasso","LastschriftDE","LastschriftAT","DemandeDePrelevement","DirectDebitUK","Domicil","LastschriftCH","RID","OrdenDeDomiciliacion","Autogiro","Betalingsservice"],"type":"string"},"businessIdentificationCode":{"type":"string","description":"The business identification code for Swiss direct payment methods that use\nthe Global Collect payment gateway. Only applicable to direct debit\npayment methods in Switzerland with Global Collect.\n"},"city":{"description":"The city of the customer's address. Applicable to debit payment methods.\n","type":"string"},"country":{"type":"string","description":"The two-letter country code of the customer's address. Applicable to direct debit payment methods."},"creditCardAddress1":{"type":"string","description":"The first line of the card holder's address, which is often a street\naddress or business name. Applicable to credit card and direct debit\npayment methods.\n"},"creditCardAddress2":{"type":"string","description":"The second line of the card holder's address. Applicable to credit card\nand direct debit payment methods.\n"},"creditCardCity":{"type":"string","description":"The city of the card holder's address. Applicable to credit card and\ndirect debit payment methods.\n"},"creditCardCountry":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country where the credit card holder stays."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regardless of the country texts selected when creating the payment method, only the supported country name returns in this field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a complete list of supported country names, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View countries or regions"},"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":"Internationalization is not supported for the API field value."},"children":[]}]}]}],"type":"string"},"creditCardExpirationMonth":{"type":"integer","format":"int32","description":"One or two digits expiration month.\n","minimum":1,"maximum":12},"creditCardExpirationYear":{"type":"integer","format":"int32","description":"Four-digit expiration year.\n"},"creditCardHolderName":{"type":"string","description":"The full name of the credit card holder.\n"},"creditCardMaskNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The masked credit card number, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*********1112"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"creditCardPostalCode":{"type":"string","description":"The postal code for the address of the credit card holder.\n"},"creditCardState":{"type":"string","description":"The state where the credit card holder stays.\n"},"creditCardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the credit card or debit card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JCB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Diners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about credit card types supported by different payment gateways, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=payments-supported-payment-gateways"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Payment Gateways"},"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":"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 only returned for the Credit Card and Debit Card payment types."},"children":[]}]}]}],"type":"string"},"deviceSessionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The session ID of the user when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created or updated."},"children":[]}]}]}],"type":"string"},"existingMandate":{"description":"Indicates whether the mandate is an existing mandate.\n","enum":["Yes","No"],"type":"string"},"email":{"description":"The email address of the payment method holder.\n","type":"string"},"firstName":{"type":"string","description":"The customer's first name. Only applicable to direct debit payment methods.\n"},"iBAN":{"type":"string","description":"The International Bank Account Number used to create the SEPA payment method. The value is masked.\n"},"iPAddress":{"type":"string","description":"The IP address of the user when the payment method was created or updated.\n"},"identityNumber":{"type":"string","description":"The identity number of the account holder or the cardholder.\n"},"companyName":{"type":"string","description":"The name of the company.\n"},"isCompany":{"type":"boolean","description":"Whether the customer account is a company.\n"},"lastFailedSaleTransactionDate":{"type":"string","format":"date","description":"The date of the last failed attempt to collect payment with this payment\nmethod.\n"},"lastName":{"type":"string","description":"The customer's last name. Only applicable to direct debit payment methods.\n"},"lastTransactionDateTime":{"type":"string","description":"The date and time of the most recent transaction.\n","format":"date-time"},"lastTransactionStatus":{"type":"string","description":"The status of the most recent transaction."},"mandateCreationDate":{"description":"The date on which the mandate was created.\n","format":"date","type":"string"},"mandateId":{"description":"The mandate ID.\n","type":"string"},"mandateReason":{"description":"The reason of the mandate from the gateway side.\n","type":"string"},"mandateReceived":{"type":"string","description":"Indicates whether the mandate is received from the gateway.\n","enum":["Yes","No"]},"mandateStatus":{"type":"string","description":"The status of the mandate from the gateway side.\n"},"mandateUpdateDate":{"type":"string","format":"date","description":"The date on which the mandate was updated.\n"},"maxConsecutivePaymentFailures":{"type":"integer","format":"int32","description":"The number of allowable consecutive failures Zuora attempts with the payment method before stopping.\n"},"paymentMethodId":{"type":"string","description":"ID of the associated payment method.\n"},"name":{"type":"string","description":"The name of the payment method.\n"},"numConsecutiveFailures":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of consecutive failed payments for this payment method. It is reset to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" upon successful payment."},"children":[]}]}]}]},"paymentMethodStatus":{"type":"string","description":"The status of the payment method.\n","enum":["Active","Closed","Scrubbed"]},"paymentRetryWindow":{"type":"integer","format":"int32","description":"The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.\n"},"paypalBaid":{"type":"string","description":"ID of a PayPal billing agreement. \n","example":"I-1TJ3GAGG82Y9"},"paypalEmail":{"type":"string","description":"Email address associated with the PayPal payment method. \n"},"paypalPreapprovalKey":{"type":"string","description":"The PayPal preapproval key.\n"},"paypalType":{"type":"string","description":"The type of the PayPal payment method.\n"},"phone":{"type":"string","description":"The phone number that the account holder registered with the bank. This\nfield is used for credit card validation when passing to a gateway.\n"},"postalCode":{"type":"string","description":"The zip code of the customer's address. Only applicable to direct debit\npayment methods.\n"},"secondTokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A gateway unique identifier that replaces sensitive payment method data."},"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 only returned for the Credit Card Reference Transaction payment type."},"children":[]}]}]}],"type":"string"},"state":{"type":"string","description":"The state of the customer's address. Only applicable to direct debit\npayment methods.\n"},"streetName":{"type":"string","description":"The street name of the customer's address. Only applicable to direct debit\npayment methods.\n"},"streetNumber":{"type":"string","description":"The street number of the customer's address. Only applicable to direct\ndebit payment methods.\n"},"tokenId":{"type":"string","description":"A gateway unique identifier that replaces sensitive payment method data or\nrepresents a gateway's unique customer profile. Applicable to CC Reference\nTransaction payment methods.\n"},"totalNumberOfErrorPayments":{"type":"integer","format":"int32","description":"The number of error payments that used this payment method."},"totalNumberOfProcessedPayments":{"type":"integer","format":"int32","description":"The number of successful payments that used this payment method."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the payment method. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"useDefaultRetryRule":{"type":"boolean","description":"Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.\n"},"methodReferenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query."},"children":[]}]}]}]},"userReferenceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference of the user or customer account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}]},"subType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identification reference indicating the subtype of the custom payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should be mapped to a field name defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query."},"children":[]}]}]}]},"methodSpecificData":{"type":"string","description":"Other method-specific data of the payment method.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment Method Snapshot object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPaymentMethodSnapshotResponse"}},"components/schemas/ExpandedPaymentRun":{"id":"components/schemas/ExpandedPaymentRun","kind":"json-schema","title":"QueryPaymentRunResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the payment run.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment run.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the payment run gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment run.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the payment run gets updated in the system.\n"},"endDate":{"type":"string","description":"The end date of the payment run.\n"},"executedDate":{"type":"string","format":"date-time","description":"The date and time when the payment run is executed.\n"},"numberOfCreditBalanceAdjustments":{"type":"integer","format":"int32","description":[{"$$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 only available if you have the Credit Balance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of credit balance adjustments that are successfully processed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the payment run."},"children":[]}]}]}]},"numberOfErrors":{"format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of payments with the status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"numberOfInvoices":{"type":"integer","format":"int32","description":[{"$$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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of invoices that are picked up for processing in the payment run."},"children":[]}]}]}]},"numberOfPayments":{"type":"integer","format":"int32","description":"The number of payments that are successfully processed in the payment run.\n"},"numberOfUnprocessed":{"type":"integer","format":"int32","description":"The number of billing documents with remaining positive balances after the\npayment run is completed.\n"},"paymentRunNumber":{"type":"string","description":"Number of the payment run.\n"},"status":{"description":"The status of the created payment run.\n","enum":["Pending","Processing","Completed","Error","Canceled"],"type":"string"},"targetDate":{"type":"string","format":"date","description":"The target date used to determine which receivables to be collected in the\npayment run. \n"},"applyCreditBalance":{"description":"Whether to apply credit balances in the payment run. This field is only\navailable when you have Invoice Settlement feature disabled.\n","type":"boolean"},"consolidatedPayment":{"type":"boolean","description":[{"$$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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process Electronic Payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission also needs to be allowed for a Manage Payment Runs role to work. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-payments-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to process a single payment for all receivables that are due on an account."},"children":[]}]}]}]},"processPaymentWithClosedPM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to process payments even if the default payment method is closed."},"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 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process Electronic Payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission also needs to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allowed for a Manage Payment Runs role to work. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-payments-roles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"type":"boolean"},"collectPayment":{"description":"Whether to process electronic payments during the execution of payment\nruns. \n","type":"boolean"},"autoApplyCreditMemo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply a posted credit memo to one or more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receivables in the payment run."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled. The Invoice Settlement feature is generally available as of Zuora"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Release 296 (March 2021). This feature includes Unapplied"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checklist"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guide"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"type":"boolean"},"autoApplyUnappliedPayment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to automatically apply unapplied payments to  one or more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receivables in the payment run."},"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 only available if you have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled. The Invoice Settlement feature is generally available as of Zuora"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Release 296 (March 2021). This feature includes Unapplied"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to enable Invoice Settlement, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement Enablement and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checklist"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guide"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"type":"boolean"},"numberOfCreditMemos":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of credit memos that are successfully processed in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment run."},"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 only available if you have the Invoice Settlement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}]},"numberOfDebitMemos":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of debit memos that are picked up for processing in the payment run."},"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 only available if you have the Invoice Settlement feature enabled."},"children":[]}]}]}]},"numberOfDebitMemosUnprocessed":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of debit memos that are not processed in the payment run."},"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 only available if you have the Invoice Settlement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}]},"numberofUnappliedPayments":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of unapplied payments that are successfully processed in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment run."},"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 only available if you have the Invoice Settlement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]}]},"totalExecutionTime":{"type":"integer","format":"int64","description":"The total time taken to execute the payment run in milliseconds.\n"},"errorMessage":{"type":"string","description":"The detailed information of the error response.\n"},"runDate":{"type":"string","format":"date","description":"The date and time when the scheduled payment run is to be executed for\ncollecting payments.\n"},"nextRunOn":{"type":"string","format":"date","description":"The date when the next payment run is scheduled to run.\n"},"repeatType":{"type":"string","description":"The repeat type of the payment run.\n","enum":["None","Daily","Weekly","Monthly"]},"repeatFrom":{"type":"string","description":"The start date of the scheduled payment run.\n"},"repeatTo":{"type":"string","description":"The end date of of the scheduled payment run.\n"},"runTime":{"type":"integer","format":"int32","description":"The scheduled run time (hour) of day.\n","minimum":0,"maximum":23},"timeZone":{"type":"string","description":"Timezone of the scheduled payment run.\n"},"monthlyOnDay":{"type":"string","description":"The repeat day in a month.\n"},"weeklyOnDay":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The repeat day in a week."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Mon","Tue","Wed","Thu","Fri","Sat","Sun"]},"accountId":{"description":"The ID of the customer account associated with the payment run.\n","type":"string"},"batch":{"type":"string","description":"The alias name given to a batch.\n","example":"Batch1"},"billingCycleDay":{"description":"The billing cycle day (BCD), the day of the month when a bill run\ngenerates invoices for the account. \n","example":1,"type":"string"},"currency":{"description":"A currency defined in the web-based UI administrative settings.\n","example":"USD","type":"string"},"paymentGatewayId":{"type":"string","description":"The ID of the gateway instance that processes the payment.\n","format":"uuid","nullable":true},"billingRunId":{"type":"string","description":"The unique identifier of the billing run that the payment run is\nassociated with.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment Run object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPaymentRunResponse"}},"components/schemas/ExpandedPaymentSchedule":{"id":"components/schemas/ExpandedPaymentSchedule","kind":"json-schema","title":"QueryPaymentScheduleResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the payment schedule.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment schedule.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the payment schedule gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment schedule.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the payment schedule gets updated in the system.\n"},"number":{"type":"string","description":"Number of the payment schedule.\n"},"accountId":{"type":"string","description":"ID of the account that owns the payment schedule.\n"},"invoiceId":{"type":"string","description":"The unique identifier of the invoice to which the payment is applied.\n"},"debitmemoId":{"type":"string","description":"The unique identifier of the debit memo to which the payment is applied.\n"},"paymentOptionId":{"type":"string","description":"The unique identifier of the payment option that is used to process\nthe payment schedule.\n"},"startDate":{"type":"string","format":"date","description":"The date when the first payment of this payment schedule is\nproccessed.\n"},"runHour":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour in the day in the tenant’s timezone the recurring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment schedule items will be collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for custom payment schedules."},"children":[]}]}]}],"minimum":0,"maximum":23},"period":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring payment schedule only. The period of payment generation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for custom payment schedules."},"children":[]}]}]}],"nullable":true,"enum":["Monthly","Weekly","BiWeekly",null]},"prepayment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payments created by the payment schedule are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used as a reserved payment. This field is available only if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepaid cash drawdown permission is enabled. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}]},"occurrences":{"type":"integer","format":"int32","description":"The number of payment schedule items that are created by this payment schedule.\n"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the payment schedule."},"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":"Active: There is still payment schedule item to process."},"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":"Canceled: After a payment schedule is canceled by the user, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule is marked as "},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completed: After all payment schedule items are processed, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"enum":["Active","Canceled","Completed"]},"description":{"type":"string","description":"The description of the payment schedule.\n"},"nextPaymentDate":{"type":"string","format":"date","description":"The date the next payment will be processed.\n"},"recentPaymentDate":{"type":"string","format":"date","description":"The date the last payment was processed.\n"},"totalPaymentsProcessed":{"type":"integer","format":"int32","description":"The number of processed payments.\n"},"totalPaymentsErrored":{"type":"integer","format":"int32","description":"The number of errored payments.\n"},"totalAmount":{"description":"The total amount that will be collected by the payment\nschedule.            \n","type":"number"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment Schedule object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPaymentScheduleResponse"}},"components/schemas/ExpandedPaymentScheduleItem":{"id":"components/schemas/ExpandedPaymentScheduleItem","kind":"json-schema","title":"QueryPaymentScheduleItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the payment schedule item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment schedule item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the payment schedule item gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment schedule item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The time that the payment schedule item gets updated in the system.\n"},"number":{"type":"string","description":"Number of the payment schedule item.\n"},"accountId":{"type":"string","description":"ID of the account that owns the payment schedule.\n"},"invoiceId":{"type":"string","description":"The unique identifier of the invoice to which the payment is applied.\n"},"debitmemoId":{"type":"string","description":"The unique identifier of the debit memo to which the payment is applied.\n"},"paymentOptionId":{"type":"string","description":"The unique identifier of the payment option that is used to process\nthe payment schedule item.\n"},"prepayment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the payments created by the payment schedule are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used as a reserved payment. This field is available only if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepaid cash drawdown permission is enabled. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid Cash with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}]},"scheduledDate":{"type":"string","format":"date","description":"The scheduled date when the payment is processed.\n"},"runHour":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At which hour in the day in the tenant’s timezone the recurring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment schedule items will be collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for custom payment schedules."},"children":[]}]}]}],"minimum":0,"maximum":23},"paymentMethodId":{"type":"string","description":"ID of the payment method that will pay the billing documents.\n"},"paymentGatewayId":{"type":"string","nullable":true,"description":"ID of the payment gateway that processes the payment.\n"},"amount":{"type":"number","description":"The total amount of the payment schedule item.\n"},"balance":{"type":"number","description":"The remaining balance of payment schedule item.\n"},"currency":{"type":"string","description":"The currency in which the payment is made.\n\nNote: If this field was not specified, the default value is the currency set for the account.\n"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payment method of the payment schedule item."},"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":"Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment has been collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Failed to collect the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": After a pending payment schedule item is canceled by the user, the item is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Pending","Processed","Error","Canceled"],"type":"string"},"errorMessage":{"type":"string","description":"The error message indicating if the error is related to the\nconfiguration or the payment collection.\n"},"paymentId":{"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 payment that is created by the payment schedule item, or linked to the payment schedule item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only available if the request doesn’t specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to a value equal to or smaller than_"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"336.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":{"type":"string","description":"The description of the payment schedule item.\n"},"cancellationReason":{"type":"string","description":"The reason for the cancellation of payment schedule item.  \n"},"paymentScheduleId":{"type":"string","description":"ID of the payment schedule to which the payment schedule item belongs.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Payment Schedule Item object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPaymentScheduleItemResponse"}},"components/schemas/ExpandedPrepaidBalance":{"id":"components/schemas/ExpandedPrepaidBalance","kind":"json-schema","title":"QueryPrepaidBalanceResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the prepaid balance.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment application.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the payment application was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment application.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the payment application was last updated.\n"},"name":{"type":"string","description":"The name of the prepaid balance.\n"},"totalFund":{"type":"number","description":"The total amount of all prepaid balance funds.\n"},"balance":{"type":"number","description":"The current prepaid balance.\n"},"endDate":{"description":"End date of the validity period.","format":"date","type":"string"},"startDate":{"description":"Start date of the validity period.","format":"date","type":"string"},"accountId":{"type":"string","description":"The ID of the customer account to which the prepaid balance belongs.\n"},"origSubscriptionId":{"type":"string","description":"If it belongs to a subscription, the original subscription ID.\n"},"uOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The units of measure for prepayment charge. Units of measure"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are configured in the web-based UI. Your values depend on your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid unit of measure"},"children":[]}]}]}],"type":"string"},"prepaidBalanceState":{"type":"string","description":"The state of the prepaid balance. \n","enum":["ACTIVE","EXPIRED"]},"prepaidType":{"type":"integer","format":"int32","description":"The type of the prepaid balance.\n","nullable":true},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"origSubscription":{"$ref":"#/components/schemas/NestedSubscriptionOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Prepaid Balance object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPrepaidBalanceResponse"}},"components/schemas/NestedPrepaidBalanceOnExpand":{"id":"components/schemas/NestedPrepaidBalanceOnExpand","kind":"json-schema","title":"QueryPrepaidBalanceResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the prepaid balance.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the payment application.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the payment application was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the payment application.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the payment application was last updated.\n"},"name":{"type":"string","description":"The name of the prepaid balance.\n"},"totalFund":{"type":"number","description":"The total amount of all prepaid balance funds.\n"},"balance":{"type":"number","description":"The current prepaid balance.\n"},"endDate":{"description":"End date of the validity period.","format":"date","type":"string"},"startDate":{"description":"Start date of the validity period.","format":"date","type":"string"},"accountId":{"type":"string","description":"The ID of the customer account to which the prepaid balance belongs.\n"},"origSubscriptionId":{"type":"string","description":"If it belongs to a subscription, the original subscription ID.\n"},"uOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The units of measure for prepayment charge. Units of measure"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are configured in the web-based UI. Your values depend on your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid unit of measure"},"children":[]}]}]}],"type":"string"},"prepaidBalanceState":{"type":"string","description":"The state of the prepaid balance. \n","enum":["ACTIVE","EXPIRED"]},"prepaidType":{"type":"integer","format":"int32","description":"The type of the prepaid balance.\n","nullable":true},"account":{"type":"object","description":"The account associated with the prepaid balance.\n"},"origSubscription":{"type":"object","description":"The subscription associated with the prepaid balance.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Prepaid Balance object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPrepaidBalanceResponse"}},"components/schemas/NestedValidityPeriodSummaryOnExpand":{"id":"components/schemas/NestedValidityPeriodSummaryOnExpand","kind":"json-schema","title":"QueryValidityPeriodSummaryResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the validity period summary.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the validity period summary.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the validity period summary was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the validity period summary.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the validity period summary was last updated.\n"},"prepaidBalanceId":{"type":"string","description":"The unique identifier of the prepaid balance.\n"},"startDate":{"type":"string","format":"date","description":"The start date of the validity period.\n"},"endDate":{"type":"string","format":"date","description":"The end date of the validity period.\n"},"totalBalance":{"type":"number","description":"The total prepaid balance for the current validity period.\n"},"remainingBalance":{"type":"number","description":"The remaining prepaid balance for the current validity period.\n"},"totalBilledAmount":{"type":"number","description":"The total amount that has been billed.\n"},"billedBalanceAmount":{"type":"number","description":"The total amount of the billing documents balances.\n"},"subscriptionNumber":{"type":"string","description":"The number of the subscription the validity period belongs to.\n"},"uom":{"type":"string","description":"The UOM of the validity period.\n"},"accountNumber":{"type":"string","description":"The number of the account to which the prepaid balance belongs.\n"},"accountId":{"type":"string","description":"The ID of the account to which the prepaid balance belongs.\n"},"overageRatedQuantity":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overage rated quantity for the validity period."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageRatedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageRatedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields of the Validity Period Summary object are approaching end of support on  February 01, 2025. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=overageratedquantity-and-overageratedamount-fields-end-of-support","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product and feature end of support plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"overageRatedAmount":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overage rated amount for the validity period."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageRatedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageRatedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields of the Validity Period Summary object are approaching end of support on  February 01, 2025. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=overageratedquantity-and-overageratedamount-fields-end-of-support","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product and feature end of support plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"account":{"type":"object","description":"The account associated with the validty period summary.\n"},"prepaidBalance":{"type":"object","description":"The prepaid balance associated with the validity period summary.\n"},"billingTiming":{"type":"string","description":"The billing timing of the validity period.\n","enum":["In Advance","In Arrears"]}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Validity Period Summary object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryValidityPeriodSummaryResponse"}},"components/schemas/ExpandedPrepaidBalanceFund":{"id":"components/schemas/ExpandedPrepaidBalanceFund","kind":"json-schema","title":"QueryPrepaidBalanceFundResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the prepaid balance fund.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the prepaid balance fund.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the prepaid balance fund was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the prepaid balance fund.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the prepaid balance fund was last updated.\n"},"accountId":{"type":"string","description":"The ID of the customer account to which the prepaid balance fund belongs.\n"},"balance":{"type":"number","description":"The remaining balance (remaining units) on the fund.\n"},"chargeSegmentNumber":{"type":"integer","format":"int32","description":"The number of the charge segment. One prepaid balance fund can only belong to one charge segment.\n"},"endDate":{"type":"string","format":"date","description":"End date of the fund effective period.\n"},"fundedBalance":{"type":"number","description":"The total units of the fund. \n"},"fundSourceType":{"type":"string","description":"The type of the Prepaid Balance Fund.  \n","enum":["CHARGE","ORDER_LINE_ITEM","CREDIT_MEMO_ITEM","DEBIT_MEMO_ITEM"]},"fundingPrice":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price amount of a fund. A rounded value that follows the associated invoice owner's "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=rounding-and-precision-in-zuora","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency rounding rule"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (Number of billing periods in one fund validity period) * (price in one billing period)"},"children":[]}]}]}]},"totalBilled":{"type":"number","description":"The total billed amount of a fund.\n"},"totalBalance":{"type":"number","description":"The total balance of a fund.\n"},"originalTotalBalance":{"type":"number","description":"The original total balance of a fund.\n"},"originalFundingPrice":{"type":"number","description":"The original price amount of a fund.\n"},"originalFundEndDate":{"type":"string","format":"date","description":"The original end date of the fund effective period.\n"},"rolloverValidityPeriodStartDate":{"type":"string","format":"date","description":"Start date of the rollover validity period.\n"},"rolloverValidityPeriodEndDate":{"type":"string","format":"date","description":"End date of the rollover validity period.\n"},"prepaidBalanceId":{"type":"string","description":"The ID of the prepaid balance associated to which this prepaid balance fund belongs.\n"},"priority":{"type":"integer","format":"int32","description":"The priority of the Fund. Possible values include: 10(high), 50(medium),100(low)\n","enum":[10,50,100]},"sourceId":{"type":"string","description":"The source Id of the fund. It is the original charge ID. \n"},"startDate":{"type":"string","format":"date","description":"Start date of the fund effective period.\n"},"vpSummaryId":{"type":"string"},"rolloverCount":{"type":"integer","format":"int32"},"originFundId":{"type":"string"},"rolloverApplyOption":{"type":"string"},"done":{"type":"integer","format":"int32"},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"prepaidBalance":{"$ref":"#/components/schemas/NestedPrepaidBalanceOnExpand"},"source":{"$ref":"#/components/schemas/NestedRatePlanChargeOnExpand"},"vpSummary":{"$ref":"#/components/schemas/NestedValidityPeriodSummaryOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Prepaid Balance Fund object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPrepaidBalanceFundResponse"}},"components/schemas/NestedPrepaidBalanceFundOnExpand":{"id":"components/schemas/NestedPrepaidBalanceFundOnExpand","kind":"json-schema","title":"QueryPrepaidBalanceFundResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the prepaid balance fund.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the prepaid balance fund.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the prepaid balance fund was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the prepaid balance fund.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the prepaid balance fund was last updated.\n"},"accountId":{"type":"string","description":"The ID of the customer account to which the prepaid balance fund belongs.\n"},"balance":{"type":"number","description":"The remaining balance (remaining units) on the fund.\n"},"chargeSegmentNumber":{"type":"integer","format":"int32","description":"The number of the charge segment. One prepaid balance fund can only belong to one charge segment.\n"},"endDate":{"type":"string","format":"date","description":"End date of the fund effective period.\n"},"fundedBalance":{"type":"number","description":"The total units of the fund. \n"},"fundSourceType":{"type":"string","description":"The type of the Prepaid Balance Fund.  \n","enum":["CHARGE","ORDER_LINE_ITEM","CREDIT_MEMO_ITEM","DEBIT_MEMO_ITEM"]},"fundingPrice":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price amount of a fund. A rounded value that follows the associated invoice owner's "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=rounding-and-precision-in-zuora","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency rounding rule"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (Number of billing periods in one fund validity period) * (price in one billing period)"},"children":[]}]}]}]},"totalBilled":{"type":"number"},"totalBalance":{"type":"number"},"originalTotalBalance":{"type":"number"},"originalFundingPrice":{"type":"number"},"originalFundEndDate":{"type":"string","format":"date"},"rolloverValidityPeriodStartDate":{"type":"string","format":"date"},"rolloverValidityPeriodEndDate":{"type":"string","format":"date"},"prepaidBalanceId":{"type":"string","description":"The ID of the prepaid balance associated to which this prepaid balance fund belongs.\n"},"priority":{"type":"integer","format":"int32","description":"The priority of the Fund. Possible values include: 10(high), 50(medium),100(low)\n","enum":[10,50,100]},"sourceId":{"type":"string","description":"The source Id of the fund. It is the original charge ID. \n"},"startDate":{"type":"string","format":"date","description":"Start date of the fund effective period.\n"},"vpSummaryId":{"type":"string"},"rolloverCount":{"type":"integer","format":"int32"},"originFundId":{"type":"string"},"rolloverApplyOption":{"type":"string"},"done":{"type":"integer","format":"int32"},"account":{"type":"object","description":"The account associated with the prepaid balance fund.\n"},"prepaidBalance":{"type":"object","description":"The prepaid balance that contains the prepaid balance fund.\n"},"source":{"type":"object","description":"The rate plan charge associated with the prepaid balance fund.\n"},"vpSummary":{"type":"object","description":"The validity period summary associated with the prepaid balance fund.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Prepaid Balance Fund object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPrepaidBalanceFundResponse"}},"components/schemas/ExpandedPrepaidBalanceTransaction":{"id":"components/schemas/ExpandedPrepaidBalanceTransaction","kind":"json-schema","title":"QueryPrepaidBalanceTransactionResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the prepaid balance transaction.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the prepaid balance transaction.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the prepaid balance transaction was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the prepaid balance transaction.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the prepaid balance transaction was last updated.\n"},"accountId":{"type":"string","description":"The ID of the customer account on which the prepaid balance transaction occurs.\n"},"prepaidBalanceId":{"type":"string","description":"The ID of the prepaid balance.\n"},"fundId":{"type":"string","description":"The ID of the prepaid balance fund.\n"},"amount":{"type":"number","description":"The amount of units to be adjusted to the prepaid balance (could be positive or negative).\n"},"balance":{"type":"number","description":"The prepaid balance after a transaction.\n"},"sourceId":{"type":"string","description":"The transaction source id (original Charge Id, Guided Usage Id, Order Line Item Id).\n"},"transactionDate":{"type":"string","format":"date","description":"The date when the prepaid balance transaction occurs.\n"},"transactionSourceType":{"type":"string","description":"The type of the transaction source. \n","enum":["CHARGE","ORDER_LINE_ITEM","USAGE"]},"prepaidBalanceTransactionType":{"type":"string","description":"The type of the Prepaid Balance Transaction. \n","enum":["PREPAYMENT","DRAWDOWN","PREPAYMENT_ADJUSTMENT","DRAWDOWN_ADJUSTMENT","DRAWDOWN_REVERSAL","PREPAYMENT_CREDIT_BACK","PREPAYMENT_CREDIT_BACK_REVERSAL"]},"usageUom":{"type":"string"},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number","nullable":true},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"prepaidBalance":{"$ref":"#/components/schemas/NestedPrepaidBalanceOnExpand"},"fund":{"$ref":"#/components/schemas/NestedPrepaidBalanceFundOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Prepaid Balance Transaction object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryPrepaidBalanceTransactionResponse"}},"components/schemas/ExpandedProcessedUsage":{"id":"components/schemas/ExpandedProcessedUsage","kind":"json-schema","title":"QueryProcessedUsageResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the processed usage.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the processed usage.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the processed usage was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the processed usage.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the processed usage was last updated.\n"},"usageId":{"type":"string","description":"The unique identifier of the usage.\n"},"amount":{"type":"number","description":"The amount of the processed usage.\n"},"billingPeriodEndDate":{"type":"string","description":"The end date of the billing period for the processed usage.\n"},"billingPeriodStartDate":{"type":"string","description":"The start date of the billing period for the processed usage.\n"},"invoiceItemId":{"type":"string","description":"The unique identifier of the invoice item associated with the processed usage.\n"},"creditMemoItemId":{"type":"string","description":"The unique identifier of the credit memo item associated with the processed usage.\n"},"ratePlanChargeId":{"type":"string","description":"ID of the rate plan charge associated with the processed usage.\n"},"usage":{"$ref":"#/components/schemas/NestedUsageOnExpand"},"invoiceItem":{"$ref":"#/components/schemas/NestedInvoiceItemOnExpand"},"creditMemoItem":{"$ref":"#/components/schemas/NestedCreditMemoItemOnExpand"}},"type":"object","title":"QueryProcessedUsageResponse","additionalProperties":false}},"components/schemas/NestedProductRatePlanOnExpand":{"id":"components/schemas/NestedProductRatePlanOnExpand","kind":"json-schema","title":"QueryProductRatePlanResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the product rate plan.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the product rate plan.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the product rate plan was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the product rate plan.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the product rate plan was last updated.\n"},"productId":{"type":"string","description":"The unique identifier of the product to which this product rate\nplan belongs.\n"},"name":{"type":"string","description":"The name of the product rate plan.\n"},"description":{"type":"string","description":"A description of the product rate plan.\n"},"effectiveStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First date the rate plan is active (i.e., available to be subscribed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to), as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Before this date, the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotStarted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"effectiveEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final date the rate plan is active, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". After this date,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the rate plan status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"grade":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grade of the product rate plan."},"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 in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actively soliciting feedback from a small set of early adopters before"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"releasing it as generally available. If you want to join this early"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"productRatePlanNumber":{"type":"string","description":"The natural key of the product rate plan. \n"},"product":{"type":"object","description":"The product associated with the product rate plan.\n"},"productRatePlanCharges":{"type":"array","items":{"type":"object"},"description":"The product rate plan charges on the product rate plan.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product Rate Plan object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryProductRatePlanResponse"}},"components/schemas/ExpandedProduct":{"id":"components/schemas/ExpandedProduct","kind":"json-schema","title":"QueryProductResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the product.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the product.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the product was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the product.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the product was last updated.\n"},"allowFeatureChanges":{"type":"boolean","description":"Controls whether to allow your users to add or remove features while creating or amending a subscription.\n","default":false},"description":{"type":"string","description":"A description of the product. \n"},"name":{"type":"string","description":"The name of the product. This information is displayed in the product\ncatalog pages in the web-based UI.\n"},"effectiveEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product expires and can't be subscribed to anymore,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"effectiveStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product becomes available and can be subscribed to, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"sKU":{"type":"string","description":"The unique SKU for the product.\n"},"productNumber":{"type":"string","description":"The product number of the product.\n"},"category":{"type":"string","description":"Category of the product. Used by Zuora Quotes Guided Product Selector.\n","enum":["Base Products","Add On Services","Miscellaneous Products"]},"productRatePlans":{"type":"array","items":{"$ref":"#/components/schemas/NestedProductRatePlanOnExpand"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryProductResponse"}},"components/schemas/NestedProductOnExpand":{"id":"components/schemas/NestedProductOnExpand","kind":"json-schema","title":"QueryProductResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the product.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the product.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the product was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the product.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the product was last updated.\n"},"allowFeatureChanges":{"type":"boolean","description":"Controls whether to allow your users to add or remove features while creating or amending a subscription.\n","default":false},"description":{"type":"string","description":"A description of the product. \n"},"name":{"type":"string","description":"The name of the product. This information is displayed in the product\ncatalog pages in the web-based UI.\n"},"effectiveEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product expires and can't be subscribed to anymore,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"effectiveStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the product becomes available and can be subscribed to, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"sKU":{"type":"string","description":"The unique SKU for the product.\n"},"productNumber":{"type":"string","description":"The product number of the product.\n"},"category":{"type":"string","description":"Category of the product. Used by Zuora Quotes Guided Product Selector.\n","enum":["Base Products","Add On Services","Miscellaneous Products"]},"productRatePlans":{"type":"array","items":{"type":"object"},"description":"The product rate plans contained in this product."}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryProductResponse"}},"components/schemas/NestedPrpcOnExpand":{"id":"components/schemas/NestedPrpcOnExpand","kind":"json-schema","title":"QueryProductRatePlanChargeResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the product rate plan charge.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the product rate plan charge.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the product rate plan charge was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the product rate plan charge.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the product rate plan charge was last updated.\n"},"accountingCode":{"type":"string","description":"The accounting code for the charge. Accounting codes group\ntransactions that contain similar accounting attributes.\n","maxLength":100},"applyDiscountTo":{"type":"string","description":"Indicates which type of charge the discount charge applies to.\n","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE",null],"nullable":true},"chargeFunction":{"description":[{"$$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 only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"Standard: Normal charge with no Prepayment or Commitment or Drawdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepayment: For recurring charges. Unit or currency based prepaid charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown: For usage charges. Drawdown from prepaid funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"],"type":"string"},"isAllocationEligible":{"type":"boolean","description":"Indicates whether the charge segment is allocation eligible in revenue recognition. \n","default":false},"isUnbilled":{"type":"boolean","description":"Specifies how to perform the accounting during revenue recognition. \n","default":false},"applyToBillingPeriodPartially":{"description":"Allow the discount duration to be aligned with the billing period partially.\n","type":"boolean","default":false},"billCycleDay":{"type":"integer","format":"int64","description":"Sets the bill cycle day (BCD) for the charge. The BCD determines which\nday of the month customer is billed. The BCD value in the account can\noverride the BCD in this object.\n","minimum":1,"maximum":31},"billCycleType":{"description":"Specifies how to determine the billing day for the\ncharge.               \n","enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek","TermStartDay","TermEndDay"],"type":"string"},"billingPeriod":{"description":"The billing period for the charge. The start day of the billing period\nis also called the bill cycle day (BCD).\n","enum":["Month","Quarter","Annual","Semi-Annual","Specific Months","Subscription Term","Week","Specific Weeks","Specific Days"],"type":"string"},"billingPeriodAlignment":{"type":"string","description":"The billing period alignment setting for this charge.\n","enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart","AlignToTermEnd"]},"billingTiming":{"type":"string","description":"The billing timing for this charge.\n","enum":["IN_ADVANCE","IN_ARREARS"]},"chargeModel":{"description":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n","enum":["Discount-Fixed Amount","Discount-Percentage","Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Tiered Pricing","Tiered with Overage Pricing","Volume Pricing","Delivery Pricing","MultiAttributePricing","PreratedPerUnit","PreratedPricing`","HighWatermarkVolumePricing","HighWatermarkTieredPricing"],"type":"string"},"chargeType":{"description":"Specifies the type of charge.\n","enum":["OneTime","Recurring","Usage"],"type":"string"},"creditOption":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"]},"defaultQuantity":{"type":"number","nullable":true,"description":"The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n"},"deferredRevenueAccount":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the deferred revenue account for this charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100},"description":{"type":"string","description":"Description of the product rate plan charge.\n"},"discountClassId":{"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 class the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied."},"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://docs.zuora.com?resourceId=billing-manage-discount-classes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Discount Classes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account",null],"type":"string","nullable":true},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number","nullable":true},"endDateCondition":{"description":"The end date condition for this charge.\n","enum":["SubscriptionEnd","OneTime","FixedPeriod","SpecificEndDate"],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related rate plan charges and order line items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"includedUnits":{"type":"number","description":"Specifies the number of units in the base set of units.\n"},"isPrepaid":{"type":"boolean","default":false,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this charge is a prepayment (topup) charge or a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge."},"children":[]}]}]}]},"isRollover":{"type":"boolean","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It determines whether the rollover fields are needed."},"children":[]}]}]}]},"isStackedDiscount":{"type":"boolean","description":[{"$$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 only applicable to the Discount - Percentage charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates whether the discount is to be calculated as stacked discount. Possible values are 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":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is a stacked discount, which should be calculated by stacking with other discounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is not a stacked discount, which should be calculated in sequence with other discounts."},"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://docs.zuora.com?resourceId=billing-discount-charge-models"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stacked discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"legacyRevenueReporting":{"type":"boolean","description":"Indicates whether to use the legacy revenue reporting for this charge.\n"},"listPriceBase":{"description":"The list price base for the product rate plan charge.\n\nThis field is only applicable for recurring charges.\n","enum":["Per Billing Period","Per Month","Per Week","Per Year","Per Specific Months"],"type":"string"},"specificListPriceBase":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. 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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"maxQuantity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of units for this charge. This field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field can be used to create a range of units allowed in a product rate plan charge."},"children":[]}]}]}]},"minQuantity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum number of units for this charge. This field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field can be used to create a range of units allowed in a product rate plan charge."},"children":[]}]}]}]},"name":{"description":"Name of the product rate-plan charge. Not required to be unique.\n","type":"string"},"numberOfPeriod":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is ued when overage smoothing model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RollingWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rollover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"overageCalculationOption":{"description":"Value specifies when to calculate overage charges.\n","type":"string","enum":["EndOfSmoothingPeriod","PerBillingPeriod",null],"nullable":true},"overageUnusedUnitsCreditOption":{"type":"string","description":"Determines whether to credit the customer with unused units of usage.\n","enum":["NoCredit","CreditBySpecificRate"],"nullable":true},"prepaidOperationType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this charge. It is either a prepayment (topup) charge or a drawdown charge."},"children":[]}]}]}],"enum":["topup","drawdown",null],"type":"string","nullable":true},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number","nullable":true},"prepaidTotalQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of units that end customers can use during a validity period when they subscribe to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","nullable":true},"priceChangeOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies an automatic price change when a termed subscription is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"renewed and the following applies:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"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":"AutomatedPriceChange setting is on"},"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":"Charge type is not one-time"},"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":"Charge model is not discount fixed amount"},"children":[]}]}]}]}]}],"enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"type":"string","default":"NoChange","nullable":true},"priceIncreasePercentage":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PriceChangeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AutomatedPriceChange setting is on"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge type is not one-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge model is not discount fixed amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: a decimal between -100 and 100"},"children":[]}]}]}],"minimum":-100,"maximum":100,"nullable":true},"productRatePlanChargeNumber":{"type":"string","description":"The natural key of the product rate plan charge.\n"},"prorationOption":{"type":"string","description":[{"$$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 only available if you have the Charge Level Proration feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charge-level proration option for the product rate plan charge."},"children":[]}]}]}]},"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for per unit, volume pricing, and tiered pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-Time Charges and Recurring Charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string","nullable":true},"revRecTriggerCondition":{"description":"Specifies when revenue recognition begins.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate",null],"maxLength":22,"type":"string","nullable":true},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","type":"string"},"rolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period length of the rollover fund."},"children":[]}]}]}],"type":"integer","format":"int32"},"rolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"integer","format":"int64"},"recognizedRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the recognized revenue account for this charge."},"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":"Required when the Allow Blank Accounting Code setting is No."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional when the Allow Blank Accounting Code setting is Yes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"smoothingModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the smoothing model for an overage smoothing charge model or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an tiered with overage model, which is an advanced type of a usage"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"model that avoids spikes in usage charges. If a customer's usage"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"spikes in a single period, then an overage smoothing model eases"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overage charges by considering usage and multiple periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the following values shows which smoothing model will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied to the charge when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Overage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered with Overage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used:"},"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":"code","inline":true,"attributes":{"content":"RollingWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" considers a number of periods to smooth usage. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rolling window starts and increments forward based on billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequency. When allowed usage is met, then period resets and a new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"window begins."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rollover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" considers a fixed number of periods before calculating"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage. The net balance at the end of a period is unused usage, which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is carried over to the next period's balance."},"children":[]}]}]}]}]}],"type":"string","nullable":true},"specificBillingPeriod":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the billing period is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Months then this positive"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer reflects the number of months for billing period charges."},"children":[]}]}]}],"nullable":true},"taxable":{"type":"boolean","description":"Specifies whether the charge is taxable; used by Zuora Tax. \n"},"taxCode":{"type":"string","description":"Specifies the tax code for taxation rules; used by Zuora Tax.\n"},"taxMode":{"description":"Specifies how to define taxation for the charge; used by Zuora Tax.\n","enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"triggerEvent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: 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":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date specified."},"children":[]}]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance","SpecificDate"]},"upToPeriods":{"type":"integer","format":"int64","nullable":true,"description":"Specifies the length of the period during which the charge is active.\nIf this period ends before the subscription ends, the charge ends when\nthis period ends.\n\nIf the subscription end date is subsequently changed through a\nRenewal, or Terms and Conditions amendment, the charge end date will\nchange accordingly up to the original period end.\n"},"upToPeriodsType":{"description":"The period type used to define when the charge ends.\n","enum":["Billing Periods","Days","Weeks","Months","Years",null],"type":"string","nullable":true},"usageRecordRatingOption":{"description":"Determines how Zuora processes usage records for per-unit usage\ncharges. \n","type":"string","nullable":true},"useDiscountSpecificAccountingCode":{"type":"boolean","nullable":true,"description":"Determines whether to define a new accounting code for the new\ndiscount charge.\n"},"useTenantDefaultForPriceChange":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shows the tenant-level percentage uplift value for an automatic price"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"change to a termed subscription's renewal. You set the tenant uplift"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value in the web-based UI: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing > Define Default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"validityPeriodType":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period in which the prepayment units are valid to use as defined"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SubscriptionTerm","Annual","SemiAnnual","Quarter","Month"]},"weeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which day of the week as the bill cycle day (BCD) for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"priceUpsellQuantityStacked":{"type":"boolean","description":"Indicates whether the price upsell quantity is stacked.\n"},"deliveryScheduleId":{"type":"string","description":"The unique identifier of the delivery schedule associated with the\nproduct rate plan charge. This field is applicable only when this charge is\nusing Delivery Pricing charge model.\n"},"commitmentType":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the type of commitment. A prepaid charge can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A minimum commitment(in-arrears) charge can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. For topup(recurring or one-time) charges, this field indicates what type of funds are created."},"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 UNIT, it will create a fund with given prepaidUom."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If CURRENCY, it will create a fund with the currency amount calculated in list price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"]},"isCommitted":{"type":"boolean","description":"Indicates whether the charge is commited.\n"},"productRatePlanId":{"type":"string","description":"The unique identifier of the product rate plan to which this product rate plan charge belongs.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The type of the accounting code for accounts receivable.\n"},"recognizedRevenueAccountingCodeId":{"description":"The accounting code for recognized revenue, such as Monthly Recurring\nCharges or Overage Charges. \n","type":"string"},"deferredRevenueAccountingCodeId":{"description":"The type associated with the deferred revenue accounting code, such as\nDeferred Revenue. \n","type":"string","nullable":true},"adjustmentLiabilityAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment liability accounting code."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}]},"adjustmentRevenueAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment revenue accounting code."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}]},"contractAssetAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract asset accounting code."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}]},"contractLiabilityAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}]},"contractRecognizedRevenueAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}]},"unbilledReceivablesAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"revRecCode":{"description":"Associates this product rate plan charge with a specific revenue\nrecognition code.\n","maxLength":70,"type":"string","nullable":true},"uOM":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the Units of Measure (uom) configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings >"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the productRatePlanCharges."},"children":[]}]}]}],"nullable":true},"drawdownUom":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"prepaidUom":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"productRatePlan":{"type":"object","description":"The product rate plan that contains this product rate plan charge.\n"},"productRatePlanChargeTiers":{"type":"array","items":{"type":"object"},"description":"The product rate plan charge tiers contained in this product rate plan charge.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product Rate Plan Charge object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryProductRatePlanChargeResponse"}},"components/schemas/ExpandedProductRatePlan":{"id":"components/schemas/ExpandedProductRatePlan","kind":"json-schema","title":"QueryProductRatePlanResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the product rate plan.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the product rate plan.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the product rate plan was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the product rate plan.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the product rate plan was last updated.\n"},"productId":{"type":"string","description":"The unique identifier of the product to which this product rate\nplan belongs.\n"},"name":{"type":"string","description":"The name of the product rate plan.\n"},"description":{"type":"string","description":"A description of the product rate plan.\n"},"effectiveStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First date the rate plan is active (i.e., available to be subscribed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to), as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Before this date, the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotStarted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"effectiveEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final date the rate plan is active, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". After this date,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the rate plan status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"grade":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grade of the product rate plan."},"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 in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actively soliciting feedback from a small set of early adopters before"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"releasing it as generally available. If you want to join this early"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"adopter program, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"productRatePlanNumber":{"type":"string","description":"The natural key of the product rate plan. \n"},"product":{"$ref":"#/components/schemas/NestedProductOnExpand"},"productRatePlanCharges":{"type":"array","items":{"$ref":"#/components/schemas/NestedPrpcOnExpand"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product Rate Plan object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryProductRatePlanResponse"}},"components/schemas/NestedPrpcTierOnExpand":{"id":"components/schemas/NestedPrpcTierOnExpand","kind":"json-schema","title":"QueryProductRatePlanChargeTierResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the product rate plan charge tier.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the product rate plan charge tier.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the product rate plan charge tier gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the product rate plan charge tier.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the product rate plan charge tier was last updated.\n"},"active":{"type":"boolean","description":"Indicates whether the product rate plan charge tier is active.\n"},"currency":{"type":"string","description":"The valid code corresponding to the currency for the tier's price.\n"},"discountAmount":{"type":"number","description":"The specific amount for a fixed discount. This field is applicable for charges based on the Discount-Fixed Amount charge model.\n","format":"double"},"discountPercentage":{"type":"number","description":"The percentage of discount for a percentage discount. This field is applicable for charges based on the Discount-Percentage charge model.\n","format":"double"},"endingUnit":{"type":"number","description":"The end number of a range of units for the tier. This field is\napplicable for charges based on the Tiered Pricing or Tiered with\nOverage Pricing charge model.\n"},"includedUnits":{"type":"number","description":"Specifies the number of units in the base set of units.\n"},"overagePrice":{"description":"Indicates whether the price is an overage price, which is the price when usage surpasses the last defined tier.\n","format":"double","type":"number"},"price":{"type":"number","description":"The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n","format":"double"},"priceFormat":{"type":"string","description":"Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only.\n","enum":["Flat Fee","Per Unit"]},"startingUnit":{"type":"number","description":"The starting number of a range of units for the tier. This field is\napplicable for charges based on the Tiered Pricing or Tiered with\nOverage Pricing charge model.\n"},"tier":{"type":"integer","format":"int32","description":"A unique number that identifies the tier that the price applies to.\n"},"isDefault":{"type":"boolean","description":"Indicates whether the tier is the default tier. The default tier is the\ntier that is used when the usage does not fall into any of the defined\ntiers.\n"},"productRatePlanChargeId":{"type":"string","description":"The unique identifier of the product rate plan charge that the tier\nbelongs to.\n"},"productChargeDefinitionId":{"type":"string","description":"The unique identifier of the product rate plan charge definition that\nthe tier belongs to.\n"},"productRatePlanCharge":{"type":"object","description":"The product rate plan charge that contains this product rate plan charge tier.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product Rate Plan Charge Tier object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryProductRatePlanChargeTierResponse"}},"components/schemas/ExpandedProductRatePlanCharge":{"id":"components/schemas/ExpandedProductRatePlanCharge","kind":"json-schema","title":"QueryProductRatePlanChargeResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the product rate plan charge.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the product rate plan charge.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the product rate plan charge was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the product rate plan charge.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the product rate plan charge was last updated.\n"},"accountingCode":{"type":"string","description":"The accounting code for the charge. Accounting codes group\ntransactions that contain similar accounting attributes.\n","maxLength":100},"applyDiscountTo":{"type":"string","description":"Indicates which type of charge the discount charge applies to.\n","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE",null],"nullable":true},"chargeFunction":{"description":[{"$$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 only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines what type of charge it is:"},"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":"Standard: Normal charge with no Prepayment or Commitment or Drawdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepayment: For recurring charges. Unit or currency based prepaid charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown: For usage charges. Drawdown from prepaid funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CreditCommitment: For usage charges. Credit to minimum commitment funds."},"children":[]}]}]}]}],"enum":["Standard","Prepayment","CommitmentTrueUp","Drawdown","CreditCommitment","DrawdownAndCreditCommitment"],"type":"string"},"isAllocationEligible":{"type":"boolean","description":"Indicates whether the charge segment is allocation eligible in revenue recognition. \n","default":false},"isUnbilled":{"type":"boolean","description":"Specifies how to perform the accounting during revenue recognition. \n","default":false},"applyToBillingPeriodPartially":{"description":"Allow the discount duration to be aligned with the billing period partially.\n","type":"boolean","default":false},"billCycleDay":{"type":"integer","format":"int64","description":"Sets the bill cycle day (BCD) for the charge. The BCD determines which\nday of the month customer is billed. The BCD value in the account can\noverride the BCD in this object.\n","minimum":1,"maximum":31},"billCycleType":{"description":"Specifies how to determine the billing day for the\ncharge.               \n","enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek","TermStartDay","TermEndDay"],"type":"string"},"billingPeriod":{"description":"The billing period for the charge. The start day of the billing period\nis also called the bill cycle day (BCD).\n","enum":["Month","Quarter","Annual","Semi-Annual","Specific Months","Subscription Term","Week","Specific Weeks","Specific Days"],"type":"string"},"billingPeriodAlignment":{"type":"string","description":"The billing period alignment setting for this charge.\n","enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart","AlignToTermEnd"]},"billingTiming":{"type":"string","description":"The billing timing for this charge.\n","enum":["IN_ADVANCE","IN_ARREARS"]},"chargeModel":{"description":"Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n","enum":["Discount-Fixed Amount","Discount-Percentage","Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Tiered Pricing","Tiered with Overage Pricing","Volume Pricing","Delivery Pricing","MultiAttributePricing","PreratedPerUnit","PreratedPricing`","HighWatermarkVolumePricing","HighWatermarkTieredPricing"],"type":"string"},"chargeType":{"description":"Specifies the type of charge.\n","enum":["OneTime","Recurring","Usage"],"type":"string"},"creditOption":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"]},"defaultQuantity":{"type":"number","nullable":true,"description":"The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n"},"deferredRevenueAccount":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the deferred revenue account for this charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100},"description":{"type":"string","description":"Description of the product rate plan charge.\n"},"discountClassId":{"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 class the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied."},"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://docs.zuora.com?resourceId=billing-manage-discount-classes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Discount Classes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"discountLevel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account",null],"type":"string","nullable":true},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number","nullable":true},"endDateCondition":{"description":"The end date condition for this charge.\n","enum":["SubscriptionEnd","OneTime","FixedPeriod","SpecificEndDate"],"type":"string"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to exclude the related rate plan charges and order line items from revenue accounting."},"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 only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled."},"children":[]}]}]}]},"includedUnits":{"type":"number","description":"Specifies the number of units in the base set of units.\n"},"isPrepaid":{"type":"boolean","default":false,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this charge is a prepayment (topup) charge or a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge."},"children":[]}]}]}]},"isRollover":{"type":"boolean","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It determines whether the rollover fields are needed."},"children":[]}]}]}]},"isStackedDiscount":{"type":"boolean","description":[{"$$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 only applicable to the Discount - Percentage charge model."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates whether the discount is to be calculated as stacked discount. Possible values are 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":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is a stacked discount, which should be calculated by stacking with other discounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This is not a stacked discount, which should be calculated in sequence with other discounts."},"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://docs.zuora.com?resourceId=billing-discount-charge-models"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stacked discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"legacyRevenueReporting":{"type":"boolean","description":"Indicates whether to use the legacy revenue reporting for this charge.\n"},"listPriceBase":{"description":"The list price base for the product rate plan charge.\n\nThis field is only applicable for recurring charges.\n","enum":["Per Billing Period","Per Month","Per Week","Per Year","Per Specific Months"],"type":"string"},"specificListPriceBase":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. 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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per_Specific_Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"maxQuantity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of units for this charge. This field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field can be used to create a range of units allowed in a product rate plan charge."},"children":[]}]}]}]},"minQuantity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum number of units for this charge. This field and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field can be used to create a range of units allowed in a product rate plan charge."},"children":[]}]}]}]},"name":{"description":"Name of the product rate-plan charge. Not required to be unique.\n","type":"string"},"numberOfPeriod":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of periods to use when calculating charges in an overage smoothing charge model."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is ued when overage smoothing model is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RollingWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rollover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"overageCalculationOption":{"description":"Value specifies when to calculate overage charges.\n","type":"string","enum":["EndOfSmoothingPeriod","PerBillingPeriod",null],"nullable":true},"overageUnusedUnitsCreditOption":{"type":"string","description":"Determines whether to credit the customer with unused units of usage.\n","enum":["NoCredit","CreditBySpecificRate"],"nullable":true},"prepaidOperationType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this charge. It is either a prepayment (topup) charge or a drawdown charge."},"children":[]}]}]}],"enum":["topup","drawdown",null],"type":"string","nullable":true},"prepaidQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"type":"number","nullable":true},"prepaidTotalQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of units that end customers can use during a validity period when they subscribe to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","nullable":true},"priceChangeOption":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies an automatic price change when a termed subscription is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"renewed and the following applies:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"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":"AutomatedPriceChange setting is on"},"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":"Charge type is not one-time"},"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":"Charge model is not discount fixed amount"},"children":[]}]}]}]}]}],"enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"type":"string","default":"NoChange","nullable":true},"priceIncreasePercentage":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PriceChangeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AutomatedPriceChange setting is on"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge type is not one-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge model is not discount fixed amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: a decimal between -100 and 100"},"children":[]}]}]}],"minimum":-100,"maximum":100,"nullable":true},"productRatePlanChargeNumber":{"type":"string","description":"The natural key of the product rate plan charge.\n"},"prorationOption":{"type":"string","description":[{"$$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 only available if you have the Charge Level Proration feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charge-level proration option for the product rate plan charge."},"children":[]}]}]}]},"ratingGroup":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a rating group based on which usage records are rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can be applied for all charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can only be applied for per unit, volume pricing, and tiered pricing charge models."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only available if you have the Active Rating feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field only for Usage charges. One-Time Charges and Recurring Charges return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"string","nullable":true},"revRecTriggerCondition":{"description":"Specifies when revenue recognition begins.\n","enum":["ContractEffectiveDate","ServiceActivationDate","CustomerAcceptanceDate",null],"maxLength":22,"type":"string","nullable":true},"revenueRecognitionRuleName":{"description":"The name of the revenue recognition rule governing the revenue schedule.\n","type":"string"},"rolloverApply":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"],"type":"string"},"rolloverPeriodLength":{"default":null,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period length of the rollover fund."},"children":[]}]}]}],"type":"integer","format":"int32"},"rolloverPeriods":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}],"type":"integer","format":"int64"},"recognizedRevenueAccount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the recognized revenue account for this charge."},"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":"Required when the Allow Blank Accounting Code setting is No."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional when the Allow Blank Accounting Code setting is Yes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":100,"type":"string"},"smoothingModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the smoothing model for an overage smoothing charge model or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an tiered with overage model, which is an advanced type of a usage"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"model that avoids spikes in usage charges. If a customer's usage"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"spikes in a single period, then an overage smoothing model eases"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overage charges by considering usage and multiple periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the following values shows which smoothing model will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied to the charge when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Overage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tiered with Overage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used:"},"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":"code","inline":true,"attributes":{"content":"RollingWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" considers a number of periods to smooth usage. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rolling window starts and increments forward based on billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frequency. When allowed usage is met, then period resets and a new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"window begins."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rollover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" considers a fixed number of periods before calculating"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage. The net balance at the end of a period is unused usage, which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is carried over to the next period's balance."},"children":[]}]}]}]}]}],"type":"string","nullable":true},"specificBillingPeriod":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the billing period is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Months then this positive"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer reflects the number of months for billing period charges."},"children":[]}]}]}],"nullable":true},"taxable":{"type":"boolean","description":"Specifies whether the charge is taxable; used by Zuora Tax. \n"},"taxCode":{"type":"string","description":"Specifies the tax code for taxation rules; used by Zuora Tax.\n"},"taxMode":{"description":"Specifies how to define taxation for the charge; used by Zuora Tax.\n","enum":["TaxExclusive","TaxInclusive",null],"type":"string","nullable":true},"triggerEvent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: 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":"code","inline":true,"attributes":{"content":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date specified."},"children":[]}]}]}]}],"enum":["ContractEffective","ServiceActivation","CustomerAcceptance","SpecificDate"]},"upToPeriods":{"type":"integer","format":"int64","nullable":true,"description":"Specifies the length of the period during which the charge is active.\nIf this period ends before the subscription ends, the charge ends when\nthis period ends.\n\nIf the subscription end date is subsequently changed through a\nRenewal, or Terms and Conditions amendment, the charge end date will\nchange accordingly up to the original period end.\n"},"upToPeriodsType":{"description":"The period type used to define when the charge ends.\n","enum":["Billing Periods","Days","Weeks","Months","Years",null],"type":"string","nullable":true},"usageRecordRatingOption":{"description":"Determines how Zuora processes usage records for per-unit usage\ncharges. \n","type":"string","nullable":true},"useDiscountSpecificAccountingCode":{"type":"boolean","nullable":true,"description":"Determines whether to define a new accounting code for the new\ndiscount charge.\n"},"useTenantDefaultForPriceChange":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shows the tenant-level percentage uplift value for an automatic price"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"change to a termed subscription's renewal. You set the tenant uplift"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value in the web-based UI: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Billing > Define Default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"validityPeriodType":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period in which the prepayment units are valid to use as defined"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SubscriptionTerm","Annual","SemiAnnual","Quarter","Month"]},"weeklyBillCycleDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which day of the week as the bill cycle day (BCD) for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limited Availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you wish to have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access to the feature, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"priceUpsellQuantityStacked":{"type":"boolean","description":"Indicates whether the price upsell quantity is stacked.\n"},"deliveryScheduleId":{"type":"string","description":"The unique identifier of the delivery schedule associated with the\nproduct rate plan charge. This field is applicable only when this charge is\nusing Delivery Pricing charge model.\n"},"commitmentType":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the type of commitment. A prepaid charge can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A minimum commitment(in-arrears) charge can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. For topup(recurring or one-time) charges, this field indicates what type of funds are created."},"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 UNIT, it will create a fund with given prepaidUom."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If CURRENCY, it will create a fund with the currency amount calculated in list price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"]},"isCommitted":{"type":"boolean","description":"Indicates whether the charge is commited.\n"},"productRatePlanId":{"type":"string","description":"The unique identifier of the product rate plan to which this product rate plan charge belongs.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The type of the accounting code for accounts receivable.\n"},"recognizedRevenueAccountingCodeId":{"description":"The accounting code for recognized revenue, such as Monthly Recurring\nCharges or Overage Charges. \n","type":"string"},"deferredRevenueAccountingCodeId":{"description":"The type associated with the deferred revenue accounting code, such as\nDeferred Revenue. \n","type":"string","nullable":true},"adjustmentLiabilityAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment liability accounting code."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}]},"adjustmentRevenueAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the adjustment revenue accounting code."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}]},"contractAssetAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type associated with the contract asset accounting code."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}]},"contractLiabilityAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract liability."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}]},"contractRecognizedRevenueAccountingCodeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for contract recognized revenue."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}]},"unbilledReceivablesAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for unbilled receivables."},"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 only available if you have the Zuora Billing -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue Integration feature enabled."},"children":[]}]}]}],"type":"string","nullable":true},"revRecCode":{"description":"Associates this product rate plan charge with a specific revenue\nrecognition code.\n","maxLength":70,"type":"string","nullable":true},"uOM":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the Units of Measure (uom) configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings >"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the productRatePlanCharges."},"children":[]}]}]}],"nullable":true},"drawdownUom":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"prepaidUom":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"productRatePlan":{"$ref":"#/components/schemas/NestedProductRatePlanOnExpand"},"productRatePlanChargeTiers":{"type":"array","items":{"$ref":"#/components/schemas/NestedPrpcTierOnExpand"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product Rate Plan Charge object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryProductRatePlanChargeResponse"}},"components/schemas/ExpandedProductRatePlanChargeTier":{"id":"components/schemas/ExpandedProductRatePlanChargeTier","kind":"json-schema","title":"QueryProductRatePlanChargeTierResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the product rate plan charge tier.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the product rate plan charge tier.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the product rate plan charge tier gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the product rate plan charge tier.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the product rate plan charge tier was last updated.\n"},"active":{"type":"boolean","description":"Indicates whether the product rate plan charge tier is active.\n"},"currency":{"type":"string","description":"The valid code corresponding to the currency for the tier's price.\n"},"discountAmount":{"type":"number","description":"The specific amount for a fixed discount. This field is applicable for charges based on the Discount-Fixed Amount charge model.\n","format":"double"},"discountPercentage":{"type":"number","description":"The percentage of discount for a percentage discount. This field is applicable for charges based on the Discount-Percentage charge model.\n","format":"double"},"endingUnit":{"type":"number","description":"The end number of a range of units for the tier. This field is\napplicable for charges based on the Tiered Pricing or Tiered with\nOverage Pricing charge model.\n"},"includedUnits":{"type":"number","description":"Specifies the number of units in the base set of units.\n"},"overagePrice":{"description":"Indicates whether the price is an overage price, which is the price when usage surpasses the last defined tier.\n","format":"double","type":"number"},"price":{"type":"number","description":"The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n","format":"double"},"priceFormat":{"type":"string","description":"Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only.\n","enum":["Flat Fee","Per Unit"]},"startingUnit":{"type":"number","description":"The starting number of a range of units for the tier. This field is\napplicable for charges based on the Tiered Pricing or Tiered with\nOverage Pricing charge model.\n"},"tier":{"type":"integer","format":"int32","description":"A unique number that identifies the tier that the price applies to.\n"},"isDefault":{"type":"boolean","description":"Indicates whether the tier is the default tier. The default tier is the\ntier that is used when the usage does not fall into any of the defined\ntiers.\n"},"productRatePlanChargeId":{"type":"string","description":"The unique identifier of the product rate plan charge that the tier\nbelongs to.\n"},"productChargeDefinitionId":{"type":"string","description":"The unique identifier of the product rate plan charge definition that\nthe tier belongs to.\n"},"productRatePlanCharge":{"$ref":"#/components/schemas/NestedPrpcOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Product Rate Plan Charge Tier object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryProductRatePlanChargeTierResponse"}},"components/schemas/ExpandedRamp":{"id":"components/schemas/ExpandedRamp","kind":"json-schema","title":"QueryRampResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the ramp.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the ramp.\n"},"createdDate":{"type":"string","format":"date-time","description":"The time that the ramp gets created in the system.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the ramp.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the ramp was last updated.\n"},"name":{"type":"string","description":"The name of the ramp.\n"},"number":{"type":"string","description":"The number of the ramp. It is automaticcally generated by the billing system.\n"},"description":{"type":"string","description":"The short description of the ramp.\n"},"subscriptionNumbers":{"type":"string","description":"The number of the subscription that is considered as part of the ramp deal.\n"},"chargeNumbers":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of the rate plan charge. It can contain multiple charge numbers, separated by commas("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"orderId":{"type":"string","description":"The unique identifier of the order.\n"},"grossTcb":{"description":"The gross TCB value before discount charges are applied.","type":"number"},"grossTcv":{"description":"The gross TCV value before discount charges are applied.","type":"number"},"netTcb":{"description":"The net TCB value after discount charges are applied.","type":"number"},"netTcv":{"description":"The net TCV value after discount charges are applied.","type":"number"},"discountTcb":{"description":"The discount amount for the TCB.","type":"number"},"discountTcv":{"description":"The discount amount for the TCV.","type":"number"},"metricsProcessingStatus":{"type":"string","description":"Status of the metrics processing. \n","enum":["Completed","NotStarted"]}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Ramp object. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryRampResponse"}},"components/schemas/ExpandedRatePlan":{"id":"components/schemas/ExpandedRatePlan","kind":"json-schema","title":"QueryRatePlanResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the rate plan.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the rate plan.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the rate plan was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the rate plan.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the rate plan was last updated.\n"},"productId":{"type":"string","description":"The unique identifier of the product associated with the rate plan.\n"},"amendmentId":{"type":"string","description":"The unique identifier of the amendment made to the subscription.\n"},"amendmentType":{"type":"string","description":"The type of amendment associated with the rate plan. This field only applies to amendment rate plans.\n"},"name":{"type":"string","description":"The name of the rate plan.\n"},"productRatePlanId":{"type":"string","description":"The unique identifier of the product rate plan that the rate plan is based on.\n"},"subscriptionId":{"type":"string","description":"The unique identifier of the subscription associated with the rate plan.\n"},"subscriptionOwnerId":{"type":"string","description":"The unique identifier of the account that owns the subscription.\n"},"invoiceOwnerId":{"type":"string","description":"The unique identifier of the account that will pay the invoice.\n"},"reverted":{"type":"boolean","description":"Indicates whether the rate plan has been reverted.\n"},"externallyManagedPlanId":{"type":"string","description":"Indicates the unique identifier for the rate plan purchased on a\nthird-party store. This field is used to represent a subscription rate\nplan created through third-party stores.\n"},"originalRatePlanId":{"type":"string","description":"The original ID of the subscription rate plan, which is the ID of the subscription rate plan in the version-1 subscription.\n"},"subscriptionOfferId":{"type":"string","description":"The unique identifier of the subscription offer associated with the rate plan.\n"},"subscriptionRatePlanNumber":{"type":"string","description":"The number of the rate plan in the subscription.\n"},"subscription":{"$ref":"#/components/schemas/NestedSubscriptionOnExpand"},"productRatePlan":{"$ref":"#/components/schemas/NestedProductRatePlanOnExpand"},"ratePlanCharges":{"type":"array","items":{"$ref":"#/components/schemas/NestedRatePlanChargeOnExpand"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryRatePlanResponse"}},"components/schemas/NestedRatePlanOnExpand":{"id":"components/schemas/NestedRatePlanOnExpand","kind":"json-schema","title":"QueryRatePlanResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the rate plan.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the rate plan.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the rate plan was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the rate plan.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the rate plan was last updated.\n"},"productId":{"type":"string","description":"The unique identifier of the product associated with the rate plan.\n"},"amendmentId":{"type":"string","description":"The unique identifier of the amendment made to the subscription.\n"},"amendmentType":{"type":"string","description":"The type of amendment associated with the rate plan. This field only applies to amendment rate plans.\n"},"name":{"type":"string","description":"The name of the rate plan.\n"},"productRatePlanId":{"type":"string","description":"The unique identifier of the product rate plan that the rate plan is based on.\n"},"subscriptionId":{"type":"string","description":"The unique identifier of the subscription associated with the rate plan.\n"},"subscriptionOwnerId":{"type":"string","description":"The unique identifier of the account that owns the subscription.\n"},"invoiceOwnerId":{"type":"string","description":"The unique identifier of the account that will pay the invoice.\n"},"externallyManagedPlanId":{"type":"string","description":"Indicates the unique identifier for the rate plan purchased on a\nthird-party store. This field is used to represent a subscription rate\nplan created through third-party stores.\n"},"originalRatePlanId":{"type":"string","description":"The original ID of the subscription rate plan, which is the ID of the subscription rate plan in the version-1 subscription.\n"},"subscriptionOfferId":{"type":"string","description":"The unique identifier of the subscription offer associated with the rate plan.\n"},"subscriptionRatePlanNumber":{"type":"string","description":"The number of the rate plan in the subscription.\n"},"subscription":{"type":"object","description":"The subscription associated with the rate plan.\n"},"productRatePlan":{"type":"object","description":"The product rate plan associated with the rate plan.\n"},"reverted":{"type":"boolean","description":"Indicates whether the rate plan has been reverted.\n"},"ratePlanCharges":{"type":"array","items":{"type":"object"},"description":"The rate plan charges on the rate plan.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryRatePlanResponse"}},"components/schemas/ExpandedRatePlanCharge":{"id":"components/schemas/ExpandedRatePlanCharge","kind":"json-schema","title":"QueryRatePlanChargeResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the rate plan charge.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the rate plan charge.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the rate plan charge was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the rate plan charge.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the rate plan charge was last updated.\n"},"ratePlanId":{"type":"string","description":"The unique identifier of the rate plan to which this rate plan charge belongs.\n"},"productRatePlanChargeId":{"type":"string","description":"The unique identifier of the product rate plan charge associated with this product rate plan charge.\n"},"accountingCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accounting code for the charge. Accounting codes group transactions that contain similar accounting 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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.AccountingCode"},"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 value changes if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.AccountingCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not change when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.AccountingCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]}]}]}],"type":"string"},"applyDiscountTo":{"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 charges a specific discount applies to."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.ApplyDiscountTo"},"children":[]}]}]}],"type":"string"},"billCycleDay":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the charge's billing cycle day (BCD), which is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when bill runs generate invoices for charges associated with the product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate plan charge or the account."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.BillCycleDay"},"children":[]}]}]}]},"billCycleType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to determine the billing day for the charge."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.BillCycleType"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":" You can override the value inherited from the Product Rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plan Charge, but only when creating a new subscription or a New Product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amendment."},"children":[]}]}]}]},"billingPeriod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows billing period to be overridden on rate plan Charge."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": **inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.BillingPeriod"},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can override the value inherited from the Product Rate Plan Charge,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but only when creating a new subscription or a New Product amendment."},"children":[]}]}]}]},"billingPeriodAlignment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aligns charges within the same subscription if multiple charges"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"begin on different dates."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.BillingPeriodAlignment"},"children":[]}]}]}]},"billingTiming":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types."},"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":" You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type."},"children":[]}]}]}],"enum":["In Advance","In Arrears"]},"chargedThroughDate":{"type":"string","format":"date","description":"The date through which a customer has been billed for the charge.\n","maxLength":29},"chargeModel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how to evaluate charges. Charge models must be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"individually activated in the web-based UI."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.ChargeModel"},"children":[]}]}]}]},"chargeNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique number that identifies the charge. This number is returned as a string."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 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":"automatically generated if left "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a unique number of 50 characters or fewer"},"children":[]}]}]}]}],"type":"string"},"chargeType":{"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 type of charge."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.ChargeType"},"children":[]}]}]}]},"description":{"type":"string","description":"A description of the rate plan charge. \n"},"discountLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application scope of the discount charge. For example, if the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyDiscountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the discount charge applies to all recurring charges in the same subscription as the discount charge."},"children":[]}]}]}],"enum":["rateplan","subscription","account"]},"dMRC":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A delta monthly recurring charge is the change in monthly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recurring revenue caused by an amendment or a new subscription."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"drawdownRate":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"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":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"between Usage UOM and Drawdown UOM for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charge"},"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":"Must be a positive number (>0)."},"children":[]}]}]}],"type":"number"},"dTCV":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After an Amendment, the change in the total contract value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(TCV) amount for this charge, compared with its previous value."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"effectiveEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date when the rate plan charge becomes active, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"effectiveStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final date the rate plan is active, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"endDateCondition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition for the charge to become inactive."},"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":"If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the charge is active for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"predefined duration based on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the date when the charge becomes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inactive."},"children":[]}]}]}]}]}],"enum":["SubscriptionEnd","FixedPeriod","SpecificEndDate","OneTime"],"type":"string"},"estimatedStartDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated start date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"estimatedEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated end date of the pending charge in an active subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system automatically calculates the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge."},"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 available only when the Pending Subscription Processing feature is turned on."},"children":[]}]}]}]},"excludeItemBillingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both the following features are enabled in your tenant, you must ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in an Create Subscription or Add Product order action is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBillingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in this order action to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"Prepaid with Drawdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"excludeItemBookingFromRevenueAccounting":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flag to exclude rate plan charges from revenue accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both the following features are enabled in your tenant, you must ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excludeItemBookingFromRevenueAccounting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set consistently for a prepayment charge and the corresponding drawdown charge."},"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":"Prepaid with Drawdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-order-to-revenue","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order to Revenue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=revenue-billing-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Billing - Revenue Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"boolean"},"invoiceScheduleId":{"type":"string","description":"The unique identifier of the invoice schedule associated with the subscription.\n"},"isLastSegment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the segment of the rate plan charge is the most"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recent segment."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated."},"children":[]}]}]}]},"isPrepaid":{"type":"boolean","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this charge is a prepayment (topup) charge or a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge."},"children":[]}]}]}]},"isRollover":{"type":"boolean","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It determines whether the rollover fields are needed."},"children":[]}]}]}]},"rolloverPeriods":{"type":"integer","format":"int64","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the number of rollover periods, it is restricted to 3."},"children":[]}]}]}]},"rolloverPeriodLength":{"type":"integer","format":"int32","nullable":true,"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rolloverPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year."},"children":[]}]}]}]},"rolloverApply":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the priority of rollover, which is either first or last."},"children":[]}]}]}],"enum":["ApplyFirst","ApplyLast"]},"isProcessed":{"type":"boolean","description":"Indicates whether the rate plan charge has been processed.\n"},"listPriceBase":{"type":"string","description":"The list price base for the product rate plan charge.\n","enum":["Per Billing Period","Per Month","Per Week","Per Year","Per Specific Months"]},"specificListPriceBase":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of months for the list price base of the charge. This field is required if you set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"This field is available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-annual-list-price","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual List Price"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":" if you do not set the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListPriceBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Per Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"maximum":200,"minimum":1,"nullable":true},"priceUpsellQuantityStacked":{"type":"boolean"},"commitmentType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zuora-WSDL-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"133"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or higher. Otherwise, an error occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field defines the type of commitment. A prepaid charge can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A minimum commitment(in-arrears) charge can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. For topup(recurring or one-time) charges, this field indicates what type of funds are created."},"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 UNIT, it will create a fund with given prepaidUom."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If CURRENCY, it will create a fund with the currency amount calculated in list price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges."},"children":[]}]}]}],"enum":["UNIT","CURRENCY"],"type":"string"},"isCommitted":{"type":"boolean","description":"Indicates whether the rate plan charge is commited.\n"},"mRR":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly recurring revenue (MRR) is the amount of recurring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges in a given month. The MRR calculation doesn't include one-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"charges nor usage charges."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the rate plan charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 100"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"numberOfPeriods":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of periods to use when calculating charges"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in an overage smoothing charge model."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.NumberOfPeriod"},"children":[]}]}]}]},"originalId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original ID of the rate plan charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"overageCalculationOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when to calculate overage charges. If the value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the SmoothingMode field is null (not specified and not inherited from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductRatePlanCharge.SmoothingMode), the value of this field is ignored."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 20"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.OverageCalculationOption"},"children":[]}]}]}]},"overageUnusedUnitsCreditOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether to credit the customer with unused units"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of usage."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 20"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.OverageUnusedUnitsCreditOption"},"children":[]}]}]}]},"prepaidOperationType":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this charge. It is either a prepayment (topup) charge or a drawdown charge."},"children":[]}]}]}],"enum":["topup","drawdown",null],"type":"string","nullable":true},"prepaidQuantity":{"type":"number","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units included in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a positive number (>0)."},"children":[]}]}]}],"nullable":true},"prepaidTotalQuantity":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of units that end customers can use during a validity period when they subscribe to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","nullable":true},"priceChangeOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies an automatic price change when a termed subscription is renewed."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 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":"code","inline":true,"attributes":{"content":"NoChange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificPercentageValue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UseLatestProductCatalogPricing"},"children":[]}]}]}]}]},"priceIncreasePercentage":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage to increase or decrease the price"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of renewed subscriptions."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a decimal value between -100 and 100"},"children":[]}]}]}]},"processedThroughDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date until when charges have been processed. When billing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in arrears, such as usage, this field value is the the same as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargedThroughDate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value. This date is the earliest date when a charge can be amended."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"prorationOption":{"type":"string","description":"Determines how to prorate charges when a subscription is created or amended.\n"},"quantity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default quantity of units, such as the number of authors"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a hosted wiki service. Valid for all charge models except for Flat"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee pricing."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a valid quantity value"},"children":[]}]}]}]},"numberOfDeliveries":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of deliveries in the billing period for the charge segment."},"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":"numberOfDeliveries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for the Delivery Pricing charge model only."},"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 Delivery Pricing charge model is in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Adopter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable billing features by yourself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center. You can check "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable Charge Types / Models"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"ratingGroup":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rating group based on which usage records are rated. Only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicable to Usage charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible 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":"ByBillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a billing period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages on the same usage start date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageRecord"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on each usage record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByUsageUpload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the  usages in a uploaded usage file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"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":"code","inline":true,"attributes":{"content":"ByGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The rating is based on all the usages in a custom group."},"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://docs.zuora.com?resourceId=billing-usage-rating-by-group"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage rating by group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload","ByGroupId"]},"revenueRecognitionRuleName":{"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 Revenue Recognition Rule that you want the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Plan Charge to use. This field can be updated when "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default, the Revenue Recognition Rule is inherited from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Product Rate Plan Charge. For Amend calls, you can use this field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only for NewProduct amendments. For Update calls, you can use this field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only to update subscriptions in draft status. Note that if you use this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field to specify a Revenue Recognition Rule for the Rate Plan Charge,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the rule will remain as specified even if you later change the rule"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used by the corresponding Product Rate Plan Charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": n/a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevenueRecognitionRuleName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the name of an active Revenue Recognition Rule"},"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":": Unless overridden, this value changes if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevenueRecognitionRuleName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not change when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevenueRecognitionRuleName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]}]}]}]},"revenueRecognitionTiming":{"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 revenue recognition timing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"]},"revenueAmortizationMethod":{"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 revenue amortization method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revenue recognition policy configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Zuora Billing UI."},"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 only available if you have the Order to Revenue feature enabled."},"children":[]}]}]}],"maxLength":200,"type":"string","enum":["Immediate","Ratable Using Start And End Dates"]},"revRecCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associates this product rate plan charge with a specific revenue recognition code."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 70"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a valid revenue recognition code"},"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":": Unless overridden, this value changes if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not change when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]}]}]}]},"revRecTriggerCondition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when revenue recognition begins."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 22"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecTriggerCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or 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":"code","inline":true,"attributes":{"content":"ContractEffectiveDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivationDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptanceDate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Unless overridden, this value changes if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecTriggerCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RatePlanCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not change when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.RevRecTriggerCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated. \""},"children":[]}]}]}]},"segment":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifying number of the subscription rate plan segment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segments are numbered sequentially, starting with 1."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 2"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}]},"specificBillingPeriod":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizes the number of months or weeks for the charges"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing period. This field is required if you set the value of the BillingPeriod"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Specific Weeks"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.BillingPeriod"},"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":" You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment."},"children":[]}]}]}]},"specificEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific date on which the charge ends, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29"},"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":":"},"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":"This field is only applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificEndDate"},"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 subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date."},"children":[]}]}]}]}]},"tCV":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total contract value (TCV) is the value of a single rate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan charge in a subscription over the lifetime of the subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value does not represent all charges on the subscription. The TCV"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"includes recurring charges and one-time charges, but it doesn't include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 16"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"format":"double","type":"number"},"triggerDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the charge becomes effective and billing begins,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. This field is required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TriggerEvent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29"},"children":[]}]}]}],"format":"date","type":"string"},"triggerEvent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when to start billing the customer for the charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"**Note: **This field can be passed through the Subscribe and Amend calls and will override the default value set on the Product Rate Plan Charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 18"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.TriggerEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and can be 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":"ContractEffective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the date when the subscription's contract goes into effect and the charge is ready to be billed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ServiceActivation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the services or products for a subscription have been activated and the customers have access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the customer accepts the services or products for a subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SpecificDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid only on the RatePlanCharge."},"children":[]}]}]}]}],"type":"string"},"uOM":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the units to measure usage."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 25"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.UOM"},"children":[]}]}]}],"type":"string"},"upToPeriods":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inherited from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"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":":"},"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":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriodsType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period. This field is only applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"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":"You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to override the value in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProductRatePlanCharge.UpToPeriod"},"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 you override the value in this field, enter a whole number between 0 and 65535, exclusive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end."},"children":[]}]}]}]}]},"upToPeriodsType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period type used to define when the charge ends. This field can be updated when "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"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":"You must use this field together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpToPeriods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDateCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FixedPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Billing Periods","Days","Weeks","Months","Years"],"default":"Billing Periods"},"version":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the rate plan charge. Each time a charge is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amended, Zuora creates a new version of the rate plan charge."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated."},"children":[]}]}]}]},"weeklyBillCycleDay":{"description":"Specifies which day of the week as the bill cycle day (BCD) for the charge.\n","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"subscriptionId":{"type":"string","description":"The unique identifier of the subscription to which the rate plan charge belongs.\n"},"subscriptionOwnerId":{"type":"string","description":"ID of the account that owns the subscription.\n"},"invoiceOwnerId":{"type":"string","description":"ID of the account that will pay the billing documents for the subscription.\n"},"originalOrderDate":{"type":"string","format":"date","description":"The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue.\n"},"amendedByOrderOn":{"type":"string","format":"date","description":"The date when the rate plan charge is amended through an order\nor amendment. This field is to standardize the booking date\ninformation to increase audit ability and traceability of data\nbetween Zuora Billing and Zuora Revenue. It is mapped as the\nbooking date for a sale order line in Zuora Revenue.\n"},"validityPeriodType":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period in which the prepayment units are valid to use as defined in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"]},"creditOption":{"type":"string","description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The way to calculate credit. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepayment-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"enum":["TimeBased","ConsumptionBased","FullCreditBack"]},"applyToBillingPeriodPartially":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow the discount duration to be aligned with the billing period partially."},"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":": You must enable the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-manage-enhanced-discount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhanced Discounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to access this field."},"children":[]}]}]}]},"productChargeDefinitionId":{"type":"string","description":"The unique ID of the product charge definition.\n"},"accountReceivableAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the accountReceivableAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-invoice-settlement","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"deferredRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the deferredRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"recognizedRevenueAccountingCodeId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the recognizedRevenueAccountingCode of a standalone charge."},"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 available when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-zuora-finance","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Finance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" features are enabled."},"children":[]}]}]}],"type":"string"},"prepaidUOM":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepayment charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"drawdownUom":{"description":[{"$$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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of measurement for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-create-drawdown-charge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"drawdown charge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"salesPrice":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sales price associated with the rate plan charge expressed as a decimal."},"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":"Notes"},"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":"This field is only available to subscriptions that are created through orders and exist after 2023-01-10."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field applies to the following charge models, and the values vary with the charge models:"},"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":"Flat fee: the value equals the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"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":"text","inline":true,"attributes":{"content":"Per unit: the value equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"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":"Fixed amount discount: the value equals the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"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":"text","inline":true,"attributes":{"content":"Volume: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit."},"children":[]}]}]}]}]}]}]},"taxable":{"type":"boolean","description":"Indicates whether the rate plan charge is taxable.\n"},"reverted":{"type":"boolean","description":"Indicates whether the rate plan charge has been reverted.\n"},"reflectDiscountInNetAmount":{"type":"boolean","description":"Indicates whether the discount is reflected in the net amount.\n"},"ratePlan":{"$ref":"#/components/schemas/NestedRatePlanOnExpand"},"productRatePlanCharge":{"$ref":"#/components/schemas/NestedPrpcOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Rate Plan Charge object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryRatePlanChargeResponse"}},"components/schemas/ExpandedRatePlanChargeTier":{"id":"components/schemas/ExpandedRatePlanChargeTier","kind":"json-schema","title":"QueryRatePlanChargeTierResponse","data":{"properties":{"currency":{"type":"string","description":"The currency of the rate plan charge tier.\n"},"discountAmount":{"type":"number","description":"The discount amount if it is a amount-based discount.\n"},"discountPercentage":{"type":"number","description":"The discount percentage if it is a percentage-based discount.\n"},"endingUnit":{"type":"number","description":"The ending number of a range of units for the tier.\n"},"includedUnits":{"type":"number","description":"The number of units included in the tier.\n"},"overagePrice":{"type":"number","description":"The overage price. An overage occurs when usage surpasses the last defined tier. \nThis field is applicable only to tier pricing and volume pricing models.\n"},"price":{"type":"number","description":"The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the change model is tiered pricing.\n"},"priceFormat":{"type":"string","description":"Indicates if the price is a flat fee or is per unit.\n","enum":["Per Unit","Flat Fee"]},"startingUnit":{"type":"number","description":"The start number of a range of units for the tier.\n"},"tier":{"type":"integer","format":"int64","description":"A unique number that identifies the tier that the price applies to.\n"},"id":{"type":"string","description":"The unique identifier of the rate plan charge tier.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the rate plan charge tier.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the rate plan charge tier was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the rate plan charge tier.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the rate plan charge tier was last updated.\n"},"ratePlanChargeId":{"type":"string","description":"The unique identifier of the rate plan charge to which the rate plan charge tier belongs.\n"},"ratePlanCharge":{"$ref":"#/components/schemas/NestedRatePlanChargeOnExpand"}},"type":"object","title":"QueryRatePlanChargeTierResponse","additionalProperties":true}},"components/schemas/ExpandedRatingResult":{"id":"components/schemas/ExpandedRatingResult","kind":"json-schema","title":"QueryRatingResultResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the rating result.\n"},"createdByID":{"type":"string","description":"The unique identifier of the user who created the rating result.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the rating result was created in the Zuora\nsystem.\n"},"updatedByID":{"type":"string","description":"The unique identifier of the user who last updated the rating result.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the rating result was last updated.\n"},"accountId":{"type":"string","description":"The unique identifier of the customer account associated with the rating result.\n"},"subscriptionId":{"type":"string","description":"The unique identifier of the subscription associated with the rating result.\n"},"ratePlanChargeId":{"type":"string","description":"The unique identifier of the rate plan charge associated with the rating result.\n"},"quantity":{"type":"number","description":"The quantity of the charge.\n"},"amount":{"type":"number","description":"The amount of the charge.\n"},"serviceStartDate":{"type":"string","format":"date","description":"The start date of the service period for the rating result.\n"},"serviceEndDate":{"type":"string","format":"date","description":"The end date of the service period for the rating result.\n"},"status":{"type":"string","description":"The status of the rating result.\n"},"isPartial":{"type":"boolean","description":"Indicates whether the rating result is partial.\n"},"chargeSegmentNumber":{"type":"integer","format":"int32","description":"Rate plan charge number.\n"},"invoiceItemId":{"type":"string","description":"The unique identifier of the invoice item associated with the rating result.\n"},"actualPeriodStartDate":{"type":"string","format":"date","description":"The start date of the actual period for the rating result.\n"},"actualPeriodEndDate":{"type":"string","format":"date","description":"The end date of the actual period for the rating result.\n"},"billingCycleDay":{"type":"integer","format":"int32","description":"The day of the month on which the billing cycle starts.\n"},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"ratePlanCharge":{"$ref":"#/components/schemas/NestedRatePlanChargeOnExpand"},"subscription":{"$ref":"#/components/schemas/NestedSubscriptionOnExpand"},"invoiceItem":{"$ref":"#/components/schemas/NestedInvoiceItemOnExpand"}},"type":"object","title":"QueryRatingResultResponse","additionalProperties":false}},"components/schemas/NestedRefundApplicationOnExpand":{"id":"components/schemas/NestedRefundApplicationOnExpand","kind":"json-schema","title":"QueryRefundApplicationResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the refund application.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the refund application.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the refund application was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the refund application.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the refund application was last updated.\n"},"accountId":{"type":"string","description":"The ID of the account associated with this refund application. \n"},"applicationGroupId":{"type":"string","description":"The ID of the application group to which this payment application belongs.\n"},"applyAmount":{"type":"number","description":"The total amount of the refund to be applied.\n","format":"double"},"creditMemoId":{"type":"string","description":"The unique identifier of the credit memo to which the associated payment was applied.\n"},"effectiveDate":{"type":"string","format":"date","description":"The date when the refund application becomes effective.\n"},"invoiceId":{"type":"string","description":"The unique identifier of the invoice to which the associated payment was applied.\n"},"paymentId":{"type":"string","description":"The unique identifier of the payment associated with the refund application.\n"},"refundId":{"type":"string","description":"The unique identifier of the refund associated with the refund application.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The Account Receivable accounting code of a standalone charge.\n"},"onAccountAccountingCodeId":{"description":"The accounting code that maps to an on account in your accounting\nsystem.\n","type":"string"},"unappliedPaymentAccountingCodeId":{"type":"string","description":"The accounting code for the unapplied payment.\n"},"cashAccountingCodeId":{"type":"string","description":"The accounting code for cash payments.\n"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this transaction.\n"},"refund":{"type":"object","description":"The refund associated with the refund application.\n"},"payment":{"type":"object","description":"The payment associated with the refund application.\n"},"refundApplicationItems":{"type":"array","items":{"type":"object"},"description":"The refund application items contained in the refund application.\n"}},"type":"object","title":"QueryRefundApplicationResponse","additionalProperties":false}},"components/schemas/ExpandedRefund":{"id":"components/schemas/ExpandedRefund","kind":"json-schema","title":"QueryRefundResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the refund.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the refund.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the refund was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the refund.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the refund was last updated.\n"},"accountId":{"description":"The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.\n","type":"string"},"amount":{"description":"The total amount of the refund.\n","format":"double","type":"number"},"cancelledOn":{"description":"The date and time when the refund was cancelled.\n","format":"date-time","type":"string"},"comment":{"description":"Comments about the refund.\n","type":"string","nullable":true},"paymentMethodSnapshotId":{"type":"string","description":"The unique ID of the payment method snapshot which is a copy of the particular payment method used in a transaction.\n"},"accountingCode":{"type":"string","description":"The accounting code that maps to this refund transaction in your accounting\nsystem.\n"},"currency":{"type":"string","description":"The currency of the refund.\n"},"gatewayReconciliationReason":{"description":"The reason of gateway reconciliation.\n","type":"string"},"gatewayReconciliationStatus":{"description":"The status of gateway reconciliation.\n","type":"string"},"gatewayResponse":{"description":"The message returned from the payment gateway for the refund. This\nmessage is gateway-dependent.\n","type":"string"},"gatewayResponseCode":{"description":"The code returned from the payment gateway for the refund. This code\nis gateway-dependent.\n","type":"string"},"gatewayState":{"description":"The status of the refund in the gateway. \n","enum":["MarkedForSubmission","Submitted","Settled","NotSubmitted","FailedToSettle"],"type":"string"},"markedForSubmissionOn":{"description":"The date and time when a refund was marked and waiting for batch submission to the payment process.\n","format":"date-time","type":"string"},"methodType":{"description":"How an external refund was issued to a customer. \n","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"paymentMethodId":{"type":"string","description":"The unique ID of the payment method that the customer used to make the refund.\n"},"payoutId":{"type":"string","description":"The payout ID of the refund from the gateway side.\n"},"reasonCode":{"type":"string","description":"A code identifying the reason for the transaction.\n"},"refundNumber":{"type":"string","description":"The number of the refund.\n"},"referenceID":{"description":"The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n","type":"string"},"refundDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the refund takes effect, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, 2017-03-01."},"children":[]}]}]}],"format":"date","type":"string"},"refundTransactionTime":{"description":"The date and time when the refund was issued.\n","format":"date-time","type":"string"},"sourceType":{"type":"string","description":"Specifies whether the refund is a refund payment or a credit balance. \n","enum":["Payment","CreditBalance","CreditMemo"]},"secondRefundReferenceId":{"description":"The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n","type":"string"},"settledOn":{"description":"The date and time when the refund was settled in the payment processor. This field is used by the Spectrum gateway only and not applicable to other gateways.\n","format":"date-time","type":"string"},"softDescriptor":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string"},"softDescriptorPhone":{"description":"A payment gateway-specific field that maps Zuora to other gateways.\n","type":"string"},"status":{"description":"The status of the refund. \n","enum":["Processed","Canceled","Error","Processing"],"type":"string"},"submittedOn":{"type":"string","description":"The date and time when the refund was submitted.\n","format":"date-time"},"transferredToAccounting":{"description":"Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n","enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"type":{"type":"string","description":"The type of the refund. \n","enum":["External","Electronic"]},"associatedTransactionNumber":{"type":"string","description":"The number of the associated transactions, such as payments.\n"},"gateway":{"type":"string","description":"The gateway that processed the original payment. A gateway is an online service provider that connects an online shopping cart to a payment processor.\nZuora uses this same gateway for the corresponding refund. \nIf this payment gateway is no longer active, then the electronic refund fails. \n"},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"paymentMethod":{"$ref":"#/components/schemas/NestedPaymentMethodOnExpand"},"refundApplications":{"type":"array","items":{"$ref":"#/components/schemas/NestedRefundApplicationOnExpand"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Refund object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryRefundResponse"}},"components/schemas/NestedRefundApplicationItemOnExpand":{"id":"components/schemas/NestedRefundApplicationItemOnExpand","kind":"json-schema","title":"QueryRefundApplicationItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the refund application item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the refund application item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the refund application item was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the refund application item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the refund application item was last updated.\n"},"amount":{"type":"number","description":"The amount of the refund application item.\n"},"effectiveDate":{"type":"string","format":"date","description":"The date when the refund application item becomes effective.\n"},"applicationGroupId":{"type":"string","description":"The ID of the application group to which this refund application belongs.\n"},"refundApplicationId":{"type":"string","description":"The ID of the refund application to which this refund application item belongs.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The Account Receivable accounting code of a standalone charge.\n"},"onAccountAccountingCodeId":{"description":"The accounting code that maps to an on account in your accounting system.\n","type":"string"},"unappliedPaymentAccountingCodeId":{"type":"string","description":"The accounting code for the unapplied payment.\n"},"cashAccountingCodeId":{"type":"string","description":"The accounting code for cash payments.\n"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this transaction.\n"},"creditTaxationItemId":{"type":"string","description":"The unique identifier of the credit taxation item to which the refund application item is applied.\n"},"creditMemoItemId":{"type":"string","description":"The unique identifier of the credit memo item to which the refund application item is applied.\n"},"refundApplication":{"type":"object","description":"The refund application object that contains the refund application item.\n"}},"type":"object","title":"QueryRefundApplicationItemResponse","additionalProperties":false}},"components/schemas/ExpandedRefundApplication":{"id":"components/schemas/ExpandedRefundApplication","kind":"json-schema","title":"QueryRefundApplicationResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the refund application.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the refund application.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the refund application was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the refund application.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the refund application was last updated.\n"},"accountId":{"type":"string","description":"The ID of the account associated with this refund application. \n"},"applicationGroupId":{"type":"string","description":"The ID of the application group to which this payment application belongs.\n"},"applyAmount":{"type":"number","description":"The total amount of the refund to be applied.\n","format":"double"},"creditMemoId":{"type":"string","description":"The unique identifier of the credit memo to which the associated payment was applied.\n"},"effectiveDate":{"type":"string","format":"date","description":"The date when the refund application becomes effective.\n"},"invoiceId":{"type":"string","description":"The unique identifier of the invoice to which the associated payment was applied.\n"},"paymentId":{"type":"string","description":"The unique identifier of the payment associated with the refund application.\n"},"refundId":{"type":"string","description":"The unique identifier of the refund associated with the refund application.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The accountReceivableAccountingCode of a standalone charge.\n"},"onAccountAccountingCodeId":{"description":"The accounting code that maps to an on account in your accounting\nsystem.\n","type":"string"},"unappliedPaymentAccountingCodeId":{"type":"string","description":"The accounting code for the unapplied payment.\n"},"cashAccountingCodeId":{"type":"string","description":"The accounting code for cash payments.\n"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this transaction.\n"},"refund":{"$ref":"#/components/schemas/NestedRefundOnExpand"},"payment":{"$ref":"#/components/schemas/NestedPaymentOnExpand"},"refundApplicationItems":{"type":"array","items":{"$ref":"#/components/schemas/NestedRefundApplicationItemOnExpand"}}},"type":"object","title":"QueryRefundApplicationResponse","additionalProperties":false}},"components/schemas/ExpandedRefundApplicationItem":{"id":"components/schemas/ExpandedRefundApplicationItem","kind":"json-schema","title":"QueryRefundApplicationItemResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the refund application item.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the refund application item.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the refund application item was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the refund application item.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the refund application item was last updated.\n"},"amount":{"type":"number","description":"The amount of the refund application item.\n"},"effectiveDate":{"type":"string","format":"date","description":"The date when the refund application item becomes effective.\n"},"applicationGroupId":{"type":"string","description":"The ID of the application group to which this refund application belongs.\n"},"refundApplicationId":{"type":"string","description":"The ID of the refund application to which this refund application item belongs.\n"},"accountReceivableAccountingCodeId":{"type":"string","description":"The Account Receivable accounting code of a standalone charge.\n"},"onAccountAccountingCodeId":{"description":"The accounting code that maps to an on account in your accounting system.\n","type":"string"},"unappliedPaymentAccountingCodeId":{"type":"string","description":"The accounting code for the unapplied payment.\n"},"cashAccountingCodeId":{"type":"string","description":"The accounting code for cash payments.\n"},"journalEntryId":{"type":"string","description":"The ID of the journal entry that corresponds to this transaction.\n"},"creditTaxationItemId":{"type":"string","description":"The unique identifier of the credit taxation item to which the refund application item is applied.\n"},"creditMemoItemId":{"type":"string","description":"The unique identifier of the credit memo item to which the refund application item is applied.\n"},"refundApplication":{"$ref":"#/components/schemas/NestedRefundApplicationOnExpand"}},"type":"object","title":"QueryRefundApplicationItemResponse","additionalProperties":false}},"components/schemas/ExpandedSummaryStatementRun":{"id":"components/schemas/ExpandedSummaryStatementRun","kind":"json-schema","title":"ExpandedSummaryStatementRun","data":{"properties":{"accountId":{"description":"The unique identifier for the statement account.\n","type":"string"},"autoEmailEnabled":{"description":"Indicates whether automatic emails are enabled.\n","type":"string"},"batchName":{"description":"The name of the batch used to filter accounts, for example, Batch1.\n","type":"string"},"billCycleDay":{"description":"The bill cycle day for filtering accounts, represented as a number, for example '01' to '31'.\n","nullable":true,"type":"string"},"createdDate":{"description":"The date and time when the summary statement run was created.\n","format":"dateTime","type":"string"},"updatedDate":{"description":"The date and time when the summary statement run was last updated.\n","format":"dateTime","type":"string"},"createdById":{"description":"The user ID of the person who created the summary statement run.\n","type":"string"},"updatedById":{"description":"The user ID of the person who last updated the summary statement run.\n","type":"string"},"dateRangeType":{"description":"The type of date range used for the statement.\n","enum":["Custom","PreviousOneCalendarMonth","PreviousThreeCalendarMonth"],"type":"string"},"deleted":{"description":"Indicates whether the statement has been deleted.\n","type":"string"},"description":{"description":"A description of the summary statement run.\n","type":"string"},"endDate":{"description":"The end date of the statement in the format YYYY-MM-DD.\n","format":"date","type":"string"},"id":{"description":"The unique identifier of the statement.\n","type":"string"},"numberOfAccounts":{"description":"The number of accounts being processed in the summary statement run.\n","type":"string"},"runType":{"description":"The type of summary statement run.\n","enum":["AdHoc","Scheduled"],"type":"string"},"startDate":{"description":"The start date of the statement in the format YYYY-MM-DD.\n","format":"date","type":"string"},"statementRunNumber":{"description":"The unique number assigned to this statement run.\n","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the statement, with possible 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":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GenerationCompleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completed (indicates PDF generation is completed and emails are triggered if AutoEmailEnabled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For AutoEmailEnabled, the possible values are Pending, Processing, GenerationCompleted, Completed, Error"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For AutoEmailDisabled, the possible values are Pending, Processing, Completed"},"children":[]}]}]}],"enum":["Pending","Processing","GenerationCompleted","Completed","Error","Terminated"],"type":"string"},"targetAccountCategory":{"description":"The method used to filter accounts.\n","enum":["SingleAccount","AllAccounts","AccountsWithOpenInvoices","AccountsWithOpenBalances","AccountsWithoutInvoices","AccountsWithoutInvoicesAndOpenBalances"],"type":"string"},"errorCategory":{"description":"The category of error when the operation fails.\n","type":"string"},"errorMessage":{"description":"The specific error message when the operation fails.\n","type":"string"},"success":{"description":"Indicates whether the call succeeded.","type":"boolean"},"statementDate":{"description":"The date of the statement in the format YYYY-MM-DD.\n","format":"date","type":"string"},"statementNumber":{"description":"The unique number assigned to the statement.\n","type":"string"},"statementRunId":{"description":"ID of the statement run.\n","type":"string"},"emailStatus":{"type":"string","description":"The email status of the statement.\n"}},"type":"object"}},"components/schemas/ExpandedSummaryStatement":{"id":"components/schemas/ExpandedSummaryStatement","kind":"json-schema","title":"ExpandedSummaryStatement","data":{"properties":{"accountId":{"description":"The unique identifier for the statement account.\n","type":"string"},"autoEmailEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to send an email after a statement is generated. Acceptable values are "},"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":". If unspecified, the default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"description":{"description":"A text description of the statement run.\n","type":"string"},"batchName":{"description":"Name of the batch.","type":"string","nullable":true},"billCycleDay":{"description":"The bill cycle day for filtering accounts, with values ranging from '01' to '31'.\n","nullable":true,"type":"string"},"dateRangeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date range for the statement."},"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":"PreviousThreeCalendarMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PreviousOneCalendarMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected, the start and end dates are automatically calculated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PreviousThreeCalendarMonth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is chosen today (2024-08-20), the dates would be 2024-05-01 to 2024-07-31."},"children":[]}]}]}],"enum":["Custom","PreviousThreeCalendarMonth","PreviousOneCalendarMonth"],"type":"string"},"runType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled type of the run which can either be AdHoc or Scheduled. Currently, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdHoc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]}],"enum":["AdHoc"],"type":"string"},"createdById":{"description":"The ID of the user who created the statement.\n","type":"string"},"createdDate":{"description":"The date and time when the statement was created.\n","format":"dateTime","type":"string"},"deleted":{"description":"Indicates whether the statement has been deleted.\n","type":"string"},"endDate":{"description":"The end date of the statement in the format YYYY-MM-DD.\n","format":"date","type":"string"},"fileId":{"description":"The ID associated with the file generated for the statement.\n","type":"string"},"id":{"description":"The unique identifier of the statement.\n","type":"string"},"startDate":{"description":"The start date of the statement in the format YYYY-MM-DD.\n","format":"date","type":"string"},"emailStatus":{"type":"string","description":"The email status of the statement.\n"},"statementDate":{"description":"The date of the statement in the format YYYY-MM-DD.\n","format":"date","type":"string"},"statementNumber":{"description":"The unique number assigned to the statement.\n","type":"string"},"statementRunNumber":{"description":"The number of the related statement run.\n","type":"string"},"statementRunId":{"description":"The ID of the related statement run.\n","type":"string"},"status":{"description":"The current status of the statement.\n","enum":["Pending","Processing","Completed","Error","Terminated"],"type":"string"},"targetAccountCategory":{"type":"string","description":"The method used to filter accounts.\n","enum":["SingleAccount","AllAccounts","AccountsWithOpenInvoices","AccountsWithOpenBalances","AccountsWithoutInvoices","AccountsWithoutInvoicesAndOpenBalances"]},"updatedById":{"description":"The ID of the user who last updated the statement.\n","type":"string"},"updatedDate":{"description":"The date and time when the statement was last updated.\n","format":"dateTime","type":"string"},"errorCategory":{"description":"The category of error when the operation fails.\n","type":"string"},"errorMessage":{"description":"The specific error message when the operation fails.\n","type":"string"},"success":{"description":"Indicates whether the call succeeded.","type":"boolean"}},"type":"object"}},"components/schemas/ExpandedSubscription":{"id":"components/schemas/ExpandedSubscription","kind":"json-schema","title":"QuerySubscriptionResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the subscription.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the subscription.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the subscription was created in the Zuora\nsystem.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the subscription.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the subscription was last updated.\n"},"accountId":{"type":"string","description":"The ID of the account associated with this subscription."},"autoRenew":{"type":"boolean","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscription automatically renews at the end of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"term."},"children":[]}]}]}],"default":false},"cancelledDate":{"type":"string","format":"date","description":"The date on which the subscription was canceled.\n"},"contractAcceptanceDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the customer accepts the contract, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"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 not set:"},"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":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not set, the value of this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field is set to be the contract effective date."},"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":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set, the value of this field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is set to be the service activation date."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractEffectiveDate <= serviceActivationDate <="},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractAcceptanceDate"},"children":[]}]}]}]},"contractEffectiveDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription is activated, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must specify a Service Activation date if the Customer Acceptance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date is set. If the Customer Acceptance date is not set, the value of"},"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":"serviceActivationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field defaults to be the Contract"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Effective Date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing trigger dates must follow this rule:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractEffectiveDate <= serviceActivationDate <="},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractAcceptanceDate"},"children":[]}]}]}]},"creatorAccountId":{"type":"string","description":"The ID of the account that created the subscription. This field is\nautomatically populated with the ID of the account that creates the\nsubscription.\n"},"creatorInvoiceOwnerId":{"type":"string","description":"The account ID that owns the invoices associated with the subscription or the amended subscription.\n"},"currentTerm":{"type":"integer","format":"int64","description":"The length of the period for the current subscription term.\n"},"currentTermPeriodType":{"type":"string","description":"The period type for the current subscription term.\n","enum":["Month","Year","Day","Week"],"default":"Month"},"initialTerm":{"type":"integer","format":"int64","description":"The length of the period for the initial subscription term.\n"},"initialTermPeriodType":{"type":"string","description":"The period type for the first subscription term.\n","enum":["Month","Year","Day","Week"],"default":"Month"},"invoiceOwnerId":{"type":"string","description":"The account ID that owns the invoices associated with the subscription. \n"},"isInvoiceSeparate":{"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":"Determines if the subscription is invoiced separately."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then all charges for this subscription are collected into the subscription's own invoice."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the subscription.\n"},"notes":{"type":"string","description":"Additional information about the subscription.\n","maxLength":65535},"originalCreatedDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription was originally created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is the same as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value until the subscription is amended."},"children":[]}]}]}]},"originalId":{"type":"string","description":"The original rate plan charge ID. Only available for update\nsubscription.\n"},"previousSubscriptionId":{"type":"string","description":"The ID of the previous subscription. This field is only available if\nthe subscription is a renewal subscription.\n"},"renewalSetting":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether a termed subscription will remain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or change to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it is renewed."},"children":[]}]}]}],"enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"default":"RENEW_WITH_SPECIFIC_TERM"},"renewalTerm":{"type":"integer","format":"int64","description":"The length of the period for the subscription renewal term.\n"},"renewalTermPeriodType":{"type":"string","description":"The period type for the subscription renewal term.\n","enum":["Month","Year","Day","Week"],"default":"Month"},"revision":{"type":"string","description":"An auto-generated decimal value uniquely tagged with a subscription.\nThe value always contains one decimal place, for example, the revision\nof a new subscription is 1.0. If a further version of the subscription\nis created, the revision value will be increased by 1. Also, the\nrevision value is always incremental regardless of deletion of\nsubscription versions.\n"},"serviceActivationDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the services or products within a subscription have been activated and access has been provided to the customer, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"status":{"type":"string","description":"Subscription status.\n","enum":["Draft","Pending Activation","Pending Acceptance","Active","Cancelled","Suspended"]},"isLatestVersion":{"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current subscription object is the latest version."},"children":[]}]}]}],"type":"boolean"},"subscriptionEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the subscription term ends, where the subscription ends"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at midnight the day before."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 12/31/2016, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptions ends at midnight (00:00:00 hours) on 12/30/2016."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This date is the same as the term end date or the cancelation date, as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"appropriate."},"children":[]}]}]}]},"subscriptionStartDate":{"type":"string","format":"date","description":"Date the subscription becomes effective.\n"},"subscriptionVersionAmendmentId":{"type":"string","description":"The ID of the amendment made to this subscription version.\n"},"termEndDate":{"type":"string","format":"date","description":"Date the subscription term ends. If the subscription is evergreen,\nthis is null or is the cancellation date (if one has been set).\n"},"termStartDate":{"type":"string","format":"date","description":"Date the subscription term begins. If this is a renewal subscription,\nthis date is different from the subscription start date.\n"},"termType":{"type":"string","description":"The type of the subscription term.\n","enum":["TERMED","EVERGREEN"]},"version":{"type":"integer","format":"int64","description":"This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment."},"cMRR":{"type":"number","description":"Monthly recurring revenue of the subscription.\n"},"billToContactSnapshotId":{"type":"string","description":"The ID of the bill-to contact snapshot.\n"},"billToContactId":{"type":"string","description":"The ID of the bill-to contact for the subscription.\n"},"invoiceTemplateId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice template associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Template from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}]},"sequenceSetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the sequence set associated with the subscription."},"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":":"},"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 you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Billing Attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature disabled, this field is unavailable in the request body and 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":" in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default Set from Account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this field during subscription creation, the value of this field is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response body."},"children":[]}]}]}]}],"type":"string","nullable":true},"shipToContactId":{"type":"string","description":"The ID of the ship-to contact for the subscription.\n"},"shipToContactSnapshotId":{"type":"string","description":"The ID of the ship-to contact snapshot.\n"},"soldToContactId":{"type":"string","description":"The ID of the sold-to contact for the subscription.\n"},"soldToContactSnapshotId":{"type":"string","description":"The ID of the sold-to contact snapshot.\n"},"externallyManagedBy":{"type":"string","description":"An enum field on the Subscription object to indicate the name of a\nthird-party store. This field is used to represent subscriptions created\nthrough third-party stores.\n","enum":["Amazon","Apple","Google","Roku"]},"lastBookingDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last booking date of the subscription object. This field is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"writable only when the subscription is newly created as a first"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"version subscription. You can override the date value when creating a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription through the Subscribe and Amend API or the subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creation UI (non-Orders). Otherwise, the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per the user's timezone. The value of this field is as follows:"},"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":"For a new subscription created by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-apis-subscribe-and-amend"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe and Amend"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs"},"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 field has the value of the subscription creation date."},"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":"For a subscription changed by an amendment, this field has the value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the amendment booking date."},"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":"For a subscription created or changed by an order, this field has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the value of the order date."},"children":[]}]}]}]}]}],"format":"date","type":"string"},"invoiceScheduleId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the invoice schedule associated with the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple invoice schedules are created for different terms of a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription, this field stores the latest invoice schedule."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-billing-schedule-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"cancelReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for a subscription cancellation copied from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of a Cancel Subscription order action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains valid value only if a subscription is cancelled"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"through the Orders UI or API. Otherwise, the value for this field will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"prepayment":{"type":"boolean","description":"Whether the subscription is prepaid.\n"},"currency":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency of the subscription."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-multiple-currencies-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}],"type":"string"},"orderId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the order associated with the subscription."},"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 available only for orders that exist after the end of June 2023."},"children":[]}]}]}],"type":"string"},"rampId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the ramp object associated with the subscription."},"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 available only if you have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-overview-ramp-and-ramp-metrics","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ramp"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled."},"children":[]}]}]}]},"paymentTerm":{"type":"string","description":"Name of the payment term associated with the account. For example,\n\"Net 30\". The payment term determines the due dates of invoices.\n"},"quoteNumber__QT":{"type":"string","description":"The unique identifier of the Quote. This field is used in Zuora data\nsources to report on Subscription metrics. If the subscription originated\nfrom Zuora Quotes, the value is populated with the value from Zuora\nQuotes.\n","maxLength":32},"quoteType__QT":{"description":"The Quote type that represents the subscription lifecycle stage such as\nNew, Amendment, Renew or Cancel. This field is used in Zuora data sources\nto report on Subscription metrics. If the subscription originated from\nZuora Quotes, the value is populated with the value from Zuora Quotes.\n","maxLength":32,"type":"string"},"quoteBusinessType__QT":{"type":"string","description":"The specific identifier for the type of business transaction the Quote\nrepresents such as New, Upsell, Downsell, Renewal or Churn. This field is\nused in Zuora data sources to report on Subscription metrics. If the\nsubscription originated from Zuora Quotes, the value is populated with the\nvalue from Zuora Quotes.\n","maxLength":32},"opportunityName__QT":{"type":"string","description":"The unique identifier of the Opportunity. This field is used in Zuora data\nsources to report on Subscription metrics. If the subscription originated\nfrom Zuora Quotes, the value is populated with the value from Zuora\nQuotes.\n","maxLength":100},"opportunityCloseDate__QT":{"type":"string","format":"date"},"cpqBundleJsonId__QT":{"description":"The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.\n","maxLength":32,"type":"string"},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"invoiceOwner":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"billToContact":{"$ref":"#/components/schemas/ExpandedContact"},"soldToContact":{"$ref":"#/components/schemas/ExpandedContact"},"invoiceItems":{"type":"array","items":{"$ref":"#/components/schemas/NestedInvoiceItemOnExpand"}},"ratePlans":{"type":"array","items":{"$ref":"#/components/schemas/NestedRatePlanOnExpand"}}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Subscription object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QuerySubscriptionResponse"}},"components/schemas/ExpandedUsage":{"id":"components/schemas/ExpandedUsage","kind":"json-schema","title":"QueryUsageResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the usage.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the usage.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the usage was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the usage.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the usage was last updated.\n"},"accountId":{"type":"string","description":"The ID of the customer account associated with the usage.\n"},"accountNumber":{"type":"string","description":"The number of the customer account associated with the usage.\n"},"ratePlanChargeId":{"type":"string","description":"ID of the rate plan charge that pays for this usage.\n"},"endDateTime":{"type":"string","description":"End date of the time period in which usage is tracked. Zuora uses\nthis field value to determine the usage date.\n","format":"date-time"},"productRatePlanChargeId":{"type":"string","description":"The product rate plan charge number that you use for a dynamic usage charge.\n"},"quantity":{"type":"number","description":"Number of units used.\n"},"rbeStatus":{"type":"string","description":"Indicates if the rating and billing engine (RBE) processed usage data for an invoice.\n","enum":["Importing","Pending","Processed"]},"sourceType":{"type":"string","description":"Indicates if the usage records were imported from the web-based UI or the API.\n","enum":["API","Import"]},"startDateTime":{"description":"Start date of the time period in which usage is tracked. Zuora uses\nthis field value to determine the usage date.\n","format":"date-time","type":"string"},"subscriptionId":{"type":"string","description":"The original ID of the subscription that contains the fees related to the usage data.\n"},"submissionDateTime":{"type":"string","format":"date-time","description":"The date and time when the usage was submitted.\n"},"uOM":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":{"type":"string","description":"A description of the usage record.\n"},"importId":{"type":"string","description":"The unique identifier of the import.\n"},"uniqueKey":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a customer-defined specific identifier of a usage record."},"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 only available if you have the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"feature or the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled Usage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature enabled. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=billing-unbilled-usage"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload usage record with unique"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"key"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}],"type":"string"},"fileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File ID of the uploaded usage records file. You can use this file ID with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_Files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to download the file."},"children":[]}]}]}],"type":"string"},"fileName":{"type":"string","description":"The name of the import file when the usage record is imported from the file.\n"},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Usage object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryUsageResponse"}},"components/schemas/ExpandedValidityPeriodSummary":{"id":"components/schemas/ExpandedValidityPeriodSummary","kind":"json-schema","title":"QueryValidityPeriodSummaryResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the validity period summary.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the validity period summary.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the validity period summary was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the validity period summary.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the validity period summary was last updated.\n"},"prepaidBalanceId":{"type":"string","description":"The unique identifier of the prepaid balance.\n"},"startDate":{"type":"string","format":"date","description":"The start date of the validity period.\n"},"endDate":{"type":"string","format":"date","description":"The end date of the validity period.\n"},"totalBalance":{"type":"number","description":"The total prepaid balance for the current validity period.\n"},"remainingBalance":{"type":"number","description":"The remaining prepaid balance for the current validity period.\n"},"totalBilledAmount":{"type":"number","description":"The total amount that has been billed.\n"},"billedBalanceAmount":{"type":"number","description":"The total amount of the billing documents balances.\n"},"subscriptionNumber":{"type":"string","description":"The number of the subscription the validity period belongs to.\n"},"uom":{"type":"string","description":"The UOM of the validity period.\n"},"accountNumber":{"type":"string","description":"The number of the account to which the prepaid balance belongs.\n"},"accountId":{"type":"string","description":"The ID of the account to which the prepaid balance belongs.\n"},"billingTiming":{"type":"string","description":"The billing timing of the validity period.\n","enum":["In Advance","In Arrears"]},"overageRatedQuantity":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overage rated quantity for the validity period."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageRatedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageRatedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields of the Validity Period Summary object are approaching end of support on  February 01, 2025. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=overageratedquantity-and-overageratedamount-fields-end-of-support","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product and feature end of support plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"overageRatedAmount":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overage rated amount for the validity period."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageRatedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"overageRatedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields of the Validity Period Summary object are approaching end of support on  February 01, 2025. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=overageratedquantity-and-overageratedamount-fields-end-of-support","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product and feature end of support plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"account":{"$ref":"#/components/schemas/NestedAccountOnExpand"},"prepaidBalance":{"$ref":"#/components/schemas/NestedPrepaidBalanceOnExpand"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the Validity Period Summary object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryValidityPeriodSummaryResponse"}},"components/schemas/ExpandedContactSnapshot":{"id":"components/schemas/ExpandedContactSnapshot","kind":"json-schema","title":"QueryContactSnapshotResponse","data":{"properties":{"id":{"type":"string","description":"The unique identifier of the contact snapshot.\n"},"createdById":{"type":"string","description":"The unique identifier of the user who created the snapshot.\n"},"createdDate":{"type":"string","format":"date-time","description":"The date and time when the contact snapshot was created.\n"},"updatedById":{"type":"string","description":"The unique identifier of the user who last updated the snapshot.\n"},"updatedDate":{"type":"string","format":"date-time","description":"The date and time when the contact snapshot was last updated.\n"},"accountId":{"type":"string","description":"The unique identifier of the associated billing account.\n"},"contactId":{"type":"string","description":"The unique identifier of the original contact.\n"},"firstName":{"type":"string","description":"The first name of the contact.\n"},"lastName":{"type":"string","description":"The last name of the contact.\n"},"nickName":{"type":"string","description":"The nickname of the contact.\n"},"address1":{"type":"string","description":"The first line of the address.\n"},"address2":{"type":"string","description":"The second line of the address.\n"},"city":{"type":"string","description":"The city of the contact's address.\n"},"state":{"type":"string","description":"The state or province of the contact's address.\n"},"postalCode":{"type":"string","description":"The postal or ZIP code.\n"},"county":{"type":"string","description":"The county or region of the contact.\n"},"country":{"type":"string","description":"The county or region of the contact.\n"},"taxRegion":{"type":"string","description":"The tax region applicable to the contact.\n"},"description":{"type":"string","description":"The free-form description of the contact snapshot.\n"},"homePhone":{"type":"string","description":"The home phone number.\n"},"otherPhone":{"type":"string","description":"Any other phone number.\n"},"otherPhoneType":{"type":"string","description":"The type of the other phone number.\n"},"fax":{"type":"string","description":"The fax number.\n"},"personalEmail":{"type":"string","description":"The personal email address.\n"},"workEmail":{"type":"string","description":"The personal email address.\n"},"deleted":{"type":"boolean","description":"Indicates whether the contact snapshot is marked as deleted.\n"}},"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields of the ContactSnapshot object. Only the indexed custom fields with a specified value (not null) are returned. The name of each custom field has the form "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customField"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"__c"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom field names are case sensitive. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"type":"object","title":"QueryContactSnapshotResponse"}},"components/schemas/RatingDetails":{"id":"components/schemas/RatingDetails","kind":"json-schema","title":"RatingDetailResponse","data":{"type":"object","title":"RatingDetailResponse","properties":{"id":{"type":"string","description":"The unique identifier of the Rating Detail."},"invoiceItemId":{"type":"string","description":"The unique identifier of the Invoice Item this Rating Detail is associated to."},"creditMemoItemId":{"type":"string","nullable":true,"description":"The unique identifier of the Credit Memo Item this Rating Detail is associated to."},"chargeType":{"type":"string","description":"The type of charge of the associated Invoice Item."},"chargeModel":{"type":"string","description":"The charge model of the associated Invoice Item."},"formula":{"type":"string","description":"Text with mathematical formula used to rate the amount."},"calculation":{"type":"string","description":"Details of the rating done by replacing values in the formula."},"calculatedAmount":{"type":"number","format":"double","description":"The output result of the rating calculation."},"currency":{"type":"string","description":"The currency code of the calculated amount."},"unitOfMeasure":{"type":"string","description":"Unit of measure if it's a usage charge."},"quantity":{"type":"number","format":"double","nullable":true,"description":"If usage charge, quantity of usages."},"billedQuantity":{"type":"number","format":"double","nullable":true,"description":"For on-demand usage charges, previously billed quantity in the same billing period."},"billedAmount":{"type":"number","format":"double","nullable":true,"description":"For on-demand usage charges, previously billed amount in the same billing period."},"isProration":{"type":"boolean","description":"True if the billing period is a prorated period."},"isCredit":{"type":"boolean","description":"True if this is a credit."},"listPriceBase":{"type":"string","description":"List price base from the rate plan charge."},"billingCycleDay":{"type":"integer","description":"Billing cycle day from the rate plan charge."},"billingCycleType":{"type":"string","description":"Billing cycle type from the rate plan charge."},"billingPeriod":{"type":"string","description":"Billing period from the rate plan charge."},"specificBillingPeriod":{"type":"string","description":"Specific billing period from the rate plan charge."},"validityPeriodType":{"type":"string","description":"Validity period type for prepaid or commitment charges."},"billingPeriodAlignment":{"type":"string","description":"Billing period alignment from the rate plan charge."},"alignmentStartDate":{"type":"string","format":"date","description":"Start date used for billing alignment."},"amountWithoutTax":{"type":"number","format":"double","description":"The amount from the Invoice Item or Credit Memo Item."},"isInclusiveTaxNoRounding":{"type":"boolean","description":"True if tax mode option is set to tax inclusive."},"isProrationPartialPeriod":{"type":"boolean","description":"True if billing rule \"Prorate recurring charges for partial period?\" is Yes."},"isProrateMonthlyCharges":{"type":"boolean","description":"True if billing rule \"Bill usage/recurring charges for partial month?\" is Yes."},"isProrateWeeklyCharges":{"type":"boolean","description":"True if billing rule \"Bill usage/recurring charges for partial week?\" is Yes."},"prorationUnitRule":{"type":"string","description":"Value of billing rule for prorating units."},"daysInMonthRule":{"type":"string","description":"Value of billing rule for days in a month."},"recurringCreditProrationOptionRule":{"type":"string","description":"Billing rule for recurring credit proration option."},"isCreditWithOriginalCE":{"type":"boolean","description":"True if permission for credit with original invoice item amount is enabled."},"isProrateDiscountCredit":{"type":"boolean","description":"True if prorated discount credit rule is enabled."},"stackedDiscountClassApplyRule":{"type":"string","description":"Billing rule for applying stacked discount class."},"recurringPeriodStart":{"type":"string","format":"date","description":"Start date of the current service period."},"recurringPeriodEnd":{"type":"string","format":"date","description":"End date of the current service period."},"chargeStartDate":{"type":"string","format":"date","description":"Charge start date."},"chargeEndDate":{"type":"string","format":"date","description":"Charge end date."},"subStartDate":{"type":"string","format":"date","description":"Subscription start date."},"subEndDate":{"type":"string","format":"date","description":"Subscription end date."},"termStartDate":{"type":"string","format":"date","description":"Term start date."},"termEndDate":{"type":"string","format":"date","description":"Term end date."},"creditOption":{"type":"string","description":"Credit option from the rate plan charge."},"fundingPrice":{"type":"number","format":"double","description":"Total price of current validity period fund."},"totalBalance":{"type":"number","format":"double","description":"Total fund or discount schedule balance."},"remainingBalance":{"type":"number","format":"double","description":"Remaining fund or discount schedule balance."},"originalBillingPeriodStart":{"type":"string","format":"date","description":"Start date of original billing period if credit."},"originalBillingPeriodEnd":{"type":"string","format":"date","description":"End date of original billing period if credit."},"originalAmount":{"type":"number","format":"double","description":"Original billed amount if credit."},"basePrice":{"type":"number","format":"double","description":"Base price or fixed amount."},"discountClass":{"type":"string","description":"Discount class as in rate plan charge."},"discountClassOrder":{"type":"integer","description":"Order number of discount class."},"discountLevel":{"type":"string","description":"Discount level from rate plan charge."},"discountApplySequence":{"type":"integer","description":"Sequence in which the discount is applied."},"discountSchedulePeriodStart":{"type":"string","format":"date","description":"Discount schedule start date."},"discountSchedulePeriodEnd":{"type":"string","format":"date","description":"Discount schedule end date."},"regularChargeAmount":{"type":"number","format":"double","description":"Amount of the charge that the discount is applied to."},"regularChargeAmountLeft":{"type":"number","format":"double","description":"Remaining amount of charge before this discount is applied."},"originalRegularChargeAmount":{"type":"number","format":"double","description":"Original amount of charge before credit."},"discountBalanceFormula":{"type":"string","description":"Formula used to calculate discount total balance."}},"additionalProperties":false}},"components/schemas/QueryRatingDetailsResponse":{"id":"components/schemas/QueryRatingDetailsResponse","kind":"json-schema","title":"QueryRatingDetailsResponse","data":{"type":"object","title":"QueryRatingDetailsResponse","properties":{"nextPage":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string to use as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the next request to paginate results."},"children":[]}]}]}]},"data":{"type":"array","description":"Array of rating detail results.","items":{"$ref":"#/components/schemas/RatingDetails"}}},"additionalProperties":false}},"components/schemas/DataQueryJobCommon":{"id":"components/schemas/DataQueryJobCommon","kind":"json-schema","title":"DataQueryJobCommon","data":{"properties":{"createdBy":{"description":"The query job creator's Id.\n","format":"uuid","maxLength":64,"minLength":64,"type":"string"},"id":{"description":"Internal identifier of the query job.\n","format":"uuid","maxLength":64,"minLength":64,"type":"string"},"query":{"description":"The query that was submitted.\n","type":"string"},"remainingRetries":{"description":"The number of times that Zuora will retry the query if Zuora is unable to perform the query.\n","type":"integer"},"sourceData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the source that data queries run against:"},"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":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the live transactional databases at Zuora (Data Query Live)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAREHOUSE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-zuora-warehouse-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Warehouse"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"type":"string"},"updatedOn":{"description":"Date and time when the query job was last updated, in ISO 8601 format.\n","format":"date-time","type":"string"},"useIndexJoin":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to use Index Join. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-data-query-practices","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Index Join"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/DataQueryJob":{"id":"components/schemas/DataQueryJob","kind":"json-schema","title":"queryJob","data":{"allOf":[{"$ref":"#/components/schemas/DataQueryJobCommon"},{"properties":{"dataFile":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the query results. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"URL","type":"string"},"outputRows":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of rows the query results. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"processingTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing time of the query job, in milliseconds. Only applicable if the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"queryStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the query job."},"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":"submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - query submitted to query service for processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - query accepted by the query service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - query executed by the query service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - query execution completed by the query service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - query unable to be processed by the query service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - query cancelled by the user"},"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":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataFile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the location of the query results."},"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":"accepted"},"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":", you can use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/DELETE_DataQueryJob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel a data query job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to prevent Zuora from performing the query. Zuora then sets the status of the query job to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["submitted","accepted","in_progress","completed","failed","cancelled"],"type":"string"}},"type":"object"}],"description":"A data query job.\n","title":"queryJob"}},"components/schemas/GetDataQueryJobsResponse":{"id":"components/schemas/GetDataQueryJobsResponse","kind":"json-schema","title":"GetDataQueryJobsResponse","data":{"properties":{"data":{"description":"List of data query jobs. The query jobs are listed in reverse order of creation.\n","items":{"$ref":"#/components/schemas/DataQueryJob"},"type":"array"}},"type":"object"}},"components/schemas/SubmitDataQueryRequest":{"id":"components/schemas/SubmitDataQueryRequest","kind":"json-schema","title":"SubmitDataQueryRequest","data":{"example":{"query":"SELECT accountnumber, balance FROM Account WHERE Account.balance > 100","compression":"NONE","output":{"target":"S3"},"outputFormat":"CSV"},"properties":{"columnSeparator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The column separator. Only applicable if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outputFormat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"compression":{"description":"Specifies whether Zuora compresses the query results.\n","enum":["NONE","GZIP","ZIP"],"type":"string"},"encryptionKey":{"description":"Base-64 encoded public key of an RSA key-pair. \n\nNote that Data Query only supports 1024-bit RSA keys.\n\nIf you set this field, Zuora encrypts the query results using the provided public key. You must use the corresponding private key to decrypt the query results.\n","format":"byte","type":"string"},"output":{"description":"Additional information about the query results.\n","properties":{"target":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["S3"],"type":"string"}},"required":["target"],"type":"object"},"outputFormat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the format of the query results."},"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":"JSON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each row in the query results will be a JSON object. The format of the query result file is "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Lines"},"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":"code","inline":true,"attributes":{"content":"CSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each row in the query results will be a comma-separated list of values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each row in the query results will be a tab-separated list of values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Pass any character as your custom delimiter into the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"columnSeparator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}],"enum":["JSON","CSV","TSV","DSV"],"type":"string"},"query":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query to perform. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-sql-queries-in-data-query"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SQL Queries in Data Query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"string"},"readDeleted":{"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the query will retrieve only the deleted record. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"readDeleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or it is not included in the request body, the query will retrieve only the non-deleted records. If it is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only the deleted records will be retrieved."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you select the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, both non-deleted and deleted records will be retrieved regardless of the value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"readDeleted"},"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":"Note that Data Query is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through Data Query."},"children":[]}]}]}],"type":"boolean"},"sourceData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the source that data queries run against:"},"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":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the live transactional databases at Zuora (Data Query Live)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAREHOUSE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. This option is available only if you have the Zuora Warehouse feature enabled in your tenant. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-zuora-warehouse-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Warehouse"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this option is selected, you can specify warehouse size in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"warehouseSize"},"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 field is not specified, the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used."},"children":[]}]}]}],"enum":["LIVE","WAREHOUSE"],"type":"string"},"useIndexJoin":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to use Index Join. Index join is useful when you have a specific reference value in your WHERE clause to index another large table by. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-data-query-practices"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Index Join"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"type":"boolean"},"warehouseSize":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the size of Zuora Warehouse. This field is available only if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAREHOUSE"},"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 field is not specified or set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xsmall"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used."},"children":[]}]}]}],"enum":["xsmall","NULL"],"type":"string"}},"required":["query","outputFormat","compression","output"],"type":"object"}},"components/schemas/SubmitDataQueryResponse":{"id":"components/schemas/SubmitDataQueryResponse","kind":"json-schema","title":"SubmitDataQueryResponse","data":{"properties":{"data":{"$ref":"#/components/schemas/DataQueryJob"}},"type":"object"}},"components/schemas/DataQueryErrorResponse":{"id":"components/schemas/DataQueryErrorResponse","kind":"json-schema","title":"DataQueryErrorResponse","data":{"properties":{"code":{"description":"Error code.\n","type":"integer"},"message":{"description":"Error message.\n","type":"string"}},"type":"object"}},"components/schemas/GetDataQueryJobResponse":{"id":"components/schemas/GetDataQueryJobResponse","kind":"json-schema","title":"GetDataQueryJobResponse","data":{"properties":{"data":{"$ref":"#/components/schemas/DataQueryJob"}},"type":"object"}},"components/schemas/DataQueryJobCancelled":{"id":"components/schemas/DataQueryJobCancelled","kind":"json-schema","title":"cancelledQueryJob","data":{"allOf":[{"$ref":"#/components/schemas/DataQueryJobCommon"},{"properties":{"queryStatus":{"description":"Status of the query job.\n","enum":["cancelled"],"type":"string"}},"type":"object"}],"description":"A cancelled data query job.\n","title":"cancelledQueryJob"}},"components/schemas/DeleteDataQueryJobResponse":{"id":"components/schemas/DeleteDataQueryJobResponse","kind":"json-schema","title":"DeleteDataQueryJobResponse","data":{"properties":{"data":{"$ref":"#/components/schemas/DataQueryJobCancelled"}},"type":"object"}},"components/schemas/BatchQuery":{"id":"components/schemas/BatchQuery","kind":"json-schema","title":"query","data":{"properties":{"apiVersion":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API."},"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":": As of API version 69 and later, Zuora changed the format of certain fields. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-date-field-changes-in-the-wsdl","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date Field Changes in the SOAP API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information and a list of affected fields."},"children":[]}]}]}],"type":"string"},"convertToCurrencies":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currencies that you want to convert transaction amounts into. You can specify any number of currencies. Specify the currencies using their "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=view-countries-or-regions","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO currency codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and separate each currency with a comma, for example, \"EUR,GBP,JPY\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-creating-the-data-source-export-using-the-aqua-api","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Convert Transaction Amounts Into Any Currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information and examples."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this field, you must have "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=ar-foreign-currency-conversion","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Foreign Currency Conversion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled and you must be using API version 78 or later."},"children":[]}]}]}],"type":"string"},"deleted":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates that the AQuA incremental load will retrieve deleted records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to export deleted data, this field is required."},"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":": AQuA API is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through AQuA."},"children":[]}]}]}],"items":{"properties":{"column":{"description":"Name of the Column in the extracted file that points to the deleted records. \n","type":"string"},"format":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be set to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Numeric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Boolean"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Numeric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", deleted records are marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Boolean"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", deleted records are marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"title":"deletedRecord","type":"object"},"type":"array"},"name":{"description":"The query name that can uniquely identify the query in this API request.\n","type":"string"},"query":{"description":"A valid ZOQL query or Export ZOQL query statement.\n","type":"string"},"type":{"description":"The query type.\n","enum":["zoql","zoqlexport"],"type":"string"}},"title":"query"}},"components/schemas/SubmitBatchQueryRequest":{"id":"components/schemas/SubmitBatchQueryRequest","kind":"json-schema","title":"SubmitBatchQueryRequest","data":{"example":{"queries":[{"query":"select AccountNumber, BillCycleDay from Account","type":"zoql"}]},"properties":{"dateTimeUtc":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using WSDL 69 and later you can ensure that the exported output of dateTime records are rendered according to ISO-8601 generic UTC form by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTimeUtc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTimeUtc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", exports of dateTime data types will be rendered in the following generic format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss-hhmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss+hhmm"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Regardless of what batchType query is used ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zoql"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zoqlexport"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the query response output for datetime data types can be standardized by setting dateTimeUtc to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the results will display datetime types with the format: YYYY-MM-DDThh:mm:ss+/-hhmm."},"children":[]}]}]}],"type":"boolean"},"format":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format of the query. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["csv","zip","gzip"],"type":"string"},"incrementalTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows you to override the time from which a Stateful AQuA job incrementally retrieves records that have been created or modified, using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2015-01-21 10:30:01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", AQuA will retrieve records that have created or modified beginning at 10:30:01. If this parameter is not set, AQuA continues to use the Start Time of the last AQuA session to retrieve records incrementally."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time zone of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depends on which Zuora data center you use. For US Data Center customers, the time zone of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Pacific Time. For EU Data Center customers, the time zone of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is UTC. If the time zone of your system is different from the time zone of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you will need to convert to the appropriate time zone before setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"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":"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 can only be used in Stateful AQuA mode."},"children":[]}]}]}],"format":"dateTime","type":"string"},"name":{"description":"The name of the job. 32 character limit.\n","type":"string"},"notifyUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If URL is provided, the AQuA job will call this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notifyUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the job has completed. The value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notifyUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" needs to have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"${JOBID}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"${STATUS}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholders. These placeholders will be replaced by the actual job ID and status when returned in the response. Status will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after the AQuA job is done."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you submit an AQuA query with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notifyUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified, the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notifyUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be ignored if your organization has already "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-callout-notification-for-completed-aqua-jobs","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configured a callout notification through the Zuora user interface"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"nullReplacement":{"description":"The string used to represent null values in the query results. If you do not set this parameter, null values are represented by the empty string in the query results.\n","type":"string"},"offset":{"default":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field specifies the time offset for AQuA queries in stateful mode. It is an integer in the range 0 to 3,600 seconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you set this field to 600 seconds and you post a query in stateful mode at 2:00 AM, it will query against data created or updated between the completion time of the previous query and 1:50 AM."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field will override the value you configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Administration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AQuA API Stateful Mode Time Offset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"partner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It must be used together with \"project\" field to uniquely identify a data integration target."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as \"Salesforce\", and \"project\" as \"00170000011K3Ub.\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null."},"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":": Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-bulk-data-extraction-from-zuora-using-aqua","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk data extraction from Zuora using AQuA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for best practices."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":": Submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to obtain a partner ID."},"children":[]}]}]}],"type":"string"},"project":{"description":"The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.\n\nThis field must be used together with partner field to uniquely identify a data integration target. \n\nThis field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.\n","type":"string"},"queries":{"description":"A JSON array object that contains a list of batch objects.\n","items":{"$ref":"#/components/schemas/BatchQuery"},"required":["name","query"],"type":"array"},"sourceData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the source this aggregate query runs against:"},"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":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the live transactional databases at Zuora (Data Query Live)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, the default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used."},"children":[]}]}]}]}],"enum":["LIVE"],"type":"string"},"useQueryLabels":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this optional flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request will use object and field API names for the CSV header output instead of the field labels. Data integration projects should set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useQueryLabels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so that API names remain the same."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useQueryLabels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so that output CSV headers display the more user-friendly object and field labels."},"children":[]}]}]}],"type":"boolean"},"version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API version you want to use."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The supported versions are 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":"code","inline":true,"attributes":{"content":"1.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It supports both modes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Default. It supports stateless modes only."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-aqua-stateless-and-stateful-modes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stateless and stateful modes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"}},"components/schemas/BatchesQueries":{"id":"components/schemas/BatchesQueries","kind":"json-schema","title":"batch","data":{"properties":{"apiVersion":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API."},"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":": As of API version 69 and later, Zuora changed the format of certain fields. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-date-field-changes-in-the-wsdl","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date Field Changes in the SOAP API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information and a list of affected fields."},"children":[]}]}]}],"type":"string"},"batchId":{"description":"A 32-character ID of the query batch.\n","type":"string"},"batchType":{"description":"The kind of batch job being submitted.\n","enum":["zoql","zoqlexport"],"type":"string"},"deleted":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates that the AQuA incremental load will retrieve deleted records."},"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":": AQuA API is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through AQuA."},"children":[]}]}]}],"items":{"properties":{"column":{"description":"Name of the Column in the extracted file that points to the deleted records. \n","type":"string"},"format":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be set to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Numeric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Boolean"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Numeric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", deleted records are marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Boolean"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", deleted records are marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"title":"deletedRecord","type":"object"},"type":"array"},"full":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates a full or incremental load. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Full and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Incremental."},"children":[]}]}]}],"type":"boolean"},"name":{"description":"Name of the query supplied in the request.\n","type":"string"},"query":{"description":"The requested query string.\n","type":"string"},"recordCount":{"description":"The number of records included in the query output file.\n","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the query task:"},"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":"submitted: The query was submitted to the query executor for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending: The query was waiting for being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executing: The query is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed: The query was successfully executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aborted: The query execution failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records."},"children":[]}]}]}]}],"enum":["submitted","pending","executing","completed","aborted","deleted_notallowed"],"type":"string"}},"title":"batch"}},"components/schemas/SubmitBatchQueryResponse":{"id":"components/schemas/SubmitBatchQueryResponse","kind":"json-schema","title":"SubmitBatchQueryResponse","data":{"properties":{"batches":{"description":"A JSON array object that contains a list of batch objects.\n","items":{"$ref":"#/components/schemas/BatchesQueries"},"required":["name","query","status","batchId","batchType"],"type":"array"},"encrypted":{"description":"If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents.      \n","enum":["pgp","none"],"type":"string"},"format":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format of the query. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["csv","zip","gzip"],"type":"string"},"id":{"description":"The job ID created for the AQuA API request. The job ID can be used for querying for the query status. \n\nThe ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null.\n","type":"string"},"incrementalTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows you to override the time from which a Stateful AQuA job incrementally retrieves records that have been created or modified, using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. For example, if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2015-01-21 10:30:01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", AQuA will retrieve records that have created or modified beginning at 10:30:01. If this parameter is not set, AQuA continues to use the Start Time of the last AQuA session to retrieve records incrementally."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time zone of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depends on which Zuora data center you use. For US Data Center customers, the time zone of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is Pacific Time. For EU Data Center customers, the time zone of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is UTC. If the time zone of your system is different from the time zone of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you will need to convert to the appropriate time zone before setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incrementalTime"},"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":"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 can only be used in Stateful AQuA mode."},"children":[]}]}]}],"format":"dateTime","type":"string"},"name":{"description":"The name of the job. 32 character limit.\n","type":"string"},"notifyUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If URL is provided, the AQuA job will call this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notifyUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the job has completed. The value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notifyUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" needs to have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"${JOBID}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"${STATUS}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholders. These placeholders will be replaced by the actual job ID and status when returned in the response. Status will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after the AQuA job is done."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you submit an AQuA query with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notifyUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified, the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notifyUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be ignored if your organization has already "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-callout-notification-for-completed-aqua-jobs","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configured a callout notification through the Zuora user interface"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"offset":{"default":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field specifies the time offset for AQuA queries in stateful mode. It is an integer in the range 0 to 3,600 seconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if you set this field to 600 seconds and you post a query in stateful mode at 2:00 AM, it will query against data created or updated between the completion time of the previous query and 1:50 AM."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field will override the value you configured in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Administration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AQuA API Stateful Mode Time Offset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"partner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It must be used together with \"project\" field to uniquely identify a data integration target."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as \"Salesforce\", and \"project\" as \"00170000011K3Ub.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null."},"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":": Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-bulk-data-extraction-from-zuora-using-aqua","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk data extraction from Zuora using AQuA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for best practices."},"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":": Submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to obtain a partner ID."},"children":[]}]}]}],"type":"string"},"project":{"description":"The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.\n\nThis field must be used together with partner field to uniquely identify a data integration target. \n\nThis field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.\n","type":"string"},"sourceData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the source this aggregate query runs against:"},"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":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the live transactional databases at Zuora (Data Query Live)."},"children":[]}]}]}]}],"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the AQuA job:"},"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":"submitted: The AQuA job was submitted to the query executor for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executing: The AQuA job is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed: The AQuA job was successfully executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error: The AQuA job was not processed because of validation errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aborted: The AQuA job execution failed because one or more queries of this job failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled: The AQuA job was cancelled."},"children":[]}]}]}]}],"enum":["submitted","executing","completed","error","aborted","cancelled"],"type":"string"},"useLastCompletedJobQueries":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then all the previous queries are merged with existing queries."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the flag is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then the previous queries are ignored, and only the new query is executed."},"children":[]}]}]}],"type":"boolean"},"version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API version you want to use."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The supported versions are 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":"code","inline":true,"attributes":{"content":"1.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It supports both modes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Default. It supports stateless modes only."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-aqua-stateless-and-stateful-modes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stateless and stateful modes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"}},"components/schemas/BatchesQueriesById":{"id":"components/schemas/BatchesQueriesById","kind":"json-schema","title":"batch","data":{"properties":{"apiVersion":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API."},"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":": As of API version 69 and later, Zuora changed the format of certain fields. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-date-field-changes-in-the-wsdl","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date Field Changes in the SOAP API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information and a list of affected fields."},"children":[]}]}]}],"type":"string"},"batchId":{"description":"A 32-character ID of the query batch.\n","type":"string"},"batchType":{"description":"The kind of batch job being submitted.\n","enum":["zoql","zoqlexport"],"type":"string"},"fileId":{"description":"The ID of the query results file.\n\nUse Get Results Files to download the query results file. The query results file is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP.\n","type":"string"},"full":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates a full or incremental load. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"True"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Full and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"False"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Incremental."},"children":[]}]}]}],"type":"boolean"},"message":{"description":"The error message.\n","maximum":2048,"type":"string"},"name":{"description":"Name of the query supplied in the request.\n","type":"string"},"query":{"description":"The requested query string.\n","type":"string"},"recordCount":{"description":"The number of records included in the query output file.\n","type":"string"},"segments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of IDs of query results files. Replaces fileId for full data loads in stateful mode if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/data/aggregate-query-api-aqua/file-segmentation","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Segmentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Get Results Files to download each query results file. Each query results file contains at most 500,000 records and is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP."},"children":[]}]}]}],"type":"array","items":{}},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the query task:"},"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":"submitted: The query was submitted to the query executor for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending: The query was waiting for being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executing: The query is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed: The query was successfully executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aborted: The query execution failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records."},"children":[]}]}]}]}],"enum":["submitted","pending","executing","completed","aborted","deleted_notallowed"],"type":"string"}},"title":"batch"}},"components/schemas/GetAggregateQueryJobResponse":{"id":"components/schemas/GetAggregateQueryJobResponse","kind":"json-schema","title":"GetAggregateQueryJobResponse","data":{"properties":{"batches":{"description":"A JSON array object that contains a list of batch objects.\n","items":{"$ref":"#/components/schemas/BatchesQueriesById"},"required":["name","query","status","batchId","batchType"],"type":"array"},"encrypted":{"description":"If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents.\n","enum":["pgp","none"],"type":"string"},"format":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format of the query. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["csv","zip","gzip"],"type":"string"},"id":{"description":"The job ID created for the AQuA API request. The job ID can be used for querying for the query status. \n\nThe ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null.\n","type":"string"},"name":{"description":"The name of the job. 32 character limit.\n","type":"string"},"partner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It must be used together with \"project\" field to uniquely identify a data integration target."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as \"Salesforce\", and \"project\" as \"00170000011K3Ub.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null."},"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":": Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-bulk-data-extraction-from-zuora-using-aqua","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk data extraction from Zuora using AQuA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for best practices."},"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":": Submit a request at "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"http://support.zuora.com","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to obtain a partner ID."},"children":[]}]}]}],"type":"string"},"project":{"description":"The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.\n\nThis field must be used together with partner field to uniquely identify a data integration target. \n\nThis field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.\n","type":"string"},"sourceData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the source this aggregate query runs against:"},"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":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the live transactional databases at Zuora (Data Query Live)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAREHOUSE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-zuora-warehouse-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Warehouse"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"type":"string"},"startTime":{"description":"The start time of the query. \n","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the AQuA job:"},"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":"submitted: The AQuA job was submitted to the query executor for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executing: The AQuA job is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed: The AQuA job was successfully executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error: The AQuA job was not processed because of validation errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aborted: The AQuA job execution failed because one or more queries of this job failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled: The AQuA job was cancelled."},"children":[]}]}]}]}],"enum":["submitted","executing","completed","error","aborted","cancelled"],"type":"string"},"version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API version you want to use."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The supported versions are 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":"code","inline":true,"attributes":{"content":"1.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It supports both modes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Default. It supports stateless modes only."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-aqua-stateless-and-stateful-modes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stateless and stateful modes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"}},"components/schemas/BatchQueries":{"id":"components/schemas/BatchQueries","kind":"json-schema","title":"batch","data":{"properties":{"batchId":{"description":"A 32-character ID of the query batch.\n","type":"string"},"batchType":{"description":"The kind of batch job being submitted.              \n","enum":["zoql","zoqlexport"],"type":"string"},"fileId":{"description":"The ID of the query results file.\n\nUse Get Results Files to download the query results file. The query results file is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP.\n","type":"string"},"message":{"description":"The error message.\n","maximum":2048,"type":"string"},"name":{"description":"Name of the query supplied in the request.\n","type":"string"},"query":{"description":"The requested query string.\n","type":"string"},"recordCount":{"description":"The number of records included in the query output file.\n","type":"string"},"segments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of IDs of query results files. Replaces fileId for full data loads in stateful mode if "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com/en/zuora-platform/data/aggregate-query-api-aqua/file-segmentation","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Segmentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Get Results Files to download each query results file. Each query results file contains at most 500,000 records and is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP."},"children":[]}]}]}],"type":"array","items":{}},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the query task:"},"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":"submitted: The query was submitted to the query executor for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending: The query was waiting for being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executing: The query is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed: The query was successfully executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aborted: The query execution failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records."},"children":[]}]}]}]}],"enum":["submitted","pending","executing","completed","aborted","deleted_notallowed"],"type":"string"}},"title":"batch"}},"components/schemas/DeleteBatchQueryJobResponse":{"id":"components/schemas/DeleteBatchQueryJobResponse","kind":"json-schema","title":"DeleteBatchQueryJobResponse","data":{"properties":{"batches":{"description":"A JSON array object that contains a list of batch objects.\n","items":{"$ref":"#/components/schemas/BatchQueries"},"required":["name","query","status","batchId","batchType"],"type":"array"},"format":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format of the query. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["csv","zip","gzip"],"type":"string"},"id":{"description":"The job ID created for the AQuA API request. The job ID can be used for querying for the query status. \n\nThe ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null.\n","type":"string"},"name":{"description":"The name of the job. 32 character limit.\n","type":"string"},"sourceData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the source this aggregate query runs against:"},"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":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the live transactional databases at Zuora (Data Query Live)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAREHOUSE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-zuora-warehouse-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Warehouse"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the AQuA job:"},"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":"submitted: The AQuA job was submitted to the query executor for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"executing: The AQuA job is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed: The AQuA job was successfully executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error: The AQuA job was not processed because of validation errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aborted: The AQuA job execution failed because one or more queries of this job failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled: The AQuA job was cancelled."},"children":[]}]}]}]}],"enum":["submitted","executing","completed","error","aborted","cancelled"],"type":"string"},"version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API version you want to use."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The supported versions are 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":"code","inline":true,"attributes":{"content":"1.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It supports both modes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Default. It supports stateless modes only."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=platform-aqua-stateless-and-stateful-modes","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stateless and stateful modes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"format":"float","type":"number"}},"type":"object"}},"components/schemas/JsonNode":{"id":"components/schemas/JsonNode","kind":"json-schema","title":"JsonNode","data":{"description":"Json node object contains metadata.","title":"JsonNode","type":"object","nullable":true}},"components/schemas/ConfigTemplateErrorResponse":{"id":"components/schemas/ConfigTemplateErrorResponse","kind":"json-schema","title":"ConfigTemplateErrorResponse","data":{"example":{"reasons":[{"code":"ObjectNotFound","message":"Configuration Templates does not exist."}]},"properties":{"reasons":{"items":{"properties":{"code":{"description":"The error code of response.\n","type":"string"},"message":{"description":"A detailed description of the error response.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/MigrationComponentContent":{"id":"components/schemas/MigrationComponentContent","kind":"json-schema","title":"MigrationComponentContent","data":{"description":"When a comparison is made between a source and target tenant, it sends a response to the user interface.","properties":{"attribute":{"type":"string"},"componentType":{"description":"Type of selected components to be migrated.","type":"string"},"currentTargetResponse":{"$ref":"#/components/schemas/JsonNode"},"description":{"type":"string"},"disabled":{"type":"string"},"errorMessage":{"description":"Error information.","type":"string"},"httpMethods":{"type":"string"},"id":{"type":"string"},"key":{"type":"string"},"migratedOn":{"description":"It is the time when migration is triggered.","format":"date-time","type":"string"},"migrationId":{"description":"Migration ID. It is generated at the time of triggering deployment.","type":"string"},"pathPattern":{"description":"PathPattern of component.","type":"string"},"previousTargetResponse":{"$ref":"#/components/schemas/JsonNode"},"result":{"description":"Returns the result details of Components.","type":"string"},"segregationKey":{"description":"Displays the differences between components.","type":"string"},"sourceResponse":{"$ref":"#/components/schemas/JsonNode"},"status":{"description":"Returns the status of each component.","type":"string"},"updateStatus":{"description":"Updated Status.","type":"string"}},"title":"MigrationComponentContent","type":"object"}},"components/schemas/CompareSchemaKeyValue":{"id":"components/schemas/CompareSchemaKeyValue","kind":"json-schema","title":"CompareSchemaKeyValue","data":{"description":"When a comparison is made between a source and target tenant, it sends a response to the user interface.","properties":{"difference":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Returns the different components list.","type":"object"},"response":{"description":"Provides the total reponse of the components.","items":{"$ref":"#/components/schemas/MigrationComponentContent"},"type":"array"},"segregationKeys":{"description":"Provides separation of components.","items":{"type":"string"},"type":"array"}},"title":"CompareSchemaKeyValue","type":"object"}},"components/schemas/CompareSchemaInfoResponse":{"id":"components/schemas/CompareSchemaInfoResponse","kind":"json-schema","title":"CompareSchemaInfoResponse","data":{"description":"When Tenant's Compare API returns a result, this object is used to send the response to UI.","properties":{"customFields":{"items":{"$ref":"#/components/schemas/CompareSchemaKeyValue"},"type":"array"},"customObjects":{"items":{"$ref":"#/components/schemas/CompareSchemaKeyValue"},"type":"array"},"dataAccessControl":{"items":{"$ref":"#/components/schemas/CompareSchemaKeyValue"},"type":"array"},"metaData":{"$ref":"#/components/schemas/JsonNode"},"notifications":{"items":{"$ref":"#/components/schemas/CompareSchemaKeyValue"},"type":"array"},"productCatalog":{"items":{"$ref":"#/components/schemas/CompareSchemaKeyValue"},"type":"array"},"settings":{"items":{"$ref":"#/components/schemas/CompareSchemaKeyValue"},"type":"array"},"workflows":{"items":{"$ref":"#/components/schemas/CompareSchemaKeyValue"},"type":"array"}},"title":"CompareSchemaInfoResponse","type":"object"}},"components/schemas/TemplateMigrationClientRequest":{"id":"components/schemas/TemplateMigrationClientRequest","kind":"json-schema","title":"TemplateMigrationClientRequest","data":{"description":"Request to add a new Template migration.\nTemplateMigrationClientRequest object contains request details of target tenant, source tenant, and template information needed for migration.\n","properties":{"comments":{"type":"string"},"description":{"description":"Description of the migration.","example":"Migration from/to Sandbox","type":"string"},"emailIds":{"description":"List of Emails with comma separator.","example":"abcd@zuora.com,xyz@zuora.com","type":"string"},"entityUuid":{"description":"Entity UUID","example":11111,"type":"string"},"metaData":{"$ref":"#/components/schemas/JsonNode"},"name":{"description":"Name of the migration.","example":"Job A","type":"string"},"request":{"description":"List of settings need to be migrated.","example":"ST 4","items":{"$ref":"#/components/schemas/MigrationComponentContent"},"type":"array"},"sendEmail":{"description":"Flag determines whether or not to send an email.","example":true,"type":"boolean"}},"required":["description","entityUuid","name","sendEmail"],"title":"TemplateMigrationClientRequest","type":"object"}},"components/schemas/MigrationClientResponse":{"id":"components/schemas/MigrationClientResponse","kind":"json-schema","title":"MigrationClientResponse","data":{"description":"Response after migration is added.","properties":{"emailIds":{"description":"List of Emails with comma separator ","type":"string"},"environment":{"description":"Environment information","type":"string"},"id":{"description":"Variable to hold the job ID.","type":"string"},"migratedBy":{"description":"User responsible for migration.","example":"Jane Cooper","type":"string"},"migrationDescription":{"description":"Description of the migration.","example":"Migration from/to Sandbox","type":"string"},"migrationEnd":{"description":"Timestamp when migration ended.","example":"2020-11-01 18:00:00","type":"string"},"migrationName":{"description":"Name of the migration.","example":"Job A","type":"string"},"migrationStart":{"description":"Timestamp when migration started.","example":"2020-11-01 18:00:00","type":"string"},"response":{"items":{"$ref":"#/components/schemas/MigrationComponentContent"},"type":"array"},"sourceTenantDescription":{"description":"Source Tenant Description.","example":"Duno","type":"string"},"sourceTenantName":{"description":"Source Tenant Name.","example":"Duno","type":"string"},"status":{"description":"Status of the Migration Job.","example":"IN PROGRESS","type":"string"},"type":{"type":"string"}},"required":["id","migratedBy","migrationDescription","migrationEnd","migrationName","migrationStart","sourceTenantDescription","sourceTenantName","status"],"title":"MigrationClientResponse","type":"object"}},"components/schemas/ConfigurationTemplateContent":{"id":"components/schemas/ConfigurationTemplateContent","kind":"json-schema","title":"ConfigurationTemplateContent","data":{"description":"It contains information about template schemas with segregation keys.","properties":{"componentType":{"description":"Type of Component.","type":"string"},"error":{"description":"Error Information.","type":"string","nullable":true},"id":{"description":"Id of Each component.","type":"string"},"key":{"description":"Key value of fields inside component.","type":"string"},"method":{"description":"Http method which is used to retrieve the particular component.","type":"string"},"payload":{"$ref":"#/components/schemas/JsonNode"},"result":{"description":"Contains the response of details fetched regarding selected component.","type":"string"},"segregationKey":{"description":"Gives the difference between components and sub components.","type":"string"},"templateId":{"description":"Id of the Template.","type":"string","nullable":true},"url":{"description":"Metadata is retrieved from this URL.","type":"string"}},"title":"ConfigurationTemplateContent","type":"object"}},"components/schemas/SettingComponentKeyValue":{"id":"components/schemas/SettingComponentKeyValue","kind":"json-schema","title":"SettingComponentKeyValue","data":{"description":"Provides details about the individual components that need to be compared and deployed.","properties":{"errors":{"items":{"type":"string"},"type":"array"},"originalPayload":{"$ref":"#/components/schemas/JsonNode"},"response":{"items":{"$ref":"#/components/schemas/ConfigurationTemplateContent"},"type":"array"},"segregationKeys":{"items":{"type":"string"},"type":"array"}},"title":"SettingComponentKeyValue","type":"object"}},"components/schemas/SettingSourceComponentResponse":{"id":"components/schemas/SettingSourceComponentResponse","kind":"json-schema","title":"SettingSourceComponentResponse","data":{"description":"Provides details about the different components that need to be compared and deployed.","properties":{"customFields":{"items":{"$ref":"#/components/schemas/SettingComponentKeyValue"},"type":"array"},"customObjects":{"items":{"$ref":"#/components/schemas/SettingComponentKeyValue"},"type":"array"},"dataAccessControl":{"items":{"$ref":"#/components/schemas/SettingComponentKeyValue"},"type":"array"},"dataQuery":{"items":{"$ref":"#/components/schemas/SettingComponentKeyValue"},"type":"array"},"multiOrg":{"items":{"$ref":"#/components/schemas/SettingComponentKeyValue"},"type":"array"},"notifications":{"items":{"$ref":"#/components/schemas/SettingComponentKeyValue"},"type":"array"},"organizationHierarchy":{"items":{"$ref":"#/components/schemas/SettingComponentKeyValue"},"type":"array"},"productCatalog":{"items":{"$ref":"#/components/schemas/SettingComponentKeyValue"},"type":"array"},"settings":{"items":{"$ref":"#/components/schemas/SettingComponentKeyValue"},"type":"array"},"workflows":{"items":{"$ref":"#/components/schemas/SettingComponentKeyValue"},"type":"array"}},"title":"SettingSourceComponentResponse","type":"object","nullable":true}},"components/schemas/TemplateDetailResponse":{"id":"components/schemas/TemplateDetailResponse","kind":"json-schema","title":"TemplateDetailResponse","data":{"description":"Contains all template details.","properties":{"active":{"description":"Whether or not the template is active.","type":"boolean"},"content":{"$ref":"#/components/schemas/SettingSourceComponentResponse"},"createdBy":{"description":"Information about the user who created it.","type":"string"},"createdOn":{"description":"When it is created.","type":"string"},"description":{"description":"Template description which contains the information about the created template.","type":"string"},"entityName":{"description":"Name of the Entity","type":"string"},"environment":{"description":"Details of the environment in which the template was created.","type":"string"},"errors":{"description":"Error information.","type":"string"},"id":{"description":"Id of the template.","type":"string"},"name":{"description":"Name of the template.","type":"string"},"status":{"description":"The status of the template creation, such as whether it is in progress, completed, or failed.","type":"string"},"tenantName":{"description":"Tenant's name for whom the template is created.","type":"string"}},"title":"TemplateDetailResponse","type":"object"}},"components/schemas/TemplateResponse":{"id":"components/schemas/TemplateResponse","kind":"json-schema","title":"TemplateResponse","data":{"description":"It contains a collection of all the templates that have been created.","properties":{"templates":{"description":"Contains list of template details.","items":{"$ref":"#/components/schemas/TemplateDetailResponse"},"type":"array"}},"title":"TemplateResponse","type":"object"}},"components/schemas/CreateTemplateRequestContent":{"id":"components/schemas/CreateTemplateRequestContent","kind":"json-schema","title":"CreateTemplateRequestContent","data":{"description":"CreateTemplateRequestContent object contains information for creating template.\n","properties":{"content":{"$ref":"#/components/schemas/SettingSourceComponentResponse"},"customFields":{"description":"Selected custom fields component or not.","type":"boolean"},"customObjects":{"description":"Selected custom objects component or not.","type":"boolean"},"description":{"description":"Creates template description.","type":"string"},"name":{"description":"Name of the Template.","type":"string"},"notifications":{"description":"Selected Notification component or not.","type":"boolean"},"selectedComponents":{"description":"ConfigurationTemplateContent object contains the selected meta data information.","items":{"$ref":"#/components/schemas/ConfigurationTemplateContent"},"type":"array"},"settings":{"description":"Selected Settings component or not.","type":"boolean"},"templateTenant":{"description":"ID of the template tenant.","example":"80b3f8cd-5801-4ed7-bee7-ad1569916c2f","type":"string"},"workflows":{"description":"Selected Workflow component or not.","type":"boolean"}},"required":["description","name","templateTenant"],"title":"CreateTemplateRequestContent","type":"object"}},"components/schemas/SyncDeploymentTemplateRequest":{"id":"components/schemas/SyncDeploymentTemplateRequest","kind":"json-schema","title":"SyncDeploymentTemplateRequest","data":{"description":"Request schema for syncing a deployment template to another tenant.","type":"object","properties":{"templateId":{"type":"string","description":"The ID of the deployment template to be synced.","example":"f7849a41-8a3b-4cd2-8ec0-c9d225d7720b"},"targetTenantId":{"type":"string","description":"The ID of the target tenant to which the template should be synced.","example":"4d6ab8fc-4faa-4ef2-a9ec-3b90bf3f3ddf"}},"required":["templateId","targetTenantId"]}},"components/schemas/DeploymentManagerResponse":{"id":"components/schemas/DeploymentManagerResponse","kind":"json-schema","title":"DeploymentManagerResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Deployment Manager migration process"},"status":{"type":"string","description":"Status of the Deployment Manager migration process","enum":["DEPLOYING","REVERTING","PARTIALLY-REVERTED","FAILED","ROLLBACK-FAILED","REVERTED","COMPARING","SUBMITTED","SKIPPED","IDENTICAL","COMPARE-DONE","COMPARE-FAILED","CANCELLED"]}}}},"components/schemas/BulkJobRequest":{"id":"components/schemas/BulkJobRequest","kind":"json-schema","title":"BulkJobRequest","data":{"type":"object","required":["name","objectType"],"properties":{"name":{"type":"string","description":"Name of the job. Max length is 255 characters."},"objectType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object on which the bulk job is created."},"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":":"},"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 import or delete an account, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"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":"To update an account, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"advanced-accounts-and-contact"},"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":"To update an account's status, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account-legacy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["account","accountingcode","accountingperiod","account-legacy","advanced-accounts-and-contact","amendment","bill-run","bill-run-batches","bill-run-filters","contact","credit-memo","credit-memo-from-charge","credit-memo-from-invoice","debit-memo","debit-memo-from-charge","debit-memo-from-invoice","invoice","journal-entry","journal-run","omni-channel-subscription","order","order-create-order-line-item","order-create-subscription-existing-account","order-create-subscription-existing-account-with-volume-charge","order-create-subscription-with-new-account","order-remove-product","order-update-subscription-add-product","order-update-subscription-change-plan`","order-update-subscription-price-quantity-change","payment","payment-profile","payment-schedule","payment-schedule-item","payments-simple","payments-unapply","product","product-charge-definition","product-rate-plan","product-rate-plan-charge","product-rate-plan-charge-tier","product-rate-plan-definition","refund","refund-legacy","revenue-accounting-code","subscription","subscription-add-rate-plan","subscription-change-rate-plan","subscription-remove-rate-plan","subscription-update-rate-plan","taxation-item","unitofmeasure","usage"],"x-enumDescriptions":{"account":"Import or Delete","accountingcode":"Import or Update","accountingperiod":"Import","account-legacy":"Update","advanced-accounts-and-contact":"Update","amendment":"Import","bill-run":"Import","bill-run-batches":"Import","bill-run-filters":"Import","contact":"Import or Update","credit-memo":"Import or Update","credit-memo-from-charge":"Import","credit-memo-from-invoice":"Import","debit-memo":"Import or Update","debit-memo-from-charge":"Update","debit-memo-from-invoice":"Update","invoice":"Import, Update, Delete, or Cancel","journal-entry":"Import or Update","journal-run":"Import","omni-channel-subscription":"Import","order":"Import","order-create-order-line-item":"Import","order-create-subscription-existing-account":"Import","order-create-subscription-existing-account-with-volume-charge":"Import","order-create-subscription-with-new-account":"Import","order-remove-product":"Import","order-update-subscription-add-product":"Import","order-update-subscription-change-plan":"Import","order-update-subscription-price-quantity-change":"Import","payment":"Import or Update","payment-profile":"Import","payment-schedule":"Import","payment-schedule-item":"Update","payments-simple":"Update","payments-unapply":"Update","product":"Import, Update, or Delete","product-charge-definition":"Import or Update","product-rate-plan":"Import or Update","product-rate-plan-charge":"Import or Update","product-rate-plan-charge-tier":"Update","product-rate-plan-definition":"Import","refund":"Update","refund-legacy":"Update","revenue-accounting-code":"Update","subscription":"Import, Update, Delete, or Cancel","subscription-add-rate-plan":"Update","subscription-change-rate-plan":"Update","subscription-remove-rate-plan":"Update","subscription-update-rate-plan":"Update","taxation-item":"Import or Update","unitofmeasure":"Import","usage":"Import or Update"}},"description":{"type":"string","description":"Short description of the job. Max length is 255 characters"},"mappings":{"type":"array","description":"List of mappings. Each mapping maps a source field to a target field in the object. If the field is an array, the type and arrayType must be specified.","items":{"type":"object","required":["source","target"],"properties":{"source":{"type":"string","description":"Source field name"},"target":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target field name."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must not contain spaces, dots ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), underscores ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or asterisks ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"type":{"type":"string","description":"Field type","enum":["array","string","number","boolean"]},"arrayType":{"type":"string","description":"Type of objects in the array if the field is an array type","enum":["string","number","boolean"]}}}},"headers":{"type":"array","description":"List of headers in the source file. Required if the source file does not have a header row.","items":{"type":"string"}},"rowIdHeader":{"type":"string","description":"Header in the source file that contains the row id."},"delimiter":{"type":"string","description":"Delimiter used in the source file. Default is comma.\n  Supported values: comma, tab, pipe, semicolon, colon, caret, tilde, dot/period"},"hasHeaders":{"type":"boolean","description":"Indicates if the source file has a header row. Default is false"},"fileType":{"type":"string","description":"Type of the source file. Supported values: csv, jsonl \nDefault is csv, which means delimited file where the delimiter can be comma but can also be one of the other supported delimiters","enum":["csv","jsonl"]},"jobType":{"type":"string","description":"Type of the bulk job being created. Default is IMPORT","enum":["Import","Delete","Update","Cancel"]},"isCustomObject":{"type":"boolean","description":"Indicates if the object type is a custom object. Default is false"},"customObjectNamespace":{"type":"string","description":"Namespace of the custom object. Applicable only when isCustomObject is true. Default namespace is 'default'."},"dataSourceType":{"type":"string","description":"The data source type of the job","readOnly":true,"enum":["UserUpload","Salesforce","Chargebee","Stripe"]},"systemType":{"type":"string","description":"The system type for the job","readOnly":true,"enum":["BILLING"]}}}},"components/schemas/CreateResponse":{"id":"components/schemas/CreateResponse","kind":"json-schema","title":"CreateResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job"},"uploadUrl":{"type":"string","description":"URL to upload the file. This is the URL to which the file should be uploaded using a PUT request."},"uploadRequest":{"type":"object","properties":{"uri":{"type":"string","format":"uri","description":"URL to which the file must be uploaded."},"fields":{"type":"object","description":"Form fields required to complete the S3 file upload.","additionalProperties":{"type":"string"}}}},"status":{"type":"string","description":"Status of the job","enum":["Created","Submitted","In Progress","Aborting","Completed","Failed","Aborted","Cancelled","Downloading"]},"jobType":{"type":"string","description":"Type of the job","enum":["Import","Delete","Update","Cancel"]}}}},"components/schemas/UploadRequest":{"id":"components/schemas/UploadRequest","kind":"json-schema","title":"UploadRequest","data":{"type":"object","description":"Information required to upload the file to S3.","properties":{"uri":{"type":"string","format":"uri","description":"URL to which the file must be uploaded."},"fields":{"type":"object","description":"Form fields to include in the upload request.","additionalProperties":{"type":"string"}}}}},"components/schemas/SubmitBulkJobResponse":{"id":"components/schemas/SubmitBulkJobResponse","kind":"json-schema","title":"SubmitBulkJobResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job"},"uploadUrl":{"type":"string","description":"URL to upload the file. This is the URL to which the file should be uploaded using a PUT request."},"uploadRequest":{"$ref":"#/components/schemas/UploadRequest"},"status":{"type":"string","description":"Status of the job","enum":["Created","Submitted","In Progress","Aborting","Completed","Failed","Aborted","Cancelled","Downloading"]},"jobType":{"type":"string","description":"Type of the job","readOnly":true,"enum":["Import","Delete","Update","Cancel"]}}}},"components/schemas/QueryJobSummaryResponse":{"id":"components/schemas/QueryJobSummaryResponse","kind":"json-schema","title":"QueryJobSummaryResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job","readOnly":true},"name":{"type":"string","description":"Name of the job","readOnly":true},"description":{"type":"string","description":"Description of the job","readOnly":true},"createdAt":{"type":"integer","format":"int64","description":"Time the job was created","readOnly":true},"createdBy":{"type":"string","description":"User who created the job","readOnly":true},"status":{"type":"string","description":"Status of the job","readOnly":true,"enum":["Created","Submitted","In Progress","Aborting","Completed","Failed","Aborted","Cancelled","Downloading"]},"rowCount":{"type":"integer","format":"int32","description":"Number of rows in the job","readOnly":true},"rowsSucceeded":{"type":"integer","format":"int32","description":"Number of rows that succeeded in the job","readOnly":true},"rowsFailed":{"type":"integer","format":"int32","description":"Number of rows that failed in the job","readOnly":true},"lastUpdatedAt":{"type":"integer","format":"int64","description":"Time the job was last updated","readOnly":true},"failureReason":{"type":"string","description":"Reason the job failed","readOnly":true},"objectType":{"type":"string","description":"Type of object the job is for","readOnly":true},"jobType":{"type":"string","description":"Type of job","readOnly":true,"enum":["Import","Delete","Update","Cancel"]},"isCustomObject":{"type":"boolean","description":"Whether the job is for a custom object","readOnly":true},"customObjectNamespace":{"type":"string","description":"Namespace of the custom object the job is for","readOnly":true},"dataSourceType":{"type":"string","description":"Type of data source the job is for","readOnly":true,"enum":["UserUpload","Salesforce","Chargebee","Stripe"]},"systemType":{"type":"string","description":"Type of system the job is for","readOnly":true,"enum":["BILLING"]},"fileType":{"type":"string","description":"Type of the source file","readOnly":true,"enum":["csv","jsonl"]}}}},"components/schemas/IdStatusResponse":{"id":"components/schemas/IdStatusResponse","kind":"json-schema","title":"IdStatusResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job","readOnly":true},"status":{"type":"string","description":"Status of the job","readOnly":true,"enum":["Created","Submitted","In Progress","Aborting","Completed","Failed","Aborted","Cancelled","Downloading"]}}}},"components/schemas/DownloadsResponse":{"id":"components/schemas/DownloadsResponse","kind":"json-schema","title":"DownloadsResponse","data":{"type":"object","properties":{"jobId":{"type":"string","format":"uuid","description":"Unique identifier for the job.","readOnly":true},"status":{"type":"string","description":"Status of the job.","enum":["Created","Submitted","In Progress","Aborting","Completed","Failed","Aborted","Cancelled","Downloading"],"readOnly":true},"sourceFile":{"type":"string","description":"Source file URL.","readOnly":true},"errorRowsFile":{"type":"string","description":"URL for the file containing rows that failed.","readOnly":true},"successRowsFile":{"type":"string","description":"URL for the file containing successfully processed rows.","readOnly":true},"delimiter":{"type":"string","description":"Delimiter used in the source file (e.g., comma or pipe).","readOnly":true}}}},"components/schemas/GetSummariesResponse":{"id":"components/schemas/GetSummariesResponse","kind":"json-schema","title":"GetSummariesResponse","data":{"type":"object","properties":{"data":{"type":"array","description":"List of job summaries","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job","readOnly":true},"name":{"type":"string","description":"Name of the job","readOnly":true},"status":{"type":"string","description":"Status of the job","readOnly":true,"enum":["Created","Submitted","In Progress","Aborting","Completed","Failed","Aborted","Cancelled","Downloading"]},"description":{"type":"string","description":"Description of the job","readOnly":true},"createdAt":{"type":"integer","format":"int64","description":"Time the job was created","readOnly":true},"createdBy":{"type":"string","description":"User who created the job","readOnly":true},"submittedAt":{"type":"integer","format":"int64","description":"Time the job was submitted","readOnly":true},"submittedBy":{"type":"string","description":"User who submitted the job","readOnly":true},"rowCount":{"type":"integer","format":"int32","description":"Number of rows in the job","readOnly":true},"rowsSucceeded":{"type":"integer","format":"int32","description":"Number of rows that succeeded in the job","readOnly":true},"rowsFailed":{"type":"integer","format":"int32","description":"Number of rows that failed in the job","readOnly":true},"lastUpdatedAt":{"type":"integer","format":"int64","description":"Time the job was last updated","readOnly":true},"failureReason":{"type":"string","description":"Reason the job failed","readOnly":true},"objectType":{"type":"string","description":"Type of object the job is for","readOnly":true},"jobType":{"type":"string","description":"Type of job","readOnly":true,"enum":["Import","Delete","Update","Cancel"]},"isCustomObject":{"type":"boolean","description":"Whether the job is for a custom object","readOnly":true},"customObjectNamespace":{"type":"string","description":"Namespace of the custom object the job is for","readOnly":true},"dataSourceType":{"type":"string","description":"Type of data source the job is for","readOnly":true,"enum":["UserUpload","Salesforce","Chargebee","Stripe"]},"systemType":{"type":"string","description":"Type of system the job is for","readOnly":true,"enum":["BILLING"]},"fileType":{"type":"string","readOnly":true,"enum":["csv","jsonl"]}}}},"nextPageCursor":{"type":"string","description":"Cursor for the next page of results","readOnly":true}}}},"components/schemas/SubmitDataLabelingJobRequest":{"id":"components/schemas/SubmitDataLabelingJobRequest","kind":"json-schema","title":"SubmitDataLabelingJobRequest","data":{"example":{"objectType":"Account","orgIds":["12345678-1234-1234-1234-123456789012"],"query":"select Id from Account where BillToContact.Country = 'US'","queryType":"ByZoql"},"properties":{"ids":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of the objects to be labeled, only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ById"},"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":"There is a 4MB limit of the JSON payload, so in case of a large number of IDs, please make sure the payload is less than 4MB."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"objectType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The object type of the data labeling job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, the following objects are supported:"},"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":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the associated transaction objects of the account being labeled will automatically inherit the org label of the account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Product"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You have to label the Account object first, make sure all accounts have been labeled, then you can proceed with the Product object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get all the unlabeled accounts by running a Data Source export job, with the following query:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"SELECT Id, Name FROM Account WHERE Organization.Id IS NULL\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SELECT Id, Name FROM Account WHERE Organization.Id IS NULL\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the ProductRatePlanS of the product will be automatically labeled with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs"},"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 labeling products, you can omit the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, i.e, leave it empty, the system will find all the subscriptions that include the product and get the org list of those subscriptions, then label the product with those "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", aka, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"derived orgs"},"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":"You can also explicitly specify the orgs parameter, in that case, you will need to provide a super set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"derived orgs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillRun"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You don't need to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, we will label the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillRun"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with all the orgs because existing runs could pick up all accounts. You can definitely create new bill run with certain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to operate separately by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentRun"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same as BillRun."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ForecastRun"},"children":[]}]}]}]}]}],"type":"string"},"orgIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of the organizations that the data labeling job will associate with the data to be labeled. Either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, one and only one org Id is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For configuration objects, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are treated differently, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to unlabel the object, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to label it with all orgs."},"children":[]}]}]}],"format":"byte","items":{"format":"uuid","maxLength":36,"minLength":36,"type":"string"},"type":"array"},"orgs":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The names of the organizations that the data labeling job will associate with the data to be labeled. Either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, one and only one org name is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For configuration objects, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are treated differently, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to unlabel the object, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to label it with all orgs."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"query":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query that the data labeling job will run to fetch the data to be labeled, only required if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ByZoql"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"queryType":{"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 query that the data labeling job will run to fetch the data to be labeled."},"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":"ByZoql"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The data labeling job will run a ZOQL query which is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to fetch the data to be labeled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ById"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The data labeling job will fetch the data to be labeled by the IDs specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}],"enum":["ByZoql","ById"],"type":"string"}},"required":["objectType","queryType"],"type":"object"}},"components/schemas/SubmitDataLabelingJobResponse":{"id":"components/schemas/SubmitDataLabelingJobResponse","kind":"json-schema","title":"SubmitDataLabelingJobResponse","data":{"properties":{"jobId":{"description":"Identifier of the data labeling job.\n","format":"uuid","maxLength":32,"minLength":32,"type":"string"},"jobStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the data labeling job."},"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":"Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The data labeling job has been accepted by the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispatched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The data labeling job is dispatched to the data labeling service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The data labeling job has completed. Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" simply means the data labeling job has completed, but it does not mean the data labeling job has labeled all the data. You can check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to see how many data have been "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labeled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Accepted","Dispatched","Completed"],"type":"string"},"success":{"description":"Indicates whether the job was submitted successfully.\n","type":"boolean"}},"type":"object"}},"components/schemas/GetDataLabelingJobResponse":{"id":"components/schemas/GetDataLabelingJobResponse","kind":"json-schema","title":"GetDataLabelingJobResponse","data":{"properties":{"jobId":{"description":"Identifier of the data labeling job.\n","format":"uuid","maxLength":32,"minLength":32,"type":"string"},"jobStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the data labeling job."},"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":"Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The data labeling job has been accepted by the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispatched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The data labeling job is dispatched to the data labeling service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The data labeling job has completed. Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" simply means the data labeling job has completed, but it does not mean the data labeling job has labeled all the data. You can check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to see how many data have been "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labeled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["Accepted","Dispatched","Completed"],"type":"string"},"objectType":{"description":"The object type of the data labeling job.\n","type":"string"},"progress":{"properties":{"failed":{"description":"The number of objects that have failed to be labeled.\n","type":"integer"},"labeled":{"description":"The number of objects that have been labeled.\n","type":"integer"},"timeout":{"description":"The number of objects that have timed out to be labeled.          \n","type":"integer"}},"type":"object"},"success":{"description":"Indicates whether the job was submitted successfully.\n","type":"boolean"},"totalObject":{"description":"The total number of objects to be labeled.\n","type":"integer"}},"type":"object"}},"components/schemas/RegenerateBookingRequest":{"id":"components/schemas/RegenerateBookingRequest","kind":"json-schema","title":"RegenerateBookingRequest","data":{"example":{"subscriptionName":"A-S00000001","subscriptionVersion":1,"type":"Subscription"},"properties":{"itemNumber":{"description":"The item number.\n","type":"string"},"orderLineItemId":{"description":"The order line item ID.\n","type":"string"},"orderNumber":{"description":"The order number.\n","type":"string"},"subscriptionId":{"description":"The subscription ID.\n","type":"string"},"subscriptionName":{"description":"The subscription name.\n","type":"string"},"subscriptionVersion":{"description":"The subscription version.\n","type":"integer"},"ratePlanChargeId":{"description":"The rate plan charge ID of dynamic usage charge.\n","type":"string"},"chargeNumber":{"description":"The charge number of dynamic usage charge.\n","type":"string"},"type":{"description":"The type of business object for which you want to generate the transactions.\n","enum":["Subscription","OrderLineItem","DynamicUsageCharge"],"type":"string"}},"type":"object"}},"components/schemas/ResponseReasons":{"id":"components/schemas/ResponseReasons","kind":"json-schema","title":"ResponseReasons","data":{"properties":{"code":{"description":"The error code of response.\n","type":"string"},"message":{"description":"The detail information of the error response.\n","type":"string"}},"type":"object"}},"components/schemas/RegenerateTransactionObjectResponse":{"id":"components/schemas/RegenerateTransactionObjectResponse","kind":"json-schema","title":"RegenerateTransactionObjectResponse","data":{"properties":{"idList":{"description":"A list of the IDs for the business objects for which you generate the transactions. \n","items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ResponseReasons"},"type":"array"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/RegenerateBillingRequest":{"id":"components/schemas/RegenerateBillingRequest","kind":"json-schema","title":"RegenerateBillingRequest","data":{"example":{"number":"CM00000001","type":"CreditMemo"},"properties":{"id":{"description":"ID of Invoice, CreditMemo, DebitMemo, or InvoiceItemAdjustment.\n","type":"string"},"number":{"description":"Number of Invoice, CreditMemo, DebitMemo, or InvoiceItemAdjustment.\n","type":"string"},"type":{"description":"The type of business object for which you want to generate the transactions.\n","enum":["Invoice","CreditMemo","DebitMemo","InvoiceItemAdjustment"],"type":"string"}},"type":"object"}},"components/schemas/RegenerateRevRecEventsResponse":{"id":"components/schemas/RegenerateRevRecEventsResponse","kind":"json-schema","title":"RegenerateRevRecEventsResponse","data":{"properties":{"reasons":{"items":{"$ref":"#/components/schemas/ResponseReasons"},"type":"array"},"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/DailyConsumptionRevRecRequest":{"id":"components/schemas/DailyConsumptionRevRecRequest","kind":"json-schema","title":"DailyConsumptionRevRecRequest","data":{"example":{"chargeSegmentNumber":"1","fundId":"2c9890508ad035db018ad0d8d1685fef","originalChargeId":"2c9890508ad035db018ad0d8d1685fef"},"properties":{"chargeSegmentNumber":{"description":"Rate plan charge number.\n","type":"string"},"fundId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fund ID. For more information about fund, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prepaid with Drawdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"originalChargeId":{"description":"Original rate plan charge ID.\n","type":"string"}},"required":["originalChargeId"],"type":"object"}},"components/schemas/GETAutoBackfillJobResponse":{"id":"components/schemas/GETAutoBackfillJobResponse","kind":"json-schema","title":"GETAutoBackfillJobResponse","data":{"type":"object","properties":{"id":{"description":"Job ID","type":"string"},"createdOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The created-on date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"int64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"type":"integer","format":"int64"},"createdOnReadable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The created-on date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"type":"string","format":"datetime"},"updatedOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The updated-on date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"int64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"type":"integer","format":"int64"},"updatedOnReadable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The updated-on date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"type":"string","format":"datetime"},"updatedByUsername":{"description":"The user who performs the booking date backfill job\n","type":"string"},"status":{"description":"The status of the booking date backfill job\n","type":"string","enum":["ACCEPTED","PROCESSING","COMPLETED","FAILED","STOPPED"]},"type":{"description":"The type of the auto backfill job\n","type":"string","enum":["BookingDate","RatePlanCharge","OrderLineItem"]},"batchSentCount":{"description":"The batch count sent for execution\n","type":"integer","format":"int32"},"batchFinishedCount":{"description":"The finished batch count\n","type":"integer","format":"int32"},"errorCount":{"description":"The failed record count\n","type":"integer","format":"int32"},"progress":{"description":"The progress of the booking date backfill job\n","type":"string"}}}},"components/schemas/DataBackfillJobType":{"id":"components/schemas/DataBackfillJobType","kind":"json-schema","title":"DataBackfillJobType","data":{"description":"The data backfill job type","type":"string","enum":["ProductRatePlanCharge","RatePlanCharge","InvoiceDetail","MemoDetail","InvoiceItemAdjustment"]}},"components/schemas/DataBackfillJobStatus":{"id":"components/schemas/DataBackfillJobStatus","kind":"json-schema","title":"DataBackfillJobStatus","data":{"description":"The status of the data backfill job","type":"string","enum":["Pending","Processing","Completed","Canceled","Failed","Stopping","Stopped"]}},"components/schemas/DataBackfillJob":{"id":"components/schemas/DataBackfillJob","kind":"json-schema","title":"DataBackfillJob","data":{"type":"object","properties":{"id":{"description":"Job ID","type":"string"},"importType":{"$ref":"#/components/schemas/DataBackfillJobType"},"uploadedFileId":{"description":"ID of the uploaded file","type":"string"},"uploadedFileName":{"description":"Name of the uploaded file","type":"string"},"uploadedFileUrl":{"description":"URL of the uploaded file. You can download the uploaded file via this url.","type":"string"},"uploadedFileSize":{"description":"Size of the uploaded file","type":"string"},"inputFileSize":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Size of the uploaded file, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"int64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"type":"integer","format":"int64"},"outputSize":{"description":"Size of the output file. \n","type":"string"},"outputType":{"description":"Type of the output file.","type":"string"},"outputFileSize":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Size of the output file, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"int64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":"integer","format":"int64"},"resultFileId":{"description":"ID of the output result file that you can download when a data backfill job is completed. \n","type":"string"},"resultFileName":{"description":"Name of the result file that you can download when a data backfill job is completed\n","type":"string"},"resultFileUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the result file that you can download when a data backfill job is completed. You can download the result file via this URL. In the result file, you can see the data that you uploaded and the result for each record in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column of the file. For the record that fails to be updated, you can see the reason for failure in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error Message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column of the file."},"children":[]}]}]}],"type":"string"},"uploadedBy":{"description":"The user who uploads the file\n","type":"string"},"uploadedOn":{"description":"The date and time when the file is uploaded\n","type":"string","format":"date-time"},"completedOn":{"description":"The date and time when the data backfill action is completed\n","type":"string","format":"date-time"},"startedProcessingOn":{"description":"The date and time when the data backfill action is started\n","type":"string","format":"date-time"},"totalCount":{"description":"The total count of the data records to backfill\n","type":"integer","format":"int32"},"failedCount":{"description":"The count of the data records that failed to be backfilled\n","type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/DataBackfillJobStatus"},"failureMessage":{"description":"Message for the failure\n","type":"string"},"processedCount":{"description":"The count of the data records that are being processed\n","type":"integer","format":"int64"},"successCount":{"description":"The count of the data records that are successfully backfilled\n","type":"integer","format":"int64"},"remainingTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining time for the data backfill job, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"int64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"type":"integer","format":"int64"},"remainingTimeText":{"description":"The remaining time for the data backfill job, in the text format\n","type":"string"},"completedPercentage":{"description":"The percentage of the completed data records\n","type":"integer","format":"int32"}}}},"components/schemas/zObject":{"id":"components/schemas/zObject","kind":"json-schema","title":"zObject","data":{"additionalProperties":{"description":"Field of the object.\n"},"type":"object"}},"components/schemas/ProxyActioncreateRequest":{"id":"components/schemas/ProxyActioncreateRequest","kind":"json-schema","title":"ProxyActioncreateRequest","data":{"example":{"type":"Account","objects":[{"Name":"Amy Lawrence","Status":"Draft","Currency":"USD","BillCycleDay":1}]},"properties":{"objects":{"description":"","items":{"$ref":"#/components/schemas/zObject"},"type":"array"},"type":{"description":"","type":"string"}},"required":["objects","type"],"type":"object"}},"components/schemas/ActionsErrorResponse":{"id":"components/schemas/ActionsErrorResponse","kind":"json-schema","title":"ActionsErrorResponse","data":{"properties":{"Code":{"description":"","type":"string"},"Message":{"description":"","type":"string"}},"type":"object"}},"components/schemas/SaveResult":{"id":"components/schemas/SaveResult","kind":"json-schema","title":"SaveResult","data":{"properties":{"Errors":{"description":"","items":{"$ref":"#/components/schemas/ActionsErrorResponse"},"type":"array"},"Id":{"description":"","type":"string"},"Success":{"description":"","type":"boolean"}},"type":"object"}},"components/schemas/ProxyActiondeleteRequest":{"id":"components/schemas/ProxyActiondeleteRequest","kind":"json-schema","title":"ProxyActiondeleteRequest","data":{"example":{"type":"ProductRatePlanCharge","ids":["2c93808457d787030157e031fcd34e19"]},"properties":{"ids":{"description":"A list of one or more IDs for the objects you want to delete.\n","items":{"type":"string"},"type":"array"},"type":{"description":"The type of object that you are deleting.\n","type":"string"}},"required":["type","ids"],"type":"object"}},"components/schemas/DeleteResult":{"id":"components/schemas/DeleteResult","kind":"json-schema","title":"DeleteResult","data":{"properties":{"errors":{"description":"If the delete failed, this contains an array of Error objects.\n","items":{"$ref":"#/components/schemas/ActionsErrorResponse"},"type":"array"},"id":{"description":"ID of the deleted object.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A boolean field indicating the success of the delete operation. If the delete was successful, it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/ProxyActionqueryRequest":{"id":"components/schemas/ProxyActionqueryRequest","kind":"json-schema","title":"ProxyActionqueryRequest","data":{"example":{"queryString":"select AccountNumber, BillCycleDay from Account where Id = '8ad09378905a5af201907ca1edb524c2'"},"properties":{"conf":{"description":"Configuration of the query result.","properties":{"batchSize":{"description":"Defines the batch size of the query result. The range is 1 - 2000 (inclusive). If a value higher than 2000 is submitted, only 2000 results are returned.\n","type":"integer"}},"type":"object"},"queryString":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com?resourceId=platform-zoql"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZOQL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that specifies the object to query, the fields to retrieve, and any filters."},"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":" When querying one time charges from ProductRatePlanCharge, you need to specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChargeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"One-Time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OneTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"required":["queryString"],"type":"object"}},"components/schemas/ProxyActionqueryResponse":{"id":"components/schemas/ProxyActionqueryResponse","kind":"json-schema","title":"ProxyActionqueryResponse","data":{"properties":{"done":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the returned records contain all the query results."},"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":"queryLocator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is returned, this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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 no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryLocator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is returned, this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"boolean"},"queryLocator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A marker passed to QueryMore to get the next set of results. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/Action_POSTqueryMore/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QueryMore"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"records":{"description":"A list of queried results.","items":{"$ref":"#/components/schemas/zObject"},"type":"array"},"size":{"description":"The number of the returned query results.","format":"int32","type":"integer"}},"type":"object"}},"components/schemas/ProxyActionqueryMoreRequest":{"id":"components/schemas/ProxyActionqueryMoreRequest","kind":"json-schema","title":"ProxyActionqueryMoreRequest","data":{"example":{"queryLocator":"2c92c0f9602fb240016049ac7e0b47e7-2000"},"properties":{"conf":{"description":"Configuration of the query result.","properties":{"batchSize":{"description":"Defines the batch size of the query result. The range is 1 - 2000 (inclusive). If a value higher than 2000 is submitted, only 2000 results are returned.\n","type":"integer"}},"type":"object"},"queryLocator":{"description":"A marker passed to QueryMore to get the next set of results.","type":"string"}},"required":["queryLocator"],"type":"object"}},"components/schemas/ProxyActionqueryMoreResponse":{"id":"components/schemas/ProxyActionqueryMoreResponse","kind":"json-schema","title":"ProxyActionqueryMoreResponse","data":{"properties":{"done":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the returned records contain all the query results."},"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":"queryLocator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is returned, this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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 no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queryLocator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is returned, this field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"boolean"},"queryLocator":{"description":"A marker passed to QueryMore to get the next set of results.","type":"string"},"records":{"description":"A list of queried results.","items":{"$ref":"#/components/schemas/zObject"},"type":"array"},"size":{"description":"The number of the returned query results.","format":"int32","type":"integer"}},"type":"object"}},"components/schemas/zObject_update":{"id":"components/schemas/zObject_update","kind":"json-schema","title":"zObject","data":{"allOf":[{"properties":{"Id":{"description":"","type":"string"},"fieldsToNull":{"description":"Used to set a list of fields to null.\n","items":{"type":"string"},"type":"array"}},"required":["Id"],"type":"object"},{"$ref":"#/components/schemas/zObject"}],"title":"zObject"}},"components/schemas/ProxyActionupdateRequest":{"id":"components/schemas/ProxyActionupdateRequest","kind":"json-schema","title":"ProxyActionupdateRequest","data":{"example":{"objects":[{"Id":"8ad09378905a5af201907ca1edb524c2","BillCycleDay":1}],"type":"Account"},"properties":{"objects":{"description":"","items":{"$ref":"#/components/schemas/zObject_update"},"type":"array"},"type":{"description":"","type":"string"}},"required":["objects","type"],"type":"object"}},"components/schemas/BodyInSettingValueRequest":{"id":"components/schemas/BodyInSettingValueRequest","kind":"json-schema","title":"settingsRequestBody","data":{"additionalProperties":true,"description":"Request payload if any","title":"settingsRequestBody","type":"object"}},"components/schemas/ChildrenSettingValueRequest":{"id":"components/schemas/ChildrenSettingValueRequest","kind":"json-schema","title":"childSettingsRequest","data":{"properties":{"body":{"$ref":"#/components/schemas/BodyInSettingValueRequest"},"id":{"description":"The id of the request. You can set it to any string. It must be unique within the whole batch.\n","type":"string"},"method":{"description":"One of the HTTP methods supported by the setting endpoint, for example, GET,PUT,POST or DELETE.\n","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE"],"type":"string"},"url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relative URL of the setting. It is the same as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pathPattern"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response body of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_ListAllSettings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing all settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/billing-rules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"title":"childSettingsRequest","type":"object"}},"components/schemas/SettingValueRequest":{"id":"components/schemas/SettingValueRequest","kind":"json-schema","title":"settingsRequest","data":{"properties":{"body":{"$ref":"#/components/schemas/BodyInSettingValueRequest"},"children":{"description":"An array of requests that can only be executed after its parent request has been executed successfully.\n","items":{"$ref":"#/components/schemas/ChildrenSettingValueRequest"},"type":"array"},"id":{"description":"The id of the request. You can set it to any string. It must be unique within the whole batch.\n","type":"string"},"method":{"description":"One of the HTTP methods supported by the setting endpoint, for example, GET,PUT,POST or DELETE.\n","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE"],"type":"string"},"url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relative URL of the setting. It is the same as in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pathPattern"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response body of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_ListAllSettings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing all Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/billing-rules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"title":"settingsRequest","type":"object"}},"components/schemas/SettingsBatchRequest":{"id":"components/schemas/SettingsBatchRequest","kind":"json-schema","title":"SettingsBatchRequest","data":{"example":{"requests":[{"id":"1","method":"GET","url":"/billing-rules"},{"id":"2","method":"GET","url":"/accounting-rules"}]},"properties":{"requests":{"items":{"$ref":"#/components/schemas/SettingValueRequest"},"type":"array"}},"type":"object"}},"components/schemas/BodyInSettingValueReponse":{"id":"components/schemas/BodyInSettingValueReponse","kind":"json-schema","title":"settingsResponseBody","data":{"additionalProperties":true,"description":"Response body if the request is executed successfully.","title":"settingsResponseBody","type":"object"}},"components/schemas/SettingValueResponse":{"id":"components/schemas/SettingValueResponse","kind":"json-schema","title":"settingsValueResponse","data":{"properties":{"body":{"$ref":"#/components/schemas/BodyInSettingValueReponse"},"errorMessages":{"description":"An array of error messages if errors occur when executing the request.\n","items":{"type":"string"},"type":"array"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User readable response status, for example, 502 BAD_GATEWAY."},"children":[]}]}]}],"type":"string"}},"title":"settingsValueResponse","type":"object"}},"components/schemas/SettingValueResponseWrapper":{"id":"components/schemas/SettingValueResponseWrapper","kind":"json-schema","title":"settingsValueResponseWrapper","data":{"properties":{"id":{"description":"The Id of the corresponding request.\n","type":"string"},"method":{"description":"The HTTP method. It is the same as that of the corresponding request.\n","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE"],"type":"string"},"response":{"$ref":"#/components/schemas/SettingValueResponse"},"url":{"description":"The url as specified in the corresponding request.\n","type":"string"}},"title":"settingsValueResponseWrapper","type":"object"}},"components/schemas/SettingsBatchResponse":{"id":"components/schemas/SettingsBatchResponse","kind":"json-schema","title":"batchResponse","data":{"properties":{"responses":{"items":{"$ref":"#/components/schemas/SettingValueResponseWrapper"},"type":"array"}},"title":"batchResponse","type":"object"}},"components/schemas/SettingItemHttpRequestParameter":{"id":"components/schemas/SettingItemHttpRequestParameter","kind":"json-schema","title":"httpRequestParameter","data":{"properties":{"description":{"description":"The description of the paramter.","type":"string"},"name":{"description":"The name of the parameter.","type":"string"}},"title":"httpRequestParameter","type":"object"}},"components/schemas/SettingItemHttpOperation":{"id":"components/schemas/SettingItemHttpOperation","kind":"json-schema","title":"httpOperation","data":{"properties":{"method":{"description":"One of the HTTP methods supported by the setting endpoint, for example, GET,PUT,POST or DELETE.","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE"],"type":"string"},"parameters":{"description":"An array of paramters required by this operation.","items":{"$ref":"#/components/schemas/SettingItemHttpRequestParameter"},"type":"array"},"requestType":{"description":"JSON Schema for the request body of this operation.","type":"object"},"responseType":{"description":"JSON Schema for the response body of this operation.","type":"object"},"url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint url of the operation method. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/settings/billing-rules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"title":"httpOperation","type":"object"}},"components/schemas/SettingItemWithOperationsInformation":{"id":"components/schemas/SettingItemWithOperationsInformation","kind":"json-schema","title":"settingItem","data":{"properties":{"context":{"description":"The context where this setting item is effective.","enum":["Tenant","Entity","User","None"],"type":"string"},"description":{"description":"The description of the setting item as you see from Zuora UI.","type":"string"},"httpOperations":{"description":"An array of HTTP operation methods that are supported on this setting endpoint.","items":{"$ref":"#/components/schemas/SettingItemHttpOperation"},"type":"array"},"key":{"description":"The unique key to distinguish the setting item.","type":"string"},"pathPattern":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path pattern of the setting endpoint, relative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/settings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/billing-rules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"title":"settingItem","type":"object"}},"components/schemas/ListAllSettingsResponse":{"id":"components/schemas/ListAllSettingsResponse","kind":"json-schema","title":"allSettings","data":{"properties":{"settings":{"items":{"$ref":"#/components/schemas/SettingItemWithOperationsInformation"},"type":"array"}},"title":"allSettings","type":"object"}},"components/schemas/RestoreFile":{"id":"components/schemas/RestoreFile","kind":"json-schema","title":"RestoreFile","data":{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the quota limit is exceeded, and you will see an error message in the response body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Your file restoration request can not be processed currently due to reaching the maximum daily limit of 1000 files as of 2024-04-01 14:12. Please wait for the limit to be refreshed or reach out to Zuora support if the request is urgent.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In such cases, wait for a limit refresh or submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"},"fileId":{"description":"The unique ID of the file.\n","type":"string"},"status":{"description":"The status of the file restore operation.\n","enum":["ACTIVE","ARCHIVING","ARCHIVED","RESTORE_ACCEPTED","RESTORE_IN_PROGRESS","RESTORED"],"type":"string"}},"type":"object"}},"components/schemas/RetrieveFileStatus":{"id":"components/schemas/RetrieveFileStatus","kind":"json-schema","title":"RetrieveFileStatus","data":{"properties":{"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"accessible":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the file is accessible."},"children":[]}]}]}],"type":"boolean"},"status":{"description":"The status of the file restore operation.\n","enum":["ACTIVE","ARCHIVING","ARCHIVED","RESTORE_ACCEPTED","RESTORE_IN_PROGRESS","RESTORED"],"type":"string"}},"type":"object"}},"components/schemas/ProxyPostImport":{"id":"components/schemas/ProxyPostImport","kind":"json-schema","title":"ProxyPostImport","data":{"properties":{"Id":{"description":"The ID of the Import object that was created.\n","type":"string"},"Success":{"description":"Indicates whether the call succeeded.\n","type":"boolean"}},"type":"object"}},"components/schemas/ProxyGetImport":{"id":"components/schemas/ProxyGetImport","kind":"json-schema","title":"ProxyGetImport","data":{"properties":{"CreatedById":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user ID of the person who created the import."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"type":"string"},"CreatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the import was created."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"format":"date-time","type":"string"},"Id":{"description":"Object identifier.","type":"string"},"ImportType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of item imported."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 7"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Usage"},"children":[]}]}]}],"type":"string"},"ImportedCount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of records successfully imported."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"format":"int32","type":"integer"},"Md5":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A check to validate the import file's integrity."},"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":"Character limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 32"},"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":"System-generated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" no"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a string of 32 characters or fewer"},"children":[]}]}]}],"type":"string"},"Name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A descriptive name for the import."},"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":"Character limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 100"},"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":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"a string of 100 characters or fewer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if NULL default is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import <ImportType_value>"},"children":[]}]}]}]}],"type":"string"},"OriginalResourceUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL for your import file, which contains your records for upload. When you upload the file, Zuora assigns it to this address."},"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":"Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" automatic dynamically-generated URL"},"children":[]}]}]}],"type":"string"},"ResultResourceUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL for the import result file, which is a zipped CSV file."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatic dynamically-generated URL"},"children":[]}]}]}],"type":"string"},"Status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the import process."},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated using 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":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]}]}],"type":"string"},"StatusReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for the system-generated status. Use this information if the import fails."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 2000"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated error message"},"children":[]}]}]}],"type":"string"},"TotalCount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of records in the import file."},"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":"Character limit"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"format":"int32","type":"integer"},"UpdatedById":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the user who last updated the import."},"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":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 32"},"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":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"type":"string"},"UpdatedDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when the import was last updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 29 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": automatically generated"},"children":[]}]}]}],"format":"date-time","type":"string"}},"type":"object"}},"components/schemas/GETCustomExchangeRatesType":{"id":"components/schemas/GETCustomExchangeRatesType","kind":"json-schema","title":"GETCustomExchangeRatesType","data":{"properties":{"inverse":{"description":[{"$$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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the exchange rate in the response is an inverse exchange rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the exchange rate in the response is not an inverse exchange rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is determined by the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use inverse rate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" checkbox in your Zuora Finance Manage Currency Conversion settings."},"children":[]}]}]}]}],"type":"boolean"},"rateSetName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the exchange rate set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify the exchange rate set only when "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange Rate Set"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission is available. To enable the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange Rate Set"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option, submit a request at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://support.zuora.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Global Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"rates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for exchange rate data. Contains a set of fields that provide exchange rate data for each day between the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (inclusive)."},"children":[]}]}]}],"additionalProperties":{"type":"object","title":"rate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for exchange rate information on a given date. The field name is a  date in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-01-15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"providerExchangeRateDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of the exchange rate used. The date is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater."},"children":[]}]}]}],"format":"date","type":"string"}},"additionalProperties":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The exchange rate on the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"providerExchangeRateDate"},"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 field name is the ISO currency code of the currency, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is the exchange rate for the specified date, in the format of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0000000000"},"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":"There may be more than one currency returned for a given"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"providerExchangeRateDate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the rate for a certain currency is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not available on the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"providerExchangeRateDate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the currency is not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned in the response."},"children":[]}]}]}]}},"type":"object","title":"rates"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/POSTAttachmentResponseType":{"id":"components/schemas/POSTAttachmentResponseType","kind":"json-schema","title":"POSTAttachmentResponseType","data":{"properties":{"fileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID to identify the attached file. Use this file ID with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_Files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to download the file."},"children":[]}]}]}],"type":"string"},"id":{"description":"Attachment id.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GETAttachmentResponseType":{"id":"components/schemas/GETAttachmentResponseType","kind":"json-schema","title":"GETAttachmentResponseType","data":{"properties":{"createdBy":{"description":"Zuora user id who added this attachment to the object.\n","type":"string"},"createdOn":{"description":"Date and time when the attachment was added to the object.\n","type":"string"},"description":{"description":"Description of the attachment.\n","type":"string"},"fileContentType":{"description":"File type.\n","type":"string"},"fileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File ID of the attached file. Use this file ID with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_Files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to download the file."},"children":[]}]}]}],"type":"string"},"fileName":{"description":"Attachment file name.\n","type":"string"},"id":{"description":"Id of this attachment.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"},"updatedBy":{"description":"Zuora user id who last updated the attachment.\n","type":"string"},"updatedOn":{"description":"Date and time when the attachment was last updated.\n","type":"string"}},"type":"object"}},"components/schemas/PUTAttachmentType":{"id":"components/schemas/PUTAttachmentType","kind":"json-schema","title":"PUTAttachmentType","data":{"example":{"description":"Details of the attachment"},"properties":{"description":{"description":"Description of the attachment.\n","type":"string"},"fileName":{"description":"File name of the attachment. The value should not contain the file extension. Only the file name without the extension can be edited.\n","type":"string"}},"type":"object"}},"components/schemas/GETAttachmentResponseWithoutSuccessType":{"id":"components/schemas/GETAttachmentResponseWithoutSuccessType","kind":"json-schema","title":"attachments","data":{"properties":{"createdBy":{"description":"Zuora user id of who added this attachment to the object.\n","type":"string"},"createdOn":{"description":"Date and time when the attachment was added to the object.\n","type":"string"},"description":{"description":"Description of the attachment.\n","type":"string","nullable":true},"fileContentType":{"description":"Attachment file type.\n","type":"string"},"fileId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File ID of the attached file. Use this file ID with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/GET_Files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to download the file."},"children":[]}]}]}],"type":"string"},"fileName":{"description":"Attachment file name.\n","type":"string"},"id":{"description":"Zuora id of this attachement.\n","type":"string"},"organizationLabel":{"description":"The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n","type":"string"},"updatedBy":{"description":"Zuora user id who last updated the attachment.\n","type":"string"},"updatedOn":{"description":"Date and time when the attachment was last updated.\n","type":"string"}},"title":"attachments","type":"object"}},"components/schemas/GETAttachmentsResponseType":{"id":"components/schemas/GETAttachmentsResponseType","kind":"json-schema","title":"GETAttachmentsResponseType","data":{"properties":{"attachments":{"description":"Container for one or more attachments.\n","items":{"$ref":"#/components/schemas/GETAttachmentResponseWithoutSuccessType"},"type":"array"},"nextPage":{"description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n","format":"URL","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"}},"components/schemas/GetObjectSummary":{"id":"components/schemas/GetObjectSummary","kind":"json-schema","title":"GetObjectSummary","data":{"type":"object","required":["objectName","label","supportCustomField"],"properties":{"objectName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical object name from Metastore (DQ/OQ). Casing matches the provider (often lowercase"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); not normalized to PascalCase."},"children":[]}]}]}],"example":"account"},"label":{"type":"string","description":"Human-readable label","example":"Account"},"category":{"type":"string","description":"Object category (DQ/OQ contexts only)","example":"core"},"supportCustomField":{"type":"boolean","description":"Whether this object supports custom fields","example":true},"href":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path to the describe endpoint for this object. The path segment uses the same casing as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectName"},"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 server returns this path "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix; combine with the API base URL"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://rest.zuora.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"/object-metadata/account?context=DQ"}}}},"components/schemas/ErrorReason":{"id":"components/schemas/ErrorReason","kind":"json-schema","title":"ErrorReason","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single Zuora reason entry (code + message)."},"children":[]}]}]}],"required":["code","message"],"properties":{"code":{"type":"integer","description":"Zuora reason code (RRRRRRCC format)","example":50000027},"message":{"type":"string","description":"Human-readable explanation for this reason"}}}},"components/schemas/MetadataApiError":{"id":"components/schemas/MetadataApiError","kind":"json-schema","title":"MetadataApiError","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora v1 REST error envelope returned by this API: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus "},"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":"The HTTP status is indicated by the response status line only; there are no top-level"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields in the JSON body."},"children":[]}]}]}],"required":["reasons","requestId"],"properties":{"reasons":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ErrorReason"}},"requestId":{"type":"string","description":"Request correlation id (Zuora IT id from the gateway when available; otherwise a generated UUID).\n","example":"9458f78d-ae13-4a71-87d9-532182c6eb0f"}}}},"components/schemas/InlineRelationshipSchema":{"id":"components/schemas/InlineRelationshipSchema","kind":"json-schema","title":"InlineRelationshipSchema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inline relationship metadata attached to foreign key fields (DQ/OQ only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides quick access to relationship information without parsing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-zuora-relationships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"required":["object","cardinality","fields"],"properties":{"object":{"type":"string","description":"Related object name","example":"Contact"},"cardinality":{"type":"string","enum":["manyToOne","oneToMany"],"description":"Relationship cardinality"},"fields":{"type":"object","description":"Foreign key field mappings","additionalProperties":{"type":"string"}}}}},"components/schemas/FieldSchema":{"id":"components/schemas/FieldSchema","kind":"json-schema","title":"FieldSchema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field definition with JSON Schema core properties and Zuora extensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-zuora-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flags are emitted only when true; if a flag is absent, treat it as false."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extensions vary by context:"},"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":"DQ/OQ: filterable, sortable, indexed, unique, object-key, inline relationships"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DSE/AQUA: selectable, createable, updateable, relationship metadata"},"children":[]}]}]}]}],"required":["type"],"properties":{"type":{"type":"string","description":"JSON Schema type","nullable":true,"enum":["string","number","integer","boolean","array","object"]},"format":{"type":"string","description":"JSON Schema format hint","enum":["date","date-time","uuid"]},"description":{"type":"string","description":"Field description"},"readOnly":{"type":"boolean","description":"Present only when true (read-only fields)"},"maxLength":{"type":"integer","description":"Maximum string length"},"minimum":{"type":"number","description":"Minimum numeric value"},"maximum":{"type":"number","description":"Maximum numeric value"},"enum":{"type":"array","description":"Allowed values for picklist fields","items":{"type":"string"}},"default":{"description":"Default value"},"x-zuora-type":{"type":"string","description":"Original Zuora type name","example":"zuuid"},"x-zuora-filterable":{"type":"boolean","description":"Whether field can be filtered (DQ/OQ/DSE)"},"x-zuora-sortable":{"type":"boolean","description":"Whether field can be sorted (DQ/OQ)"},"x-zuora-indexed":{"type":"boolean","description":"Whether field is indexed (DQ/OQ)"},"x-zuora-unique":{"type":"boolean","description":"Whether field values must be unique (DQ/OQ)"},"x-zuora-object-key":{"type":"boolean","description":"Whether field is the object's primary key (DQ/OQ)"},"x-zuora-custom-field":{"type":"boolean","description":"Whether this is a custom field"},"x-zuora-selectable":{"type":"boolean","description":"Whether field can be selected in queries (DSE/AQUA)"},"x-zuora-createable":{"type":"boolean","description":"Whether field can be set on create (DSE/AQUA)"},"x-zuora-updateable":{"type":"boolean","description":"Whether field can be updated (DSE/AQUA)"},"x-zuora-relationship":{"$ref":"#/components/schemas/InlineRelationshipSchema"}}}},"components/schemas/RelationshipSchema":{"id":"components/schemas/RelationshipSchema","kind":"json-schema","title":"RelationshipSchema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relationship metadata describing how this object relates to another."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format varies by context:"},"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":"DQ/OQ: Basic cardinality and field mappings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DSE/AQUA: Additional label, directRelationship, and path metadata"},"children":[]}]}]}]}],"required":["object","cardinality"],"properties":{"object":{"type":"string","description":"Related object name","example":"Contact"},"cardinality":{"type":"string","enum":["manyToOne","oneToMany","manyToMany"],"description":"Relationship cardinality"},"fields":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Foreign key field mappings (local field -> remote field)"},"children":[]}]}]}],"additionalProperties":{"type":"string"},"example":{"BillToContactId":"Id"}},"label":{"type":"string","description":"Human-readable relationship label (DSE/AQUA only)","example":"Bill To Contact"},"directRelationship":{"type":"boolean","description":"Whether this is a direct relationship (DSE/AQUA only)"},"path":{"type":"string","description":"Relationship path (DSE/AQUA only)","example":"Account.BillToContact"}}}},"components/schemas/GetJsonSchema":{"id":"components/schemas/GetJsonSchema","kind":"json-schema","title":"GetJsonSchema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Schema Draft 2020-12 with Zuora extensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See https://json-schema.org/draft/2020-12/schema for core schema."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora extensions (x-zuora-*) provide additional metadata about"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields and relationships specific to Zuora's data platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zuora.com/schemas/{name}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{name}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"canonical object name"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the provider (same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" forced PascalCase rewrite. It does not encode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the REST URL of this request or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"required":["$schema","$id","type"],"properties":{"$schema":{"type":"string","description":"JSON Schema dialect","example":"https://json-schema.org/draft/2020-12/schema"},"$id":{"type":"string","format":"uri","description":"Stable schema URI (canonical object name suffix; not the REST URL for this endpoint)","example":"https://api.zuora.com/schemas/account"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical object name from upstream (same segment as in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"account"},"description":{"type":"string","description":"Object description","example":"Account object schema"},"type":{"type":"string","enum":["object"],"description":"Schema type (always 'object' for Zuora objects)"},"properties":{"type":"object","description":"Field definitions keyed by field name","additionalProperties":{"$ref":"#/components/schemas/FieldSchema"}},"required":{"type":"array","description":"List of required field names","items":{"type":"string"}},"x-zuora-context":{"type":"string","enum":["DQ","OQ","DSE","AQUA"],"description":"Data context"},"x-zuora-category":{"type":"string","description":"Object category (DQ/OQ only)","example":"core"},"x-zuora-support-custom-field":{"type":"boolean","description":"Whether object supports custom fields"},"x-zuora-relationships":{"type":"array","description":"Relationships to other objects","items":{"$ref":"#/components/schemas/RelationshipSchema"}}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","maxLength":64},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"11e643f4-a3ee-8bad-b061-0025904c756d"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"properties":{"client_id":{"description":"The Client ID of the OAuth client.\n","maxLength":36,"minLength":36,"type":"string"},"client_secret":{"description":"The Client Secret that was displayed when the OAuth client was created.\n","maxLength":42,"type":"string"},"grant_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The OAuth grant type that will be used to generate the token. The value of this parameter must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["client_credentials"],"type":"string"}},"required":["client_id","client_secret","grant_type"],"type":"object"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"object","properties":{"X-RateLimit-Limit-minute":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate limit of this operation, in requests per minute. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"X-RateLimit-Remaining-minute":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests that you may make in the next minute. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","maxLength":255},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. \nYou cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"WWW-Authenticate":{"type":"string","enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:\\n\\n"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\n\\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\\n\\n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n"},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string"},"WWW-Authenticate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. \nYou cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"WWW-Authenticate":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain."},"children":[]}]}]}]},"RateLimit-Limit":{"type":"string"},"RateLimit-Remaining":{"type":"number"},"RateLimit-Reset":{"type":"number"},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain."},"children":[]}]}]}]},"RateLimit-Limit":{"type":"string","description":"The request limit quota for the time window closest to exhaustion. See rate limits docs."},"RateLimit-Remaining":{"type":"number","description":"The number of requests remaining in the time window closest to quota exhaustion. See rate limits docs."},"RateLimit-Reset":{"type":"number","description":"The number of seconds until the quota resets for the time window closest to exhaustion. See rate limits docs."},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call."},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain."},"children":[]}]}]}]},"RateLimit-Limit":{"type":"string","description":"The request limit quota for the time window closest to exhaustion. See rate limits docs."},"RateLimit-Remaining":{"type":"number","description":"The number of requests remaining in the time window closest to quota exhaustion. See rate limits docs."},"RateLimit-Reset":{"type":"number","description":"The number of seconds until the quota resets for the time window closest to exhaustion. See rate limits docs."},"WWW-Authenticate":{"type":"string","enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call."},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":"The number of requests remaining in the time window closest to quota exhaustion."},"RateLimit-Reset":{"type":"number","description":"The number of seconds until the quota resets for the time window closest to exhaustion."},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. \nYou cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"object","properties":{"expand":{"type":"object","description":"Controls which related objects are expanded and included in the response.\n","properties":{"productRatePlans":{"type":"boolean","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes product rate plans in the response."},"children":[]}]}]}]},"productRatePlanCharges":{"type":"boolean","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes product rate plan charges in the response."},"children":[]}]}]}]},"businessContextFilters":{"type":"boolean","description":[{"$$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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes business context filters in the response."},"children":[]}]}]}]}}}}},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":"The request limit quota for the time window closest to exhaustion."},"RateLimit-Remaining":{"type":"number","description":"The number of requests remaining in the time window closest to quota exhaustion."},"RateLimit-Reset":{"type":"number","description":"The number of seconds until the quota resets for the time window closest to quota exhaustion."},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. \nYou cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion."},"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://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}]},"WWW-Authenticate":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string"},"WWW-Authenticate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call."},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","properties":{"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. \nYou cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"string","example":"-occurredAt"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":20},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"string","enum":["pending","active","paused","inactive","expired","revoked"]},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":1},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"integer","maximum":40,"default":20},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"properties":{"jobId":{"description":"The ID of an asynchronous job that will be returned for tracking the status and result of the job.","format":"UUID","type":"string"}},"type":"object"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"Location":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for accessing the job result, in the format of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/async-jobs/{jobId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/async-jobs/2c90a02d676688200167770ce20601b6"},"children":[]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"format":"date","type":"string"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"enum":["all","cancelled","completed","draft","executing","failed","pending","scheduled"],"type":"string"},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"properties":{"jobId":{"description":"The ID of an asynchronous job that will be returned for tracking the status and result of the job.","format":"UUID","type":"string"},"success":{"description":"Indicates whether the operation call succeeded.","type":"boolean"}},"type":"object"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"Location":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL for accessing the job result, in the format of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/async-jobs/{jobId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/async-jobs/1bc24f315d7b48d3a20245bfe73bdceb"},"children":[]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"format":"string","type":"string"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header. "},"Zuora-Track-Id":{"maxLength":64,"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. "}}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"format":"UUID","type":"string"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"properties":{"cancelReason":{"description":"The reason for cancelling the order.","example":"Customer cancelled the order.","type":"string"}},"type":"object"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. \nYou cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"string","format":"CommitmentTypeEnum","enum":["MinCommitment","MaxCommitment"],"example":"MinCommitment"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":20},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"properties":{"file":{"description":"The usage data to import. The supported formats are excel, csv, and zip.\n","format":"binary","type":"string"}},"required":["file"],"type":"object"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"string","default":79},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"string","enum":["0.0.1"]},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"string","default":"application/json"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"string","example":"multipart/form-data"},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"The file to store"},"hasHeader":{"type":"boolean","description":"Indicates if the file has a header (for CSV/Excel)"},"firstRow":{"type":"integer","description":"Indicates where the first row starts (for CSV format)"},"delimiter":{"type":"string","description":"Delimiter to separate values (for CSV format)"},"sheet":{"type":"string","description":"The sheet where data lives (for Excel)"},"dataRange":{"type":"string","description":"The data range in the sheet (for Excel)"},"resolveFileNameConflict":{"type":"boolean","description":"Whether to generate a UUID file name"},"targetFolder":{"type":"string","description":"The target folder to store the file"},"overwriteExistingFile":{"type":"boolean","description":"Whether to overwrite an existing file"}}},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/StreamingEvent"},{"type":"array","items":{"$ref":"#/components/schemas/StreamingEvent"}}]},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"string","enum":["SAMPLE","ERROR"]},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"string","enum":["DEBUG","NORMAL"]},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":30,"maximum":500},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":30,"maximum":100},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":1},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"string","enum":["csv","parquet","avro"],"default":"csv"},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"string","enum":["none","gzip","lz4","zstd"],"default":"none"},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"string","example":"2c734651-1ca5-4a87-b104-fecba5bf1c35"},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2026-02-10"},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2026-02-16"},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"string","enum":["MANUAL","AUTOMATIC"]},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["RUNNING","FINISHED","FAILED","CANCELED"]}},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":20,"minimum":1,"maximum":100},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"string","example":"eyJqb2JJZCI6MTIzND..."},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":20,"maximum":50},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"maxLength":64,"type":"string","description":"A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"enum":["Draft","Posted","Canceled","Error"],"type":"string"},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"WWW-Authenticate":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"},"children":[]}]}]}]}}},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"properties":{"file":{"description":"The PDF file to upload for the invoice.\n","format":"binary","type":"string"}},"type":"object"},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"maxLength":64,"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.        \n"}}},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"format":"double","type":"number"},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"type":"string"},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"enum":["Processing","Yes","No","Error","Ignore"],"type":"string"},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"properties":{"file":{"description":"The PDF file to upload for the credit memo.\n","format":"binary","type":"string"}},"type":"object"},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"properties":{"file":{"description":"The PDF file to upload for the debit memo.\n","format":"binary","type":"string"}},"type":"object"},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"type":"string","example":"AU"},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"string","example":"PEPPOLNetwork","enum":["Clearance","ClearanceWithCancellation","PEPPOLNetwork","Unknown"]},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"string","example":"8ad093788ea359ca018ea75fb12a6348"},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"string","enum":["XML","PDF","ZIP","OASIS_Universal_Business_Language_XML"]},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"enum":["Invoice","CreditMemo","DebitMemo"],"type":"string"},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"},{"$ref":"#/components/schemas/CommonResponse"}]},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"WWW-Authenticate":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. \nYou cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"WWW-Authenticate":{"enum":["Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this header is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n"},"children":[]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. \nYou cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EComplianceSourceObjectType"},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"type":"string","enum":["EReporting"]},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"string","enum":["INVOICE","CREDIT_MEMO","DEBIT_MEMO","PAYMENT","REFUND"]},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"integer","default":20},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"maxLength":64,"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding:\\ \\ gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data.\\n\\ \\nNote that only the following MIME types support gzipped responses:\\n\\ \\  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n\\ \\  - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\\n\""},"children":[]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header. "},"Zuora-Track-Id":{"maxLength":64,"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. "}}},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"example":{"cancelOnce":true},"properties":{"cancelOnce":{"default":true,"description":"Whether to cancel the current bill run or cancel all future recurring bill runs, only valid for a scheduled bill run.\n","type":"boolean"}},"type":"object"},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"example":{"invoiceDate":"2022-01-01"},"properties":{"invoiceDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that appears on the invoice being created, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-mm-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value cannot fall in a closed accounting period."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["invoiceDate"],"type":"object"},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"properties":{"billingPreviewRunId":{"description":"Id of the billing preview run.\n","type":"string"},"success":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the request was processed successfully."},"children":[]}]}]}],"type":"boolean"}},"type":"object"},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"string","enum":["ApplePay","GooglePay"]},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"enum":["Draft","Processing","Processed","Error","Canceled","Posted"],"type":"string"},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"enum":["External","Electronic"],"type":"string"},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"enum":["Pending","Processing","Completed","Error","Canceled"],"type":"string"},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"type":"string"},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"enum":["Processed","Canceled","Error","Processing"],"type":"string"},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"object","properties":{"bulkPaymentOptionItems":{"type":"array","description":"An array of payment profiles you want to create or update.\n","items":{"properties":{"subscriptionId":{"type":"string","description":"The ID of the subscription associated with the payment profile fields.\n","format":"uuid"},"paymentMethodId":{"type":"string","description":"The ID of the payment method that processes the payment.\n","format":"uuid"},"paymentGatewayId":{"type":"string","description":"The ID of the gateway instance that processes the payment.\n","format":"uuid"}}}}},"example":{"bulkPaymentOptionItems":[{"subscriptionId":"8ad080f08ed1c780018ed6acc5eb65fd","paymentGatewayId":"8b48f15831445266784be9fb20be9b40","paymentMethodId":"8ad09be48e5bcc3f018e5f0c0791674d"},{"subscriptionId":"2c92c0f86a8dd422016a9e7a70116b0d","paymentGatewayId":"8ad086dc88762fc7018876e2a83406ef","paymentMethodId":"8ad0950c8292b8560182a75940b808cd"}]}},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation is successful."}},"example":{"success":true}},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation is successful."},"message":{"type":"string","description":"The response message."}},"example":{"success":true,"message":"Payments with the following IDs enqueued for processing: [290, 291]"}},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation is successful."},"message":{"type":"string","description":"The response message."}},"example":{"success":true,"message":"Payments with the following IDs enqueued for processing: [300]"}},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation is successful."},"message":{"type":"string","description":"The response message."}},"example":{"success":true,"message":"Payments with the following IDs enqueued for processing: [310, 311, 312]"}},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"object","properties":{"account_ids":{"type":"array","description":"IDs of accounts.","items":{"type":"string"}},"debit_memo_ids":{"type":"array","description":"IDs of debit memos.","items":{"type":"string"}},"invoice_ids":{"type":"array","description":"IDs of invoices.","items":{"type":"string"}}},"example":{"account_ids":["2c92c0f96bd69165016bdcbf55ad5e62"],"invoice_ids":["2c92c0fa7853052701785a38c6622473","2c92c0fa7849b40a01784bc5de0f760f"],"debit_memo_ids":["2c92c0fa7853052701785a38f3bb267f"]}},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation is successful."},"message":{"type":"string","description":"The response message."}},"example":{"success":true,"message":"Payments with the following IDs enqueued for processing: [100, 101, 110, 111, 121]"}},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation is successful."},"message":{"type":"string","description":"The response message."}},"example":{"success":true,"message":"Payments with the following IDs have been removed from the retry cycle: [290, 291]"}},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation is successful."},"message":{"type":"string","description":"The response message."}},"example":{"success":true,"message":"Payments with the following IDs have been removed from the retry cycle: [301]"}},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation is successful."},"message":{"type":"string","description":"The response message."}},"example":{"success":true,"message":"Payments with the following IDs have been removed from the retry cycle: [310, 311, 312]"}},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"object","properties":{"payment_id":{"type":"string","description":"ID of a failed payment."}},"example":{"payment_id":"2c92c0867849d42301784bc9ce806c31"}},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation is successful."},"message":{"type":"string","description":"The response message."}},"example":{"success":true,"message":"Payment entered into retry process"}},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":99,"default":10},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["billto","soldto","shipto","defaultpaymentmethod","subscriptions","payments","refunds","creditmemos","debitmemos","invoices","usages","paymentmethods","subscriptions.rateplans","subscriptions.rateplans.rateplancharges"]}},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"object","title":"QueryAccountsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedAccount"}}}},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"object","title":"QueryAmendmentsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedAmendment"}}}},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"object","title":"QueryBillingRunsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedBillingRun"}}}},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"object","title":"QueryContactsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedContact"}}}},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","billtocontact","billtocontactsnapshot","soldtocontactsnapshot","shiptocontactsnapshot","creditmemoitems","creditmemoitems.subscription","creditmemoitems.subscription.account","creditmemoapplications"]}},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"object","title":"QueryCreditMemosResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedCreditMemo"}}}},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["creditmemo"]}},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"object","title":"QueryCreditMemoApplicationsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedCreditMemoApplication"}}}},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["subscription","rateplancharge","subscriptionowner","credittaxationitems"]}},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"object","title":"QueryCreditMemoItemsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedCreditMemoItem"}}}},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"object","title":"QueryDebitMemoItemsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedDailyConsumptionSummary"}}}},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","billtocontact","billtocontactsnapshot","soldtocontactsnapshot","shiptocontactsnapshot","debitmemoitems","debitmemoitems.subscription","debitmemoitems.subscription.account"]}},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"object","title":"QueryDebitMemosResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedDebitMemo"}}}},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["subscription","rateplancharge","subscriptionowner","debittaxationitems"]}},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"object","title":"QueryDebitMemoItemsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedDebitMemoItem"}}}},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedDeliveryAdjustment"}}}},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedFulfillment"}}}},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","account.billto","account.soldto","account.shipto","billtocontact","billtocontactsnapshot","creditmemoapplications","creditmemoapplications.creditmemo","creditmemoparts","creditmemoparts.creditmemo","soldtocontactsnapshot","shiptocontactsnapshot","invoiceitems","invoiceitems.subscription","invoiceitems.subscription.account","paymentapplications","paymentapplications.payment","paymentparts","paymentparts.payment"]}},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"object","title":"QueryInvoicesResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedInvoice"}}}},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["invoice","subscription","subscriptionowner","taxationitems","rateplancharge","orderlineitem"]}},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"object","title":"QueryInvoiceItemsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedInvoiceItem"}}}},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["invoicescheduleitems","invoicescheduleitems.invoice","invoicescheduleitems.creditmemo","invoiceschedulebookings","invoiceschedulebookings.order","invoiceschedulebookings.subscription","rateplancharges"]}},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"object","title":"QueryInvoiceSchedulesResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedInvoiceSchedule"}}}},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["subscription","order"]}},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"object","title":"QueryOrderActionsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedOrderAction"}}}},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["billto","invoiceitems","invoiceowneraccount","owneraccount","soldtoinfo"]}},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"type":"object","title":"QueryOrderLineItemsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedOrderLineItem"}}}},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","orderlineitems","orderlineitems.invoiceitems","orderactions","orderactions.subscription","orderactions.subscription.rateplans","orderactions.subscription.rateplans.rateplancharges"]}},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"object","title":"QueryOrdersResponse","description":"","nullable":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedOrders"}}}},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","account.billto","account.soldto","paymentmethod","paymentapplications","paymentscheduleitempayments","paymentscheduleitempayments.paymentscheduleitem"]}},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"type":"object","title":"QueryPaymentsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPayment"}}}},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["payment"]}},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"type":"object","title":"QueryPaymentApplicationsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPaymentApplication"}}}},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account"]}},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"type":"object","title":"QueryPaymentMethodsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPaymentMethod"}}}},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"object","title":"QueryPaymentMethodSnapshotsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPaymentMethodSnapshot"}}}},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"object","title":"QueryPaymentRunsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPaymentRun"}}}},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"object","title":"QueryPaymentSchedulesResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPaymentSchedule"}}}},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["paymentscheduleitempayments","paymentscheduleitempayments.payment"]}},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"object","title":"QueryPaymentScheduleItemsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPaymentScheduleItem"}}}},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","origsubscription"]}},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"object","title":"QueryPrepaidBalancesResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPrepaidBalance"}}}},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","prepaidbalance","source","vpsummary"]}},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"object","title":"QueryPrepaidBalanceFundsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPrepaidBalanceFund"}}}},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","prepaidbalance","fund"]}},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"type":"object","title":"QueryPrepaidBalanceTransactionsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedPrepaidBalanceTransaction"}}}},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["usage","invoiceitem","creditmemoitem"]}},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"type":"object","title":"QueryProcessedUsagesResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedProcessedUsage"}}}},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["productrateplans","productrateplans.productrateplancharges","productrateplans.productrateplancharges.productrateplanchargetiers"]}},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"type":"object","title":"QueryProductsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedProduct"}}}},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["product","productrateplancharges","productrateplancharges.productrateplanchargetiers","externalproductrateplans"]}},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"type":"object","title":"QueryProductRatePlansResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedProductRatePlan"}}}},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["productrateplan","productrateplanchargetiers"]}},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"type":"object","title":"QueryProductRatePlanChargesResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedProductRatePlanCharge"}}}},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["productrateplancharge"]}},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"type":"object","title":"QueryProductRatePlanChargeTiersResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedProductRatePlanChargeTier"}}}},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedRamp"}}}},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["subscription","productrateplan","rateplancharges","rateplancharges.rateplanchargetiers"]}},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"type":"object","title":"QueryRatePlansResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedRatePlan"}}}},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["rateplan","productrateplancharge","rateplanchargetiers"]}},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"object","title":"QueryRatePlanChargesResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedRatePlanCharge"}}}},"id":"schema_177"},"schema_178":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["rateplancharge"]}},"id":"schema_178"},"schema_179":{"kind":"json-schema","data":{"type":"object","title":"QueryRatePlanChargesResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedRatePlanChargeTier"}}}},"id":"schema_179"},"schema_180":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","rateplancharge","subscription","invoiceitem"]}},"id":"schema_180"},"schema_181":{"kind":"json-schema","data":{"type":"object","title":"QueryRatingResultsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedRatingResult"}}}},"id":"schema_181"},"schema_182":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","account.billto","account.soldto","paymentmethod","refundapplications","refundapplications.payment","refundapplications.refundapplicationitems"]}},"id":"schema_182"},"schema_183":{"kind":"json-schema","data":{"type":"object","title":"QueryRefundsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedRefund"}}}},"id":"schema_183"},"schema_184":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["refund","payment","refundapplicationitems"]}},"id":"schema_184"},"schema_185":{"kind":"json-schema","data":{"type":"object","title":"QueryRefundApplicationsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedRefundApplication"}}}},"id":"schema_185"},"schema_186":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["refundapplication"]}},"id":"schema_186"},"schema_187":{"kind":"json-schema","data":{"type":"object","title":"QueryRefundApplicationItemsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedRefundApplicationItem"}}}},"id":"schema_187"},"schema_188":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["endDate","startDate","statementRunNumber"]}},"id":"schema_188"},"schema_189":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["accountId","id","startDate","statementRunNumber","status"]}},"id":"schema_189"},"schema_190":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["endDate","statementDate","statementNumber"]}},"id":"schema_190"},"schema_191":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["accountId","id","startDate","statementDate","statementNumber","statementRunId","status","emailStatus"]}},"id":"schema_191"},"schema_192":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["createdById","createdDate","deleted","endDate","fileId","updatedById","updatedDate","errorCategory","errorMessage"]}},"id":"schema_192"},"schema_193":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","invoiceowner","billtocontact","soldtocontact","invoiceitems","rateplans","rateplans.rateplancharges","rateplans.rateplancharges.rateplanchargetiers","account.billto","account.soldto","account.paymentmethods","order"]}},"id":"schema_193"},"schema_194":{"kind":"json-schema","data":{"type":"object","title":"QuerySubscriptionsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedSubscription"}}}},"id":"schema_194"},"schema_195":{"kind":"json-schema","data":{"type":"object","title":"QueryTaxationItemsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedTaxationItem"}}}},"id":"schema_195"},"schema_196":{"kind":"json-schema","data":{"type":"object","title":"QueryUsagesResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedUsage"}}}},"id":"schema_196"},"schema_197":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["account","prepaidbalance"]}},"id":"schema_197"},"schema_198":{"kind":"json-schema","data":{"type":"object","title":"QueryValidityPeriodSummarysResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedValidityPeriodSummary"}}}},"id":"schema_198"},"schema_199":{"kind":"json-schema","data":{"type":"object","title":"QueryCustomObjectsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"id":"schema_199"},"schema_200":{"kind":"json-schema","data":{"type":"object","additionalProperties":true},"id":"schema_200"},"schema_201":{"kind":"json-schema","data":{"type":"object","title":"QueryContactSnapshotsResponse","description":"","nullable":false,"additionalProperties":false,"properties":{"nextPage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to retrieve the next page of the response if it exists; otherwise absent."},"children":[]}]}]}],"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExpandedContactSnapshot"}}}},"id":"schema_201"},"schema_202":{"kind":"json-schema","data":{"type":"integer","maximum":300,"default":300},"id":"schema_202"},"schema_203":{"kind":"json-schema","data":{"type":"integer","maximum":300,"default":8},"id":"schema_203"},"schema_204":{"kind":"json-schema","data":{"properties":{"file":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File containing data about the mass action you want to perform. The file requirements are the same as when uploading a file through the Mass Updater in the Zuora UI. The file must be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file or a zipped "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum file size is 4 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data in the file must be formatted according to the mass action type you want to perform."},"children":[]}]}]}],"format":"binary","type":"string"},"params":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container for the following fields. You must format this parameter as a JSON object."},"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":"code","inline":true,"attributes":{"content":"actionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - Type of mass action you want to perform. The following mass actions are supported: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateAccountingCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateRevenueSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateRevenueSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DeleteRevenueSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ImportFXRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MPU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checksum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (string) - An MD5 checksum that is used to validate the integrity of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the uploaded file. The checksum is a 32-character string."},"children":[]}]}]}]}]}],"type":"string"}},"required":["file","params"],"type":"object"},"id":"schema_204"},"schema_205":{"kind":"json-schema","data":{"type":"number"},"id":"schema_205"},"schema_206":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GETPublicNotificationDefinitionResponse"},"type":"array"},"next":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URI to query the next page of data, e.g. '/notification-definitions?start=1&limit=10'. The start equals request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null."},"children":[]}]}]}],"example":"/notification-definitions?start=1&limit=10","type":"string"}},"type":"object"},"id":"schema_206"},"schema_207":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","description":"The Zuora request ID passed from the request or generated by the API Gateway."},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_207"},"schema_208":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GETPublicEmailTemplateResponse"},"type":"array"},"next":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URI to query the next page of data, e.g. '/notification-definitions?start=1&limit=10'. The start equals request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null."},"children":[]}]}]}],"type":"string"}},"type":"object"},"id":"schema_208"},"schema_209":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"maxLength":64,"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n    examples:\n"}}},"id":"schema_209"},"schema_210":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/GETPublicCalloutTemplateResponse"},"type":"array"},"next":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URI to query the next page of data, e.g. '/notifications/callout-templates?start=21&limit=20'."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start equals request's start+limit, and the limit equals the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request's limit. If the current page is the last page, this value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is null."},"children":[]}]}]}],"type":"string"}}},"id":"schema_210"},"schema_211":{"kind":"json-schema","data":{"default":20,"format":"int32","maximum":5000,"minimum":1,"type":"integer"},"id":"schema_211"},"schema_212":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_212"},"schema_213":{"kind":"json-schema","data":{"type":"string","enum":["Headers","Footers","Other"]},"id":"schema_213"},"schema_214":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GetPublicReusableBlockResponse"},"type":"array"},"next":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URI to query the next page of data, e.g. '/notifications/reusable-blocks?start=21&limit=20'. The start equals the request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null."},"children":[]}]}]}],"type":"string"}},"type":"object"},"id":"schema_214"},"schema_215":{"kind":"json-schema","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error message notifying that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be empty."},"children":[]}]}]}],"example":"may not be null (path = PublicNotificationHistoryResource.deleteHistoryByAccountId.query param accountId, invalidValue = null)","type":"string"},"id":"schema_215"},"schema_216":{"kind":"json-schema","data":{"default":0,"minimum":0,"type":"integer"},"id":"schema_216"},"schema_217":{"kind":"json-schema","data":{"default":10,"minimum":1,"type":"integer"},"id":"schema_217"},"schema_218":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EventTrigger"},"type":"array"},"next":{"description":"The link to the next page. No value if it is last page.","type":"string"}},"type":"object"},"id":"schema_218"},"schema_219":{"kind":"json-schema","data":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GetScheduledEventResponse"},"type":"array"},"next":{"description":"The link to the next page. No value if it is last page.","example":"/events/scheduled-events?start=10&limit=10","type":"string"}},"type":"object"},"id":"schema_219"},"schema_220":{"kind":"json-schema","data":{"enum":["type"],"type":"string"},"id":"schema_220"},"schema_221":{"kind":"json-schema","data":{"description":"The URI of the deleted custom object definition","example":"/objects/definitions/default/test_custom_object","format":"uri","type":"string"},"id":"schema_221"},"schema_222":{"kind":"json-schema","data":{"maximum":1000,"minimum":1,"type":"integer"},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"format":"uuid","maxLength":36,"minLength":36,"type":"string"},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"description":"The URI of the deleted custom object record.","example":"/objects/records/default/test_custom_object/3a437f0b-fa7a-45bf-a9a5-2187a5a13ec0","format":"uri","type":"string"},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"default":25,"maximum":100,"type":"integer"},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"enum":["pending","accepted","in_progress","completed","failed","cancelled"],"type":"string"},"id":"schema_226"},"schema_227":{"kind":"json-schema","data":{"description":"The CSV file to be uploaded. The file must be encoded in UTF-8 and the file size limit is 15 MB.","type":"string"},"id":"schema_227"},"schema_228":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"ffdb2cd6-d55d-4401-ac52-38d9e7c1d0cd"},"id":"schema_228"},"schema_229":{"kind":"json-schema","data":{"default":1,"type":"integer"},"id":"schema_229"},"schema_230":{"kind":"json-schema","data":{"properties":{"active_workflow_version_id":{"description":"The id of a version. This version will then be set to the active version of the workflow definition.\n","type":"integer"},"description":{"description":"The description of the workflow defintion\n","type":"string"},"name":{"description":"The name of the workflow definition\n","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be "},"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":"Inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Active workfow definitions run like normal. Inactive workflow definitions cannot be run."},"children":[]}]}]}],"type":"string"}},"type":"object","example":{"description":"Retrieve and update products"}},"id":"schema_230"},"schema_231":{"kind":"json-schema","data":{"properties":{"errors":{"description":"The list of errors returned from the workflow","items":{"$ref":"#/components/schemas/WorkflowError"},"type":"array"}},"type":"object"},"id":"schema_231"},"schema_232":{"kind":"json-schema","data":{"example":{"accountId":"4028905f5a87c0ff015a87d25ae90025","paymentId":"4028905f5a87c0ff015a889ddfb800c0"},"type":"object"},"id":"schema_232"},"schema_233":{"kind":"json-schema","data":{"properties":{"errors":{"description":"The list of errors returned from the workflow","items":{"$ref":"#/components/schemas/WorkflowError"},"type":"array"},"parameters":{"description":"The request body that was originally provided to the run API."}},"type":"object"},"id":"schema_233"},"schema_234":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"maxLength":64,"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request\nheaders, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_234"},"schema_235":{"kind":"json-schema","data":{"enum":["accepted","in_progress","completed","failed","cancelled"],"type":"string"},"id":"schema_235"},"schema_236":{"kind":"json-schema","data":{"default":20,"maximum":1000,"type":"integer"},"id":"schema_236"},"schema_237":{"kind":"json-schema","data":{"type":"string","enum":["application/json"]},"id":"schema_237"},"schema_238":{"kind":"json-schema","data":{"format":"uuid","maxLength":64,"minLength":64,"type":"string"},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_239"},"schema_240":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"maxLength":64,"type":"string","description":"A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_240"},"schema_241":{"kind":"json-schema","data":{"properties":{"template":{"description":"Template contains the config metadata and target tenant information.","format":"binary","type":"string"}},"type":"object"},"id":"schema_241"},"schema_242":{"kind":"json-schema","data":{"required":["customFields","description","name","notifications","productCatalog","reporting","sendEmail","settings","sourceTenantId","userRoles","workflows"],"type":"object","properties":{"name":{"type":"string","description":"Deployment's name."},"description":{"type":"string","description":"Deployment's description."},"sendEmail":{"type":"boolean","description":"Specifies if an email should be sent."},"emails":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If sendEmail parameter is set to true, comma separated values of emails can be specified. Example  email1@test.com,email2@test.com."},"children":[]}]}]}]},"comments":{"type":"string","description":"Content of the email to be sent."},"settings":{"type":"boolean","description":"Specified if settings module should be considered in the deployment process."},"notifications":{"type":"boolean","description":"Specified if notifications module should be considered in the deployment process."},"workflows":{"type":"boolean","description":"Specified if workflows module should be considered in the deployment process."},"customFields":{"type":"boolean","description":"Specified if customFields module should be considered in the deployment process."},"customObjects":{"type":"boolean","description":"Specified if customObjects module should be considered in the deployment process."},"productCatalog":{"type":"boolean","description":"Specified if productCatalog module should be considered in the deployment process."},"taxation":{"type":"boolean","description":"Specified if taxation module should be considered in the deployment process."},"userRoles":{"type":"boolean","description":"Specified if userRoles module should be considered in the deployment process."},"reporting":{"type":"boolean","description":"Specified if reporting module should be considered in the deployment process."},"sourceTenantId":{"type":"string","description":"Id of the source tenant."}}},"id":"schema_242"},"schema_243":{"kind":"json-schema","data":{"type":"object","properties":{"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"maxLength":64,"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_243"},"schema_244":{"kind":"json-schema","data":{"required":["description","name","sendEmail","template"],"type":"object","properties":{"name":{"type":"string","description":"Deployment's name"},"description":{"type":"string","description":"Deployment's description."},"sendEmail":{"type":"boolean","description":"Specifies if an email should be sent."},"emails":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If sendEmail parameter is set to true, comma separated values of emails can be specified. Example  email1@test.com,email2@test.com."},"children":[]}]}]}]},"comments":{"type":"string","description":"Content of the email to be sent."},"template":{"type":"string","description":"Template file.","format":"binary"}}},"id":"schema_244"},"schema_245":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Deployment Manager migration process."},"name":{"type":"string","description":"Name of the Deployment Manager migration process."},"description":{"type":"string","description":"Description of the Deployment Manager migration process."},"sourceTenantName":{"type":"string","description":"Name of the source Tenant."},"sourceTenantDescription":{"type":"string","description":"Description of the source Tenant."},"status":{"type":"string","description":"Status of the Deployment Manager migration process.","enum":["DEPLOYING","REVERTING","PARTIALLY-REVERTED","FAILED","ROLLBACK-FAILED","REVERTED","COMPARING","SUBMITTED","SKIPPED","IDENTICAL","COMPARE-DONE","COMPARE-FAILED","CANCELLED"]},"startTime":{"type":"string","description":"start timestamp of the Deployment Manager migration process."},"endTime":{"type":"string","description":"end timestamp of the Deployment Manager migration process."},"migratedBy":{"type":"string","description":"User who initiated the Deployment Manager migration process."},"type":{"type":"string","description":"Type of the Deployment Manager migration process."},"environment":{"type":"string","description":"Environment of the Deployment Manager migration process."},"emailIds":{"type":"string","description":"emailIds notified of the Deployment Manager migration process."},"productCatalog":{"type":"boolean","description":"Boolean flag specifies if the migration process includes product catalog module."},"errors":{"type":"string","description":"Errors of the Deployment Manager migration process."}}},"id":"schema_245"},"schema_246":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the migration process."},"name":{"type":"string","description":"Name of the migration."},"description":{"type":"string","description":"Description of the migration."},"status":{"type":"string","description":"Migration status."},"targetTenant":{"type":"object","properties":{"id":{"type":"string","description":"Target tenant id."},"name":{"type":"string","description":"Target tenant name."},"environment":{"type":"string","description":"Target tenant description."}}},"deploymentDate":{"type":"string","description":"Deployment timestamp."},"runBy":{"type":"string","description":"Name of the user who executed the migration."},"succeeded":{"type":"array","items":{"type":"object","properties":{"component":{"type":"string","description":"Component name."},"subComponent":{"type":"string","description":"Subcomponent name."},"key":{"type":"string","description":"Key to identify a particular migration data."}}}},"failed":{"type":"array","items":{"type":"object","properties":{"component":{"type":"string","description":"Component name."},"subComponent":{"type":"string","description":"Subcomponent name."},"key":{"type":"string","description":"Key to identify a particular migration data."},"errorInfo":{"type":"string","description":"Error details of the migration."}}}},"skipped":{"type":"array","items":{"type":"object","properties":{"component":{"type":"string","description":"Component name."},"subComponent":{"type":"string","description":"Subcomponent name."},"key":{"type":"string","description":"Key to identify a particular migration data."},"reason":{"type":"string","description":"The rationale behind the non-migration of specific data."}}}}}},"id":"schema_246"},"schema_247":{"kind":"json-schema","data":{"required":["activeProducts","activeRatePlans","compareField","description","inActiveProducts","inActiveRatePlans","name","sendEmail","sourceTenantId"],"type":"object","properties":{"name":{"type":"string","description":"Deployment's name.","example":"Tenant01PC"},"description":{"type":"string","description":"Deployment's description.","example":"Product Catalog tenant - 01"},"sendEmail":{"type":"boolean","description":"Specifies if an email should be sent.","example":true},"emails":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If sendEmail parameter is set to true, comma separated values of emails can be specified. Example  email1@test.com,email2@test.com."},"children":[]}]}]}],"example":"zuoraUser@zuora.com"},"comments":{"type":"string","description":"Content of the email to be sent.","example":"Product Catalog tenant - 47"},"inActiveProducts":{"type":"boolean","description":"Specifies if inactive products needs to be migrated.","example":false},"activeProducts":{"type":"boolean","description":"Specifies if active products needs to be migrated.","example":true},"activeRatePlans":{"type":"boolean","description":"Specifies if active rate plans needs to be migrated.","example":true},"inActiveRatePlans":{"type":"boolean","description":"Specifies if inactive active rate plans needs to be migrated.","example":true},"compareField":{"type":"string","description":"Specifies the compare field to be using during migration.","enum":["name","sku"],"example":"name"},"sourceTenantId":{"type":"string","description":"Specifies the source tenant id.","example":"83e7e56d-0e02-4b4d-91f6-cc77f322c40b"}}},"id":"schema_247"},"schema_248":{"kind":"json-schema","data":{"required":["activeProducts","activeRatePlans","compareField","description","inActiveProducts","inActiveRatePlans","name","sendEmail","template"],"type":"object","properties":{"name":{"type":"string","description":"Deployment's name.","example":"Deploy PC"},"description":{"type":"string","description":"Deployment's description.","example":"Import Product Catalog - template"},"sendEmail":{"type":"boolean","description":"Specifies if an email should be sent.","example":true},"emails":{"type":"string","description":"If sendEmail parameter is set to true, comma separated values of emails can be specified.","example":"zuoraUser1@zuora.com,zuoraUser2@zuora.com"},"comments":{"type":"string","description":"Content of the email to be sent.","example":"Import Product Catalog - template"},"template":{"type":"string","description":"Template file.","format":"binary","example":"@/Users/praghav/Downloads/products.json"},"inActiveProducts":{"type":"boolean","description":"Specifies if inactive products needs to be migrated.","example":false},"activeProducts":{"type":"boolean","description":"Specifies if active products needs to be migrated.","example":true},"activeRatePlans":{"type":"boolean","description":"Specifies if active rate plans needs to be migrated.","example":true},"inActiveRatePlans":{"type":"boolean","description":"Specifies if inactive rate plans needs to be migrated.","example":true},"compareField":{"type":"string","description":"Specifies the compare field to be using during migration.","enum":["name","sku"],"example":"name"}}},"id":"schema_248"},"schema_249":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}]},"RateLimit-Limit":{"type":"string","description":"The request limit quota for the time window closest to exhaustion."},"RateLimit-Remaining":{"type":"number","description":"The number of requests remaining in the time window closest to quota exhaustion."},"RateLimit-Reset":{"type":"number","description":"The number of seconds until the quota resets for the time window closest to quota exhaustion."},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call."},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_249"},"schema_250":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","maxLength":36,"minLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":"This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data."},"RateLimit-Limit":{"type":"string","description":"The request limit quota for the time window closest to exhaustion."},"RateLimit-Remaining":{"type":"number","description":"The number of requests remaining in the time window closest to quota exhaustion."},"RateLimit-Reset":{"type":"number","description":"The number of seconds until the quota resets for the time window closest to quota exhaustion."},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_252"},"schema_253":{"kind":"json-schema","data":{"type":"string","enum":["Created","Submitted","In Progress","Aborting","Completed","Failed","Aborted","Cancelled","Downloading"]},"id":"schema_253"},"schema_254":{"kind":"json-schema","data":{"type":"object","properties":{"mappings":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"column":{"type":"string"}}}}}},"id":"schema_254"},"schema_255":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"","items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"id":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"meta":{"type":"object","nullable":true},"totalResults":{"type":"integer","description":"Total numbers of groups present.\n","example":28},"resources":{"type":"array","items":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"]},"id":{"type":"string","example":"01b496f7-1988-44aa-9ea6-c27f0288fa9d"},"displayName":{"type":"string","example":"Test_GroupName"},"members":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"e1b624ac-e00f-422b-b4da-20070901b22f"}}}},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:zuora:scim:schemas:1.0:GroupExtension"]},"description":{"type":"string","example":"Test_GroupDescription"},"organizationId":{"type":"string","example":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e"},"active":{"type":"boolean","example":true}}},"meta":{"type":"object","nullable":true,"properties":{"resourceType":{"type":"string","example":"Group"},"location":{"type":"string","example":"http://localhost:9900/scim/v2/Groups/01b496f7-1988-44aa-9ea6-c27f0288fa9d"}}}}}}}},"id":"schema_255"},"schema_256":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_256"},"schema_257":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"description":"Indicates whether the call succeeded.\n","type":"boolean","example":false},"reasons":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","example":"Unauthorized"},"code":{"type":"string","example":"90000011"}}}}}},"id":"schema_257"},"schema_258":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","description":"The timestamp when the response was generated.\n","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"string","description":"Indicates whether the call succeeded.\n","example":403},"error":{"type":"string","description":"A brief description of the error that occurred.\n","example":"Forbidden"},"message":{"type":"string","description":"A detailed message providing additional context about the error or issue. This can be used for debugging or informational purposes.\n","example":"Admin access denied"},"path":{"type":"string","description":"The API endpoint path that was accessed when the error occurred. This helps to identify which part of the API was involved.\n","example":"/scim/v2/Groups"}}},"id":"schema_258"},"schema_259":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"List of schema identifiers that define the format of the group resource.","example":["urn:ietf:params:scim:api:messages:2.0:Error"]},"status":{"type":"string","description":"The HTTP status code indicating the error type.","example":"404"},"detail":{"type":"string","description":"A brief explanation of the error, providing context about the resource issue.","example":"Resource not found"}}},"id":"schema_259"},"schema_260":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"List of schema URNs defining the structure of the group resource."},"displayName":{"type":"string","description":"Name of the group."},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"List of URNs for the extension schemas."},"description":{"type":"string","description":"Description of the group."},"organizationId":{"type":"string","description":"Identifier for the associated organization."}}}}},"id":"schema_260"},"schema_261":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Unique identifier for the group."},"displayName":{"type":"string","description":"Name of the group."},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","description":"Custom extension schema with additional group attributes.","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the format of the group resource.","items":{"type":"string"}},"description":{"type":"string","description":"Description of the group."},"organizationId":{"type":"string","description":"Identifier for the associated organization."},"active":{"type":"boolean","description":"Indicates if the group is active."}}},"meta":{"type":"object","description":"Metadata about the resource.","properties":{"resourceType":{"type":"string","description":"Type of the resource."},"location":{"type":"string","description":"URL of the group resource."}}}}},"id":"schema_261"},"schema_262":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_262"},"schema_263":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates if the request was successful (false for errors).","example":false},"reasons":{"type":"array","description":"List of reasons for the unauthorized error.","items":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"Unauthorized"},"code":{"type":"string","description":"Error code.","example":"90000011"}}}}}},"id":"schema_263"},"schema_264":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","description":"Time when the error occurred.","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"integer","description":"HTTP status code.","example":403},"error":{"type":"string","description":"Error type.","example":"Forbidden"},"message":{"type":"string","description":"Details about the access denial.","example":"Admin access denied"},"path":{"type":"string","description":"Endpoint path where the error occurred.","example":"/scim/v2/Groups"}}},"id":"schema_264"},"schema_265":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the format of the group resource.","items":{"type":"string"}},"status":{"type":"string","description":"HTTP status code.","example":"404"},"detail":{"type":"string","description":"Reason for the resource not being found.","example":"Resource not found"}}},"id":"schema_265"},"schema_266":{"kind":"json-schema","data":{"type":"array","description":"Array of group resources returned by the bulk operation.","items":{"type":"object","required":["schemas","displayName","urn:zuora:scim:schemas:1.0:GroupExtension","meta"],"properties":{"schemas":{"type":"array","description":"List of schema URNs defining the structure of the group resource.","items":{"type":"string"}},"displayName":{"type":"string","description":"Name of the group."},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","description":"Custom extension schema with additional attributes for the group.","properties":{"schemas":{"type":"array","description":"List of URNs for the extension schemas.","items":{"type":"string"}},"description":{"type":"string","description":"Description of the group."},"organizationId":{"type":"string","description":"Identifier for the associated organization."},"active":{"type":"boolean","description":"Indicates whether the group is active."}}},"meta":{"type":"object","nullable":true,"description":"Metadata about the group resource.","properties":{"resourceType":{"type":"string","description":"Type of the resource (e.g., Group)."}}}}}},"id":"schema_266"},"schema_267":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema URNs defining the structure of the response.","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"totalResults":{"type":"integer","description":"Total number of user groups returned in the response.","example":2},"id":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"meta":{"type":"string","nullable":true},"resources":{"type":"array","description":"List of group resources returned by the query.","items":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the format of the group resource.","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"]},"id":{"type":"string","description":"Unique identifier for the group.","example":"5aa8a1fe-4ed4-44db-a6ae-78645a20ae21"},"displayName":{"type":"string","description":"Name of the group.","example":"test_group_1"},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","description":"Custom extension schema with additional attributes for the group.","properties":{"schemas":{"type":"array","description":"List of URNs for the extension schemas.","items":{"type":"string"},"example":["urn:zuora:scim:schemas:1.0:GroupExtension"]},"description":{"type":"string","description":"Description of the group.","example":""},"organizationId":{"type":"string","description":"Identifier for the associated organization.","example":"ec141dc2-901e-4813-a25d-ef480cff1e26"},"active":{"type":"boolean","description":"Indicates whether the group is active.","example":true}}},"meta":{"type":"object","nullable":true,"description":"Metadata about the group resource.","properties":{"resourceType":{"type":"string","description":"Type of the resource (e.g., Group).","example":"Group"},"location":{"type":"string","description":"URL to access the group resource.","example":"http://localhost:9900/scim/v2/Groups/bulk/5aa8a1fe-4ed4-44db-a6ae-78645a20ae21"}}}}}},"startIndex":{"type":"integer"},"itemsPerPage":{"type":"integer"}}},"id":"schema_267"},"schema_268":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_268"},"schema_269":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful (false for errors).","example":false},"reasons":{"type":"array","description":"List of reasons for the unauthorized error.","items":{"type":"object","properties":{"message":{"type":"string","description":"Error message indicating the reason for unauthorized access.","example":"Unauthorized"},"code":{"type":"string","description":"Error code associated with the unauthorized error.","example":"90000011"}}}}}},"id":"schema_269"},"schema_270":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","description":"Time when the error occurred.","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"integer","description":"HTTP status code indicating the forbidden error.","example":403},"error":{"type":"string","description":"Type of error indicating a forbidden action.","example":"Forbidden"},"message":{"type":"string","description":"Description of why the action is forbidden.","example":"Admin access denied"},"path":{"type":"string","description":"Endpoint path where the error occurred.","example":"/scim/v2/Groups/bulk"}}},"id":"schema_270"},"schema_271":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema URNs defining the structure of the error response.","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:Error"]},"status":{"type":"string","description":"HTTP status code indicating that the resource was not found.","example":"404"},"detail":{"type":"string","description":"Details explaining why the resource was not found.","example":"Resource not found"}}},"id":"schema_271"},"schema_272":{"kind":"json-schema","data":{"type":"object","required":["schemas","operations"],"properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the format of the request.","items":{"type":"string"}},"operations":{"type":"array","description":"List of operations to be performed on the resource.","items":{"type":"object","required":["op","path","value"],"properties":{"op":{"type":"string","description":"Operation to be performed. Can be 'add' to add a new item or 'remove' to delete an item.","enum":["add","remove"]},"path":{"type":"string","description":"Path to the item or property to be modified."},"value":{"type":"array","description":"List of values associated with the operation.","items":{"type":"object","properties":{"value":{"type":"string","description":"The value to be added or removed."}}}}}}}}},"id":"schema_272"},"schema_273":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the structure of the response.","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"id":{"type":"string","nullable":true,"description":""},"externalId":{"type":"string","nullable":true,"description":""},"meta":{"type":"object","nullable":true,"description":"Metadata about the group.","properties":{"resourceType":{"type":"string","description":"Type of resource, which is 'Group' for this object.","example":"Group"},"location":{"type":"string"}}},"totalResults":{"type":"integer","description":"Total number of groups returned in the response.","example":2},"resources":{"type":"array","description":"List of groups included in the response.","items":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that describe the format of the group.","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"]},"id":{"type":"string","description":"Unique identifier for the group.","example":"5aa8a1fe-4ed4-44db-a6ae-78645a20ae21"},"displayName":{"type":"string","description":"Name of the group.","example":"test_group_1"},"members":{"type":"array","description":"List of members associated with the group.","items":{"type":"object","properties":{"value":{"type":"string","description":"Identifier for a member of the group."},"display":{"type":"string","description":""}}}},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","description":"Custom attributes for the group defined by the extension schema.","properties":{"schemas":{"type":"array","description":"List of schema identifiers specific to the extension.","items":{"type":"string"},"example":["urn:zuora:scim:schemas:1.0:GroupExtension"]},"description":{"type":"string","description":"Additional description for the group.","example":""},"organizationId":{"type":"string","description":"Identifier for the organization associated with the group.","example":"ec141dc2-901e-4813-a25d-ef480cff1e26"},"active":{"type":"boolean","description":"Indicates if the group is active.","example":true}}},"meta":{"type":"object","description":"Metadata about the group.","properties":{"resourceType":{"type":"string","description":"Type of resource, which is 'Group' for this object.","example":"Group"},"location":{"type":"string"}}}}}},"startIndex":{"type":"integer"},"itemsPerPage":{"type":"integer"}}},"id":"schema_273"},"schema_274":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful (false in this case).","example":false},"reasons":{"type":"array","description":"List of reasons for the unauthorized error.","items":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining why the request is unauthorized.","example":"Unauthorized"},"code":{"type":"string","description":"Error code representing the unauthorized access issue.","example":"90000011"}}}}}},"id":"schema_274"},"schema_275":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","description":"Timestamp when the error occurred.","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"integer","description":"HTTP status code indicating the request is forbidden.","example":403},"error":{"type":"string","description":"Type of error indicating that access is forbidden.","example":"Forbidden"},"message":{"type":"string","description":"Description of why the request is forbidden.","example":"Admin access denied"},"path":{"type":"string","description":"Endpoint path where the forbidden error occurred.","example":"/scim/v2/Groups/bulk"}}},"id":"schema_275"},"schema_276":{"kind":"json-schema","data":{"type":"string","description":"Specify a unique idempotency key to ensure that a POST or PATCH request is idempotent. Do not use this header for other request types."},"id":"schema_276"},"schema_277":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the compression algorithm so that your client can decompress it."},"children":[]}]}]}]},"id":"schema_277"},"schema_278":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"id":"schema_278"},"schema_279":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where {token} is a valid OAuth token generated by calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/api-references/api/operation/createToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_279"},"schema_280":{"kind":"json-schema","data":{"type":"string","maxLength":64,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), semicolon ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), double quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"id":"schema_280"},"schema_281":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"operations":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["add","remove","replace"]},"path":{"type":"string"},"value":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}}}}}},"required":["schemas","operations"]},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the structure of the response.","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"id":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true,"description":"An external identifier for the resource, often used for integration with external systems."},"meta":{"type":"object","nullable":true,"description":"Metadata about the group resource.","properties":{"resourceType":{"type":"string","description":"Type of resource, which is 'Group' for this object.","example":"Group"},"location":{"type":"string"}}},"totalResults":{"type":"integer","description":"Total number of groups returned in the response.","example":2},"resources":{"type":"array","description":"List of group resources included in the response.","items":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the format of the group resource.","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"]},"id":{"type":"string","description":"Unique identifier for the group.","example":"5aa8a1fe-4ed4-44db-a6ae-78645a20ae21"},"externalId":{"type":"string","nullable":true,"description":"An external identifier for the resource, often used for integration with external systems."},"displayName":{"type":"string","description":"Name of the group.","example":"test_group_1"},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","description":"Custom attributes for the group defined by the extension schema.","properties":{"description":{"type":"string","description":"Additional description for the group.","example":""},"organizationId":{"type":"string","description":"Identifier for the organization associated with the group.","example":"ec141dc2-901e-4813-a25d-ef480cff1e26"},"active":{"type":"boolean","description":"Indicates whether the group is active.","example":true}}},"meta":{"type":"object","description":"Metadata about the group resource.","properties":{"resourceType":{"type":"string","description":"Type of resource, which is 'Group' for this object.","example":"Group"},"location":{"type":"string"}}}}}},"startIndex":{"type":"integer"},"itemsPerPage":{"type":"integer"}}},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful (false in this case).","example":false},"reasons":{"type":"array","description":"List of reasons for the unauthorized error.","items":{"type":"object","properties":{"message":{"type":"string","description":"Message explaining why the request is unauthorized.","example":"Unauthorized"},"code":{"type":"string","description":"Error code representing the unauthorized access issue.","example":"90000011"}}}}}},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","description":"The time at which the error occurred.","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"integer","description":"HTTP status code indicating that the request is forbidden.","example":403},"error":{"type":"string","description":"Type of error indicating that access is forbidden.","example":"Forbidden"},"message":{"type":"string","description":"Description of why the request is forbidden.","example":"Admin access denied"},"path":{"type":"string","description":"Endpoint path where the forbidden error occurred.","example":"/scim/v2/Groups/delete"}}},"id":"schema_284"},"schema_285":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the structure of the error response.","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:Error"]},"status":{"type":"string","description":"HTTP status code indicating that the resource was not found.","example":"404"},"detail":{"type":"string","description":"Description of the error detailing why the resource was not found.","example":"Resource not found"}}},"id":"schema_285"},"schema_286":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Unique identifier for the group."},"displayName":{"type":"string","description":"Name of the group."},"members":{"type":"array","description":"List of members associated with the group.","items":{"type":"object","properties":{"value":{"type":"string","description":"Identifier for a member of the group."},"display":{"type":"string","description":""}}}},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","description":"Custom attributes specific to the group defined by the extension schema.","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the format of the custom attributes.","items":{"type":"string"}},"description":{"type":"string","description":"Additional description for the group."},"organizationId":{"type":"string","description":"Identifier for the organization associated with the group."},"active":{"type":"boolean","description":"Indicates whether the group is active."}}},"meta":{"type":"object","description":"Metadata about the group resource.","properties":{"resourceType":{"type":"string","description":"Type of resource, which is 'Group' for this object.","enum":["Group"]},"location":{"type":"string","description":"URL where the group resource can be accessed."}}}}},"id":"schema_286"},"schema_287":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_287"},"schema_288":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"List of schema URNs defining the structure of the request."},"operations":{"type":"array","items":{"type":"object","required":["op","path","value"],"properties":{"op":{"type":"string","description":"The operation to perform (e.g., add, remove, replace)."},"path":{"type":"string","description":"The path to the attribute that is being modified."},"value":{"type":"array","items":{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"The value to be added."}}}}}}}}},"id":"schema_288"},"schema_289":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the structure of the group resource.","items":{"type":"string"}},"id":{"type":"string","description":"Unique identifier assigned to the group."},"displayName":{"type":"string","description":"Name of the group."},"members":{"type":"array","description":"List of members associated with the group.","items":{"type":"object","properties":{"value":{"type":"string","description":"Unique identifier of a member within the group."},"display":{"type":"string","description":""}}}},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","description":"Custom attributes specific to the group defined by the extension schema.","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the format of the custom attributes.","items":{"type":"string"}},"description":{"type":"string","description":"Additional description or notes about the group."},"organizationId":{"type":"string","description":"Identifier for the organization to which the group belongs."},"active":{"type":"boolean","description":"Indicates whether the group is currently active."}}},"meta":{"type":"object","description":"Metadata related to the group resource.","properties":{"resourceType":{"type":"string","description":"Type of the resource, which is 'Group' for this object.","enum":["Group"]},"location":{"type":"string","description":"URL where the group resource can be accessed."}}}}},"id":"schema_289"},"schema_290":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"displayName":{"type":"string"},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"organizationId":{"type":"string"},"active":{"type":"boolean"}}},"meta":{"type":"object","properties":{"resourceType":{"type":"string"},"location":{"type":"string"}}}}},"id":"schema_290"},"schema_291":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_291"},"schema_292":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"Operations":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["add","remove","replace"]},"path":{"type":"string"},"value":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}}}}}},"required":["schemas","Operations"]},"id":"schema_292"},"schema_293":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the structure of the group resource.","items":{"type":"string"}},"id":{"type":"string","description":"Unique identifier assigned to the group."},"displayName":{"type":"string","description":"Name of the group."},"members":{"type":"array","description":"List of members associated with the group.","items":{"type":"object","properties":{"value":{"type":"string","description":"Unique identifier of a member within the group."},"display":{"type":"string","description":""}}}},"urn:zuora:scim:schemas:1.0:GroupExtension":{"type":"object","description":"Custom attributes specific to the group defined by the extension schema.","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the format of the custom attributes.","items":{"type":"string"}},"description":{"type":"string","description":"Additional description or notes about the group."},"organizationId":{"type":"string","description":"Identifier for the organization to which the group belongs."},"active":{"type":"boolean","description":"Indicates whether the group is currently active."}}},"meta":{"type":"object","description":"Metadata related to the group resource.","properties":{"resourceType":{"type":"string","description":"Type of the resource, which is 'Group' for this object."},"location":{"type":"string","description":"URL where the group resource can be accessed."}}}}},"id":"schema_293"},"schema_294":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_294"},"schema_295":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the structure of the response.","items":{"type":"string"}},"totalResults":{"type":"integer","description":"Total number of resource types available."},"resources":{"type":"array","description":"List of resource types available.","items":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the structure of the resource type.","items":{"type":"string"}},"id":{"type":"string","description":"Unique identifier of the resource type."},"name":{"type":"string","description":"Name of the resource type."},"description":{"type":"string","description":"Detailed description of the resource type."},"endpoint":{"type":"string","description":"API endpoint for accessing the resource type."},"schema":{"type":"string","description":"Schema identifier defining the structure of the resource type."},"schemaExtensions":{"type":"array","description":"List of schema extensions applied to the resource type.","items":{"type":"object","properties":{"schema":{"type":"string","description":"Schema identifier for the extension."},"required":{"type":"boolean","description":"Indicates if the schema extension is required."}}}},"meta":{"type":"object","description":"Metadata about the resource type.","properties":{"resourceType":{"type":"string","description":"Type of the resource, which is 'ResourceType' for this object."},"location":{"type":"string","description":"URL where the resource type can be accessed."}}}}}},"startIndex":{"type":"integer","description":"Index of the first item in the current page of results."},"itemsPerPage":{"type":"integer","description":"Number of items returned per page."}}},"id":"schema_295"},"schema_296":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of URNs that specify the schemas applied to this resource. These URNs define the structure and constraints for the resource's data."},"id":{"type":"string","description":"A unique identifier for the resource type. This ID is used to reference the resource type in API requests."},"name":{"type":"string","description":"The name of the resource type. This is a human-readable identifier for the resource."},"description":{"type":"string","description":"A brief description of the resource type. This provides context or additional information about the resource's purpose and usage."},"endpoint":{"type":"string","description":"The URI path where the resource type can be accessed. This endpoint is used to interact with the resource type through the API."},"schema":{"type":"string","description":"The URN of the schema that defines the structure and attributes of the resource type. This schema provides the format and constraints for the resource's data."},"schemaExtensions":{"type":"array","items":{"type":"object","properties":{"schema":{"type":"string","description":"The URN of the schema extension that adds additional attributes to the resource type. This extends the base schema with extra fields or constraints."},"required":{"type":"boolean","description":"Indicates whether the schema extension is required for the resource type. If true, the extension must be included in resource data."}}},"description":"A list of schema extensions that provide additional attributes for the resource type. Each extension adds new fields or constraints to the resource."},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The type of resource represented by this schema. This helps identify the nature of the resource (e.g., 'ResourceType')."},"location":{"type":"string","description":"The URI where the resource type's details can be accessed. This is useful for retrieving information about the resource type."}}}}},"id":"schema_296"},"schema_297":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers defining the structure of the response.","items":{"type":"string"}},"patch":{"type":"object","description":"Information about support for patch operations.","properties":{"supported":{"type":"boolean","description":"Indicates if patch operations are supported."}}},"bulk":{"type":"object","description":"Information about support for bulk operations.","properties":{"supported":{"type":"boolean","description":"Indicates if bulk operations are supported."},"maxOperations":{"type":"integer","description":"Maximum number of operations allowed in a single bulk request."},"maxPayloadSize":{"type":"integer","description":"Maximum size (in bytes) of the payload allowed for a bulk request."}}},"filter":{"type":"object","description":"Information about support for filtering.","properties":{"supported":{"type":"boolean","description":"Indicates if filtering is supported."},"maxResults":{"type":"integer","description":"Maximum number of results that can be returned by a single filter query."}}},"changePassword":{"type":"object","description":"Information about support for password change operations.","properties":{"supported":{"type":"boolean","description":"Indicates if password change operations are supported."}}},"sort":{"type":"object","description":"Information about support for sorting.","properties":{"supported":{"type":"boolean","description":"Indicates if sorting is supported."}}},"etag":{"type":"object","description":"Information about support for ETag operations.","properties":{"supported":{"type":"boolean","description":"Indicates if ETag operations are supported."}}},"authenticationSchemes":{"type":"array","description":"List of supported authentication schemes.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the authentication scheme."},"description":{"type":"string","description":"Description of the authentication scheme."},"specUri":{"type":"string","description":"URI for the specification of the authentication scheme."},"type":{"type":"string","description":"Type of the authentication scheme (e.g., OAuth, Basic)."},"primary":{"type":"boolean","description":"Indicates if this is the primary authentication scheme."}}}},"id":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"meta":{"nullable":true,"type":"object","description":"Metadata about the resource type.","properties":{"resourceType":{"type":"string","description":"Type of the resource (e.g., ResourceType)."},"location":{"type":"string","description":"URL where the resource type can be accessed."}}},"totalResults":{"type":"integer","description":"Total number of user groups returned in the response.","example":2},"resources":{"type":"array","description":"List of resource types available.","items":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema identifiers that define the structure of the resource type.","items":{"type":"string"}},"id":{"type":"string","description":"Unique identifier of the resource type."},"name":{"type":"string","description":"Name of the resource type."},"description":{"type":"string","description":"Detailed description of the resource type."},"attributes":{"type":"array","description":"List of attributes defined by the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the attribute."},"type":{"type":"string","description":"Data type of the attribute (e.g., string, boolean)."},"multiValued":{"type":"boolean","description":"Indicates if the attribute can hold multiple values."},"description":{"type":"string","description":"Description of the attribute."},"required":{"type":"boolean","description":"Indicates if the attribute is required."},"caseExact":{"type":"boolean","description":"Indicates if the attribute value is case-sensitive."},"mutability":{"type":"string","description":"Specifies the mutability of the attribute (e.g., readOnly, readWrite)."},"returned":{"type":"string","description":"Specifies when the attribute is returned in responses (e.g., always, never)."},"uniqueness":{"type":"string","description":"Specifies the uniqueness of the attribute values (e.g., none, server)."}}}}}}}}},"id":"schema_297"},"schema_298":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header\n"}}},"id":"schema_298"},"schema_299":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema URNs defining the structure of the response.","items":{"type":"string"}},"id":{"type":"string","description":"Unique identifier of the schema."},"name":{"type":"string","description":"Name of the schema."},"description":{"type":"string","description":"Description of the schema."},"attributes":{"type":"array","description":"List of attributes defined by the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the attribute."},"type":{"type":"string","description":"Data type of the attribute (e.g., string, boolean)."},"multiValued":{"type":"boolean","description":"Indicates if the attribute can hold multiple values."},"description":{"type":"string","description":"Description of the attribute."},"required":{"type":"boolean","description":"Indicates if the attribute is required."},"caseExact":{"type":"boolean","description":"Indicates if the attribute value is case-sensitive."},"mutability":{"type":"string","description":"Specifies the mutability of the attribute (e.g., readOnly, readWrite)."},"returned":{"type":"string","description":"Specifies when the attribute is returned in responses (e.g., always, never)."},"uniqueness":{"type":"string","description":"Specifies the uniqueness of the attribute values (e.g., none, server)."}}}},"meta":{"type":"object","description":"Metadata about the schema.","properties":{"resourceType":{"type":"string","description":"Type of the resource (e.g., Schema)."},"location":{"type":"string","description":"URL where the schema can be accessed."}}}},"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Schema"],"id":"urn:ietf:params:scim:schemas:core:2.0:User","name":"User","description":"User resource schema","attributes":[{"name":"userName","type":"string","multiValued":false,"description":"User's username","required":true,"caseExact":false,"mutability":"readWrite","returned":"always","uniqueness":"server"},{"name":"displayName","type":"string","multiValued":false,"description":"User's display name","required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"}],"meta":{"resourceType":"Schema","location":"http://localhost:9900/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"}}},"id":"schema_299"},"schema_300":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]}]}}},"id":"schema_300"},"schema_301":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful (false for unauthorized errors).","example":false},"reasons":{"type":"array","description":"List of reasons explaining why the request was unauthorized.","items":{"type":"object","properties":{"message":{"type":"string","description":"A message providing details about the unauthorized error.","example":"Unauthorized"},"code":{"type":"string","description":"A code representing the specific unauthorized error.","example":"90000011"}}}}},"example":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]}},"id":"schema_301"},"schema_302":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"The timestamp when the error occurred.","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"integer","description":"HTTP status code indicating that the request is forbidden.","example":403},"error":{"type":"string","description":"Error type describing the forbidden access.","example":"Forbidden"},"message":{"type":"string","description":"A message detailing why the access was forbidden.","example":"Admin access denied"},"path":{"type":"string","description":"The request path that caused the forbidden error.","example":"/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"}},"example":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"}},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema URNs describing the structure of the error response.","items":{"type":"string"}},"status":{"type":"string","description":"HTTP status code indicating that the resource was not found.","example":"404"},"detail":{"type":"string","description":"Detailed message explaining that the resource was not found.","example":"Resource not found"}},"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"}},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"List of schema URNs that define the structure of the response.","items":{"type":"string"}},"patch":{"type":"object","description":"Details about support for the PATCH method.","properties":{"supported":{"type":"boolean","description":"Indicates whether the PATCH method is supported."}}},"bulk":{"type":"object","description":"Details about support for bulk operations.","properties":{"supported":{"type":"boolean","description":"Indicates whether bulk operations are supported."},"maxOperations":{"type":"integer","description":"The maximum number of operations that can be performed in a single bulk request."},"maxPayloadSize":{"type":"integer","description":"The maximum size of the payload for a single bulk request, in bytes."}}},"filter":{"type":"object","description":"Details about support for filtering resources.","properties":{"supported":{"type":"boolean","description":"Indicates whether filtering is supported."},"maxResults":{"type":"integer","description":"The maximum number of results that can be returned in a single request when using filters."}}},"changePassword":{"type":"object","description":"Details about support for password change operations.","properties":{"supported":{"type":"boolean","description":"Indicates whether password change operations are supported."}}},"sort":{"type":"object","description":"Details about support for sorting resources.","properties":{"supported":{"type":"boolean","description":"Indicates whether sorting is supported."}}},"etag":{"type":"object","description":"Details about support for ETag headers.","properties":{"supported":{"type":"boolean","description":"Indicates whether ETag headers are supported."}}},"authenticationSchemes":{"type":"array","description":"List of authentication schemes supported by the service provider.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the authentication scheme."},"description":{"type":"string","description":"A description of how the authentication scheme works."},"specUri":{"type":"string","description":"A URI to the specification of the authentication scheme."},"type":{"type":"string","description":"The type of the authentication scheme (e.g., OAuth2)."},"primary":{"type":"boolean","description":"Indicates whether this is the primary authentication scheme."}}}},"meta":{"type":"object","description":"Metadata about the service provider configuration.","properties":{"resourceType":{"type":"string","description":"Type of the resource returned (e.g., ServiceProviderConfig)."},"location":{"type":"string","description":"URI of the resource."}}}},"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],"patch":{"supported":true},"bulk":{"supported":true,"maxOperations":1000,"maxPayloadSize":10000},"filter":{"supported":true,"maxResults":100},"changePassword":{"supported":false},"sort":{"supported":false},"etag":{"supported":false},"authenticationSchemes":[{"name":"Client Credentials","description":"The client credentials (or other forms of client authentication) can be used as an authorization grant when the authorization scope is limited to the protected resources under the control of the client, or to protected resources previously arranged with the authorization server. Client credentials are used as an authorization grant typically when the client is acting on its own behalf (the client is also the resource owner) or is requesting access to protected resources based on an authorization previously arranged with the authorization server.\n","specUri":"https://www.rfc-editor.org/rfc/rfc6749#section-4.4","type":"oauth2","primary":true},{"name":"Authorization Grant","description":"An authorization grant is a credential representing the resource owner's authorization (to access its protected resources) used by the client to obtain an access token. This specification defines four grant types -- authorization code, implicit, resource owner password credentials, and client credentials -- as well as an extensibility mechanism for defining additional types.\n","specUri":"https://www.rfc-editor.org/rfc/rfc6749#section-4.1","type":"oauth2","primary":false}],"meta":{"resourceType":"ServiceProviderConfig","location":"http://localhost:9900/scim/v2/ServiceProviderConfig"}}},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation was successful or not.","example":false},"reasons":{"type":"array","description":"A list of reasons explaining why the request was unauthorized.","items":{"type":"object","properties":{"message":{"type":"string","description":"A message describing the reason for the unauthorized error.","example":"Unauthorized"},"code":{"type":"string","description":"An error code associated with the unauthorized error.","example":"90000011"}}}}},"example":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]}},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"The timestamp when the error occurred.","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"integer","description":"HTTP status code representing the error.","example":403},"error":{"type":"string","description":"A brief description of the error.","example":"Forbidden"},"message":{"type":"string","description":"A message explaining why access was forbidden.","example":"Admin access denied"},"path":{"type":"string","description":"The path of the request that caused the error.","example":"/scim/v2/Groups"}},"example":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Groups"}},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","description":"A list of schema URNs that describe the structure of the error response.","items":{"type":"string"}},"status":{"type":"string","description":"HTTP status code representing the error.","example":"404"},"detail":{"type":"string","description":"A detailed message explaining the resource not found error.","example":"Resource not found"}},"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"}},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that describe the structure of the response."},"totalResults":{"type":"integer","description":"The total number of results matching the query."},"resources":{"type":"array","items":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that describe the structure of the user resource."},"id":{"type":"string","description":"The unique identifier for the user resource."},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"The timestamp when the user resource was created."},"resourceType":{"type":"string","description":"The type of resource, in this case, 'User'."},"location":{"type":"string","description":"The URI of the user resource."}}},"userName":{"type":"string","description":"The username associated with the user account."},"name":{"type":"object","properties":{"formatted":{"type":"string","description":"The full name of the user, formatted for display."},"familyName":{"type":"string","description":"The user's family (last) name."},"givenName":{"type":"string","description":"The user's given (first) name."}}},"displayName":{"type":"string","description":"The display name of the user."},"preferredLanguage":{"type":"string","description":"The preferred language of the user."},"locale":{"type":"string","description":"The locale of the user."},"active":{"type":"boolean","description":"Indicates whether the user account is active."},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address of the user."},"display":{"type":"string","description":"The display name associated with the email address."},"type":{"type":"string","description":"The type of email address (e.g., work, home)."},"primary":{"type":"boolean","description":"Indicates whether this email address is the primary one for the user."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The role identifier associated with the user."},"display":{"type":"string","description":"The display name of the role."}}}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The group identifier to which the user belongs."},"display":{"type":"string","description":"The display name of the group."}}}},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs specific to the UserExtension."},"organizationId":{"type":"string","description":"The identifier of the organization to which the user belongs."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the user account (e.g., ACTIVE, PENDING_ACTIVATION)."},"children":[]}]}]}]},"ssoEnabled":{"type":"boolean","description":"Indicates whether Single Sign-On (SSO) is enabled for the user."},"region":{"type":"string","description":"The region where the user is located."}}}}}},"startIndex":{"type":"integer","description":"The index of the first result in the current page."},"itemsPerPage":{"type":"integer","description":"The number of items per page in the response."}},"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"totalResults":327,"resources":[{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"91f659cd-6ded-4d92-bd5c-144c3b5455c4","meta":{"created":"2023-07-04T10:12:03.721Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/91f659cd-6ded-4d92-bd5c-144c3b5455c4"},"userName":"aghosh+123","name":{"formatted":"aghosh g","familyName":"g","givenName":"aghosh"},"displayName":"aghosh g","preferredLanguage":"en","locale":"en-US","active":false,"emails":[{"value":"aghosh+123@zuora.com","display":"aghosh+123@zuora.com","type":"work","primary":true}],"roles":[{"value":"ADMIN","display":"ADMIN"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"ec141dc2-901e-4813-a25d-ef480cff1e26","status":"PENDING_ACTIVATION","ssoEnabled":false,"region":"US"}},{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"eb48a32d-2fe6-48d1-8a18-797919f3810a","meta":{"created":"2023-07-13T06:15:25.836Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/eb48a32d-2fe6-48d1-8a18-797919f3810a"},"userName":"Amy+555","name":{"formatted":"Amy Lawrence","familyName":"Amy","givenName":"Lawrence"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"asmurugesan+555@zuora.com","display":"asmurugesan+555@zuora.com","type":"work","primary":true}],"groups":[{"value":"7f5c248e-44e8-48d3-bacc-b5bd1253c2e4","display":""}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"rc141dc2-901e-4813-a25d-ef480cff1e26","status":"ACTIVE","ssoEnabled":false,"region":"EU"}}],"startIndex":1,"itemsPerPage":100}},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion."},"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://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion."},"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://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion."},"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://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call.\nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier.\nOtherwise, Zuora does not set this header.\n"}}},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the request was successful or not. In this case, it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" due to unauthorized access."},"children":[]}]}]}],"example":false},"reasons":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"A brief description of the reason for the unauthorized access. Provides context for the failure.","example":"Unauthorized"},"code":{"type":"string","description":"A code representing the error. Used for programmatic identification of the error.","example":"90000011"}}}}}},"id":"schema_310"},"schema_311":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"The timestamp when the error occurred. Provides context for when the error happened.","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"integer","description":"The HTTP status code for the error. Indicates that the server understood the request but refuses to authorize it.","example":403},"error":{"type":"string","description":"A brief description of the error. Indicates that access is forbidden.","example":"Forbidden"},"message":{"type":"string","description":"A detailed message about the error, usually describing why the request was forbidden.","example":"Admin access denied"},"path":{"type":"string","description":"The URI path of the request that caused the error. Helps in identifying the resource involved in the error.","example":"/scim/v2/Users"}}},"id":"schema_311"},"schema_312":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs related to the error response. Provides information about the error response structure."},"status":{"type":"string","description":"The HTTP status code for the error. Indicates that the requested resource could not be found.","example":"404"},"detail":{"type":"string","description":"A description of the error. Provides details about why the resource was not found.","example":"Resource not found"}}},"id":"schema_312"},"schema_313":{"kind":"json-schema","data":{"type":"array","description":"Array of user resources returned by the bulk operation.","items":{"type":"object","required":["schemas","name","active","emails","roles","externalId","userName","preferredLanguage","locale","urn:zuora:scim:schemas:1.0:UserExtension"],"properties":{"schemas":{"type":"array","description":"List of schema URNs defining the structure of the user resource.","items":{"type":"string"}},"name":{"type":"object","description":"Name details of the user.","properties":{"givenName":{"type":"string","description":"User's first name."},"familyName":{"type":"string","description":"User's last name."},"formatted":{"type":"string","description":"Formatted full name."}}},"active":{"type":"boolean","description":"Indicates whether the user is active."},"emails":{"type":"array","description":"List of email addresses associated with the user.","items":{"type":"object","properties":{"value":{"type":"string","description":"Email address."},"type":{"type":"string","description":"Type of email (e.g., work, personal)."},"primary":{"type":"boolean","description":"Indicates if this is the primary email."}}}},"roles":{"type":"array","description":"Roles assigned to the user.","items":{"type":"object","properties":{"value":{"type":"string","description":"Role value (e.g., ADMIN)."}}}},"externalId":{"type":"string","description":"External identifier for the user."},"userName":{"type":"string","description":"Unique username for the user."},"preferredLanguage":{"type":"string","description":"User's preferred language."},"locale":{"type":"string","description":"User's locale."},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","description":"Custom extension schema with additional attributes for the user.","properties":{"schemas":{"type":"array","description":"List of URNs for the extension schemas.","items":{"type":"string"}},"organizationId":{"type":"string","description":"Identifier for the associated organization."}}}}}},"id":"schema_313"},"schema_314":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Unique identifier for the user."},"externalId":{"type":"string","description":"External identifier for the user."},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"Timestamp of when the user was created."},"resourceType":{"type":"string","description":"Type of the resource (e.g., User)."},"location":{"type":"string","description":"URL of the user resource."}}},"userName":{"type":"string","description":"Unique username for the user."},"name":{"type":"object","properties":{"formatted":{"type":"string","description":"Formatted full name."},"familyName":{"type":"string","description":"User's last name."},"givenName":{"type":"string","description":"User's first name."}}},"displayName":{"type":"string","description":"Display name of the user."},"preferredLanguage":{"type":"string","description":"User's preferred language."},"locale":{"type":"string","description":"User's locale."},"active":{"type":"boolean","description":"Indicates whether the user is active."},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Email address."},"display":{"type":"string","description":"Display version of the email."},"type":{"type":"string","description":"Type of email (e.g., work, personal)."},"primary":{"type":"boolean","description":"Indicates if this is the primary email."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Role value (e.g., ADMIN)."},"display":{"type":"string","description":"Display version of the role."}}}},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"organizationId":{"type":"string","description":"Identifier for the associated organization."},"status":{"type":"string","description":"Current status of the user."},"ssoEnabled":{"type":"boolean","description":"Indicates if SSO is enabled for the user."},"region":{"type":"string","description":"Region associated with the user."}}}}},"id":"schema_314"},"schema_315":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that apply to the user resource. This typically includes SCIM schema definitions and any custom schemas used."},"id":{"type":"string","description":"A unique identifier for the user resource. Assigned by the server upon creation."},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"The timestamp when the user resource was created. Provides information about the creation time of the resource."},"resourceType":{"type":"string","description":"The type of resource, in this case, it will be 'User'. Helps identify the type of the resource."},"location":{"type":"string","description":"The URL to access the newly created user resource. Provides the URI of the user resource for future references or operations."}}},"userName":{"type":"string","description":"The username for the user. Typically used for login and unique identification of the user within the system."},"name":{"type":"object","properties":{"formatted":{"type":"string","description":"The full name of the user as a single formatted string. Useful for display purposes."},"familyName":{"type":"string","description":"The family name (surname) of the user. Used for sorting and identifying users."},"givenName":{"type":"string","description":"The given name (first name) of the user. Helps in personalizing interactions and communications."}}},"displayName":{"type":"string","description":"A display name for the user, typically used in user interfaces or directories. It may combine various name attributes for better presentation."},"preferredLanguage":{"type":"string","description":"The preferred language of the user for communication. This helps in providing content in the user's chosen language."},"locale":{"type":"string","description":"The locale or region of the user, often used to format dates, times, and numbers according to regional preferences."},"active":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the user account is active. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the user is considered inactive or disabled."},"children":[]}]}]}]},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address of the user. Used for communication and login purposes."},"display":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-readable email address, often the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but can be formatted differently."},"children":[]}]}]}]},"type":{"type":"string","description":"The type of email address (e.g., work, home). Helps categorize different types of email addresses."},"primary":{"type":"boolean","description":"Indicates whether this email address is the primary one for the user. Useful for identifying the main contact address."}}}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The unique identifier of a group to which the user belongs. Useful for group-based permissions and organization."},"display":{"type":"string","description":"The display name of the group. Provides a human-readable name for the group."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The role assigned to the user. Represents the user's role within the system (e.g., admin, user)."},"display":{"type":"string","description":"The display name of the role. Provides a human-readable label for the user's role."}}}},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs specific to the user extension. Defines additional properties or custom attributes for the user resource."},"organizationId":{"type":"string","description":"The unique identifier for the organization to which the user belongs. Useful for organizational management and reporting."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the user account (e.g., ACTIVE, PENDING_ACTIVATION). Helps in tracking the user’s state."},"children":[]}]}]}]},"ssoEnabled":{"type":"boolean","description":"Indicates whether Single Sign-On (SSO) is enabled for the user. Useful for authentication and access management."},"region":{"type":"string","description":"The geographical region of the user. Helps in regional data management and compliance."}}}},"example":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"eb48a32d-2fe6-48d1-8a18-797919f3810a","meta":{"created":"2023-07-13T06:15:25.836Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/eb48a32d-2fe6-48d1-8a18-797919f3810a"},"userName":"Amy+555","name":{"formatted":"Amy Lawrence","familyName":"Lawrence","givenName":"Amy"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"asmurugesan+555@zuora.com","display":"asmurugesan+555@zuora.com","type":"work","primary":true}],"groups":[{"value":"7f5c248e-44e8-48d3-bacc-b5bd1253c2e4","display":""}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"rc141dc2-901e-4813-a25d-ef480cff1e26","status":"ACTIVE","ssoEnabled":false,"region":"EU"}}},"id":"schema_315"},"schema_316":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful. For a 401 error, this will always be false.","example":false},"reasons":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"A message describing the reason for the unauthorized error. Provides more context about the failure.","example":"Unauthorized"},"code":{"type":"string","description":"An application-specific error code that provides additional details about the unauthorized error.","example":"90000011"}}}}},"example":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]}},"id":"schema_316"},"schema_317":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"The timestamp when the error occurred. Useful for debugging and tracking when the error happened.","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"integer","description":"The HTTP status code representing the error. For forbidden errors, this will always be 403.","example":403},"error":{"type":"string","description":"A brief description of the error type. In this case, it indicates a 'Forbidden' error.","example":"Forbidden"},"message":{"type":"string","description":"A message providing more details about the specific error that occurred. Describes why access was denied.","example":"Admin access denied"},"path":{"type":"string","description":"The URI path of the resource that caused the error. Helps in identifying which resource or endpoint triggered the error.","example":"/scim/v2/Users"}},"example":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Users"}},"id":"schema_317"},"schema_318":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that are relevant to the error response. Usually includes a standard error schema."},"status":{"type":"string","description":"The HTTP status code representing the error. For not found errors, this will always be '404'.","example":"404"},"detail":{"type":"string","description":"A message providing details about the resource that was not found. Helps in understanding what was missing or incorrectly requested.","example":"Resource not found"}},"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"}},"id":"schema_318"},"schema_319":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that describe the structure of the user resource. These URNs indicate the schemas that are applicable to the user data."},"name":{"type":"object","properties":{"givenName":{"type":"string","description":"The given (or first) name of the user."},"familyName":{"type":"string","description":"The family (or last) name of the user."},"formatted":{"type":"string","description":"The full name of the user in a formatted string. Typically includes given name and family name."}}},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address of the user."},"type":{"type":"string","description":"The type of email address (e.g., 'work', 'home')."},"primary":{"type":"boolean","description":"Indicates whether this email address is the user's primary email."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The role assigned to the user, typically represented by an identifier."},"display":{"type":"string","nullable":true}}}},"userName":{"type":"string","description":"The username or login name of the user."},"preferredLanguage":{"type":"string","description":"The preferred language of the user, typically represented by a locale code (e.g., 'en', 'fr')."},"locale":{"type":"string","description":"The locale of the user, typically represented by a locale code (e.g., 'en-US', 'fr-FR')."},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that describe additional extensions or custom schemas applied to the user resource."},"organizationId":{"type":"string","description":"An identifier for the organization to which the user belongs. This may be used for organizational or grouping purposes."}}}}}},"id":"schema_319"},"schema_320":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that describe the structure of the response. These URNs indicate the schemas that are applicable to the data."},"id":{"type":"string","nullable":true,"description":"A unique identifier for the response object, often used for referencing or tracking."},"externalId":{"type":"string","nullable":true,"description":"An external identifier for the resource, often used for integration with external systems."},"totalResults":{"type":"integer","description":"The total number of user resources available in the response, irrespective of pagination."},"resources":{"type":"array","items":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that describe the structure of the individual user resource. These URNs indicate the schemas applicable to the user data."},"id":{"type":"string","nullable":true,"description":"A unique identifier for the user resource."},"externalId":{"type":"string","nullable":true,"description":"An external identifier for the resource, often used for integration with external systems."},"meta":{"nullable":true,"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"The date and time when the user resource was created, in ISO 8601 format."},"resourceType":{"type":"string","description":"The type of the resource, typically 'User' for user resources."},"location":{"type":"string","description":"The URL where the user resource can be accessed."}}},"userName":{"type":"string","description":"The username or login name for the user."},"name":{"type":"object","properties":{"formatted":{"type":"string","description":"The full name of the user, formatted as a single string."},"familyName":{"type":"string","description":"The family (or last) name of the user."},"givenName":{"type":"string","description":"The given (or first) name of the user."}}},"displayName":{"type":"string","description":"The display name of the user, typically used for user identification."},"preferredLanguage":{"type":"string","description":"The user's preferred language, typically represented by a locale code (e.g., 'en', 'fr')."},"locale":{"type":"string","description":"The user's locale, typically represented as a locale code (e.g., 'en-US', 'fr-FR')."},"active":{"type":"boolean","description":"Indicates whether the user is currently active or not."},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address of the user."},"display":{"type":"string","description":"A display name or description for the email address."},"type":{"type":"string","description":"The type of email address (e.g., 'work', 'home')."},"primary":{"type":"boolean","description":"Indicates whether this email address is the primary one for the user."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The role assigned to the user, often represented by an identifier."},"display":{"type":"string","nullable":true}}}},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that describe additional extensions or custom schemas applied to the user resource."},"organizationId":{"type":"string","format":"uuid","example":"ec141dc2-901e-4813-a25d-ef480cff1e26","description":"An identifier for the organization to which the user belongs. This may be used for organizational or grouping purposes."},"status":{"type":"string","example":"NEW","description":"The current status of the user. Example values might include 'NEW', 'ACTIVE', 'INACTIVE', etc."},"ssoEnabled":{"type":"boolean","description":"Indicates whether Single Sign-On (SSO) is enabled for the user."},"region":{"type":"string"}}}}}},"startIndex":{"type":"integer"},"itemsPerPage":{"type":"integer"}}},"id":"schema_320"},"schema_321":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the operation was successful or not. For a 401 Unauthorized error, this will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"reasons":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"A brief description of the reason for the unauthorized access. This message typically explains why the request is unauthorized, such as missing or invalid authentication credentials."},"code":{"type":"string","description":"An error code that provides a more specific identification of the issue. This code can be used for debugging or logging purposes."}}}}}},"id":"schema_321"},"schema_322":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"The date and time when the error occurred, in ISO 8601 format."},"status":{"type":"integer","description":"The HTTP status code for the response, which is 403 in this case, indicating that access to the resource is forbidden."},"error":{"type":"string","description":"A short, descriptive string representing the error type. For a 403 response, this is typically 'Forbidden'."},"message":{"type":"string","description":"A human-readable message providing additional details about the error. This message typically explains why access is denied."},"path":{"type":"string","description":"The URI path of the resource where the error occurred."}}},"id":"schema_322"},"schema_323":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that describe the structure of the error response. This helps in understanding the error context."},"status":{"type":"string","description":"The HTTP status code for the response, which is 404 in this case, indicating that the requested resource could not be found."},"detail":{"type":"string","description":"A human-readable message providing additional information about the error. This typically explains what resource was not found."}}},"id":"schema_323"},"schema_324":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that apply to this resource, indicating the structure and attributes of the resource."},"id":{"type":"string","description":"A unique identifier for the resource within the system."},"externalId":{"type":"string","description":"An external identifier for the resource, often used for integration with external systems."},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"The date and time when the resource was created, in ISO 8601 format."},"resourceType":{"type":"string","description":"The type of resource (e.g., User) this metadata pertains to."},"location":{"type":"string","description":"The URL where the resource can be accessed or retrieved."}}},"userName":{"type":"string","description":"The username of the user. This is typically a unique identifier for the user within the system."},"name":{"type":"object","properties":{"formatted":{"type":"string","description":"The full name of the user in a formatted string (e.g., 'John Doe')."},"familyName":{"type":"string","description":"The family name (or surname) of the user."},"givenName":{"type":"string","description":"The given name (or first name) of the user."}}},"displayName":{"type":"string","description":"A name that is suitable for display to end-users, which may be different from the username or full name."},"preferredLanguage":{"type":"string","description":"The preferred language of the user for communication and content."},"locale":{"type":"string","description":"The locale of the user, typically used to determine regional settings (e.g., 'en-US' for English, United States)."},"active":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the user account is currently active. A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the account is active, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it is inactive."},"children":[]}]}]}]},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address of the user."},"display":{"type":"string","description":"A display name for the email address, often the same as the email address itself."},"type":{"type":"string","description":"The type of email address (e.g., 'work', 'home')."},"primary":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this email address is the primary one for the user. A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it is the primary email."},"children":[]}]}]}]}}}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The role assigned to the user (e.g., 'ADMIN', 'USER')."},"display":{"type":"string","nullable":true}}}},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs specific to the user extension, indicating additional attributes."},"organizationId":{"type":"string","description":"An identifier for the organization associated with the user, often used for organizational contexts."},"status":{"type":"string","description":"The current status of the user within the system (e.g., 'ACTIVE', 'PENDING')."},"ssoEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether Single Sign-On (SSO) is enabled for the user. A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means SSO is enabled."},"children":[]}]}]}]},"region":{"type":"string","description":""}}}}}},"id":"schema_324"},"schema_325":{"kind":"json-schema","data":{"type":"object","properties":{"itemsPerPage":{"type":"integer","description":"The items that are allowed on each page.\n"},"startIndex":{"type":"integer"},"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that apply to this resource, indicating the structure and attributes of the response."},"id":{"type":"string","nullable":true,"description":"A unique identifier for the response resource, typically the ID of the user or group."},"externalId":{"type":"string","nullable":true,"description":"An external identifier for the resource, often used for integration with external systems."},"meta":{"type":"object","nullable":true,"properties":{"created":{"type":"string","format":"date-time","description":"The date and time when the user resource was created, in ISO 8601 format."},"resourceType":{"type":"string","description":"The type of resource (e.g., 'User')."},"location":{"type":"string","description":"The URL where the user resource can be accessed or retrieved."}}},"totalResults":{"type":"integer","description":"The total number of results returned by the request. This helps in pagination and determining the total size of the dataset."},"resources":{"type":"array","items":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that define the structure and attributes of the user resource."},"id":{"type":"string","nullable":true,"description":"A unique identifier for the user resource."},"externalId":{"type":"string","nullable":true,"description":"An external identifier for the resource, often used for integration with external systems."},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"The date and time when the user resource was created, in ISO 8601 format."},"resourceType":{"type":"string","description":"The type of resource (e.g., 'User')."},"location":{"type":"string","description":"The URL where the user resource can be accessed or retrieved."}}},"userName":{"type":"string","description":"The username of the user, typically used as a unique identifier."},"name":{"type":"object","properties":{"formatted":{"type":"string","description":"The full name of the user formatted as a single string (e.g., 'John Doe')."},"familyName":{"type":"string","description":"The user's family name (surname)."},"givenName":{"type":"string","description":"The user's given name (first name)."}}},"displayName":{"type":"string","description":"A display name for the user, which may differ from the username or full name."},"preferredLanguage":{"type":"string","description":"The user's preferred language for communication and content."},"locale":{"type":"string","description":"The user's locale, which typically indicates regional settings (e.g., 'en-US')."},"active":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the user account is currently active. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means active, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means inactive."},"children":[]}]}]}]},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address of the user."},"display":{"type":"string","description":"A display name for the email address, often the same as the email address itself."},"type":{"type":"string","description":"The type of email address (e.g., 'work', 'home')."},"primary":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this email address is the primary one for the user. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means primary."},"children":[]}]}]}]}}}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The role assigned to the user (e.g., 'ADMIN')."},"display":{"type":"string","nullable":true}}}},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs specific to the user extension, detailing additional attributes."},"organizationId":{"type":"string","format":"uuid","example":"ec141dc2-901e-4813-a25d-ef480cff1e26","description":"An identifier for the organization associated with the user."},"status":{"type":"string","example":"NEW","description":"The current status of the user (e.g., 'ACTIVE', 'NEW')."},"ssoEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether Single Sign-On (SSO) is enabled for the user. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means SSO is enabled."},"children":[]}]}]}]},"region":{"type":"string","description":""}}}}}}}},"id":"schema_325"},"schema_326":{"kind":"json-schema","data":{"type":"object","properties":{},"description":"The request was successful, but there is no content to return. Typically used for operations like delete where no data is returned."},"id":"schema_326"},"schema_327":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the request was successful. For unauthorized requests, this will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"reasons":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"A description of why the request is unauthorized (e.g., 'Invalid credentials')."},"code":{"type":"string","description":"A code representing the specific reason for the unauthorized access (e.g., '90000011')."}}}}}},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"The timestamp when the error occurred, in ISO 8601 format."},"status":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HTTP status code for the error, which will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Forbidden."},"children":[]}]}]}]},"error":{"type":"string","description":"A short description of the error (e.g., 'Forbidden')."},"message":{"type":"string","description":"A detailed message explaining why access was denied (e.g., 'Admin access denied')."},"path":{"type":"string","description":"The API endpoint path where the error occurred (e.g., '/scim/v2/Users')."}}},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uuid"},"example":["ebc229f7-aef2-44ad-8e5f-9d1cf0b4c724","bb5c5d37-0707-4aee-b4b2-c818f4b3503b"]},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"type":"object","properties":{"resources":{"type":"array","items":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"externalId":{"type":"string","nullable":true,"description":"An external identifier associated with the resource, if available."},"id":{"type":"string","nullable":true,"description":"The unique identifier assigned to the resource."},"meta":{"type":"object","nullable":true,"properties":{"resourceType":{"type":"string","description":"The type of resource (e.g., 'User')."},"location":{"type":"string","description":"The URL where the resource can be accessed."},"created":{"type":"string","description":"The creation date and time when the resource was created.\n","format":"dateTime"}}},"schemaUrns":{"type":"array","items":{"type":"string"},"description":"A list of URNs for SCIM schemas that this resource conforms to."}}}},"externalId":{"type":"string","nullable":true,"description":"An external identifier associated with the collection of resources, if available."},"id":{"type":"string","nullable":true,"description":"The unique identifier for the collection of resources."},"itemsPerPage":{"type":"integer","format":"int32","description":"The number of items returned per page in the response."},"meta":{"nullable":true,"type":"object","properties":{"resourceType":{"type":"string","description":"The type of resource for the collection (e.g., 'User')."},"location":{"type":"string","description":"The URL where the collection of resources can be accessed."}}},"schemas":{"type":"array","uniqueItems":true,"items":{"type":"string"},"description":"A list of URNs for SCIM schemas applicable to the collection of resources."},"startIndex":{"type":"integer","format":"int32","description":"The index of the first item in the current page of results."},"totalResults":{"type":"integer","format":"int64","description":"The total number of results available across all pages."}}},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.\n"}}},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of URNs for SCIM schemas that this resource conforms to."},"id":{"type":"string","description":"The unique identifier for the resource."},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"The date and time when the resource was created."},"resourceType":{"type":"string","description":"The type of the resource (e.g., 'User')."},"location":{"type":"string","description":"The URL where the resource can be accessed."}}},"userName":{"type":"string","description":"The username of the user."},"name":{"type":"object","properties":{"formatted":{"type":"string","description":"The full name of the user, formatted for display."},"familyName":{"type":"string","description":"The user's family (last) name."},"givenName":{"type":"string","description":"The user's given (first) name."}}},"displayName":{"type":"string","description":"The display name of the user."},"preferredLanguage":{"type":"string","description":"The preferred language of the user."},"locale":{"type":"string","description":"The locale of the user, typically in the format 'language-COUNTRY' (e.g., 'en-US')."},"active":{"type":"boolean","description":"Indicates whether the user is active."},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address."},"display":{"type":"string","description":"A human-readable form of the email address."},"type":{"type":"string","description":"The type of email address (e.g., 'work', 'home')."},"primary":{"type":"boolean","description":"Indicates whether this is the primary email address."}}},"description":"A list of email addresses associated with the user."},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The unique identifier for the group."},"display":{"type":"string","description":"The display name of the group."}}},"description":"A list of groups the user is a member of."},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The role assigned to the user."},"display":{"type":"string","description":"The display name of the role."}}},"description":"A list of roles assigned to the user."},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of URNs for SCIM schemas that this extension conforms to."},"organizationId":{"type":"string","description":"The identifier for the organization to which the user belongs."},"status":{"type":"string","description":"The status of the user (e.g., 'ACTIVE', 'INACTIVE')."},"ssoEnabled":{"type":"boolean","description":"Indicates whether Single Sign-On (SSO) is enabled for the user."},"region":{"type":"string","description":"The region or geographic location associated with the user."}}}},"example":{"application/json":{"value":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"791aad21-0036-4138-b9b0-350516bac4ac","meta":{"created":"2023-07-13T06:15:25.836Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/791aad21-0036-4138-b9b0-350516bac4ac"},"userName":"username2","name":{"formatted":"Jane Doe","familyName":"Doe","givenName":"Jane"},"displayName":"Jane Doe","preferredLanguage":"en","locale":"en-US","active":false,"emails":[{"value":"jane.doe@example.com","display":"jane.doe@example.com","type":"work","primary":true}],"groups":[{"value":"group2","display":"Group 2"}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"org2","status":"INACTIVE","ssoEnabled":false,"region":"EU"}}}}},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the request was successful. A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that an error occurred."},"children":[]}]}]}],"example":false},"reasons":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable message describing the error or reason for the failure.","example":"Unauthorized"},"code":{"type":"string","description":"A specific error code representing the type of error. This code can be used for programmatic error handling.","example":"90000011"}}}}}},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"The date and time when the error occurred, formatted according to ISO 8601.","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"integer","description":"The HTTP status code associated with the error response. Indicates the type of error that occurred.","example":403},"error":{"type":"string","description":"A short, descriptive name for the error. Often corresponds to the HTTP status code.","example":"Forbidden"},"message":{"type":"string","description":"A detailed message describing the error that occurred. This message is intended to help the client understand the nature of the problem.","example":"Admin access denied"},"path":{"type":"string","description":"The URI path of the request that resulted in the error. This can help identify which resource or endpoint caused the issue.","example":"/scim/v2/Users/delete"}}},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]},"description":"A list of URNs indicating the schemas that describe the structure of the error response. This provides information on the format and content of the error message."},"status":{"type":"string","description":"A string representation of the HTTP status code indicating the error. This helps in identifying the type of error that occurred."},"detail":{"type":"string","description":"A detailed message providing additional context or explanation about the error. This helps in understanding the specific issue or reason for the error."}}},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"A list of schema URNs that define the structure and attributes of the user resource."},"id":{"type":"string","description":"The unique identifier for the user resource."},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"The date and time when the user resource was created."},"resourceType":{"type":"string","description":"The type of resource (e.g., 'User')."},"location":{"type":"string","description":"The URL where the user resource can be accessed or retrieved."}}},"userName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user’s unique username."},"children":[]}]}]}]},"name":{"type":"object","properties":{"formatted":{"type":"string","description":"The full name of the user, including both given and family names."},"familyName":{"type":"string","description":"The family name (surname) of the user."},"givenName":{"type":"string","description":"The given name (first name) of the user."}}},"displayName":{"type":"string","description":"The display name of the user, used for user interface purposes."},"preferredLanguage":{"type":"string","description":"The preferred language for the user, specified using a language code (e.g., 'en')."},"locale":{"type":"string","description":"The locale of the user, specified using a locale code (e.g., 'en-US')."},"active":{"type":"boolean","description":"Indicates whether the user account is active."},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address of the user."},"display":{"type":"string","description":"The email address displayed in the user interface."},"type":{"type":"string","description":"The type of email address (e.g., 'work', 'home')."},"primary":{"type":"boolean","description":"Indicates whether this email address is the primary email for the user."}}}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The identifier of the group to which the user belongs."},"display":{"type":"string","description":"The display name of the group."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The role assigned to the user."},"display":{"type":"string","description":"The display name of the role."}}}},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of schema URNs specific to Zuora’s user extension schema."},"children":[]}]}]}]},"organizationId":{"type":"string","description":"The identifier for the organization to which the user belongs."},"status":{"type":"string","description":"The status of the user account (e.g., 'ACTIVE')."},"ssoEnabled":{"type":"boolean","description":"Indicates whether Single Sign-On (SSO) is enabled for the user."},"region":{"type":"string","description":"The region associated with the user (e.g., 'EU')."}}}}},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"id":{"type":"string","nullable":true},"externalId":{"type":"string"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"resourceType":{"type":"string"},"location":{"type":"string"}}},"userName":{"type":"string"},"name":{"type":"object","properties":{"formatted":{"type":"string"},"familyName":{"type":"string"},"givenName":{"type":"string"}}},"displayName":{"type":"string"},"preferredLanguage":{"type":"string"},"locale":{"type":"string"},"active":{"type":"boolean"},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"display":{"type":"string"}}}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"display":{"type":"string"}}}},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"}},"organizationId":{"type":"string"},"status":{"type":"string"},"ssoEnabled":{"type":"boolean"},"region":{"type":"string"}}}}},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user resource."},"userName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user’s unique username."},"children":[]}]}]}]},"displayName":{"type":"string","description":"The display name of the user, typically used in user interfaces."},"active":{"type":"boolean","description":"Indicates whether the user account is currently active."},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address of the user."},"primary":{"type":"boolean","description":"Indicates whether this email address is the primary email for the user."}}}},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The type of resource, e.g., 'User'."},"created":{"type":"string","format":"date-time","description":"The date and time when the user resource was created."},"lastModified":{"type":"string","format":"date-time","description":"The date and time when the user resource was last modified."}}}}},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user resource."},"userName":{"type":"string","description":"The unique username of the user."},"displayName":{"type":"string","description":"The display name of the user, used for user interfaces and profile views."},"active":{"type":"boolean","description":"Indicates whether the user account is active (true) or inactive (false)."},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address associated with the user."},"primary":{"type":"boolean","description":"Indicates whether this email address is the primary one for the user."}}}},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The type of the resource, e.g., 'User'."},"created":{"type":"string","format":"date-time","description":"The date and time when the user resource was created."},"lastModified":{"type":"string","format":"date-time","description":"The date and time when the user resource was last modified."}}}}},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"type":"object"},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful. For a 401 Unauthorized response, this will be false.","example":false},"reasons":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"A message describing the reason for the authorization failure.","example":"Unauthorized"},"code":{"type":"string","description":"An application-specific error code indicating the nature of the authorization issue.","example":"90000011"}}}}}},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"The date and time when the error occurred, in ISO 8601 format.","example":"2023-07-28T10:47:07.931Z"},"status":{"type":"integer","description":"The HTTP status code for the response. For a 403 Forbidden response, this will be 403.","example":403},"error":{"type":"string","description":"A short, general description of the error.","example":"Forbidden"},"message":{"type":"string","description":"A detailed message explaining why access is forbidden, such as lack of permissions.","example":"Admin access denied"},"path":{"type":"string","description":"The request path that triggered the error.","example":"/scim/v2/Users/123"}}},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}},"Operations":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["replace","add","remove","copy","move","test"]},"path":{"type":"string"},"value":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","format":"email"},"display":{"type":"string"},"type":{"type":"string","enum":["work","home","other"]},"primary":{"type":"boolean"}}}}}}}}}},"required":["schemas","Operations"],"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"/emails","value":{"emails":[{"value":"updatedEmail@zuora.com","display":"updatedEmail@zuora.com","type":"home","primary":false}]}}]}},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"]},"description":"A list of schema URNs that are applicable to the user resource. This helps to identify the structure and format of the returned data."},"id":{"type":"string","description":"The unique identifier for the user resource."},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"The timestamp when the user resource was created, in ISO 8601 format."},"resourceType":{"type":"string","description":"The type of the resource, in this case, it is always 'User' for user resources."},"location":{"type":"string","description":"The URL where the full representation of the user resource can be retrieved."}}},"userName":{"type":"string","description":"The username for the user. This is a unique identifier for the user in the system."},"name":{"type":"object","properties":{"formatted":{"type":"string","description":"The full name of the user formatted as a single string (e.g., 'John Doe')."},"familyName":{"type":"string","description":"The family name (or surname) of the user."},"givenName":{"type":"string","description":"The given name (or first name) of the user."}}},"displayName":{"type":"string","description":"The display name of the user, which may be used in UIs."},"preferredLanguage":{"type":"string","description":"The preferred language of the user for communication."},"locale":{"type":"string","description":"The locale of the user, typically a language code combined with a region (e.g., 'en-US')."},"active":{"type":"boolean","description":"Indicates whether the user account is active or not."},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The email address of the user."},"display":{"type":"string","description":"A display name for the email address, typically the same as the email value."},"type":{"type":"string","description":"The type of the email address (e.g., 'work', 'home')."},"primary":{"type":"boolean","description":"Indicates whether this email address is the primary address for the user."}}}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The unique identifier for the group the user belongs to."},"display":{"type":"string","description":"The display name of the group."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The role assigned to the user."},"display":{"type":"string","description":"A display name for the role."}}}},"urn:zuora:scim:schemas:1.0:UserExtension":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:zuora:scim:schemas:1.0:UserExtension"]},"description":"A list of schema URNs that are specific to Zuora's extended user schema."},"organizationId":{"type":"string","description":"The unique identifier for the organization to which the user belongs."},"status":{"type":"string","description":"The current status of the user (e.g., ACTIVE, INACTIVE)."},"ssoEnabled":{"type":"boolean","description":"Indicates whether Single Sign-On (SSO) is enabled for this user."},"region":{"type":"string"}}}}},"id":"schema_344"},"schema_345":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful. For unauthorized responses, this is always false.","example":false},"reasons":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable message explaining the reason for the unauthorized response.","example":"Unauthorized"},"code":{"type":"string","description":"A specific error code associated with the unauthorized response. This code can be used for programmatic handling of the error.","example":"90000011"}}}}},"example":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]}},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"The date and time when the error occurred, in ISO 8601 format.","example":"2023-07-28T10:47:07.931+00:00"},"status":{"type":"integer","description":"The HTTP status code of the response, which is 403 for forbidden errors.","example":403},"error":{"type":"string","description":"A short description of the error type. For forbidden errors, this is always 'Forbidden'.","example":"Forbidden"},"message":{"type":"string","description":"A detailed message explaining why the request was forbidden. This might include additional context about access control issues.","example":"Admin access denied"},"path":{"type":"string","description":"The path of the request that resulted in the error. This helps identify which resource or endpoint was being accessed when the error occurred.","example":"/scim/v2/Users/00000000-0000-0000-0000-000000000000"}},"example":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Users/00000000-0000-0000-0000-000000000000"}},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"type":"object","properties":{"dateRange":{"type":"object","description":"Specifies the date range for the audit event query.","properties":{"startDate":{"type":"string","format":"date-time","description":"Specifies the start timestamp of the query range."},"endDate":{"type":"string","format":"date-time","description":"Specifies the end timestamp of the query range."}}},"pagination":{"type":"object","description":"Specifies the pagination settings for the query.","properties":{"items":{"type":"integer","format":"int32","description":"Specifies the number of records returned per page."},"page":{"type":"integer","format":"int32","description":"Specifies the zero-based page number to retrieve."}}},"filter":{"type":"object","description":"Specifies the filter conditions for the query.","properties":{"must":{"type":"array","description":"Specifies the conditions that all matching records must satisfy.","items":{"type":"object","properties":{"field":{"type":"string","description":"Specifies the field name to filter on."},"values":{"type":"array","description":"Specifies the values to match against the field.","items":{"type":"string"}},"operator":{"type":"string","description":"Specifies the comparison operator for the filter condition."}}}},"should":{"type":"array","description":"Specifies the conditions of which at least one must be satisfied.","items":{"type":"object","properties":{"field":{"type":"string","description":"Specifies the field name to filter on."},"values":{"type":"array","description":"Specifies the values to match against the field.","items":{"type":"string"}},"operator":{"type":"string","description":"Specifies the comparison operator for the filter condition."}}}},"exclude":{"type":"array","description":"Specifies the conditions used to exclude matching records.","items":{"type":"object","properties":{"field":{"type":"string","description":"Specifies the field name to filter on."},"values":{"type":"array","description":"Specifies the values to match against the field.","items":{"type":"string"}},"operator":{"type":"string","description":"Specifies the comparison operator for the filter condition."}}}}}},"sort":{"type":"object","description":"Specifies the sort settings for the query.","properties":{"field":{"type":"string","description":"Specifies the field used to sort the results."},"order":{"type":"string","description":"Specifies the sort direction."}}}}},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","description":"The number of events returned in the current page.","example":100},"firstPageToken":{"type":"string","example":"0"},"lastPageToken":{"type":"string","example":"34"},"nextToken":{"type":"string","nullable":true,"example":"1"},"previousToken":{"type":"string","nullable":true,"example":null},"totalPages":{"type":"integer","description":"The total number of pages available for the query.","example":35},"totalElements":{"type":"integer","description":"The total number of events that match the query.","example":3484},"events":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"timestamp":{"type":"string","format":"date-time","example":"2025-05-29T14:32:01.000Z"},"username":{"type":"string","example":"admin@zuora.com"},"userId":{"type":"string","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"action":{"type":"string","example":"LOGIN"},"actionDetails":{"type":"string","example":"Successful login via SSO"},"tenantId":{"type":"string","nullable":true,"example":null},"namespace":{"type":"string","example":"global"},"clientid":{"type":"string","example":"zuora-ui"},"clienttype":{"type":"string","example":"BROWSER"},"ipaddress":{"type":"string","example":"192.168.1.100"},"hostname":{"type":"string","example":"one.zuora.com"},"status":{"type":"string","example":"SUCCESS"},"logintype":{"type":"string","example":"SSO"},"browsertype":{"type":"string","example":"Chrome"},"browserversion":{"type":"string","example":"125.0.6422.76"}}}}}},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.zuora.com/en/basics/environments/zuora-billing-testing-environments/limits-policy-for-api-sandbox-and-developer-sandbox-environments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"type":"string","minLength":36,"maxLength":36,"description":"The Zuora internal identifier of the API call. You cannot control the value of this header."},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header."},"Concurrency-Limit-Type":{"type":"string","description":"The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query."},"Concurrency-Limit-Limit":{"type":"integer","description":"The total number of the permitted concurrent requests."},"Concurrency-Limit-Remaining":{"type":"integer","description":"The remaining number of the permitted concurrent requests."}}},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"DateRange is required"},"status":{"type":"integer","example":400}}},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Unauthorized"},"message":{"type":"string","example":"Invalid or expired access token"},"status":{"type":"integer","example":401}}},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Forbidden"},"message":{"type":"string","example":"Insufficient permissions for this organization"},"status":{"type":"integer","example":403}}},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","description":"The number of events returned in the current page.","example":50},"firstPageToken":{"type":"string","example":"0"},"lastPageToken":{"type":"string","example":"5"},"nextToken":{"type":"string","nullable":true,"example":"1"},"previousToken":{"type":"string","nullable":true,"example":null},"totalPages":{"type":"integer","description":"The total number of pages available for the query.","example":6},"totalElements":{"type":"integer","description":"The total number of events that match the query.","example":278},"events":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"c3d4e5f6-a7b8-9012-cdef-234567890123"},"timestamp":{"type":"string","format":"date-time","example":"2025-05-28T10:15:30.000Z"},"username":{"type":"string","example":"orgadmin@company.com"},"userId":{"type":"string","example":"d47ac10b-58cc-4372-a567-0e02b2c3d481"},"action":{"type":"string","example":"UPDATE"},"actionDetails":{"type":"string","example":"Role binding updated for user"},"objectType":{"type":"string","example":"ROLE_BINDING"},"objectId":{"type":"string","example":"rb-12345"},"objectname":{"type":"string","example":"Billing Admin Role"},"namespace":{"type":"string","example":"global"},"settingtype":{"type":"string","example":"ROLE_BINDING"},"changetype":{"type":"string","example":"MODIFY"},"transactionid":{"type":"string","example":"txn-abc123"}}}}}},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","description":"The number of events returned in the current page.","example":100},"firstPageToken":{"type":"string","example":"0"},"lastPageToken":{"type":"string","example":"12"},"nextToken":{"type":"string","nullable":true,"example":"1"},"previousToken":{"type":"string","nullable":true,"example":null},"totalPages":{"type":"integer","description":"The total number of pages available for the query.","example":13},"totalElements":{"type":"integer","description":"The total number of events that match the query.","example":1250},"events":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"e5f6a7b8-c9d0-1234-efgh-456789012345"},"timestamp":{"type":"string","format":"date-time","example":"2025-05-29T16:20:45.000Z"},"username":{"type":"string","example":"billing.user@customer.com"},"userId":{"type":"string","example":"a47ac10b-58cc-4372-a567-0e02b2c3d482"},"action":{"type":"string","example":"LOGIN"},"actionDetails":{"type":"string","example":"Successful login"},"tenantId":{"type":"string","example":"10138"},"tenantUsername":{"type":"string","example":"billing.user"},"namespace":{"type":"string","example":"tenant"},"clientid":{"type":"string","example":"zuora-ui"},"clienttype":{"type":"string","example":"BROWSER"},"ipaddress":{"type":"string","example":"203.0.113.50"},"hostname":{"type":"string","example":"one.zuora.com"},"status":{"type":"string","example":"SUCCESS"},"logintype":{"type":"string","example":"PASSWORD"},"browsertype":{"type":"string","nullable":true,"example":"Chrome"},"browserversion":{"type":"string","nullable":true,"example":"125.0.6422.76"}}}}}},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"Filter is required for tenant object queries"},"status":{"type":"integer","example":400}}},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","description":"The number of events returned in the current page.","example":25},"firstPageToken":{"type":"string","example":"0"},"lastPageToken":{"type":"string","example":"0"},"nextToken":{"type":"string","nullable":true,"example":null},"previousToken":{"type":"string","nullable":true,"example":null},"totalPages":{"type":"integer","description":"The total number of pages available for the query.","example":1},"totalElements":{"type":"integer","description":"The total number of events that match the query.","example":25},"events":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"a7b8c9d0-e1f2-3456-ghij-678901234567"},"timestamp":{"type":"string","format":"date-time","example":"2025-05-25T11:30:00.000Z"},"username":{"type":"string","example":"tenant.admin@customer.com"},"userId":{"type":"string","example":"c47ac10b-58cc-4372-a567-0e02b2c3d484"},"action":{"type":"string","example":"UPDATE"},"actionDetails":{"type":"string","example":"Password policy updated - minimum length changed from 8 to 12"},"objectType":{"type":"string","example":"SECURITY_POLICY"},"objectId":{"type":"string","example":"sp-10138-001"},"objectname":{"type":"string","example":"Password Policy"},"tenantId":{"type":"string","example":"10138"},"namespace":{"type":"string","example":"tenant"},"settingtype":{"type":"string","example":"SECURITY_POLICY"},"attributeid":{"type":"string","example":"minPasswordLength"},"attributename":{"type":"string","example":"Minimum Password Length"},"changetype":{"type":"string","example":"MODIFY"},"transactionid":{"type":"string","example":"txn-sp-789"}}}}}},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","description":"The number of events returned in the current page.","example":45},"firstPageToken":{"type":"string","example":"0"},"lastPageToken":{"type":"string","example":"0"},"nextToken":{"type":"string","nullable":true,"example":null},"previousToken":{"type":"string","nullable":true,"example":null},"totalPages":{"type":"integer","description":"The total number of pages available for the query.","example":1},"totalElements":{"type":"integer","description":"The total number of events that match the query.","example":45},"events":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"c9d0e1f2-a3b4-5678-ijkl-890123456789"},"timestamp":{"type":"string","format":"date-time","example":"2025-05-29T08:45:00.000Z"},"username":{"type":"string","example":"tenant.admin@customer.com"},"userId":{"type":"string","example":"c47ac10b-58cc-4372-a567-0e02b2c3d484"},"action":{"type":"string","example":"CREATE"},"actionDetails":{"type":"string","example":"New user created with Billing Admin role"},"objectType":{"type":"string","example":"USER"},"objectId":{"type":"string","example":"usr-new-001"},"objectname":{"type":"string","example":"new.user@customer.com"},"tenantId":{"type":"string","example":"10138"},"namespace":{"type":"string","example":"tenant"},"changetype":{"type":"string","example":"CREATE"},"itemtype":{"type":"string","example":"USER"},"itemid":{"type":"string","example":"usr-new-001"},"transactionid":{"type":"string","example":"txn-usr-101"}}}}}},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"type":"string","enum":["ACTIVE","INACTIVE"]},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"title":"GlobalUsersResponse","type":"object","properties":{"data":{"type":"array","items":{"title":"GlobalUserRow","type":"object","properties":{"userId":{"type":"string","format":"uuid","description":"Specifies the unique user identifier.","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"userName":{"type":"string","description":"Specifies the username.","example":"admin@company.com"},"firstName":{"type":"string","description":"Specifies the user's first name.","example":"John"},"lastName":{"type":"string","description":"Specifies the user's last name.","example":"Smith"},"status":{"type":"string","description":"Specifies the user account status.","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"},"workEmail":{"type":"string","format":"email","description":"Specifies the work email address.","example":"john.smith@company.com"},"federatedId":{"type":"string","nullable":true,"description":"Specifies the federated identity.","example":"john.smith@idp.company.com"},"ssoEnabled":{"type":"boolean","description":"Indicates whether SSO is enabled.","example":true},"oneIdRole":{"type":"string","description":"Specifies the organization-level role name.","example":"Organization Admin"},"createdOn":{"type":"string","format":"date-time","description":"Specifies the account creation timestamp.","example":"2024-01-15T10:30:00.000Z"},"deactivatedOn":{"type":"string","format":"date-time","nullable":true,"description":"Specifies the account deactivation timestamp.","example":null},"userGroups":{"type":"string","description":"Specifies the comma-separated list of group names.","example":"Billing Admins, Platform Users"},"lastLogin":{"type":"string","format":"date-time","nullable":true,"description":"Specifies the last login timestamp.","example":"2025-05-29T14:32:01.000Z"}}}},"page":{"type":"integer","description":"Specifies the current page number.","example":0},"size":{"type":"integer","description":"Specifies the page size.","example":20},"totalElements":{"type":"integer","format":"int64","description":"Specifies the total number of matching records.","example":150},"totalPages":{"type":"integer","description":"Specifies the total number of pages.","example":8},"hasNext":{"type":"boolean","description":"Indicates whether another page exists.","example":true}}},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"title":"RolesResponse","type":"object","properties":{"data":{"type":"array","items":{"title":"RoleSetRow","type":"object","properties":{"roleSetId":{"type":"string","format":"uuid","description":"Specifies the unique role set identifier.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"roleName":{"type":"string","description":"Specifies the display name of the role.","example":"Organization Admin"},"description":{"type":"string","description":"Specifies the role description.","example":"Full administrative access to the organization"},"appType":{"type":"string","description":"Specifies the application type.","enum":["BILLING","ZEPHR","REVENUE","EXTENSIBILITY_FRAMEWORK","SSP_ANALYSER","ORDER_ORCHESTRATION","PAYMENTS","COLLECT","CPQ"],"example":"BILLING"},"entityId":{"type":"string","format":"uuid","nullable":true,"description":"Specifies the tenant entity ID for the role.","example":null},"organizationId":{"type":"string","description":"Specifies the organization ID.","example":"org-12345678-abcd-efgh-ijkl-123456789012"},"status":{"type":"string","description":"Specifies the role status.","enum":["ENABLED","DISABLED"],"example":"ENABLED"},"roleType":{"type":"string","description":"Specifies the role type.","enum":["DEFAULT","CUSTOM"],"example":"DEFAULT"},"sourceType":{"type":"string","description":"Specifies the source of the role definition.","example":"USER"},"permissionGroupIds":{"type":"array","description":"Specifies the associated permission group IDs.","items":{"type":"string"},"example":["pg-11111111-aaaa-bbbb-cccc-111111111111","pg-22222222-aaaa-bbbb-cccc-222222222222"]},"globalRoleIds":{"type":"array","description":"Specifies the associated global role IDs.","items":{"type":"string"},"example":"gr-9f2c7a41-b6de-4e83-91ab-7c2d5e4f8a19"},"createdOn":{"type":"string","format":"date-time","description":"Specifies the creation timestamp.","example":"2023-01-01T00:00:00.000Z"},"updatedOn":{"type":"string","format":"date-time","description":"Specifies the last update timestamp.","example":"2023-01-01T00:00:00.000Z"},"createdByUsername":{"type":"string","description":"Specifies the username of the creator.","example":"system"}}}},"page":{"type":"integer","description":"The zero-based page number of the current page.","example":0},"size":{"type":"integer","description":"The number of records returned per page.","example":20},"totalElements":{"type":"integer","format":"int64","description":"The total number of matching records.","example":45},"totalPages":{"type":"integer","description":"The total number of available pages.","example":3},"hasNext":{"type":"boolean","description":"Indicates whether another page of results is available.","example":true}}},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"title":"RolesResponse","type":"object","properties":{"data":{"type":"array","items":{"title":"RoleSetRow","type":"object","properties":{"roleSetId":{"type":"string","format":"uuid","description":"Specifies the unique role set identifier.","example":"c3d4e5f6-a7b8-9012-cdef-234567890123"},"roleName":{"type":"string","description":"Specifies the display name of the role.","example":"Billing Admin"},"description":{"type":"string","description":"Specifies the role description.","example":"Full billing administrative access for this tenant"},"appType":{"type":"string","description":"Specifies the application type.","example":"BILLING"},"entityId":{"type":"string","description":"Specifies the tenant entity ID.","example":"ent-98765432-dcba-hgfe-lkji-210987654321"},"organizationId":{"type":"string","description":"Specifies the organization ID.","example":"org-12345678-abcd-efgh-ijkl-123456789012"},"status":{"type":"string","description":"Specifies the role status.","example":"ACTIVE"},"roleType":{"type":"string","description":"Specifies the role type.","example":"SYSTEM"},"sourceType":{"type":"string","description":"Specifies the source type.","example":"BUILT_IN"},"permissionGroupIds":{"type":"array","description":"Specifies the associated permission group IDs.","items":{"type":"string"},"example":["pg-55555555-aaaa-bbbb-cccc-555555555555","pg-66666666-aaaa-bbbb-cccc-666666666666"]},"globalRoleIds":{"type":"array","description":"Specifies the associated global role IDs.","items":{"type":"string"},"example":[]},"createdOn":{"type":"string","format":"date-time","description":"Specifies the creation timestamp.","example":"2023-01-01T00:00:00.000Z"},"updatedOn":{"type":"string","format":"date-time","description":"Specifies the last update timestamp.","example":"2023-01-01T00:00:00.000Z"},"createdByUsername":{"type":"string","description":"Specifies the username of the creator.","example":"system"}}}},"page":{"type":"integer","example":0},"size":{"type":"integer","example":20},"totalElements":{"type":"integer","format":"int64","example":12},"totalPages":{"type":"integer","example":1},"hasNext":{"type":"boolean","example":false}}},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"title":"TenantRolePermissionsResponse","type":"object","properties":{"data":{"type":"array","items":{"title":"TenantRolePermissionRow","type":"object","properties":{"roleSetId":{"type":"string","format":"uuid","description":"Specifies the unique role set identifier.","example":"c3d4e5f6-a7b8-9012-cdef-234567890123"},"roleName":{"type":"string","description":"Specifies the display name of the role.","example":"Billing Admin"},"description":{"type":"string","description":"Specifies the role description.","example":"Full billing administrative access for this tenant"},"appType":{"type":"string","description":"Specifies the application type.","example":"BILLING"},"entityId":{"type":"string","description":"Specifies the tenant entity ID.","example":"ent-98765432-dcba-hgfe-lkji-210987654321"},"status":{"type":"string","description":"Specifies the role status.","example":"ACTIVE"},"roleType":{"type":"string","description":"Specifies the role type.","example":"SYSTEM"},"createdOn":{"type":"string","format":"date-time","description":"Specifies the creation timestamp.","example":"2023-01-01T00:00:00.000Z"},"updatedOn":{"type":"string","format":"date-time","description":"Specifies the last update timestamp.","example":"2023-01-01T00:00:00.000Z"},"permissions":{"type":"array","description":"Specifies the permission details for the role.","items":{"title":"PermissionDetail","type":"object","properties":{"permissionGroupId":{"type":"string","description":"Specifies the permission group identifier.","example":"pg-55555555-aaaa-bbbb-cccc-555555555555"},"permissionGroupName":{"type":"string","description":"Specifies the display name of the permission group.","example":"Invoice Management"},"category":{"type":"string","description":"Specifies the permission category.","example":"Billing"},"permissions":{"type":"array","description":"Specifies the list of individual permissions.","items":{"type":"string"},"example":["invoice.create","invoice.read","invoice.update","invoice.delete","invoice.post"]}}}}}}},"page":{"type":"integer","description":"Specifies the zero-based page number of the current page.","example":0},"size":{"type":"integer","description":"Specifies the number of records returned per page.","example":20},"totalElements":{"type":"integer","format":"int64","description":"Specifies the total number of matching records.","example":12},"totalPages":{"type":"integer","description":"Specifies the total number of available pages.","example":1},"hasNext":{"type":"boolean","description":"Indicates whether another page of results is available.","example":false}}},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"format":"uuid","maxLength":32,"minLength":32,"type":"string"},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"jobId":{"type":"string","description":"String of 32 characters that identifies the booking date backfill job. \nThe id is generated before the backfill job is processed. \nYou can use the id to get the booking date backfill job result.\n"}}}]},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/GETAutoBackfillJobResponse"}}}}]},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"type":"string","minLength":32,"maxLength":32},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"job":{"$ref":"#/components/schemas/GETAutoBackfillJobResponse"}}}]},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stopping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is currently the only allowed value."},"children":[]}]}]}],"type":"string","enum":["Stopping"]}},"required":["status"]},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DataBackfillJob"},"file":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A file containing the data about the fields that you want to backfill. This file must be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file or a zipped "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file. The maximum file size is 4 MB. The data in the file must be formatted according to the data backfill action type that you want to perform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can download a file template to view all fields supported for your data backfill. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=billing-configure-revenue-settings","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform data backfill"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","format":"binary"},"checksum":{"description":"An MD5 checksum that is used to validate the integrity of the uploaded file.","type":"string","minLength":32,"maxLength":32}},"required":["file","type"]},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"jobId":{"type":"string","description":"String of 32 characters that identifies the data backfill job. The id is generated before the job is processed. You can use the id to retrieve the data backfill job result.\n"}}}]},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"job":{"$ref":"#/components/schemas/DataBackfillJob"}}}]},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/DataBackfillJob"}}}}]},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DataBackfillJobType"},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","description":"Indicating it should be downloaded, prefilled with the value of the filename parameters if present.\n"},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot control the value of this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["RatePlanCharge","OrderLineItem"]},"batchSize":{"type":"integer","format":"int32","default":1000,"minimum":1,"maximum":1000},"dryRun":{"type":"boolean","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the job is created in dry-run mode. In dry-run mode, the data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is not updated. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"example":{"type":"RatePlanCharge","batchSize":1000,"dryRun":false}},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"jobId":{"type":"string","description":"String of 32 characters that identifies the auto backfill job. \nThe id is generated before the backfill job is processed. \nYou can use the id to get the auto backfill job result.\n"}}}]},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"default":"Incremental","enum":["Incremental","Full"],"type":"string"},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"description":"","items":{"$ref":"#/components/schemas/SaveResult"},"type":"array"},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"description":"","items":{"$ref":"#/components/schemas/DeleteResult"},"type":"array"},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"properties":{"File":{"description":"The data to import.\n","format":"binary","type":"string"},"ImportType":{"description":"The type of data to import.\n","enum":["Usage","Payment","Quote","TaxationDetail","UpdateAccountingCode","CreateRevenueSchedule","UpdateRevenueSchedule","DeleteRevenueSchedule","ImportFXRate"],"type":"string"},"Name":{"description":"A descriptive name for the import.\n","type":"string"}},"required":["ImportType","Name","File"],"type":"object"},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"enum":["Account","Invoice","Subscription","CreditMemo","DebitMemo"],"type":"string"},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"properties":{"file":{"description":"The file to be attached. Files with the following extensions are supported: .pdf, .csv, .png, .xlsx, .xls, .doc, .docx, .msg, .jpg, .txt, .htm, .html, .eml, .pptx, .gif, .rtf, .xml, .jpeg, .log, .cls\n\nThe maximum file size is 4 MB.\n","format":"binary","type":"string"}},"required":["file"],"type":"object"},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"enum":["account","invoice","subscription","creditmemo","debitmemo"],"type":"string"},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"type":"string","enum":["DQ","OQ"]},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/GetObjectSummary"}},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_]*$"},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"type":"string","enum":["DQ","OQ","DSE","AQUA"]},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"properties":{"object":{"description":"The base object information.","type":"object","properties":{"name":{"type":"string","description":"Name of the base object."},"label":{"type":"string","description":"Label of the base object in the Zuora UI."},"fields":{"description":"The fields on the base object.","type":"array","items":{"type":"object","title":"field","properties":{"name":{"type":"string","description":"API name of the field.","example":"Account"},"label":{"type":"string","description":"Label of the field in the Zuora UI.","example":"Account"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data type of the field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the data type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"picklist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<field>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" element contains an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<options>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" element that lists the possible values of the field."},"children":[]}]}]}],"enum":["boolean","data","datetime","decimal","integer","picklist","text","timestamp","ZOQL"]},"contexts":{"type":"array","description":"The contexts of the API object, such as SOAP and REST.\n","items":{"title":"context","description":"Each context information item of the API object.\n","type":"object","properties":{"context":{"type":"string","example":"soap"}}}}}}},"related-objects":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The information of the related objects. This object is returned only if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"showRelationships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"object","title":"object","properties":{"name":{"description":"Name of the related object.","type":"string","example":"BillToContact"},"label":{"description":"Label of the related object in the Zuora UI.","type":"string","example":"Bill To"},"cardinality":{"description":"The cardinality between the base object and the related object.","type":"string","example":"TO_ONE"},"direct-relationship":{"description":"Indicates whether this object is directly joined with the base object.\n","type":"boolean","example":true},"path":{"description":"Describes how this object is joined from the base object.\n","type":"string","example":"Account.BillToContact"}}}}}}}},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"type":"integer","maximum":40,"default":10},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This header is returned if you specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header and the response contains over 1000 bytes of data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the following MIME types support gzipped responses:"},"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":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]}]}]}]}]},"RateLimit-Limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request limit quota for the time window closest to exhaustion."},"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://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}]},"RateLimit-Remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of requests remaining in the time window closest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}]},"RateLimit-Reset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds until the quota resets for the time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"window closest to quota exhaustion. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.zuora.com/docs/guides/rate-limits/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for more information."},"children":[]}]}]}]},"Zuora-Request-Id":{"maxLength":36,"minLength":36,"type":"string","description":"The Zuora internal identifier of the API call. You cannot\ncontrol the value of this header.\n"},"Zuora-Track-Id":{"type":"string","maxLength":64,"description":"A custom identifier for tracing the API call. \nIf you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. \nOtherwise, Zuora does not set this header.\n"},"Concurrency-Limit-Type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the concurrency limit, which can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"High-volume transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Object Query"},"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":"https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Concurrency-Limit-Remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining number of the permitted concurrent requests."},"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://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concurrent request limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_390"}},"exampleStore":{"paths/~1oauth~1token/post/responses/200/content/application~1json/examples/response":{"value":{"access_token":"c652cbc0ea384b9f81856a93a2a74538","expires_in":3599,"jti":"c652cbc0ea384b9f81856a93a2a74539","scope":"user.7c4d5433dc234c369a01b9719ecd059f entity.1a2b7a37-3e7d-4cb3-b0e2-883de9e766cc entity.c92ed977-510c-4c48-9b51-8d5e848671e9 service.echo.read tenant.19","token_type":"bearer"},"key":"response","summary":"response","id":"paths/~1oauth~1token/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/entitlementMetric":{"value":{"name":"AI Units Entitlement Metric","description":"Sums AI units consumed for entitlement validation","kind":["entitlement_kind"],"event_types":["ai.units.consumed"],"filters":[],"computed_properties":[{"output_key":"ai_units","expression":"quantity","output_type":"number","uom_id":"Each"}],"aggregation":{"type":"sum","property":"ai_units"},"group_keys":[{"key":"subscription_key","display_name":"Subscription","roles":["contract_usage"],"cardinality_hint":"high","position":0}]},"key":"entitlementMetric","summary":"Entitlement metric that sums AI units","id":"paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/entitlementMetric"},"paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/billableMetric":{"value":{"name":"LLM Inference Count","description":"Count of LLM inference requests grouped by model and region","kind":["billable"],"event_types":["llm.inference.completed"],"filters":[{"property":"cached","operator":"EQUALS","value":"false","case_sensitive":false}],"computed_properties":[{"output_key":"total_tokens","expression":"input_tokens + output_tokens","output_type":"number","uom_id":"Each"}],"aggregation":{"type":"count"},"group_keys":[{"key":"model","display_name":"Model","roles":["pricing","presentation"],"cardinality_hint":"low","position":0},{"key":"region","display_name":"Region","roles":["presentation"],"cardinality_hint":"low","position":1}]},"key":"billableMetric","summary":"Billable metric that counts inference requests","id":"paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/billableMetric"},"paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/percentileMetric":{"value":{"name":"p99 Inference Latency","description":"99th percentile latency across LLM inference requests","kind":["billable","diagnostic"],"event_types":["llm.inference.completed"],"filters":[{"property":"model","operator":"IN","values":["claude-opus","claude-sonnet","claude-haiku"]}],"computed_properties":[],"aggregation":{"type":"percentile","property":"latency_ms","percentile":99},"group_keys":[{"key":"model","display_name":"Model","roles":["pricing"],"cardinality_hint":"low","position":0}]},"key":"percentileMetric","summary":"Percentile diagnostic metric","id":"paths/~1commerce~1billable-metrics/post/requestBody/content/application~1json/examples/percentileMetric"},"paths/~1commerce~1billable-metrics/post/responses/200/content/application~1json/examples/response":{"value":{"value":{"id":"7ec58fadb6f84bc18e59c7529058d941","metricNumber":"BM-00000001","name":"AI Units Entitlement Metric","description":"Sums AI units consumed for entitlement validation","kind":["entitlement_kind"],"event_types":["ai.units.consumed"],"computed_properties":[{"output_key":"ai_units","expression":"quantity","output_type":"number","uom_id":"Each"}],"aggregation":{"type":"sum","property":"ai_units"},"group_keys":[{"key":"subscription_key","display_name":"Subscription","roles":["contract_usage"],"cardinality_hint":"high","position":0}],"status":"draft"}},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid billable metric request"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics/post/responses/401/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics/post/responses/500/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"id":"7ec58fadb6f84bc18e59c7529058d941","metricNumber":"BM-00000001","name":"AI Units Entitlement Metric","description":"Sums AI units consumed for entitlement validation","kind":["entitlement_kind"],"event_types":["ai.units.consumed"],"aggregation":{"type":"sum","property":"ai_units"},"group_Keys":[{"key":"subscription_key","display_name":"Subscription","roles":["contract_usage"],"cardinality_hint":"high","position":0}],"status":"published"}]},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics/get/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"value":{"id":"7ec58fadb6f84bc18e59c7529058d941","metricNumber":"BM-00000001","name":"LLM Inference Count","description":"Count of LLM inference requests grouped by model and region","kind":["billable"],"event_types":["llm.inference.completed"],"filters":[{"property":"cached","operator":"EQUALS","value":"false","case_sensitive":false}],"aggregation":{"type":"count"},"group_Keys":[{"key":"model","display_name":"Model","roles":["pricing","presentation"],"cardinality_hint":"low","position":0}],"status":"published"}},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics~1{id}/get/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid billable metric id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics~1{id}/get/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics~1{id}/put/requestBody/content/application~1json/example":{"value":{"metric_key":"7ec58fadb6f84bc18e59c7529058d941","description":"Updated count of non-cached LLM inference requests","filters":[{"property":"cached","operator":"EQUALS","value":"false"}],"group_keys":[{"key":"model","display_name":"Model","roles":["pricing","presentation"],"cardinality_hint":"low","position":0},{"key":"region","display_name":"Region","roles":["presentation"],"cardinality_hint":"low","position":1}]},"id":"paths/~1commerce~1billable-metrics~1{id}/put/requestBody/content/application~1json/example"},"paths/~1commerce~1billable-metrics~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"value":{"id":"7ec58fadb6f84bc18e59c7529058d941","metricNumber":"BM-00000001","name":"LLM Inference Count","description":"Updated count of non-cached LLM inference requests","kind":["billable"],"event_types":["llm.inference.completed"],"aggregation":{"type":"count"},"status":"draft"}},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics~1{id}/put/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid billable metric id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics~1{id}/put/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics~1{id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true,"id":"7ec58fadb6f84bc18e59c7529058d941"},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics~1{id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1billable-metrics~1{id}/delete/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid billable metric id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1billable-metrics~1{id}/delete/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1features/post/requestBody/content/application~1json/examples/booleanFeature":{"value":{"name":"sso_access","description":"Grants single sign-on access","type":"bool","status":"Active"},"key":"booleanFeature","summary":"Boolean feature","id":"paths/~1commerce~1features/post/requestBody/content/application~1json/examples/booleanFeature"},"paths/~1commerce~1features/post/requestBody/content/application~1json/examples/enumFeature":{"value":{"name":"support_tier","description":"Customer support tier","type":"enumType","status":"Active","values":["basic","premium","enterprise"]},"key":"enumFeature","summary":"Enum feature","id":"paths/~1commerce~1features/post/requestBody/content/application~1json/examples/enumFeature"},"paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedMeteredFeature":{"value":{"name":"api_calls","description":"API calls consumed per billing period","type":"numbered","status":"Active","unitOfMeasure":"Each","isMetered":true,"isCapped":true,"metricId":"7ec58fadb6f84bc18e59c7529058d941"},"key":"numberedMeteredFeature","summary":"Numbered metered feature","id":"paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedMeteredFeature"},"paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedUnmeteredFeature":{"value":{"name":"included_seats","description":"Included user seats","type":"numbered","status":"Active","unitOfMeasure":"Each","isMetered":false},"key":"numberedUnmeteredFeature","summary":"Numbered unmetered feature","id":"paths/~1commerce~1features/post/requestBody/content/application~1json/examples/numberedUnmeteredFeature"},"paths/~1commerce~1features/post/requestBody/content/application~1json/examples/taggedUnmeteredFeature":{"value":{"name":"reporting_pack","description":"Tagged unmetered feature","status":"Active","type":"unmetered","isMetered":false,"isCapped":true,"tags":["premium"]},"key":"taggedUnmeteredFeature","summary":"Unmetered feature with tags","id":"paths/~1commerce~1features/post/requestBody/content/application~1json/examples/taggedUnmeteredFeature"},"paths/~1commerce~1features/post/responses/200/content/application~1json/examples/response":{"value":{"value":{"id":"8ad088009840d1c2019855e15c993f2f","featureNumber":"FEAT-00000001","name":"sso_access","description":"Grants single sign-on access","type":"bool","status":"Active","tags":[]}},"key":"response","summary":"response","id":"paths/~1commerce~1features/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1features/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid feature request"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1features/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1features/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1commerce~1features/post/responses/401/content/application~1json/examples/response"},"paths/~1commerce~1features/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commerce~1features/post/responses/500/content/application~1json/examples/response"},"paths/~1commerce~1features/get/responses/200/content/application~1json/examples/response":{"value":{"items":[{"id":"8ad088009840d1c2019855e15c993f2f","featureNumber":"FEAT-00000001","name":"sso_access","description":"Grants single sign-on access","type":"bool","status":"Active"},{"id":"00c86e3a0595442c88ed9ef8474b10a7","featureNumber":"FEAT-00000002","name":"support_tier","description":"Customer support tier","type":"enumType","status":"Active","values":["basic","premium","enterprise"]},{"id":"572a2efe711b449e80cbef94419bc050","featureNumber":"FEAT-00000003","name":"api_calls","description":"API calls consumed per billing period","type":"numbered","status":"Active","unitOfMeasure":"Each","isMetered":true,"isCapped":true,"metricId":"7ec58fadb6f84bc18e59c7529058d941"}]},"key":"response","summary":"response","id":"paths/~1commerce~1features/get/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateName":{"value":{"id":"8ad088009840d1c2019855e15c993f2f","name":"sso_access","description":"Grants single sign-on access for enterprise accounts"},"key":"updateName","summary":"Update name and description","id":"paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateName"},"paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateTags":{"value":{"id":"8ad088009840d1c2019855e15c993f2f","tags":["premium","groupB"]},"key":"updateTags","summary":"Replace feature tags","id":"paths/~1commerce~1features/put/requestBody/content/application~1json/examples/updateTags"},"paths/~1commerce~1features/put/requestBody/content/application~1json/examples/clearTags":{"value":{"id":"8ad088009840d1c2019855e15c993f2f","clear_tags":true},"key":"clearTags","summary":"Clear feature tags","id":"paths/~1commerce~1features/put/requestBody/content/application~1json/examples/clearTags"},"paths/~1commerce~1features/put/responses/200/content/application~1json/examples/response":{"value":{"value":{"id":"8ad088009840d1c2019855e15c993f2f","featureNumber":"FEAT-00000001","name":"sso_access","description":"Grants single sign-on access for enterprise accounts","type":"bool","status":"Active","tags":[]}},"key":"response","summary":"response","id":"paths/~1commerce~1features/put/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1features/put/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid feature id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1features/put/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTagFilter":{"value":{"filter":{"feature_tag":"groupB"}},"key":"byTagFilter","summary":"Search by feature tag using filter","id":"paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTagFilter"},"paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTag":{"value":{"filters":[{"field":"feature_tag","operator":"EQ","value":"premium"}],"pagination":{"pageSize":100}},"key":"byTag","summary":"Search by feature tag","id":"paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byTag"},"paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byType":{"value":{"filters":[{"field":"feature_type","operator":"EQ","value":"bool"}],"pagination":{"page":1,"page_size":20}},"key":"byType","summary":"Search by feature type","id":"paths/~1commerce~1features~1search/post/requestBody/content/application~1json/examples/byType"},"paths/~1commerce~1features~1search/post/responses/200/content/application~1json/examples/response":{"value":{"features":[{"id":"00c86e3a0595442c88ed9ef8474b10a7","featureNumber":"FEAT-00000002","name":"support_tier","description":"Customer support tier","type":"enumType","status":"Active","tags":["premium"],"values":["basic","premium","enterprise"]},{"id":"572a2efe711b449e80cbef94419bc050","featureNumber":"FEAT-00000003","name":"api_calls","description":"API calls consumed per billing period","type":"numbered","status":"Active","unitOfMeasure":"Each","isMetered":true,"isCapped":true,"metricId":"7ec58fadb6f84bc18e59c7529058d941"}]},"key":"response","summary":"response","id":"paths/~1commerce~1features~1search/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1features~1search/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid feature search request"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1features~1search/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/numberedMetered":{"value":{"value":{"id":"572a2efe711b449e80cbef94419bc050","featureNumber":"FEAT-00000003","name":"api_calls","description":"API calls consumed per billing period","type":"numbered","status":"Active","unitOfMeasure":"Each","isMetered":true,"isCapped":true,"metricId":"7ec58fadb6f84bc18e59c7529058d941"}},"key":"numberedMetered","summary":"Numbered metered feature","id":"paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/numberedMetered"},"paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/booleanFeature":{"value":{"value":{"id":"8ad088009840d1c2019855e15c993f2f","featureNumber":"FEAT-00000001","name":"sso_access","description":"Grants single sign-on access","type":"bool","status":"Active"}},"key":"booleanFeature","summary":"Boolean feature","id":"paths/~1commerce~1features~1{id}/get/responses/200/content/application~1json/examples/booleanFeature"},"paths/~1commerce~1features~1{id}/get/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid feature id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1features~1{id}/get/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1features~1{id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true,"id":"8ad088009840d1c2019855e15c993f2f"},"key":"response","summary":"response","id":"paths/~1commerce~1features~1{id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1features~1{id}/delete/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid feature id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1features~1{id}/delete/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1charges/post/responses/200/content/application~1json/examples/response":{"value":{"accounting":{"accountingCode":"PRPC-REV-001","accountsReceivableAccount":"Accounts Receivable","accountsReceivableAccountType":"AccountsReceivable","deferredRevenueAccount":"Deferred Revenue","deferredRevenueAccountType":"DeferredRevenue","recognizedRevenueAccount":"Recognized Revenue","recognizedRevenueAccountType":"Recognized Revenue","adjustmentLiabilityAccount":"adjustL-1","adjustmentLiabilityAccountType":"AdjustmentLiability","adjustmentRevenueAccount":"adjustRev-1","adjustmentRevenueAccountType":"AdjustmentRevenue","contractAssetAccount":"CA-2","contractAssetAccountType":"ContractAsset","contractLiabilityAccount":"CL-2","contractLiabilityAccountType":"ContractLiability","contractRecognizedRevenueAccount":"Contract Recognized Revenue","contractRecognizedRevenueAccountType":"RecognizedRevenue","unbilledReceivablesAccount":"unbilledR-1","unbilledReceivablesAccountType":"UnbilledReceivables","productRatePlanChargeId":"ad95b694d2b8442b84dc8ad26561c7d7"},"attributes":[],"billCycle":{"dayOfMonth":5,"period":"bill_cycle_period_month","periodAlignment":"align_to_charge","timing":"in_advance","type":"specific_day_of_month"},"chargeFunction":"charge_function_prepayment","chargeModel":"flat_fee","chargeType":"recurring","createdById":"53c162482f054f3ca08e1ec82dccfec9","createdTime":"2025-10-13T07:46:02.000+00:00","customFields":{},"discountOptions":{"applyDetails":[],"applyTo":[],"applyToBillingPeriodPartially":false,"reflectDiscountInNetAmount":false,"rollover":false,"stackedDiscount":false},"endDateCondition":"subscription_end","upToPeriodsType":"billing_periods","upToPeriods":0,"extendedPrice":{},"id":"ad95b694d2b8442b84dc8ad26561c7d7","isChargeLevelMinCommit":false,"isCommitted":false,"labels":{},"listPriceBase":"Per_Billing_Period","specificListPriceBase":0,"mergedRateCards":[],"name":"Flat PRPC 1","negotiatedRateCards":[],"ocmJsonByCurrency":{},"organizationLabels":[],"overageOptions":{"includedUnits":0,"unusedUnitsCreditRates":{}},"prepaid":true,"prepaymentUnitType":"unit","prepayment":{"drawdownScope":"commitment_level_account","creditOption":"time_based","fundSupportAccountHierarchy":true,"operationType":"prepaid_operation_type_topup","quantity":10,"rollover":true,"rolloverApply":"apply_first","rolloverEndDateType":"rollover_end_date_type_charge_end_date","rolloverFundPriority":2,"rolloverPeriodLength":6,"rolloverPeriodType":"rollover_period_type_month","rolloverPeriods":1,"unitOfMeasure":"Each","validityPeriod":"specific_months","specificValidityPeriodLength":6,"validityPeriodAlignment":"vp_alignment_term_end","validityPeriodProrationOption":"vp_proration_option_prorate_units","drawdownPriority":5},"priceChangeOption":"no_change","pricing":{"adjustments":{},"discountAmounts":{},"discountPercentages":{},"flatAmounts":{"USD":100},"maxAmounts":{},"minAmounts":{},"percentages":{},"tiers":[],"unitAmounts":{}},"pricingSummary":["USD100"],"pricingWaterfalls":{},"productChargeDefinitions":[],"productRatePlanChargeNumber":"PRPC-00000279","productRatePlanId":"ee2d1ce1036c4dd6ae9d6945565ff7a0","prorationOption":"default_from_tenant_setting","rateCards":[],"revenue":{"excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"legacyReporting":false,"revenueRecognitionRuleName":"Recognize upon invoicing"},"taxMode":"non_taxable","taxCode":"TAX_EXEMPT","taxable":false,"triggerEvent":"contract_effective","updatedById":"53c162482f054f3ca08e1ec82dccfec9","updatedTime":"2025-10-13T07:46:02.000+00:00","useTenantDefaultForPriceChange":true},"key":"response","summary":"response","id":"paths/~1commerce~1charges/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1charges/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}],"Success":false},"key":"response","summary":"response","id":"paths/~1commerce~1charges/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1charges/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1commerce~1charges/post/responses/401/content/application~1json/examples/response"},"paths/~1commerce~1charges/put/requestBody/content/application~1json/example":{"value":{"charge":{"id":"9c4867ed55db43a89731605d5654d4ed","pricing":{"unit_amounts":{"USD":175}},"drawdown":{"unitOfMeasure":"USD","conversionRate":1.25},"rate_cards":[{"attributes":[{"name":"Age","operator":"<=","value":12},{"name":"EffectiveDate","operator":">=","value":"2025-02-01T00:00:00+00:00"}],"pricing":{"unit_amounts":{"USD":180}}},{"attributes":[{"name":"Age","operator":"between","value":[12,60]},{"name":"EffectiveDate","operator":">=","value":"2025-02-01T00:00:00+00:00"}],"pricing":{"unit_amounts":{"USD":200}}},{"attributes":[{"name":"Age","operator":">=","value":60},{"name":"EffectiveDate","operator":">=","value":"2025-02-01T00:00:00+00:00"}],"pricing":{"unit_amounts":{"USD":160}}}]}},"id":"paths/~1commerce~1charges/put/requestBody/content/application~1json/example"},"paths/~1commerce~1charges/put/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1commerce~1charges/put/responses/401/content/application~1json/examples/response"},"paths/~1commerce~1charges/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commerce~1charges/put/responses/500/content/application~1json/examples/response"},"paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/minimal":{"value":{"product_rate_plan_charge_key":"ad95b694d2b8442b84dc8ad26561c7d7"},"key":"minimal","summary":"Query with only the PRPC key (no attributes)","id":"paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/minimal"},"paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/withAttributes":{"value":{"product_rate_plan_charge_key":"ad95b694d2b8442b84dc8ad26561c7d7","evaluation_level":"LIST_PRICE","attributes":[{"name":"Age","number_value":11},{"name":"EffectiveDate","datetime_value":"2025-02-01T00:00:00Z"},{"name":"AccountContext","value":"Liquidity Provider"}]},"key":"withAttributes","summary":"Query with optional attribute values","id":"paths/~1commerce~1charges~1query/post/requestBody/content/application~1json/examples/withAttributes"},"paths/~1commerce~1charges~1query/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}],"Success":false},"key":"response","summary":"response","id":"paths/~1commerce~1charges~1query/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1charges~1query/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1commerce~1charges~1query/post/responses/401/content/application~1json/examples/response"},"paths/~1commerce~1products/post/requestBody/content/application~1json/examples/createProductExample":{"value":{"name":"New prod","start_date":"2024-01-01","end_date":"2050-12-31","category":"base","plans":[{"name":"Consumer Bronze Monthly","start_date":"2024-01-01","end_date":"2050-12-31","active_currencies":["USD"],"charges":[{"name":"Flat PRPC","charge_type":"recurring","charge_model":"flat_fee","default_quantity":10,"min_quantity":1,"max_quantity":999999,"price_increase_percentage":0,"price_change_option":"no_change","use_tenant_default_for_price_change":true,"discount_options":{"discount_class":"","discount_level":"rate_plan","stacked_discount":false,"apply_to":["one_time","recurring","usage"],"apply_to_billing_period_partially":false,"reflect_discount_in_net_amount":false,"rollover":false,"specific_accounting_codes":false,"apply_details":[]},"pricing":{"flat_amounts":{"USD":100}},"bill_cycle":{"type":"specific_day_of_month","day_of_month":5,"period_alignment":"align_to_charge","period":"bill_cycle_period_month","timing":"in_advance"},"trigger_event":"contract_effective","end_date_condition":"subscription_end","up_to_periods_type":"billing_periods","up_to_periods":0,"list_price_base":"Per_Billing_Period","specific_list_price_base":0,"accounting":{"accounting_code":"PRPC-REV-002","accounts_receivable_account":"Accounts Receivable","deferred_revenue_account":"Deferred Revenue","recognized_revenue_account":"Recognized Revenue","adjustment_liability_account":"adjustL-2","adjustment_revenue_account":"adjustRev-2","contract_asset_account":"CA-3","contract_liability_account":"CL-3","contract_recognized_revenue_account":"Contract Recognized Revenue","unbilled_receivables_account":"unbilledR-2"}}]}]},"key":"createProductExample","summary":"Product with one plan and one recurring flat-fee charge","id":"paths/~1commerce~1products/post/requestBody/content/application~1json/examples/createProductExample"},"paths/~1commerce~1products/post/responses/200/content/application~1json/examples/response":{"value":{"allowFeatureChanges":false,"category":"base","contextFilters":[],"createdBy":"53c162482f054f3ca08e1ec82dccfec9","createdTime":"2025-10-17T04:02:54.621-07:00","customFields":{},"customObjects":null,"description":"","endDate":"2050-12-31","features":[],"id":"7ec58fadb6f84bc18e59c7529058d941","legacyFeatures":[],"name":"New prod","netsuite":null,"organizationLabels":[],"plans":[{"activeCurrencies":["USD"],"attributes":[],"contextFilters":[],"createTime":"2025-10-17T04:02:54.655-07:00","createdBy":"53c162482f054f3ca08e1ec82dccfec9","customFields":{},"description":"","displayName":"","endDate":"2050-12-31","entitlements":[],"externalIdSourceSystem":"","externalRateplanId":[],"id":"572a2efe711b449e80cbef94419bc050","name":"Consumer Bronze Monthly","netsuite":null,"organizationLabels":[],"productId":"7ec58fadb6f84bc18e59c7529058d941","productRatePlanCharges":[{"accounting":{"accountingCode":"Accounts Receivable","accountsReceivableAccount":"Accounts Receivable","deferredRevenueAccount":"Accounts Receivable","recognizedRevenueAccount":"Recognized Revenue"},"attributes":[],"billCycle":{"dayOfMonth":5,"period":"bill_cycle_period_month","periodAlignment":"align_to_charge","timing":"in_advance","type":"specific_day_of_month"},"chargeFunction":"charge_function_standard","chargeModel":"flat_fee","chargeType":"recurring","createdById":"53c162482f054f3ca08e1ec82dccfec9","createdTime":"2025-10-17T04:02:54.719-07:00","customFields":{},"discountOptions":{"applyDetails":[],"applyTo":[],"applyToBillingPeriodPartially":false,"reflectDiscountInNetAmount":false,"rollover":false,"stackedDiscount":false},"drawdown":{},"endDateCondition":"subscription_end","upToPeriodsType":"billing_periods","upToPeriods":0,"extendedPrice":{},"id":"42db6ead399a4521bae91b3af469c074","isChargeLevelMinCommit":false,"isCommitted":false,"labels":{},"listPriceBase":"Per_Billing_Period","specificListPriceBase":0,"mergedRateCards":[],"name":"Flat PRPC","negotiatedRateCards":[],"ocmJsonByCurrency":{},"organizationLabels":[],"overageOptions":{"includedUnits":0,"unusedUnitsCreditRates":{}},"prepaid":false,"prepayment":{"rollover":false,"rolloverApply":"apply_last","rolloverPeriodLength":0,"rolloverPeriods":0},"priceChangeOption":"no_change","pricing":{"adjustments":{},"discountAmounts":{},"discountPercentages":{},"flatAmounts":{"USD":100},"maxAmounts":{},"minAmounts":{},"percentages":{},"tiers":[],"unitAmounts":{}},"pricingSummary":[],"pricingWaterfalls":{},"productChargeDefinitions":[],"productRatePlanChargeNumber":"PRPC-00000283","productRatePlanId":"572a2efe711b449e80cbef94419bc050","prorationOption":"default_from_tenant_setting","rateCards":[],"revenue":{"excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"legacyReporting":false,"revenueRecognitionRuleName":"Recognize upon invoicing"},"taxable":false,"triggerEvent":"contract_effective","updatedById":"53c162482f054f3ca08e1ec82dccfec9","updatedTime":"2025-10-17T04:02:54.719-07:00","useTenantDefaultForPriceChange":true}],"productRatePlanNumber":"PRP-00000198","startDate":"2024-01-01","state":"active","updateTime":"2025-10-17T04:02:54.655-07:00","updatedBy":"53c162482f054f3ca08e1ec82dccfec9"}],"productNumber":"PC-00000105","sku":"SKU-00000135","startDate":"2024-01-01","state":"product_active","updatedBy":"53c162482f054f3ca08e1ec82dccfec9","updatedTime":"2025-10-17T04:02:54.621-07:00"},"key":"response","summary":"response","id":"paths/~1commerce~1products/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1products/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}],"Success":false},"key":"response","summary":"response","id":"paths/~1commerce~1products/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1products/put/requestBody/content/application~1json/example":{"value":{"id":"8ad088009840d1c2019855e15c993f2f","name":"Software Service","description":"Software service - basic edition","category":"base","custom_fields":{"HelloBay__c":"Updated value","Tags__c":["AI Powered","Internet Required"]},"startDate":"2025-05-11","endDate":"2050-12-10"},"id":"paths/~1commerce~1products/put/requestBody/content/application~1json/example"},"paths/~1commerce~1products/put/responses/200/content/application~1json/examples/response":{"value":{"allowFeatureChanges":false,"category":"base","contextFilters":[],"createdBy":"8a90a2fd8030ea2e018032b11d3a3f06","createdTime":"2025-08-06T18:11:35.000-07:00","customFields":{},"customObjects":null,"description":"Software service - basic edition","endDate":"2050-12-31","features":[],"id":"00c86e3a0595442c88ed9ef8474b10a7","legacyFeatures":[],"name":"Amadeus","netsuite":null,"organizationLabels":[],"productNumber":"PC-00000095","productRatePlans":[],"sku":"SKU-00000122","startDate":"2024-01-08","state":"product_active","updatedBy":"53c162482f054f3ca08e1ec82dccfec9","updatedTime":"2025-10-23T04:55:54.000-07:00"},"key":"response","summary":"response","id":"paths/~1commerce~1products/put/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1products/put/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1commerce~1products/put/responses/401/content/application~1json/examples/response"},"paths/~1commerce~1products/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commerce~1products/put/responses/500/content/application~1json/examples/response"},"paths/~1commerce~1plans/post/requestBody/content/application~1json/examples/createPlanExample":{"value":{"product_key":"6b14067136304e64b090daccae6680cb","name":"New plan","start_date":"2024-01-01","end_date":"2049-12-31","active_currencies":["USD"],"charges":[{"name":"Flat PRPC 1","charge_model":"flat_fee","charge_type":"recurring","pricing":{"flat_amounts":{"USD":100}},"bill_cycle":{"type":"specific_day_of_month","day_of_month":5,"period_alignment":"align_to_charge","period":"bill_cycle_period_month"},"end_date_condition":"subscription_end","up_to_periods_type":"billing_periods","up_to_periods":0,"list_price_base":"Per_Billing_Period","specific_list_price_base":0,"trigger_event":"contract_effective","accounting":{"accounting_code":"PRPC-REV-001","accounts_receivable_account":"Accounts Receivable","deferred_revenue_account":"Deferred Revenue","recognized_revenue_account":"Recognized Revenue","adjustment_liability_account":"adjustL-1","adjustment_revenue_account":"adjustRev-1","contract_asset_account":"CA-2","contract_liability_account":"CL-2","contract_recognized_revenue_account":"Contract Recognized Revenue","unbilled_receivables_account":"unbilledR-1"}},{"name":"Flat PRPC 2","charge_model":"flat_fee","charge_type":"recurring","pricing":{"flat_amounts":{"USD":100}},"bill_cycle":{"type":"specific_day_of_month","day_of_month":5,"period_alignment":"align_to_charge","period":"bill_cycle_period_month"},"end_date_condition":"subscription_end","trigger_event":"contract_effective","accounting":{"accounting_code":"PRPC-REV-002","accounts_receivable_account":"Accounts Receivable","deferred_revenue_account":"Deferred Revenue","recognized_revenue_account":"Recognized Revenue","adjustment_liability_account":"adjustL-2","adjustment_revenue_account":"adjustRev-2","contract_asset_account":"CA-3","contract_liability_account":"CL-3","contract_recognized_revenue_account":"Contract Recognized Revenue","unbilled_receivables_account":"unbilledR-2"}}]},"key":"createPlanExample","summary":"Create a plan with two recurring flat-fee charges","id":"paths/~1commerce~1plans/post/requestBody/content/application~1json/examples/createPlanExample"},"paths/~1commerce~1plans/post/responses/200/content/application~1json/examples/response":{"value":{"activeCurrencies":["USD"],"attributes":[],"contextFilters":[],"createTime":"2025-10-13T07:46:02.314-07:00","createdBy":"53c162482f054f3ca08e1ec82dccfec9","customFields":{},"description":"","displayName":"","endDate":"2049-12-31","entitlements":[],"externalIdSourceSystem":"","externalRateplanId":[],"id":"ee2d1ce1036c4dd6ae9d6945565ff7a0","name":"New plan","netsuite":null,"organizationLabels":[],"productId":"7228c9e6fd814e3a9e59bcdf0117e34f","productRatePlanCharges":[{"accounting":{"accountingCode":"PRPC-REV-001","accountsReceivableAccount":"Accounts Receivable","accountsReceivableAccountType":"AccountsReceivable","deferredRevenueAccount":"Deferred Revenue","deferredRevenueAccountType":"DeferredRevenue","recognizedRevenueAccount":"Recognized Revenue","recognizedRevenueAccountType":"RecognizedRevenue","adjustmentLiabilityAccount":"adjustL-1","adjustmentLiabilityAccountType":"AdjustmentLiability","adjustmentRevenueAccount":"adjustRev-1","adjustmentRevenueAccountType":"AdjustmentRevenue","contractAssetAccount":"CA-2","contractAssetAccountType":"ContractAsset","contractLiabilityAccount":"CL-2","contractLiabilityAccountType":"ContractLiability","contractRecognizedRevenueAccount":"Contract Recognized Revenue","contractRecognizedRevenueAccountType":"RecognizedRevenue","unbilledReceivablesAccount":"unbilledR-1","unbilledReceivablesAccountType":"UnbilledReceivables","productRatePlanChargeId":"ad95b694d2b8442b84dc8ad26561c7d7"},"attributes":[],"billCycle":{"dayOfMonth":5,"period":"bill_cycle_period_month","periodAlignment":"align_to_charge","timing":"in_advance","type":"specific_day_of_month"},"chargeFunction":"charge_function_standard","chargeModel":"flat_fee","chargeType":"recurring","createdById":"53c162482f054f3ca08e1ec82dccfec9","createdTime":"2025-10-13T07:46:02.375-07:00","customFields":{},"discountOptions":{"applyToBillingPeriodPartially":false,"reflectDiscountInNetAmount":false,"rollover":false,"stackedDiscount":false},"drawdown":{},"endDateCondition":"subscription_end","upToPeriodsType":"billing_periods","upToPeriods":0,"listPriceBase":"Per_Billing_Period","specificListPriceBase":0,"extendedPrice":{},"id":"ad95b694d2b8442b84dc8ad26561c7d7","isChargeLevelMinCommit":false,"isCommitted":false,"labels":{},"mergedRateCards":[],"name":"Flat PRPC 1","negotiatedRateCards":[],"ocmJsonByCurrency":{},"organizationLabels":[],"overageOptions":{"includedUnits":0,"unusedUnitsCreditRates":{}},"prepaid":false,"prepayment":{"rollover":false,"rolloverApply":"apply_last","rolloverPeriodLength":0,"rolloverPeriods":0},"priceChangeOption":"no_change","pricing":{"discountAmounts":{},"discountPercentages":{},"flatAmounts":{"USD":100},"maxAmounts":{},"minAmounts":{},"percentages":{},"tiers":[],"unitAmounts":{}},"pricingSummary":[],"pricingWaterfalls":{},"productChargeDefinitions":[],"productRatePlanChargeNumber":"PRPC-00000279","productRatePlanId":"ee2d1ce1036c4dd6ae9d6945565ff7a0","prorationOption":"default_from_tenant_setting","rateCards":[],"revenue":{"excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"legacyReporting":false,"revenueRecognitionRuleName":"Recognize upon invoicing"},"taxable":false,"triggerEvent":"contract_effective","updatedById":"53c162482f054f3ca08e1ec82dccfec9","updatedTime":"2025-10-13T07:46:02.375-07:00","useTenantDefaultForPriceChange":true}],"productRatePlanNumber":"PRP-00000195","startDate":"2024-01-01","state":"active","updateTime":"2025-10-13T07:46:02.314-07:00","updatedBy":"53c162482f054f3ca08e1ec82dccfec9"},"key":"response","summary":"response","id":"paths/~1commerce~1plans/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1plans/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}]},"key":"response","summary":"response","id":"paths/~1commerce~1plans/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1plans/put/requestBody/content/application~1json/example":{"value":{"id":"5758b1d5a589840e0e6855e1c2ce014d","name":"Bronze Plan","description":"Basic version of our software service","grade":1,"startDate":"2025-09-10","endDate":"2043-08-16"},"id":"paths/~1commerce~1plans/put/requestBody/content/application~1json/example"},"paths/~1commerce~1plans/put/responses/200/content/application~1json/examples/response":{"value":{"activeCurrencies":["USD"],"attributes":[],"contextFilters":[],"createTime":"2025-02-24T01:20:44.000+00:00","createdBy":"8a90a2fd8030ea2e018032b11d3a3f06","customFields":{},"description":"Basic version of our software service","displayName":"","endDate":"2027-01-01","entitlements":[],"externalIdSourceSystem":"","externalRateplanId":[],"id":"38660706ef2f48cfb5222f7dde491895","name":"Bronze Plan","netsuite":{},"organizationLabels":[],"productId":"8a90aac8948deebf01949098b7790326","productRatePlanCharges":[{"id":"99e226fec45943f4b80ed7bcf6d595d7","name":"disc_currency","chargeType":"recurring","chargeModel":"discount_percentage","triggerEvent":"contract_effective","billCycle":{"period":"bill_cycle_period_quarter","periodAlignment":"align_to_term_start","type":"term_start_day"},"pricing":{"discountPercentages":{"USD":10},"tiers":[]},"prepayment":{"creditOption":"time_based","rollover":false,"rolloverApply":"apply_last","rolloverPeriodLength":0,"rolloverPeriods":0,"validityPeriod":"subscription_term"},"taxMode":"non_taxable","taxable":false,"createdById":"8a90a2fd8030ea2e018032b11d3a3f06","createdTime":"2025-02-24T01:21:51.000+00:00","updatedById":"8a90a2fd8030ea2e018032b11d3a3f06","updatedTime":"2025-02-24T01:21:51.000+00:00"},{"id":"fe9b0e764dca4178a11c0e471e5dc0d8","name":"prepay_currency","chargeType":"recurring","chargeModel":"flat_fee","listPriceBase":"Per_Billing_Period","triggerEvent":"contract_effective","billCycle":{"period":"bill_cycle_period_quarter","periodAlignment":"align_to_term_start","timing":"in_advance","type":"term_start_day"},"pricing":{"flatAmounts":{"USD":30},"tiers":[]},"prepayment":{"creditOption":"consumption_based","operationType":"prepaid_operation_type_topup","rollover":false,"rolloverApply":"apply_last","rolloverPeriodLength":0,"rolloverPeriods":0,"validityPeriod":"quarter"},"taxMode":"non_taxable","taxable":false,"createdById":"8a90a2fd8030ea2e018032b11d3a3f06","createdTime":"2025-02-24T01:21:23.000+00:00","updatedById":"8a90a2fd8030ea2e018032b11d3a3f06","updatedTime":"2025-02-24T01:21:23.000+00:00"}],"productRatePlanNumber":"PRP-00000172","startDate":"2025-09-10","state":"active","status":"ACTIVE","updateTime":"2025-10-23T05:16:28.334+00:00","updatedBy":"53c162482f054f3ca08e1ec82dccfec9"},"key":"response","summary":"response","id":"paths/~1commerce~1plans/put/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1plans/put/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1commerce~1plans/put/responses/401/content/application~1json/examples/response"},"paths/~1commerce~1plans/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commerce~1plans/put/responses/500/content/application~1json/examples/response"},"paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges":{"value":{"product_rate_plan_key":"572a2efe711b449e80cbef94419bc050","expand":{"product_rate_plan_charges":true}},"key":"byPlanIdExpandCharges","summary":"Query a single PRP by key and expand charges","id":"paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges"},"paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanKeyNoExpand":{"value":{"product_rate_plan_key":"11dc762a07064ce496af73ff4cfb5614"},"key":"byPlanKeyNoExpand","summary":"Query a single PRP by key (no expansion)","id":"paths/~1commerce~1plans~1query/post/requestBody/content/application~1json/examples/byPlanKeyNoExpand"},"paths/~1commerce~1plans~1query/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}],"Success":false},"key":"response","summary":"response","id":"paths/~1commerce~1plans~1query/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1plans~1query/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1commerce~1plans~1query/post/responses/401/content/application~1json/examples/response"},"paths/~1commerce~1plans~1list/post/requestBody/content/application~1json/example":{"value":{"filters":[{"field":"prp_id","operator":"EQ","value":"38660706ef2f48cfb5222f7dde491895"}],"expand":{"product_rate_plan_charges":true}},"id":"paths/~1commerce~1plans~1list/post/requestBody/content/application~1json/example"},"paths/~1commerce~1plans~1list/post/responses/200/content/application~1json/examples/response":{"value":{"values":[{"id":"38660706ef2f48cfb5222f7dde491895","createdBy":"8a90a2fd8030ea2e018032b11d3a3f06","createTime":"2025-02-24T01:21:23.000+00:00","updatedBy":"8a90a2fd8030ea2e018032b11d3a3f06","updateTime":"2025-02-24T01:21:23.000+00:00","displayName":"Bronze Plan","name":"Bronze Plan","description":"Basic version of our software service","productId":"8a90aac8948deebf01949098b7790326","startDate":"2025-09-10","endDate":"2027-01-01","state":"active","status":"ACTIVE","activeCurrencies":["USD"],"productRatePlanNumber":"PRP-00000172","productRatePlanCharges":[{"id":"fe9b0e764dca4178a11c0e471e5dc0d8","productRatePlanChargeNumber":"PRPC-00000279","name":"prepay_currency","chargeType":"recurring","chargeModel":"flat_fee","listPriceBase":"Per_Billing_Period","triggerEvent":"contract_effective","unitOfMeasure":"Each","defaultQuantity":1,"endDateCondition":"subscription_end","upToPeriodsType":"billing_periods","upToPeriods":0,"billCycle":{"period":"bill_cycle_period_quarter","periodAlignment":"align_to_term_start","timing":"in_advance","type":"term_start_day"},"pricing":{"flatAmounts":{"USD":30},"tiers":[]},"pricingSummary":["USD30"],"taxMode":"non_taxable","taxable":false,"createdById":"8a90a2fd8030ea2e018032b11d3a3f06","createdTime":"2025-02-24T01:21:23.000+00:00","updatedById":"8a90a2fd8030ea2e018032b11d3a3f06","updatedTime":"2025-02-24T01:21:23.000+00:00"}]}]},"key":"response","summary":"response","id":"paths/~1commerce~1plans~1list/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeatureById":{"value":{"featureId":"572a2efe711b449e80cbef94419bc050","defaultQuantity":100},"key":"numberedFeatureById","summary":"Numbered feature entitlement by feature ID","id":"paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeatureById"},"paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeature":{"value":{"featureNumber":"FEAT-00000003","startDate":"2025-01-01","endDate":"2099-12-31","quantity":5,"scope":"subscription","enforcementMode":"soft_warn","resetPolicy":"calendar_month","alertThresholds":"[75, 95]"},"key":"numberedFeature","summary":"Numbered feature entitlement","id":"paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/numberedFeature"},"paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/booleanFeature":{"value":{"product_rate_plan_id":"38660706ef2f48cfb5222f7dde491895","feature_number":"FEAT-00000001"},"key":"booleanFeature","summary":"Boolean feature entitlement","id":"paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/booleanFeature"},"paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/enumFeature":{"value":{"product_rate_plan_id":"38660706ef2f48cfb5222f7dde491895","feature_number":"FEAT-00000002","values":["basic","pro"]},"key":"enumFeature","summary":"Enum feature entitlement","id":"paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/enumFeature"},"paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/staticLimit":{"value":{"featureNumber":"FEAT-00000004","startDate":"2025-01-01","endDate":"2099-12-31","chargeSource":"non_billable","scope":"subscription","enforcementMode":"none","limitSource":"static","limitValue":1000},"key":"staticLimit","summary":"Unmetered entitlement with a static limit","id":"paths/~1commerce~1plans~1{id}~1entitlements/post/requestBody/content/application~1json/examples/staticLimit"},"paths/~1commerce~1plans~1{id}~1entitlements/post/responses/200/content/application~1json/examples/response":{"value":{"value":{"id":"ee2d1ce1036c4dd6ae9d6945565ff7a0","entitlementNumber":"ENT-00000001","featureNumber":"FEAT-00000003","quantity":5,"scope":"subscription","enforcementMode":"soft_warn","planId":"38660706ef2f48cfb5222f7dde491895"}},"key":"response","summary":"response","id":"paths/~1commerce~1plans~1{id}~1entitlements/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1plans~1{id}~1entitlements/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid plan or feature id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1plans~1{id}~1entitlements/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/linkCharge":{"value":{"entitlementNumber":"ENT-00000001","productRatePlanChargeId":"fe9b0e764dca4178a11c0e471e5dc0d8","chargeSource":"usage_charge","scope":"subscription","enforcementMode":"soft_warn","resetPolicy":"calendar_month","alertThresholds":"[75, 95]","limitSource":"charge"},"key":"linkCharge","summary":"Link an entitlement definition to a charge","id":"paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/linkCharge"},"paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/setBooleanValue":{"value":{"entitlement_number":"ENT-00000002","entitlement_bool":true},"key":"setBooleanValue","summary":"Set a boolean entitlement value","id":"paths/~1commerce~1plans~1entitlements/put/requestBody/content/application~1json/examples/setBooleanValue"},"paths/~1commerce~1plans~1entitlements/put/responses/200/content/application~1json/examples/response":{"value":{"value":{"id":"ee2d1ce1036c4dd6ae9d6945565ff7a0","entitlementNumber":"ENT-00000001","featureNumber":"FEAT-00000003","productRatePlanChargeId":"fe9b0e764dca4178a11c0e471e5dc0d8","chargeSource":"usage_charge","scope":"subscription","enforcementMode":"soft_warn","resetPolicy":"calendar_month","limitSource":"charge","planId":"38660706ef2f48cfb5222f7dde491895"}},"key":"response","summary":"response","id":"paths/~1commerce~1plans~1entitlements/put/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1plans~1entitlements/put/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid entitlement definition request"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1plans~1entitlements/put/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1plans~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"value":{"id":"ee2d1ce1036c4dd6ae9d6945565ff7a0","entitlementNumber":"ENT-00000001","featureNumber":"FEAT-00000003","chargeSource":"usage_charge","resetPolicy":"calendar_month","limitSource":"charge","productRatePlanChargeId":"fe9b0e764dca4178a11c0e471e5dc0d8","planId":"38660706ef2f48cfb5222f7dde491895"}},"key":"response","summary":"response","id":"paths/~1commerce~1plans~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1plans~1entitlements~1{id}/get/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid entitlement definition id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1plans~1entitlements~1{id}/get/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1products~1{product_key}/post/requestBody/content/application~1json/examples/expand":{"value":{"expand":{"productRatePlans":true,"productRatePlanCharges":true,"businessContextFilters":true}},"key":"expand","summary":"Expand related objects","id":"paths/~1commerce~1products~1{product_key}/post/requestBody/content/application~1json/examples/expand"},"paths/~1commerce~1products~1{product_key}/post/responses/200/content/application~1json/examples/response":{"value":{"id":"7228c9e6fd814e3a9e59bcdf0117e34f","createdBy":"53c162482f054f3ca08e1ec82dccfec9","createdTime":"2025-10-13T07:44:55.000-07:00","updatedBy":"53c162482f054f3ca08e1ec82dccfec9","updatedTime":"2025-10-13T07:44:55.000-07:00","name":"New prod","description":"Example product description","productNumber":"PC-00000103","sku":"SKU-00000133","startDate":"2024-01-01","endDate":"2050-12-31","category":"base","customFields":{},"customObjects":null,"allowFeatureChanges":false,"productRatePlans":[{"id":"38660706ef2f48cfb5222f7dde491895","createdBy":"53c162482f054f3ca08e1ec82dccfec9","createTime":"2025-02-24T01:21:23.000+00:00","updatedBy":"53c162482f054f3ca08e1ec82dccfec9","updateTime":"2025-02-24T01:21:23.000+00:00","name":"Bronze Plan","displayName":"Bronze Plan","description":"Basic version of our software service","productId":"7228c9e6fd814e3a9e59bcdf0117e34f","startDate":"2025-09-10","endDate":"2027-01-01","state":"active","status":"ACTIVE","activeCurrencies":["USD"],"productRatePlanNumber":"PRP-00000172","productRatePlanCharges":[{"id":"fe9b0e764dca4178a11c0e471e5dc0d8","productRatePlanChargeNumber":"PRPC-00000279","name":"prepay_currency","description":"Prepaid recurring software fee","chargeType":"recurring","chargeModel":"flat_fee","listPriceBase":"Per_Billing_Period","specificListPriceBase":1,"triggerEvent":"contract_effective","endDateCondition":"subscription_end","upToPeriodsType":"billing_periods","upToPeriods":1,"billCycle":{"period":"bill_cycle_period_quarter","periodAlignment":"align_to_term_start","timing":"in_advance","type":"term_start_day"},"pricing":{"flatAmounts":{"USD":30},"tiers":[]},"pricingSummary":["USD30"],"taxMode":"non_taxable","taxable":false,"createdById":"53c162482f054f3ca08e1ec82dccfec9","createdTime":"2025-02-24T01:21:23.000+00:00","updatedById":"53c162482f054f3ca08e1ec82dccfec9","updatedTime":"2025-02-24T01:21:23.000+00:00"}]}],"features":[],"netsuite":null,"organizationLabels":[],"contextFilters":[],"legacyFeatures":[],"dacTag":{"id":"1234567890abcdef","name":"Example DAC Tag"},"error":null},"key":"response","summary":"response","id":"paths/~1commerce~1products~1{product_key}/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1products~1{product_key}/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commerce~1products~1{product_key}/post/responses/500/content/application~1json/examples/response"},"paths/~1commerce~1products~1{product_key}/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid product_key"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1products~1{product_key}/post/responses/4XX/content/application~1json/examples/response"},"paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureId":{"value":{"featureId":"572a2efe711b449e80cbef94419bc050"},"key":"byFeatureId","summary":"Link a feature by feature ID","id":"paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureId"},"paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureNumber":{"value":{"feature_number":"FEAT-00000001"},"key":"byFeatureNumber","summary":"Link a feature by feature number","id":"paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byFeatureNumber"},"paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byProductKey":{"value":{"productKey":"PC-00000103","featureNumber":"FEAT-00000001"},"key":"byProductKey","summary":"Link a feature using a product key","id":"paths/~1commerce~1products~1{id}~1features~1add/put/requestBody/content/application~1json/examples/byProductKey"},"paths/~1commerce~1products~1{id}~1features~1add/put/responses/200/content/application~1json/examples/response":{"value":{"value":{"id":"7ec58fadb6f84bc18e59c7529058d941","name":"EMS Test Product","productNumber":"PC-00000103","features":[{"id":"8ad088009840d1c2019855e15c993f2f","featureNumber":"FEAT-00000001","name":"sso_access","type":"bool","status":"Active"}]}},"key":"response","summary":"response","id":"paths/~1commerce~1products~1{id}~1features~1add/put/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1products~1{id}~1features~1add/put/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid product or feature id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1products~1{id}~1features~1add/put/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1legacy~1products~1list/post/requestBody/content/application~1json/examples/queryByIdExpandCharges":{"value":{"filters":[{"field":"id","operator":"EQ","value":"7228c9e6fd814e3a9e59bcdf0117e34f"}],"expand":{"product_rate_plans":true,"product_rate_plan_charges":true},"pagination":{"page":1,"pageSize":10}},"key":"queryByIdExpandCharges","summary":"Query product by ID and expand plans and charges","id":"paths/~1commerce~1legacy~1products~1list/post/requestBody/content/application~1json/examples/queryByIdExpandCharges"},"paths/~1commerce~1legacy~1products~1list/post/responses/200/content/application~1json/examples/response":{"value":{"values":[{"id":"ee2d1ce1036c4dd6ae9d6945565ff7a0","name":"New prod","state":"active","effectiveStartDate":"2024-01-01","effectiveEndDate":"2050-12-31","customFields":{"InexedCFTest__c":"Test1","nonidxpicklist__c":"nidx1"},"productRatePlans":[{"id":"c3a52dd029704b7e89274c9e7e8fd99c","name":"Demo Rate Plan","state":"active","activeCurrencies":["USD"],"productRatePlanCharges":[{"id":"ebcd93dc77b34d20912dbfae5881acff","name":"Charge with state 2","type":"Recurring","model":"PerUnit","uom":"Each","billingPeriod":"Month","billingTiming":"IN_ADVANCE","isPrepaid":true,"chargeFunction":"Prepayment","commitmentType":"UNIT","prepaidOperationType":"topup","prepaidQuantity":10,"prepaidTotalQuantity":10,"prepaidUom":"Each","validityPeriodType":"MONTH","validityPeriodAlignment":"TermEnd","validityPeriodProrationOption":"ProrateUnits","specificValidityPeriodLength":6,"drawdownRate":null,"drawdownUom":null,"creditOption":"TimeBased","isRollover":true,"rolloverApply":"ApplyFirst","rolloverPeriodLength":6,"rolloverPeriods":1,"rolloverPeriodType":"Month","rolloverFundPriority":2,"rolloverEndDateType":"ChargeEndDate","fundSupportAccountHierarchy":true,"drawdownPriority":5,"listPriceBase":"Per_Billing_Period","pricing":[{"currency":"USD","price":101,"tiers":[]}],"attributes":[{"name":"State","type":"String","mapping":{"object":"account","field":"state__c"}},{"name":"EffectiveDate","type":"Datetime"}]},{"id":"5b8ec92e6af64e8fa2d8b9756b9fed10","name":"Charge with state 1","type":"Recurring","model":"PerUnit","uom":"Each","billingPeriod":"Month","billingTiming":"IN_ADVANCE","listPriceBase":"Per_Billing_Period","pricing":[{"currency":"USD","price":100,"tiers":[]}]}]}]}]},"key":"response","summary":"response","id":"paths/~1commerce~1legacy~1products~1list/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1legacy~1products~1list/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}],"Success":false},"key":"response","summary":"response","id":"paths/~1commerce~1legacy~1products~1list/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1legacy~1products~1list/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1commerce~1legacy~1products~1list/post/responses/401/content/application~1json/examples/response"},"paths/~1commerce~1tiers/put/requestBody/content/application~1json/example":{"value":{"id":"8fe232784e7946f9aa79cfc8aad30bd9","price":450},"id":"paths/~1commerce~1tiers/put/requestBody/content/application~1json/example"},"paths/~1commerce~1tiers/put/responses/200/content/application~1json/examples/response":{"value":{"createdById":"190758cda21c41138233263a951580b3","createdTime":"2025-10-15T19:07:25.000+00:00","currency":"USD","endingUnit":0,"id":"8fe232784e7946f9aa79cfc8aad30bd9","isOveragePrice":false,"price":450,"priceFormat":"price_format_flat_fee","startingUnit":0,"tier":"1","updatedById":"190758cda21c41138233263a951580b3","updatedTime":"2025-10-15T20:47:58.000+00:00"},"key":"response","summary":"response","id":"paths/~1commerce~1tiers/put/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges":{"value":{"filters":[{"field":"prp_id","operator":"EQ","value":{"string_value":"8a90f5088799c8ed01879cb4b47a3b1a"}}],"expand":{"product_rate_plan_charges":true}},"key":"byPlanIdExpandCharges","summary":"Filter by PRP ID and expand charges","id":"paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byPlanIdExpandCharges"},"paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byProductId":{"value":{"filters":[{"field":"product_id","operator":"EQ","value":{"string_value":"8a90f5088799c8ed01879cb481d83b18"}}]},"key":"byProductId","summary":"Filter by Product ID","id":"paths/~1commerce~1purchase-options~1list/post/requestBody/content/application~1json/examples/byProductId"},"paths/~1commerce~1purchase-options~1list/post/responses/200/content/application~1json/examples/sampleSuccess":{"value":{"error":null,"productRatePlans":[{"description":"","endDate":"2026-04-20","id":"8a90f5088799c8ed01879cb4b47a3b1a","name":"New Rate Plan","product":{"allowFeatureChanges":false,"category":"base","contextFilters":[],"createdTime":"2023-04-19T20:28:08.000-07:00","customFields":{"prd_text_c__c":"a"},"customObjects":null,"description":"","endDate":"2026-04-20","features":[],"id":"8a90f5088799c8ed01879cb481d83b18","legacyFeatures":[],"name":"ztax-product","netsuite":null,"organizationLabels":[],"productNumber":"PC-00000037","productRatePlans":[],"sku":"SKU-00000043","startDate":"2022-04-04","state":"product_active"},"productId":"8a90f5088799c8ed01879cb481d83b18","productRatePlanCharges":[{"accounting":{"accountsReceivableAccount":"Accounts Receivable","accountsReceivableAccountType":"AccountsReceivable"},"attributes":[],"billCycle":{"period":"bill_cycle_period_month","periodAlignment":"align_to_charge","timing":"in_advance","type":"default_from_customer"},"chargeModel":"flat_fee","chargeType":"recurring","createdById":"2c92c8fb7a2d26b6017a2eaa64c72dea","customFieldId":"3687818732","customFields":{"IncludeTowardsMinimumCommitmentAmount__c":null,"ProductType__c":null,"TrueUpChargeLevel__c":null,"TrueUpCharge__c":null,"aaa__c":null},"deliverySchedule":{"frequency":"delivery_frequency_unspecified","friday":false,"monday":false,"saturday":false,"sunday":false,"thursday":false,"tuesday":false,"wednesday":false},"description":"","id":"8a90876c8799b81801879cb516f8400b","name":"New Component","pricing":{"adjustments":{},"discountAmounts":{},"discountPercentages":{},"flatAmounts":{"USD":100},"maxAmounts":{},"metadata":{},"minAmounts":{},"percentages":{},"tiers":[],"unitAmounts":{}},"pricingSummary":["USD100"],"revenue":{"excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"legacyReporting":false,"revenueRecognitionCode":"USD","revenueRecognitionRuleName":"Recognize upon invoicing"},"taxMode":"tax_exclusive","taxable":true,"triggerEvent":"contract_effective","updatedTime":"2023-04-19T20:28:46.000+00:00"}],"productRatePlanNumber":"PRP-00000001","startDate":"2022-04-20","state":"active"}]},"key":"sampleSuccess","summary":"Successful response with one PRP (matches the request above)","id":"paths/~1commerce~1purchase-options~1list/post/responses/200/content/application~1json/examples/sampleSuccess"},"paths/~1commerce~1purchase-options~1list/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}],"success":false},"key":"response","summary":"response","id":"paths/~1commerce~1purchase-options~1list/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1purchase-options~1list/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1commerce~1purchase-options~1list/post/responses/401/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1audit-events/get/responses/200/content/application~1json/examples/response":{"value":{"events":[{"eventId":"8ad088009840d1c2019855e15c993f2f","eventType":"paused","grantId":"EG-00000001","accountId":"2c92c0f86a7e7a40016a7ec3c1f01c1a","featureCode":"api_calls","subscriptionId":"8a8081ae547aac1e01547efb61f20140","occurredAt":"2026-03-15T10:30:00Z","actorKind":"user","actorId":"53c162482f054f3ca08e1ec82dccfec9","beforeState":{"state":"active"},"afterState":{"state":"paused"},"metadata":{"reason":"Customer requested pause"},"updatedOn":"2026-03-15T10:30:00Z","updatedBy":"53c162482f054f3ca08e1ec82dccfec9","updatedByUsername":"admin@example.com"}],"nextPageToken":null},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1audit-events/get/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1authorize/post/requestBody/content/application~1json/example":{"value":{"accountKey":"A00000001","subscriptionKey":"A-S00000001","featureKey":"api_calls","requestedQuantity":25,"effectiveDate":"2026-03-15"},"id":"paths/~1commerce~1entitlements~1authorize/post/requestBody/content/application~1json/example"},"paths/~1commerce~1entitlements~1authorize/post/responses/200/content/application~1json/examples/response":{"value":{"isValid":true,"cacheTtlSeconds":60,"policy":"hard_block","totalBalance":10000,"remainingBalance":8475,"enforcementResult":"allow","currentUsage":1525,"remaining":8475,"percentageUsed":15.25,"overageQuantity":0,"chargeSource":"subscription","entitlements":[{"entitlementKey":"EG-00000001","entitlementNumber":"EG-00000001","accountKey":"A00000001","subscriptionKey":"A-S00000001","featureKey":"api_calls","featureCode":"api_calls","quantity":10000,"startDate":"2026-01-01","state":"active"}]},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1authorize/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1authorize/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid entitlement authorization request"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1authorize/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byTag":{"value":{"accountKey":"A00000001","subscriptionKey":"A-S00000001","featureTag":"premium","requestedQuantity":1,"effectiveDate":"2026-03-15"},"key":"byTag","summary":"Challenge by feature tag","id":"paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byTag"},"paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byFeatureKeys":{"value":{"accountKey":"A00000001","subscriptionKey":"A-S00000001","featureKeys":["8ad088009840d1c2019855e15c993f2f","00c86e3a0595442c88ed9ef8474b10a7"],"requestedQuantity":1,"effectiveDate":"2026-03-15"},"key":"byFeatureKeys","summary":"Challenge specific feature keys","id":"paths/~1commerce~1entitlements~1bulk-challenge/post/requestBody/content/application~1json/examples/byFeatureKeys"},"paths/~1commerce~1entitlements~1bulk-challenge/post/responses/200/content/application~1json/examples/response":{"value":{"results":[{"featureKey":"8ad088009840d1c2019855e15c993f2f","result":{"isValid":true}},{"featureKey":"00c86e3a0595442c88ed9ef8474b10a7","result":{"isValid":true}}]},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1bulk-challenge/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1bulk-challenge/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid bulk entitlement challenge request"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1bulk-challenge/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1bulk-check/post/requestBody/content/application~1json/example":{"value":{"accountKey":"A00000001","subscriptionKey":"A-S00000001","featureKeys":["api_calls","sso_access"],"requestedQuantity":1},"id":"paths/~1commerce~1entitlements~1bulk-check/post/requestBody/content/application~1json/example"},"paths/~1commerce~1entitlements~1bulk-check/post/responses/200/content/application~1json/examples/response":{"value":{"cacheTtlSeconds":60,"results":{"572a2efe711b449e80cbef94419bc050":{"isValid":true,"cacheTtlSeconds":60}}},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1bulk-check/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1bulk-check/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid bulk entitlement check request"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1bulk-check/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/batchCreate":{"value":{"grantEntitlementRequest":[{"accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"38660706ef2f48cfb5222f7dde491895","startDate":"2026-01-01","featureEntitlementPolicy":[{"featureKey":"api_calls","quantity":10000}]},{"accountKey":"A00000002","startDate":"2026-01-01","featureEntitlementPolicy":[{"featureKey":"sso_access"}]}],"skipExisting":true,"continueOnError":true},"key":"batchCreate","summary":"Create grants for multiple accounts","id":"paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/batchCreate"},"paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/idempotentResubmit":{"value":{"grantEntitlementRequest":[{"accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"38660706ef2f48cfb5222f7dde491895","startDate":"2026-01-01","featureEntitlementPolicy":[{"featureKey":"api_calls","quantity":10000}]}],"skipExisting":true,"continueOnError":true},"key":"idempotentResubmit","summary":"Resubmit the same batch with skipExisting","id":"paths/~1commerce~1entitlements~1bulk-grant/post/requestBody/content/application~1json/examples/idempotentResubmit"},"paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/succeeded":{"value":{"requested":1,"succeeded":1,"skipped":0,"failed":0,"entitlementsGranted":1,"results":[{"index":0,"accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"38660706ef2f48cfb5222f7dde491895","status":"bulk_item_succeeded","entitlement":[{"id":"8ad088009840d1c2019855e15c993f2f","entitlementKey":"EG-00000001","entitlementNumber":"EG-00000001","accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"38660706ef2f48cfb5222f7dde491895","featureKey":"api_calls","featureCode":"api_calls","quantity":10000,"startDate":"2026-01-01","state":"active","unit":"API Calls","isDisabled":false}],"skippedEntitlement":[],"error":null}]},"key":"succeeded","summary":"All items succeeded","id":"paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/succeeded"},"paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/partialSuccess":{"value":{"requested":3,"succeeded":1,"skipped":1,"failed":1,"entitlementsGranted":1,"results":[{"index":0,"accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"38660706ef2f48cfb5222f7dde491895","status":"bulk_item_succeeded","entitlement":[{"id":"8ad088009840d1c2019855e15c993f2f","entitlementKey":"EG-00000001","entitlementNumber":"EG-00000001","accountKey":"A00000001","subscriptionKey":"A-S00000001","featureKey":"api_calls","featureCode":"api_calls","quantity":10000,"startDate":"2026-01-01","state":"active"}],"skippedEntitlement":[],"error":null},{"index":1,"accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"38660706ef2f48cfb5222f7dde491895","status":"bulk_item_skipped","entitlement":[],"skippedEntitlement":[{"id":"8ad088009840d1c2019855e15c993f2f","entitlementKey":"EG-00000001","entitlementNumber":"EG-00000001","accountKey":"A00000001","subscriptionKey":"A-S00000001","featureKey":"api_calls","featureCode":"api_calls","quantity":10000,"startDate":"2026-01-01","state":"active"}],"error":null},{"index":2,"accountKey":"A00000003","status":"bulk_item_failed","entitlement":[],"skippedEntitlement":[],"error":{"type":"bad_request","errors":[{"code":"invalid_request","message":"Invalid entitlement grant request","locale":"en-US","localizedMessage":"Invalid entitlement grant request","parameter":"accountKey"}]}}]},"key":"partialSuccess","summary":"Mix of succeeded, skipped, and failed items","id":"paths/~1commerce~1entitlements~1bulk-grant/post/responses/200/content/application~1json/examples/partialSuccess"},"paths/~1commerce~1entitlements~1bulk-grant/post/responses/400/content/application~1json/examples/emptyOrTooLarge":{"value":{"type":"bad_request","errors":[{"code":"invalid_request","message":"grantEntitlementRequest must contain between 1 and 500 items","locale":"en-US","localizedMessage":"grantEntitlementRequest must contain between 1 and 500 items","parameter":"grantEntitlementRequest"}]},"key":"emptyOrTooLarge","summary":"Empty batch or more than 500 items","id":"paths/~1commerce~1entitlements~1bulk-grant/post/responses/400/content/application~1json/examples/emptyOrTooLarge"},"paths/~1commerce~1entitlements~1bulk-revoke/post/requestBody/content/application~1json/example":{"value":{"revokeEntitlementRequest":[{"entitlementKey":"EG-00000001","revokedDate":"2026-06-01"},{"entitlementKey":"EG-00000002","revokedDate":"2026-06-01","orderNumber":"O-00000002"}]},"id":"paths/~1commerce~1entitlements~1bulk-revoke/post/requestBody/content/application~1json/example"},"paths/~1commerce~1entitlements~1bulk-revoke/post/responses/200/content/application~1json/examples/response":{"value":{"revokeEntitlementsResponse":[{"value":{"isRevoked":true,"entitlement":{"id":"8ad088009840d1c2019855e15c993f2f","entitlementKey":"EG-00000001","entitlementNumber":"EG-00000001","accountKey":"A00000001","subscriptionKey":"A-S00000001","featureKey":"api_calls","featureCode":"api_calls","quantity":10000,"startDate":"2026-01-01","revokedDate":"2026-06-01","state":"revoked"}}},{"value":{"isRevoked":true,"entitlement":{"id":"00c86e3a0595442c88ed9ef8474b10a7","entitlementKey":"EG-00000002","entitlementNumber":"EG-00000002","accountKey":"A00000001","subscriptionKey":"A-S00000001","featureKey":"sso_access","featureCode":"sso_access","startDate":"2026-01-01","state":"revoked"}}}]},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1bulk-revoke/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1bulk-revoke/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid bulk revoke request"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1bulk-revoke/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/numberedFeature":{"value":{"accountKey":"A00000001","featureKey":"api_calls","requestedQuantity":100,"subscriptionKey":"A-S00000001","effectiveDate":"2026-03-15"},"key":"numberedFeature","summary":"Check a numbered metered feature","id":"paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/numberedFeature"},"paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/booleanFeature":{"value":{"accountKey":"A00000001","featureKey":"sso_access","subscriptionKey":"A-S00000001","effectiveDate":"2026-03-15"},"key":"booleanFeature","summary":"Check a boolean feature","id":"paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/booleanFeature"},"paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/enumFeature":{"value":{"accountKey":"A00000001","featureKey":"support_tier","subscriptionKey":"A-S00000001","enumValues":["basic","pro"],"effectiveDate":"2026-03-15"},"key":"enumFeature","summary":"Check an enum feature","id":"paths/~1commerce~1entitlements~1challenge/post/requestBody/content/application~1json/examples/enumFeature"},"paths/~1commerce~1entitlements~1challenge/post/responses/200/content/application~1json/examples/response":{"value":{"isValid":true,"cacheTtlSeconds":60,"policy":"hard_block","totalBalance":10000,"remainingBalance":8500,"enforcementResult":"allow","accessDeniedReason":null,"effectiveLimit":10000,"currentUsage":1500,"remaining":8500,"percentageUsed":15,"resetAt":"2026-04-01T00:00:00Z","overageQuantity":0,"chargeSource":"usage_charge","entitlements":[{"id":"8ad088009840d1c2019855e15c993f2f","entitlementKey":"EG-00000001","entitlementNumber":"EG-00000001","accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"PRP-00000001","featureKey":"api_calls","featureCode":"api_calls","quantity":10000,"startDate":"2026-01-01","state":"active"}]},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1challenge/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1challenge/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid entitlement access request"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1challenge/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/numberedGrant":{"value":{"grantEntitlementRequest":[{"accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"PRP-00000001","startDate":"2026-01-01","featureEntitlementPolicy":[{"featureKey":"api_calls","quantity":10000}]}]},"key":"numberedGrant","summary":"Manual numbered feature grant","id":"paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/numberedGrant"},"paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/booleanGrant":{"value":{"grantEntitlementRequest":[{"accountKey":"A00000001","startDate":"2026-01-01","featureEntitlementPolicy":[{"featureKey":"sso_access"}]}]},"key":"booleanGrant","summary":"Manual boolean feature grant","id":"paths/~1commerce~1entitlements~1grant/post/requestBody/content/application~1json/examples/booleanGrant"},"paths/~1commerce~1entitlements~1grant/post/responses/200/content/application~1json/examples/response":{"value":{"entitlement":[{"id":"8ad088009840d1c2019855e15c993f2f","entitlementKey":"EG-00000001","entitlementNumber":"EG-00000001","accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"PRP-00000001","featureKey":"api_calls","featureCode":"api_calls","quantity":10000,"startDate":"2026-01-01","endDate":"2026-12-31","state":"active","unit":"API Calls","isDisabled":false}]},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1grant/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1grant/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid entitlement grant request"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1grant/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1grants/get/responses/200/content/application~1json/examples/response":{"value":{"grants":[{"id":"8ad088009840d1c2019855e15c993f2f","entitlementKey":"EG-00000001","entitlementNumber":"EG-00000001","accountKey":"A00000001","subscriptionKey":"A-S00000001","featureKey":"api_calls","featureCode":"api_calls","quantity":10000,"startDate":"2026-01-01","state":"active"},{"id":"00c86e3a0595442c88ed9ef8474b10a7","entitlementKey":"EG-00000002","entitlementNumber":"EG-00000002","accountKey":"A00000001","subscriptionKey":"A-S00000001","featureKey":"sso_access","featureCode":"sso_access","startDate":"2026-01-01","state":"active"}],"totalCount":2,"nextPageToken":null},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1grants/get/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad088009840d1c2019855e15c993f2f","entitlementKey":"EG-00000001","entitlementNumber":"EG-00000001","accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"PRP-00000001","featureKey":"api_calls","featureCode":"api_calls","quantity":10000,"startDate":"2026-01-01","endDate":"2026-12-31","state":"active","unit":"API Calls","isDisabled":false,"grant":{"id":"8ad088009840d1c2019855e15c993f2f","entitlementKey":"EG-00000001","entitlementNumber":"EG-00000001","accountKey":"A00000001","subscriptionKey":"A-S00000001","planKey":"PRP-00000001","featureKey":"api_calls","featureCode":"api_calls","quantity":10000,"startDate":"2026-01-01","endDate":"2026-12-31","state":"active","unit":"API Calls","isDisabled":false}},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid entitlement key"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1grants~1{entitlementKey}/get/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/increment":{"value":{"action":"increment","delta":100},"key":"increment","summary":"Increase granted quantity","id":"paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/increment"},"paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/decrement":{"value":{"action":"decrement","delta":50},"key":"decrement","summary":"Decrease granted quantity","id":"paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/decrement"},"paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/redate":{"value":{"action":"redate","startDate":"2026-02-01","endDate":"2026-12-31"},"key":"redate","summary":"Update grant dates","id":"paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/requestBody/content/application~1json/examples/redate"},"paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/200/content/application~1json/examples/response":{"value":{"status":"queued","entitlementKey":"EG-00000001","orderIntentId":"8ad088009840d1c2019855e15c993f2f"},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid entitlement key or action"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1{entitlementKey}~1modify/post/responses/400/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/pause":{"value":{"action":"pause","reason":"Customer requested pause"},"key":"pause","summary":"Pause a grant","id":"paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/pause"},"paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/deactivate":{"value":{"action":"deactivate"},"key":"deactivate","summary":"Deactivate a grant","id":"paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/deactivate"},"paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/revoke":{"value":{"action":"revoke","reason":"Subscription cancelled","revokedDate":"2026-06-01","orderNumber":"O-00000002","orderActionNumber":"OA-00000002"},"key":"revoke","summary":"Revoke a grant","id":"paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/requestBody/content/application~1json/examples/revoke"},"paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/200/content/application~1json/examples/response":{"value":{"entitlementKey":"EG-00000001","newState":"paused","action":"pause","isRevoked":false},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/200/content/application~1json/examples/response"},"paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"40010020","message":"Invalid entitlement key or action"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commerce~1entitlements~1{entitlementKey}~1state/post/responses/400/content/application~1json/examples/response"},"paths/~1v1~1accounts/post/responses/200/content/application~1json/examples/response":{"value":{"success":true,"accountId":"8ad087d2909293cb0190964171da0999","accountNumber":"A00000214","billToContactId":"8ad087d2909293cb019096417222099b","soldToContactId":"8ad087d2909293cb01909641723e099e"},"key":"response","summary":"response","id":"paths/~1v1~1accounts/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}/delete/responses/200/content/application~1json/examples/response":{"value":{"id":"40288ae9600808280160081dc9c13f15","jobId":"40288ae9600808280160081db1533506","jobStatus":"Pending","success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response":{"value":{"basicInfo":{"accountNumber":"A00000001","batch":"Batch1","communicationProfileId":"303d186840e611df817c002185d714e1","crmId":"","id":"402892c74c9193cd014c91d35b0a0132","invoiceTemplateId":null,"name":"Test","notes":"","partnerAccount":false,"profileNumber":"CP-00000012","salesRep":"","sequenceSetId":null,"status":"Active","summaryStatementTemplateId":"ff808081298c6e5401298c7a845c007b"},"billToContact":{"address1":"","address2":"","city":"","country":null,"county":null,"fax":"","firstName":"Test","homePhone":"","id":"2c9081a03c6d7b51013c6d7e46c80a17","lastName":"Test","mobilePhone":"","nickname":"","otherPhone":"","otherPhoneType":null,"personalEmail":"","state":"","taxRegion":null,"workEmail":"contact@example.com","workPhone":"","zipCode":""},"billingAndPayment":{"additionalEmailAddresses":["contact1@example.com","contact2@example.com"],"autoPay":true,"billCycleDay":1,"currency":"USD","defaultPaymentMethodId":"2c93808457d787030157e03220ec4fad","invoiceDeliveryPrefsEmail":true,"invoiceDeliveryPrefsPrint":false,"paymentMethodCascadingConsent":false,"paymentGateway":"TestGateway","paymentTerm":"Net 30"},"einvoiceProfile":{"businessCategory":"B2B","businessName":"legal business name","businessNumber":"20002039","businessNumberSchemeId":"88","enabled":true,"endpointId":"8992","endpointSchemeId":"88","taxRegisterNumber":"TAX393999"},"metrics":{"balance":0,"contractedMrr":-900,"creditBalance":0,"totalInvoiceBalance":0},"metricsData":[{"balance":0,"contractedMrr":-900,"currency":"USD","reservedPaymentAmount":900,"totalDebitMemoBalance":0,"totalInvoiceBalance":0,"unappliedCreditMemoAmount":0,"unappliedPaymentAmount":0},{"balance":0,"contractedMrr":-900,"currency":"EUR","reservedPaymentAmount":-900,"totalDebitMemoBalance":0,"totalInvoiceBalance":0,"unappliedCreditMemoAmount":0,"unappliedPaymentAmount":0}],"soldToContact":{"address1":"","address2":"","city":"","country":null,"county":null,"fax":"","firstName":"Test","homePhone":"","id":"2c9081a03c6d7b51013c6d7e46cf0a18","lastName":"Test","mobilePhone":"","nickname":"","otherPhone":"","otherPhoneType":null,"personalEmail":"","state":"","taxRegion":null,"workEmail":"contact@example.com","workPhone":"","zipCode":""},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/200/content/application~1json/examples/response":{"value":{"ach":[{"AA_PICKLIST__c":null,"accountHolderInfo":{"accountHolderName":null,"addressLine1":"DSDFD","addressLine2":"","city":"Example City","country":"United States","email":"test@test.com","phone":"2554444","state":"Example State","zipCode":"123456"},"accountKey":"4028839f7ca29000017ca29c1ce8003f","bankABACode":"110000000","bankAccountName":"Test","bankAccountNumber":"********6789","bankAccountType":"Checking","bankIdentificationNumber":null,"bankName":"Chase","createdBy":"402881e522cf4f9b0122cf5d82860002","createdDate":"2021-10-27 05:32:19","deviceSessionId":null,"existingMandate":null,"id":"4028839f7cc14262017cc1bca9eb0008","ipAddress":null,"isDefault":false,"lastFailedSaleTransactionDate":null,"lastTransaction":"Approved","lastTransactionDateTime":"2021-10-27 05:32:19","lastTransactionStatus":"Approved","mandateInfo":{"existingMandateStatus":null,"mandateCreationDate":null,"mandateId":null,"mandateReason":null,"mandateReceivedStatus":null,"mandateStatus":null,"mandateUpdateDate":null},"maxConsecutivePaymentFailures":null,"numConsecutiveFailures":0,"paymentRetryWindow":null,"status":"Active","totalNumberOfErrorPayments":0,"totalNumberOfProcessedPayments":0,"type":"ACH","updatedBy":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2021-11-10 00:50:12","useDefaultRetryRule":true}],"creditcard":[{"AA_PICKLIST__c":null,"accountHolderInfo":{"accountHolderName":"John Smith","addressLine1":"ABC","addressLine2":"EFT","city":"Example City","country":"United States","email":"example@google.com","phone":"86123456789","state":"Example State","zipCode":"123456"},"accountKey":"4028839f7ca29000017ca29c1ce8003f","bankIdentificationNumber":"411111","cardNumber":"************1111","createdBy":"402881e522cf4f9b0122cf5d82860002","createdDate":"2021-11-15 18:59:08","creditCardType":"Visa","deviceSessionId":null,"existingMandate":null,"expirationMonth":11,"expirationYear":2027,"id":"4028839f7d26a155017d26af16ef0001","identityNumber":"97370192024","ipAddress":null,"isDefault":true,"lastFailedSaleTransactionDate":null,"lastTransaction":"Approved","lastTransactionDateTime":"2021-11-15 18:59:08","lastTransactionStatus":"Approved","mandateInfo":{"mitConsentAgreementRef":null,"mitConsentAgreementSrc":null,"mitProfileAction":null,"mitProfileAgreedOn":null,"mitProfileType":null,"mitTransactionId":null},"maxConsecutivePaymentFailures":null,"numConsecutiveFailures":0,"paymentRetryWindow":null,"status":"Active","totalNumberOfErrorPayments":0,"totalNumberOfProcessedPayments":0,"type":"CreditCard","updatedBy":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2021-11-15 18:59:08","useDefaultRetryRule":true}],"creditcardreferencetransaction":[{"AA_PICKLIST__c":null,"accountHolderInfo":{"accountHolderName":"","addressLine1":"","addressLine2":"","city":"","country":null,"email":"","phone":null,"state":"","zipCode":""},"accountKey":"4028839f7ca29000017ca29c1ce8003f","bankIdentificationNumber":null,"cardNumber":null,"createdBy":"402881e522cf4f9b0122cf5d82860002","createdDate":"2021-11-03 22:35:59","creditCardType":"Visa","deviceSessionId":null,"existingMandate":null,"expirationMonth":11,"expirationYear":2021,"id":"4028839f7ce8c530017ce9725e2c0003","ipAddress":null,"isDefault":false,"lastFailedSaleTransactionDate":null,"lastTransaction":"Approved","lastTransactionDateTime":"2021-11-03 22:35:59","lastTransactionStatus":"Approved","mandateInfo":{"mitConsentAgreementRef":null,"mitConsentAgreementSrc":null,"mitProfileAction":null,"mitProfileAgreedOn":null,"mitProfileType":null,"mitTransactionId":null},"maxConsecutivePaymentFailures":null,"numConsecutiveFailures":0,"paymentRetryWindow":null,"secondTokenId":"FGDSDF","status":"Active","tokenId":"ABCE","totalNumberOfErrorPayments":0,"totalNumberOfProcessedPayments":0,"type":"CreditCardReferenceTransaction","updatedBy":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2021-11-03 22:35:59","useDefaultRetryRule":true}],"debitcard":[{"AA_PICKLIST__c":null,"accountHolderInfo":{"accountHolderName":"John Smith","addressLine1":"1051 E Hillsdale Blvd","addressLine2":"","city":"Tynan","country":"United States","email":"smith@example.com","phone":"","state":"California","zipCode":"45101"},"accountKey":"4028839f7ca29000017ca29c1ce8003f","bankIdentificationNumber":"588888","cardNumber":"************8888","createdBy":"402881e522cf4f9b0122cf5d82860002","createdDate":"2021-11-01 00:01:52","creditCardType":"Electron","deviceSessionId":null,"existingMandate":null,"expirationMonth":11,"expirationYear":2021,"id":"4028839f7cd92a6b017cda4defd00006","ipAddress":null,"isDefault":false,"lastFailedSaleTransactionDate":null,"lastTransaction":"Approved","lastTransactionDateTime":"2021-11-01 00:01:53","lastTransactionStatus":"Approved","mandateInfo":{"mitConsentAgreementRef":null,"mitConsentAgreementSrc":null,"mitProfileAction":null,"mitProfileAgreedOn":null,"mitProfileType":null,"mitTransactionId":null},"maxConsecutivePaymentFailures":null,"numConsecutiveFailures":0,"paymentRetryWindow":null,"status":"Active","totalNumberOfErrorPayments":0,"totalNumberOfProcessedPayments":0,"type":"CreditCard","updatedBy":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2021-11-01 00:01:52","useDefaultRetryRule":true}],"defaultPaymentMethodId":"4028839f7d26a155017d26af16ef0001","paymentGateway":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/200/content/application~1json/examples/response":{"value":{"consent":true,"priorities":[{"paymentMethodId":"2c92c0f95be68649015bf14e001f2760","order":1},{"paymentMethodId":"2c92c0f95be68649015bf14e001f2761","order":2},{"paymentMethodId":"2c92c0f95be68649015bf14e001f2762","order":3}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods~1cascading/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/200/content/application~1json/examples/response":{"value":{"AA_PICKLIST__c":null,"accountHolderInfo":{"accountHolderName":"John Smith","addressLine1":"ABC","addressLine2":"EFT","city":"Example City","country":"United States","email":"example@google.com","phone":"86123456789","state":"Example State","zipCode":"844000"},"accountKey":"4028839f7ca29000017ca29c1ce8003f","bankIdentificationNumber":"411111","cardNumber":"************1111","createdBy":"402881e522cf4f9b0122cf5d82860002","createdDate":"2021-11-15 18:59:08","creditCardType":"Visa","deviceSessionId":null,"existingMandate":null,"expirationMonth":11,"expirationYear":2027,"id":"4028839f7d26a155017d26af16ef0001","identityNumber":"97370192024","ipAddress":null,"isDefault":true,"lastFailedSaleTransactionDate":null,"lastTransaction":"Approved","lastTransactionDateTime":"2021-11-15 18:59:08","lastTransactionStatus":"Approved","mandateInfo":{"mitConsentAgreementRef":null,"mitConsentAgreementSrc":null,"mitProfileAction":null,"mitProfileAgreedOn":null,"mitProfileType":null,"mitTransactionId":null},"maxConsecutivePaymentFailures":null,"numConsecutiveFailures":0,"paymentRetryWindow":null,"status":"Active","success":true,"totalNumberOfErrorPayments":0,"totalNumberOfProcessedPayments":0,"type":"CreditCard","updatedBy":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2021-11-15 18:59:08","useDefaultRetryRule":true},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1payment-methods~1default/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1summary/get/responses/200/content/application~1json/examples/response":{"value":{"basicInfo":{"accountNumber":"A00001115","additionalEmailAddresses":["contact1@example.com","contact2@example.com"],"autoPay":true,"balance":0,"billCycleDay":1,"currency":"USD","defaultPaymentMethod":{"creditCardExpirationMonth":10,"creditCardExpirationYear":2020,"creditCardNumber":"************1111","creditCardType":"Visa","id":"2c92c8f83dabf9cf013daef12dd303b0","paymentMethodType":"CreditCard"},"id":"2c92a0f9391832b10139183e277a0042","invoiceDeliveryPrefsEmail":true,"invoiceDeliveryPrefsPrint":false,"lastInvoiceDate":"2013-02-11","lastPaymentAmount":150248.1,"lastPaymentDate":"2013-03-27","name":"subscribeCallYan_1","partnerAccount":false,"paymentMethodCascadingConsent":false,"status":"Active"},"billToContact":{"address1":"1400 Bridge Pkwy","address2":"","city":"San Jose","country":"United States","county":"","fax":"","firstName":"Cheng","id":"2c92a0f9391832b10139183e27940043","lastName":"Zou","state":"California","taxRegion":"","workEmail":"contact@example.com","workPhone":"5555551212","zipCode":"95135"},"invoices":[{"amount":139722.1,"balance":0,"dueDate":"2013-02-11","id":"2c92a0953a3fa95d013a407c10a60100","invoiceDate":"2013-02-11","invoiceNumber":"INV00000323","status":"Posted"},{"amount":10521,"balance":0,"dueDate":"2012-08-11","id":"2c92a09739190dc60139194bcf1b0098","invoiceDate":"2012-08-11","invoiceNumber":"INV00000160","status":"Posted"},{"amount":10,"balance":0,"dueDate":"2012-08-11","id":"2c92a09539190dbe0139190f42780012","invoiceDate":"2012-08-11","invoiceNumber":"INV00000159","status":"Posted"}],"payments":[{"effectiveDate":"2013-03-27","id":"2c92c8f83dabf9cf013daf3bfa0305a6","paidInvoices":[{"appliedPaymentAmount":5,"invoiceId":"2c92a09539190dbe0139190f42780012","invoiceNumber":"INV00000159"},{"appliedPaymentAmount":139722.1,"invoiceId":"2c92a0953a3fa95d013a407c10a60100","invoiceNumber":"INV00000323"},{"appliedPaymentAmount":10521,"invoiceId":"2c92a09739190dc60139194bcf1b0098","invoiceNumber":"INV00000160"}],"paymentNumber":"P-00000075","paymentType":"Electronic","status":"Processed"},{"effectiveDate":"2012-08-11","id":"2c92a0f9391832b101391922ad5f049d","paidInvoices":[{"appliedPaymentAmount":5,"invoiceId":"2c92a09539190dbe0139190f42780012","invoiceNumber":"INV00000159"}],"paymentNumber":"P-00000056","paymentType":"Electronic","status":"Processed"}],"soldToContact":{"address1":"278 Bridgeton Circle","address2":"","city":"San Jose","country":"United States","county":"","fax":"","firstName":"Bill","id":"2c92a0f9391832b10139183e27940043","lastName":"Cho","state":"California","taxRegion":"","workEmail":"contact@example.com","workPhone":"5555551212","zipCode":"95135"},"subscriptions":[{"autoRenew":true,"id":"2c92c8f83dc4f752013dc72c24ee016d","initialTerm":12,"ratePlans":[{"productName":"Recurring Charge","ratePlanName":"QSF_Tier"}],"renewalTerm":3,"status":"Active","subscriptionNumber":"A-S00001081","subscriptionStartDate":"2013-02-01","termEndDate":"2014-02-01","termStartDate":"2013-02-01","termType":"TERMED"},{"autoRenew":true,"id":"2c92c8f83dc4f752013dc72bb85c0127","initialTerm":12,"ratePlans":[{"productName":"Recurring Charge","ratePlanName":"QSF_Tier"}],"renewalTerm":3,"status":"Active","subscriptionNumber":"A-S00001080","subscriptionStartDate":"2013-02-01","termEndDate":"2014-02-01","termStartDate":"2013-02-01","termType":"TERMED"},{"autoRenew":false,"id":"2c92c8f83dc4f752013dc723fdab00d4","initialTerm":10,"ratePlans":[{"productName":"Recurring Charge","ratePlanName":"QSF_Tier"}],"renewalTerm":4,"status":"Cancelled","subscriptionNumber":"A-S00001079","subscriptionStartDate":"2013-02-01","termEndDate":"2014-04-01","termStartDate":"2013-12-01","termType":"TERMED"},{"autoRenew":false,"id":"2c92c8f83db0b4b4013db4717ad000ec","initialTerm":12,"ratePlans":[{"productName":"Recurring Charge","ratePlanName":"Month_PerUnit"},{"productName":"Recurring Charge","ratePlanName":"Month_PerUnit"}],"renewalTerm":3,"status":"Active","subscriptionNumber":"A-S00001076","subscriptionStartDate":"2011-02-11","termEndDate":"2012-02-11","termStartDate":"2011-02-11","termType":"TERMED"},{"autoRenew":false,"id":"2c92c8f83db0b4b4013db3ab6a4d00bc","initialTerm":12,"ratePlans":[{"productName":"Recurring Charge","ratePlanName":"Month_PerUnit"},{"productName":"Recurring Charge","ratePlanName":"Month_PerUnit"}],"renewalTerm":3,"status":"Active","subscriptionNumber":"A-S00001075","subscriptionStartDate":"2011-02-11","termEndDate":"2012-02-11","termStartDate":"2011-02-11","termType":"TERMED"},{"autoRenew":false,"id":"2c92c8f83db0b4b4013db3aa9fbd0090","initialTerm":12,"ratePlans":[{"productName":"Recurring Charge","ratePlanName":"Month_PerUnit"}],"renewalTerm":3,"status":"Active","subscriptionNumber":"A-S00001074","subscriptionStartDate":"2011-02-11","termEndDate":"2012-02-11","termStartDate":"2011-02-11","termType":"TERMED"}],"success":true,"usage":[{"quantity":10,"startDate":"2012-02","unitOfMeasure":"UOM"},{"quantity":10,"startDate":"2012-01","unitOfMeasure":"UOM"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1summary/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1summary/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1summary/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{account-key}~1summary/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{account-key}~1summary/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1contacts/post/responses/200/content/application~1json/examples/response":{"value":{"accountId":"6e767220676e6e61206776652075207570","accountNumber":"A00000001","address1":"314, Bongora","address2":"near Tech City","city":"GHY","contactDescription":"This is a description for the contact","country":"India","county":null,"fax":"6174","firstName":"Kuhi","homePhone":"1234123","id":"6b65657020726f6c6c696e672021","lastName":"Das","mobilePhone":"123213","nickname":"Dorimi","otherPhone":"2314213","otherPhoneType":"Work","personalEmail":"kuhiroll@example.com","state":"Assam","success":true,"taxRegion":"California","workEmail":"amy.lawrence@zuora.com","workPhone":"(888) 976-9056","zipCode":"123456"},"key":"response","summary":"response","id":"paths/~1v1~1contacts/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1contacts/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1contacts/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1contacts/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1contacts/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"72756e2061726e642026206465736572742075","accountNumber":"A00000001","address1":"567, Rose Apartment","address2":"Gate no. 2","city":"Seattle","contactDescription":"This is a description","country":"United States","county":"King County","fax":"123456","firstName":"peter","homePhone":"86123456789","id":"402881a2889f2e4301889f30e64e0019","lastName":"parker","mobilePhone":"1234567890","nickname":"peet","otherPhone":"11111111111111111","otherPhoneType":"Work","personalEmail":"peet@example.com","state":"Washington","success":true,"taxRegion":"CA","workEmail":"work.mail@example.com","workPhone":"3432","zipCode":"123134"},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"6e767220676e6e61206d616b65207520637279","accountNumber":"A00000001","address1":"new Address","address2":"near Tech City","city":"Mumbai","contactDescription":"This is the new Description","country":"India","county":null,"fax":"6174","firstName":"Kuhi","homePhone":"1234123","id":"8a90f50888a3036e0188ab7b3ffe7b8a","lastName":"Das","mobilePhone":"123213","nickname":"Dorimi","otherPhone":"2314213","otherPhoneType":"Work","personalEmail":"kuhiroll@example.com","state":"Assam","success":true,"taxRegion":"California","workEmail":"amy.lawrence@zuora.com","workPhone":"(888)976-9056","zipCode":"123134"},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/200/content/application~1json/example"},"paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}~1transfer/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1contacts~1{contactId}~1scrub/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/200/content/application~1json/examples/response":{"value":{"address1":"4th street Custom colony","address2":"Thoraipakkam","city":"Chennai","contactId":"4028c7628741ebe3018745f2c4123514","country":"India","county":null,"description":null,"fax":43212,"firstName":"Pat","homePhone":9877,"id":"4028c7628741ebe3018745f2c4133515","lastName":"Parker","mobilePhone":"1234567890","nickname":"this is a nick name","otherPhone":"9876543210","otherPhoneType":"Work","personalEmail":"test123@gmail.com","postalCode":123456,"state":"TN","success":true,"taxRegion":"California","workEmail":"amy.lawrence@zuora.com","workPhone":"(888)976-9056"},"key":"response","summary":"response","id":"paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1contact-snapshots~1{contact-snapshot-id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1sign-up/post/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028818284f5f8130184f5fe1e9011e8","accountNumber":"A00000001","invoiceId":"4028818284f5f8130184f5fe23b8120c","invoiceNumber":"INV00000001","orderNumber":"O-00000001","paidAmount":300,"paymentId":"4028818284f5f8130184f5fe24b71218","paymentNumber":"P-00000001","status":"Completed","subscriptionId":"4028818284f5f8130184f5fe214611f3","subscriptionNumber":"A-S00000001","success":true},"key":"response","summary":"response","id":"paths/~1v1~1sign-up/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1sign-up/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1sign-up/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1sign-up/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1sign-up/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1preview/post/responses/200/content/application~1json/examples/response":{"value":{"success":true,"previewResult":{"invoices":[{"amount":14.99,"amountWithoutTax":14.99,"taxAmount":0,"targetDate":"2024-07-31","invoiceItems":[{"serviceStartDate":"2024-07-01","serviceEndDate":"2024-07-31","amountWithoutTax":14.99,"taxAmount":0,"chargeDescription":"","chargeName":"Monthly Fee","chargeNumber":null,"processingType":"Charge","productName":"Music Service","productRatePlanChargeId":"8ad097b4909708e001909b41bb085d38","unitPrice":14.99,"subscriptionNumber":null,"orderLineItemNumber":null,"additionalInfo":{"quantity":1,"unitOfMeasure":"","numberOfDeliveries":0}}]}]}},"key":"response","summary":"response","id":"paths/~1v1~1orders~1preview/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1preview/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1preview/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1preview/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1preview/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1async~1orders~1preview/post/responses/202/content/application~1json/examples/response":{"value":{"jobId":"2c90a02d676688200167770ce20601b6"},"key":"response","summary":"response","id":"paths/~1v1~1async~1orders~1preview/post/responses/202/content/application~1json/examples/response"},"paths/~1v1~1orders/get/responses/200/content/application~1json/examples/response":{"value":{"orders":[{"createdBy":"2c989028622282520162235ab0f603ba","createdDate":"2018-03-14 15:12:58","currency":"USD","customFields":{"order_cf_date__c":"2017-01-01"},"description":"This is a description for the Order.","existingAccountNumber":"accountA_Num","orderDate":"2017-03-01","orderLineItems":[{"UOM":null,"accountingCode":null,"amount":10000,"amountPerUnit":5000,"amountWithoutTax":10000,"billTargetDate":null,"billTo":"2c9081a03c6d7b51013c6d7e2dfc09fa","billToSnapshotId":"4028fc8487c0a43c0187c12a91500060","customFields":{"orderLineItemCF__c":"olinumber-023"},"description":"With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use.","id":"4028fc827a0e48c1017a0e4dccc60002","invoiceGroupNumber":"N-0001","invoiceOwnerAccountId":"ff80808187ff38570187ff433cbd38ef","invoiceOwnerAccountName":"AC_AC_16836148090011683614809001","invoiceOwnerAccountNumber":"AN_1683614809001","itemName":"webcam","itemNumber":"1","itemState":"Executing","itemType":"Product","listPrice":118,"listPricePerUnit":59,"orderId":"4028fc827a0e48c1017a0e58b9330014","ownerAccountId":"ff80808187ff38570187ff433f974203","ownerAccountName":"AC_AC_16836148099861683614809986","ownerAccountNumber":"AN_1683614809986","productCode":"C9201","productRatePlanChargeId":null,"purchaseOrderNumber":"960-000764","quantity":2,"soldTo":"4028fc828244a0ac018244dfc9a90bee","soldToSnapshotId":"4028fc828244a0ac018244dfc9b00bf0","transactionEndDate":"2021-02-01","transactionStartDate":"2021-02-01"}],"orderNumber":"O-00000002","status":"Completed","subscriptions":[{"baseVersion":1,"customFields":{"sub_cf_picklist__c":null},"newVersion":2,"orderActions":[{"customFields":{"oa_cf_text__c":null},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2017-03-01"},{"name":"ServiceActivation","triggerDate":"2017-03-01"},{"name":"CustomerAcceptance","triggerDate":"2017-03-01"}],"type":"UpdateProduct","updateProduct":{"chargeUpdates":[{"billing":{"billingPeriodAlignment":null},"chargeNumber":"C-00000001","customFields":{"srpc_cf_picklist__c":null},"description":null,"effectiveDate":{"specificTriggerDate":null},"newRatePlanChargeId":"2c989028622282520162235adabc0651","pricing":{"recurringVolume":{"priceChangeOption":null,"priceIncreasePercentage":null,"quantity":7,"tiers":[]}},"uniqueToken":null}],"customFields":{},"newRatePlanId":"2c989028622282520162235ada870649","ratePlanId":"2c989028622282520162235acd1b05d2","specificUpdateDate":null,"uniqueToken":null}}],"subscriptionNumber":"A-S00000001"}],"updatedBy":"2c989028622282520162235ab0f603ba","updatedDate":"2018-03-14 15:12:58"},{"createdBy":"2c989028622282520162235ab0f603ba","createdDate":"2018-03-14 15:12:55","currency":"USD","existingAccountNumber":"accountA_Num","orderDate":"2017-01-01","orderNumber":"O-00000001","status":"Completed","subscriptions":[{"baseVersion":null,"customFields":{"sub_cf_picklist__c":"sub123"},"newVersion":1,"orderActions":[{"createSubscription":{"invoiceSeparately":null,"invoiceGroupNumber":"N-0001","notes":null,"subscribeToRatePlans":[{"chargeOverrides":[{"billing":{"billCycleDay":1,"billCycleType":null,"billingPeriod":null,"billingPeriodAlignment":null,"billingTiming":null,"specificBillingPeriod":null,"weeklyBillCycleDay":null},"chargeNumber":"C-00000001","customFields":{"srpc_cf_picklist__c":null},"description":null,"endDate":{"endDateCondition":null,"specificEndDate":null,"upToPeriods":null,"upToPeriodsType":null},"pricing":{"recurringVolume":{"listPriceBase":"Per_Billing_Period","priceChangeOption":null,"priceIncreasePercentage":null,"quantity":12,"tiers":[]}},"productRateplanChargeId":"2c989028622282520162235aca7a05b9","startDate":{"specificTriggerDate":null},"uniqueToken":null}],"customFields":{},"newRatePlanId":"2c989028622282520162235acd1b05d2","productRatePlanId":"2c989028622282520162235ac91605b3","uniqueToken":null}],"subscriptionOwnerAccountNumber":"accountA_Num","terms":{"autoRenew":false,"initialTerm":{"period":12,"periodType":"Month","startDate":"2017-01-01","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":[{"period":0,"periodType":"Month"}]}},"customFields":{"order_cf_date__c":"2017-01-01"},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2017-01-01"},{"name":"ServiceActivation","triggerDate":"2017-01-01"},{"name":"CustomerAcceptance","triggerDate":"2017-01-01"}],"type":"CreateSubscription"}],"subscriptionNumber":"A-S00000001"}],"success":true,"updatedBy":"2c989028622282520162235ab0f603ba","updatedDate":"2018-03-14 15:12:55"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders/post/responses/200/content/application~1json/examples/response":{"value":{"success":true,"orderNumber":"O-00000354","accountNumber":"A00000097","status":"Completed","subscriptions":[{"subscriptionNumber":"A-S00000129","subscriptionOwnerId":"2c92c0f87270a5970172747e289a5e66","subscriptionOwnerNumber":"A00000001","status":"Active"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1async~1orders/post/responses/200/content/application~1json/examples/response":{"value":{"jobId":"1bc24f315d7b48d3a20245bfe73bdceb","success":true},"key":"response","summary":"response","id":"paths/~1v1~1async~1orders/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}/get/responses/200/content/application~1json/examples/response":{"value":{"order":{"createdBy":"402881e522cf4f9b0122cf5d82860002","createdDate":"2018-12-13 17:21:43","currency":"USD","customFields":{},"description":"This is a description for the Order.","existingAccountNumber":"A00000101","existingAccountDetails":{"basicInfo":{"accountNumber":"A00000001","batch":"Batch1","communicationProfileId":"303d186840e611df817c002185d714e1","crmId":"","id":"402892c74c9193cd014c91d35b0a0132","invoiceTemplateId":null,"name":"Test","notes":"","partnerAccount":false,"profileNumber":"CP-00000012","salesRep":"","sequenceSetId":null,"status":"Active","summaryStatementTemplateId":null,"purchaseOrderNumber":""},"billToContact":{"address1":"","address2":"","city":"","country":null,"county":null,"fax":"","firstName":"Test","homePhone":"","id":"2c9081a03c6d7b51013c6d7e46c80a17","lastName":"Test","mobilePhone":"","nickname":"","otherPhone":"","otherPhoneType":null,"personalEmail":"","state":"","taxRegion":null,"workEmail":"contact@example.com","workPhone":"","zipCode":""}},"invoiceScheduleId":"ec6f0d5dc8af451ab95343fb3c588c1a","orderDate":"2018-10-01","orderLineItems":[{"UOM":"Unit","accountingCode":"Revenue","amount":10000,"amountPerUnit":5000,"amountWithoutTax":10000,"billTargetDate":"2025-12-01","billTo":"2c9081a03c6d7b51013c6d7e2dfc09fa","billToSnapshotId":"4028fc8487c0a43c0187c12a91500060","customFields":{"orderLineItemCF__c":"olinumber-023"},"description":"With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use.","id":"4028fc827a0e48c1017a0e4dccc60002","invoiceGroupNumber":"N-0001","invoiceOwnerAccountId":"ff80808187ff38570187ff433cbd38ef","invoiceOwnerAccountName":"AC_AC_16836148090011683614809001","invoiceOwnerAccountNumber":"AN_1683614809001","itemName":"webcam","itemNumber":"1","itemState":"Executing","itemType":"Product","listPrice":118,"listPricePerUnit":59,"orderId":"4028fc827a0e48c1017a0e58b9330014","ownerAccountId":"ff80808187ff38570187ff433f974203","ownerAccountName":"AC_AC_16836148099861683614809986","ownerAccountNumber":"AN_1683614809986","productCode":"C9201","productRatePlanChargeId":null,"purchaseOrderNumber":"960-000764","quantity":2,"soldTo":"4028fc828244a0ac018244dfc9a90bee","soldToSnapshotId":"4028fc828244a0ac018244dfc9b00bf0","transactionEndDate":"2021-02-01","transactionStartDate":"2021-02-01"}],"orderNumber":"O-00000282","status":"Completed","subscriptions":[{"baseVersion":1,"customFields":{},"externallyManagedBy":null,"newVersion":2,"orderActions":[{"customFields":{},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2018-12-01"},{"name":"ServiceActivation","triggerDate":"2018-12-01"},{"name":"CustomerAcceptance","triggerDate":"2018-12-01"}],"type":"UpdateProduct","updateProduct":{"chargeUpdates":[{"billing":{"billingPeriodAlignment":"AlignToCharge"},"chargeNumber":"C-00000210","customFields":{},"description":"New description","effectiveDate":{"specificTriggerDate":"2025-12-01"},"newRatePlanChargeId":"2c98919c67a5ae9d0167a6df304b0372","pricing":{"recurringPerUnit":{"listPrice":20,"priceChangeOption":"NoChange","priceIncreasePercentage":0,"quantity":12}},"uniqueToken":"TestUniqueToken1234"}],"customFields":{},"newRatePlanId":"2c98919c67a5ae9d0167a6df3011036e","ratePlanId":"2c98919c67a5ae9d0167a68f8eb20262","specificUpdateDate":"2025-11-07","uniqueToken":"TestUniqueToken1234"}}],"subscriptionNumber":"A-S00000100","subscriptionOwnerAccountNumber":"A00000001","subscriptionOwnerAccountDetails":{"accountNumber":"A00000001","batch":"Batch1","communicationProfileId":"303d186840e611df817c002185d714e1","crmId":"","id":"402892c74c9193cd014c91d35b0a0132","invoiceTemplateId":null,"name":"Test","notes":"","partnerAccount":false,"profileNumber":"CP-00000012","salesRep":"","sequenceSetId":null,"status":"Active","summaryStatementTemplateId":null,"purchaseOrderNumber":"","billToContact":{"address1":"","address2":"","city":"","country":null,"county":null,"fax":"","firstName":"Test","homePhone":"","id":"2c9081a03c6d7b51013c6d7e46c80a17","lastName":"Test","mobilePhone":"","nickname":"","otherPhone":"","otherPhoneType":null,"personalEmail":"","state":"","taxRegion":null,"workEmail":"contact@example.com","workPhone":"","zipCode":""}}},{"baseVersion":2,"customFields":{},"externallyManagedBy":"Google","newVersion":3,"orderActions":[{"customFields":{},"resume":{"extendsTerm":true,"resumeDate":"2018-12-23","resumePeriods":10,"resumePeriodsType":"Day","resumePolicy":"FixedPeriodsFromSuspendDate","resumeSpecificDate":null},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2018-12-12"},{"name":"ServiceActivation","triggerDate":"2018-12-12"},{"name":"CustomerAcceptance","triggerDate":"2018-12-12"}],"type":"Resume"},{"customFields":{},"sequence":1,"termsAndConditions":{"autoRenew":true,"invoiceGroupNumber":"N-0001","clearingExistingInvoiceGroupNumber":false,"initialTerm":{"period":375,"periodType":"Day","startDate":"2025-12-01","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":[{"period":3,"periodType":"Month"}]},"triggerDates":[{"name":"ContractEffective","triggerDate":"2018-12-12"},{"name":"ServiceActivation","triggerDate":"2018-12-12"},{"name":"CustomerAcceptance","triggerDate":"2018-12-12"}],"type":"TermsAndConditions"}],"subscriptionNumber":"A-S00000102","subscriptionOwnerAccountNumber":"A00000001"}],"updatedBy":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2018-12-13 17:21:45"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}/put/responses/200/content/application~1json/examples/response":{"value":{"success":true,"orderNumber":"O-00000758","accountNumber":"A00000097","status":"Draft"},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/200/content/application~1json/example":{"value":{"jobId":"2c90a02d676688200167770ce20601b6","success":true},"id":"paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/200/content/application~1json/example"},"paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/example":{"value":{"processId":"30591668A6FFCE5C","reasons":[{"code":"51001122","message":"'billToContact' may not be null"},{"code":"51000030","message":"If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary"}],"success":false},"id":"paths/~1v1~1async~1orders~1{orderNumber}/delete/responses/4XX/content/application~1json/example"},"paths/~1v1~1async-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response":{"value":{"errors":null,"result":{"jobType":"AsyncCreateOrder","accountNumber":"A00000001","invoiceNumbers":["INV00000001"],"orderLineItems":[{"id":"bd78c0522adf42c2aa0fccacc997fa20","itemNumber":"116"}],"orderNumber":"OM-00002","paidAmount":"300","paymentNumber":"P-00000002","status":"Pending","subscriptions":[{"status":"Pending Activation","subscriptionNumber":"SM-00001"},{"status":"Pending Acceptance","subscriptionNumber":"SM-00002"},{"status":"Active","subscriptionNumber":"SM-00003"},{"status":"Pending Acceptance","subscriptionNumber":"SM-00004"}],"success":true},"status":"Completed","success":true},"key":"response","summary":"response","id":"paths/~1v1~1async-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1async-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1async-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1async-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1async-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response":{"value":{"orders":[{"createdBy":"2c989028622282520162235ab0f603ba","createdDate":"2018-03-14 15:12:58","currency":"USD","customFields":{"order_cf_date__c":"2017-01-01"},"description":"This is a description for the Order.","existingAccountNumber":"accountA_Num","invoiceScheduleId":"ec6f0d5dc8af451ab95343fb3c588c1a","orderDate":"2017-03-01","orderNumber":"O-00000002","status":"Completed","subscriptions":[{"baseVersion":1,"customFields":{"sub_cf_picklist__c":null},"newVersion":2,"orderActions":[{"customFields":{"oa_cf_text__c":null},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2017-03-01"},{"name":"ServiceActivation","triggerDate":"2017-03-01"},{"name":"CustomerAcceptance","triggerDate":"2017-03-01"}],"type":"UpdateProduct","updateProduct":{"chargeUpdates":[{"billing":{"billingPeriodAlignment":null},"chargeNumber":"C-00000001","customFields":{"srpc_cf_picklist__c":null},"description":null,"effectiveDate":{"specificTriggerDate":null},"newRatePlanChargeId":"2c989028622282520162235adabc0651","pricing":{"recurringVolume":{"priceChangeOption":null,"priceIncreasePercentage":null,"quantity":7,"tiers":[]}},"uniqueToken":null}],"customFields":{},"newRatePlanId":"2c989028622282520162235ada870649","ratePlanId":"2c989028622282520162235acd1b05d2","specificUpdateDate":null,"uniqueToken":null}}],"subscriptionNumber":"A-S00000001"}],"updatedBy":"2c989028622282520162235ab0f603ba","updatedDate":"2018-03-14 15:12:58"},{"createdBy":"2c989028622282520162235ab0f603ba","createdDate":"2018-03-14 15:12:55","currency":"USD","customFields":{"order_cf_date__c":"2017-01-01"},"existingAccountNumber":"accountA_Num","orderDate":"2017-01-01","orderNumber":"O-00000001","status":"Completed","subscriptions":[{"baseVersion":null,"customFields":{"sub_cf_picklist__c":"sub123"},"newVersion":1,"orderActions":[{"createSubscription":{"invoiceSeparately":null,"notes":null,"subscribeToRatePlans":[{"chargeOverrides":[{"billing":{"billCycleDay":1,"billCycleType":null,"billingPeriod":null,"billingPeriodAlignment":null,"billingTiming":null,"specificBillingPeriod":null,"weeklyBillCycleDay":null},"chargeNumber":"C-00000001","customFields":{"srpc_cf_picklist__c":null},"description":null,"endDate":{"endDateCondition":null,"specificEndDate":null,"upToPeriods":null,"upToPeriodsType":null},"pricing":{"recurringVolume":{"listPriceBase":"Per_Billing_Period","priceChangeOption":null,"priceIncreasePercentage":null,"quantity":12,"tiers":[]}},"productRateplanChargeId":"2c989028622282520162235aca7a05b9","startDate":{"specificTriggerDate":null},"uniqueToken":null}],"customFields":{},"newRatePlanId":"2c989028622282520162235acd1b05d2","productRatePlanId":"2c989028622282520162235ac91605b3","uniqueToken":null}],"subscriptionOwnerAccountNumber":"accountA_Num","terms":{"autoRenew":false,"initialTerm":{"period":12,"periodType":"Month","startDate":"2017-01-01","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":[{"period":0,"periodType":"Month"}]}},"customFields":{"oa_cf_text__c":"oa cf test"},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2017-01-01"},{"name":"ServiceActivation","triggerDate":"2017-01-01"},{"name":"CustomerAcceptance","triggerDate":"2017-01-01"}],"type":"CreateSubscription"}],"subscriptionNumber":"A-S00000001"}],"updatedBy":"2c989028622282520162235ab0f603ba","updatedDate":"2018-03-14 15:12:55"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1subscriptionOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/200/content/application~1json/examples/response":{"value":{"orders":[{"createdBy":"2c989028622282520162235ab0f603ba","createdDate":"2018-03-14 15:12:58","currency":"USD","customFields":{"order_cf_date__c":"2017-01-01"},"description":"This is a description for the Order.","existingAccountNumber":"accountA_Num","invoiceScheduleId":"ec6f0d5dc8af451ab95343fb3c588c1a","orderDate":"2017-03-01","orderNumber":"O-00000002","status":"Completed","subscriptions":[{"baseVersion":1,"customFields":{"sub_cf_picklist__c":null},"newVersion":2,"orderActions":[{"customFields":{"oa_cf_text__c":null},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2017-03-01"},{"name":"ServiceActivation","triggerDate":"2017-03-01"},{"name":"CustomerAcceptance","triggerDate":"2017-03-01"}],"type":"UpdateProduct","updateProduct":{"chargeUpdates":[{"billing":{"billingPeriodAlignment":null},"chargeNumber":"C-00000001","customFields":{"srpc_cf_picklist__c":null},"description":null,"effectiveDate":{"specificTriggerDate":null},"newRatePlanChargeId":"2c989028622282520162235adabc0651","pricing":{"recurringVolume":{"priceChangeOption":null,"priceIncreasePercentage":null,"quantity":7,"tiers":[]}},"uniqueToken":null}],"customFields":{},"newRatePlanId":"2c989028622282520162235ada870649","ratePlanId":"2c989028622282520162235acd1b05d2","specificUpdateDate":null,"uniqueToken":null}}],"subscriptionNumber":"A-S00000001"}],"updatedBy":"2c989028622282520162235ab0f603ba","updatedDate":"2018-03-14 15:12:58"},{"createdBy":"2c989028622282520162235ab0f603ba","createdDate":"2018-03-14 15:12:55","currency":"USD","customFields":{"order_cf_date__c":"2017-01-01"},"existingAccountNumber":"accountA_Num","orderDate":"2017-01-01","orderNumber":"O-00000001","status":"Completed","subscriptions":[{"baseVersion":null,"customFields":{"sub_cf_picklist__c":"sub123"},"newVersion":1,"orderActions":[{"createSubscription":{"invoiceSeparately":null,"notes":null,"subscribeToRatePlans":[{"chargeOverrides":[{"billing":{"billCycleDay":1,"billCycleType":null,"billingPeriod":null,"billingPeriodAlignment":null,"billingTiming":null,"specificBillingPeriod":null,"weeklyBillCycleDay":null},"chargeNumber":"C-00000001","customFields":{"srpc_cf_picklist__c":null},"description":null,"endDate":{"endDateCondition":null,"specificEndDate":null,"upToPeriods":null,"upToPeriodsType":null},"pricing":{"recurringVolume":{"listPriceBase":"Per_Billing_Period","priceChangeOption":null,"priceIncreasePercentage":null,"quantity":12,"tiers":[]}},"productRateplanChargeId":"2c989028622282520162235aca7a05b9","startDate":{"specificTriggerDate":null},"uniqueToken":null}],"customFields":{},"newRatePlanId":"2c989028622282520162235acd1b05d2","productRatePlanId":"2c989028622282520162235ac91605b3","uniqueToken":null}],"subscriptionOwnerAccountNumber":"accountA_Num","terms":{"autoRenew":false,"initialTerm":{"period":12,"periodType":"Month","startDate":"2017-01-01","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":[{"period":0,"periodType":"Month"}]}},"customFields":{"oa_cf_text__c":"oa cf test"},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2017-01-01"},{"name":"ServiceActivation","triggerDate":"2017-01-01"},{"name":"CustomerAcceptance","triggerDate":"2017-01-01"}],"type":"CreateSubscription"}],"subscriptionNumber":"A-S00000001"}],"updatedBy":"2c989028622282520162235ab0f603ba","updatedDate":"2018-03-14 15:12:55"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1subscription~1{subscriptionNumber}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response":{"value":{"orders":[{"createdBy":"2c989028622282520162235ab0f603ba","createdDate":"2018-03-14 15:12:58","currency":"USD","customFields":{"order_cf_date__c":"2017-01-01"},"description":"This is a description for the Order.","existingAccountNumber":"accountA_Num","invoiceScheduleId":"ec6f0d5dc8af451ab95343fb3c588c1a","orderDate":"2017-03-01","orderNumber":"O-00000002","status":"Completed","subscriptions":[{"baseVersion":1,"customFields":{"sub_cf_picklist__c":null},"newVersion":2,"orderActions":[{"customFields":{"oa_cf_text__c":null},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2017-03-01"},{"name":"ServiceActivation","triggerDate":"2017-03-01"},{"name":"CustomerAcceptance","triggerDate":"2017-03-01"}],"type":"UpdateProduct","updateProduct":{"chargeUpdates":[{"billing":{"billingPeriodAlignment":null},"chargeNumber":"C-00000001","customFields":{"srpc_cf_picklist__c":null},"description":null,"effectiveDate":{"specificTriggerDate":null},"newRatePlanChargeId":"2c989028622282520162235adabc0651","pricing":{"recurringVolume":{"priceChangeOption":null,"priceIncreasePercentage":null,"quantity":7,"tiers":[]}},"uniqueToken":null}],"customFields":{},"newRatePlanId":"2c989028622282520162235ada870649","ratePlanId":"2c989028622282520162235acd1b05d2","specificUpdateDate":null,"uniqueToken":null}}],"subscriptionNumber":"A-S00000001"}],"updatedBy":"2c989028622282520162235ab0f603ba","updatedDate":"2018-03-14 15:12:58"},{"createdBy":"2c989028622282520162235ab0f603ba","createdDate":"2018-03-14 15:12:55","currency":"USD","customFields":{"order_cf_date__c":"2017-01-01"},"existingAccountNumber":"accountA_Num","orderDate":"2017-01-01","orderNumber":"O-00000001","status":"Completed","subscriptions":[{"baseVersion":null,"customFields":{"sub_cf_picklist__c":"sub123"},"newVersion":1,"orderActions":[{"createSubscription":{"invoiceSeparately":null,"notes":null,"subscribeToRatePlans":[{"chargeOverrides":[{"billing":{"billCycleDay":1,"billCycleType":null,"billingPeriod":null,"billingPeriodAlignment":null,"billingTiming":null,"specificBillingPeriod":null,"weeklyBillCycleDay":null},"chargeNumber":"C-00000001","customFields":{"srpc_cf_picklist__c":null},"description":null,"endDate":{"endDateCondition":null,"specificEndDate":null,"upToPeriods":null,"upToPeriodsType":null},"pricing":{"recurringVolume":{"listPriceBase":"Per_Billing_Period","priceChangeOption":null,"priceIncreasePercentage":null,"quantity":12,"tiers":[]}},"productRateplanChargeId":"2c989028622282520162235aca7a05b9","startDate":{"specificTriggerDate":null},"uniqueToken":null}],"customFields":{},"newRatePlanId":"2c989028622282520162235acd1b05d2","productRatePlanId":"2c989028622282520162235ac91605b3","uniqueToken":null}],"subscriptionOwnerAccountNumber":"accountA_Num","terms":{"autoRenew":false,"initialTerm":{"period":12,"periodType":"Month","startDate":"2017-01-01","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":[{"period":0,"periodType":"Month"}]}},"customFields":{"oa_cf_text__c":"oa cf test"},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2017-01-01"},{"name":"ServiceActivation","triggerDate":"2017-01-01"},{"name":"CustomerAcceptance","triggerDate":"2017-01-01"}],"type":"CreateSubscription"}],"subscriptionNumber":"A-S00000001"}],"updatedBy":"2c989028622282520162235ab0f603ba","updatedDate":"2018-03-14 15:12:55"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1invoiceOwner~1{accountNumber}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionNumber}~1customFields/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/200/content/application~1json/examples/response":{"value":{"success":true,"orderNumber":"O-00000408","status":"Completed","accountNumber":"A00000097","subscriptions":[{"subscriptionNumber":"A-S00000143","status":"Active"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1triggerDates/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/200/content/application~1json/examples/response":{"value":{"accountNumber":"A00000001","invoiceNumbers":["INV00000001"],"orderLineItems":[{"id":"bd78c0522adf42c2aa0fccacc997fa20","itemNumber":"116"}],"orderNumber":"OM-00002","paidAmount":300,"paymentNumber":"P-00000002","status":"Pending","subscriptions":[{"status":"Pending Activation","subscriptionNumber":"SM-00001"},{"status":"Pending Acceptance","subscriptionNumber":"SM-00002"},{"status":"Active","subscriptionNumber":"SM-00003"},{"status":"Pending Acceptance","subscriptionNumber":"SM-00004"},{"status":"Suspended","subscriptionNumber":"SM-00005"},{"status":"Active","subscriptionNumber":"SM-00006"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1activate/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"CancelReason":"Customer cancelled the order.","accountNumber":"A00000001","orderNumber":"OM-00002","status":"Cancelled","success":true},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/200/content/application~1json/example":{"value":{"success":true,"commitmentNumber":"CMT-00000001","accountsActivated":2,"accountsUnchanged":5,"activatedAccountNumbers":["A00000123","A00000456"]},"id":"paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/200/content/application~1json/example"},"paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/4xx/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1commitments~1{commitmentNumber}~1associations~1rescan/post/responses/4xx/content/application~1json/examples/response"},"paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/200/content/application~1json/example":{"value":{"generationStatus":"COMPLETED","orderDeltaMetrics":{"orderDeltaMrr":[{"chargeNumber":"C-00000204","currency":"USD","endDate":"2025-10-01","grossAmount":50,"netAmount":40,"orderActionId":"8a90e5f9982f3f8a01983127d1e00fa9","orderActionSequence":0,"orderActionType":"CreateSubscription","productRatePlanChargeId":"8a90e5f9982f3f8a0198312674be0e21","ratePlanChargeId":"8a90e5f9982f3f8a01983127d2100fb3","startDate":"2025-07-01","subscriptionNumber":"A-S00000289"}],"orderDeltaQty":[{"chargeNumber":"C-00000204","endDate":"2025-10-01","orderActionId":"8a90e5f9982f3f8a01983127d1e00fa9","orderActionSequence":0,"orderActionType":"CreateSubscription","productRatePlanChargeId":"8a90e5f9982f3f8a0198312674be0e21","quantity":10,"ratePlanChargeId":"8a90e5f9982f3f8a01983127d2100fb3","startDate":"2025-07-01","subscriptionNumber":"A-S00000289"}],"orderDeltaTcb":[{"chargeNumber":"C-00000204","currency":"USD","endDate":"2025-10-01","grossAmount":150,"netAmount":120,"orderActionId":"8a90e5f9982f3f8a01983127d1e00fa9","orderActionSequence":0,"orderActionType":"CreateSubscription","productRatePlanChargeId":"8a90e5f9982f3f8a0198312674be0e21","ratePlanChargeId":"8a90e5f9982f3f8a01983127d2100fb3","startDate":"2025-07-01","subscriptionNumber":"A-S00000289"}],"orderDeltaTcv":[{"chargeNumber":"C-00000204","currency":"USD","endDate":"2025-10-01","grossAmount":150,"netAmount":120,"orderActionId":"8a90e5f9982f3f8a01983127d1e00fa9","orderActionSequence":0,"orderActionType":"CreateSubscription","productRatePlanChargeId":"8a90e5f9982f3f8a0198312674be0e21","ratePlanChargeId":"8a90e5f9982f3f8a01983127d2100fb3","startDate":"2025-07-01","subscriptionNumber":"A-S00000289"}]},"success":true},"id":"paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/200/content/application~1json/example"},"paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/4XX/content/application~1json/example":{"value":{"processId":"processId","reasons":[{"code":"58730020","message":"Invalid orderNumber: O-00000001"}],"success":false},"id":"paths/~1v1~1orders~1deltaMetrics~1{orderNumber}/get/responses/4XX/content/application~1json/example"},"paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/200/content/application~1json/examples/response":{"value":{"orders":[{"createdBy":"2c989028622282520162235ab0f603ba","createdDate":"2018-03-14 15:12:55","currency":"USD","existingAccountNumber":"accountA_Num","invoiceScheduleId":"ec6f0d5dc8af451ab95343fb3c588c1a","orderDate":"2017-01-01","orderNumber":"O-00000001","status":"Pending","subscriptions":[{"baseVersion":null,"customFields":{"sub_cf_picklist__c":"sub123"},"newVersion":1,"orderActions":[{"createSubscription":{"subscribeToRatePlans":[{"chargeOverrides":[{"chargeNumber":"C-00000001","pricing":{"recurringVolume":{"listPriceBase":"Per_Billing_Period","quantity":12,"tiers":[]}},"productRateplanChargeId":"2c989028622282520162235aca7a05b9"}],"customFields":{},"newRatePlanId":"2c989028622282520162235acd1b05d2","productRatePlanId":"2c989028622282520162235ac91605b3"}],"subscriptionOwnerAccountNumber":"accountA_Num","terms":{"autoRenew":false,"initialTerm":{"period":12,"periodType":"Month","startDate":"2017-01-01","termType":"TERMED"},"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerms":[{"period":0,"periodType":"Month"}]}},"customFields":{"order_cf_date__c":"2017-01-01"},"sequence":0,"triggerDates":[{"name":"ContractEffective","triggerDate":"2017-01-01"},{"name":"ServiceActivation","triggerDate":"2017-01-01"}],"type":"CreateSubscription"}],"subscriptionNumber":"A-S00000001"}],"success":true,"updatedBy":"2c989028622282520162235ab0f603ba","updatedDate":"2018-03-14 15:12:55"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1subscription~1{subscription-key}~1pending/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orderActions~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1orderActions~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orderActions~1{id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orderActions~1{id}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orderActions~1{id}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orderActions~1{id}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1order-line-items~1{itemId}/get/responses/200/content/application~1json/examples/response":{"value":{"orderLineItem":{"UOM":null,"accountingCode":null,"amount":10000,"amountPerUnit":5000,"amountWithoutTax":10000,"billTargetDate":null,"billTo":"2c9081a03c6d7b51013c6d7e2dfc09fa","billToSnapshotId":"4028fc8487c0a43c0187c12a91500060","customFields":{"externalNumber5__c":"olinumber-023"},"description":"With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use.","id":"4028fc827a0e48c1017a0e4dccc60002","invoiceGroupNumber":"N-0001","invoiceOwnerAccountId":"ff80808187ff38570187ff433cbd38ef","invoiceOwnerAccountName":"AC_AC_16836148090011683614809001","invoiceOwnerAccountNumber":"AN_1683614809001","itemName":"webcam","itemNumber":"1","itemState":"Executing","itemType":"Product","listPrice":118,"listPricePerUnit":59,"orderId":"4028fc827a0e48c1017a0e58b9330014","ownerAccountId":"ff80808187ff38570187ff433f974203","ownerAccountName":"AC_AC_16836148099861683614809986","ownerAccountNumber":"AN_1683614809986","productCode":"C9201","productRatePlanChargeId":null,"purchaseOrderNumber":"960-000764","quantity":2,"relatedSubscriptionNumber":"Warranty-00002","soldTo":"4028fc828244a0ac018244dfc9a90bee","soldToSnapshotId":"4028fc828244a0ac018244dfc9b00bf0","transactionDate":"2021-02-01"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1order-line-items~1{itemId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1order-line-items~1{itemId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1order-line-items~1{itemId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1order-line-items~1{itemId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1order-line-items~1{itemId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1order-line-items~1{itemId}/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1order-line-items~1{itemId}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1order-line-items~1{itemId}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1order-line-items~1{itemId}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1order-line-items~1{itemId}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1order-line-items~1{itemId}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1order-line-items~1bulk/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1order-line-items~1bulk/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1order-line-items~1bulk/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1order-line-items~1bulk/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1fulfillments/post/responses/200/content/application~1json/examples/response":{"value":{"creditMemoNumbers":null,"fulfillments":[{"fulfillmentNumber":"F-00000001","id":"4028828c82819b740182821bb3b415c6"},{"fulfillmentNumber":"F-00000002","id":"4028828c82819b740182821bb3bc15c7"}],"invoiceNumbers":["INV00000001"],"paidAmount":100,"paymentNumber":"P-00000001","success":true},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1fulfillments/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1fulfillments/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1fulfillments~1{key}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments~1{key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1fulfillments~1{key}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments~1{key}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1fulfillments~1{key}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments~1{key}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1fulfillments~1{key}/get/responses/200/content/application~1json/examples/response":{"value":{"fulfillment":{"billTargetDate":"2022-01-01","carrier":"carrier","customFields":{"priority__c":"Hight"},"description":"description","externalId":"9dc1a064-b5d1-4d7b-bd0b-ca26a1be8e01","fulfillmentDate":"2022-01-01","fulfillmentItems":[{"customFields":{"category__c":"Old"},"description":"description","fulfillmentId":"4028828c82819b74018281a69d3f0d93","id":"4028828c82819b74018281a69d680d98","itemIdentifier":"87309cf0-10c7-4130-8da2-439c96daa1ff"}],"fulfillmentLocation":"location","fulfillmentNumber":"F-00000001","fulfillmentSystem":"fulfillment system","fulfillmentType":"Delivery","id":"4028828c82819b74018281a69d3f0d93","orderLineItemId":"4028828c82819b74018281a69adf0d4e","quantity":1,"state":"SentToBilling","trackingNumber":"T-00091912"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments~1{key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1fulfillments~1{key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments~1{key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1fulfillments~1{key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments~1{key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1fulfillments~1{key}/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments~1{key}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1fulfillments~1{key}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments~1{key}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1fulfillments~1{key}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1fulfillments~1{key}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items/post/responses/200/content/application~1json/examples/response":{"value":{"fulfillmentItems":[{"id":"4028828c82819b74018282544fea17c6"},{"id":"4028828c82819b7401828254507a17c7"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items~1{id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items~1{id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items~1{id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items~1{id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items~1{id}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items~1{id}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"fulfillmentItem":{"customFields":{"PICKLIST_CF__c":"option_2"},"description":"item description","fulfillmentId":"4028828c82819b74018282572f6719b4","id":"4028828c82819b7401828257303a19b6","itemIdentifier":"5da7a054-24c6-4f29-866b-2c570d844fd0"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items~1{id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items~1{id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items~1{id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items~1{id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items~1{id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items~1{id}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1fulfillment-items~1{id}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1fulfillment-items~1{id}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1ramps~1{rampNumber}/get/responses/200/content/application~1json/examples/response":{"value":{"ramp":{"charges":[{"chargeNumber":"C-00000202"}],"description":"","id":"40289f7b7321f5ce0173229d798300cf","intervals":[{"description":"","endDate":"2020-12-31","name":"Year 1","startDate":"2020-01-01"},{"description":"","endDate":"2021-12-31","name":"Year 2","startDate":"2021-01-01"}],"name":"Two Years Ramp","number":"R-00000268","subscriptionNumber":"A-S00000287"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1ramps~1{rampNumber}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1ramps~1{rampNumber}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1ramps~1{rampNumber}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1ramps~1{rampNumber}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1ramps~1{rampNumber}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response":{"value":{"rampMetrics":{"description":"","discountTcb":0,"discountTcv":0,"grossTcb":240,"grossTcv":240,"intervals":[{"description":"","discountTcb":0,"discountTcv":0,"endDate":"2020-12-31","grossTcb":120,"grossTcv":120,"intervalMetrics":[{"chargeNumber":"C-00000202","discountTcb":0,"discountTcv":0,"endDate":"2020-12-31","grossTcb":120,"grossTcv":120,"mrr":[{"discount":0,"endDate":"2020-12-31","gross":10,"net":10,"startDate":"2020-01-01"}],"netTcb":120,"netTcv":120,"productRatePlanChargeId":"40289f7b7115832f0171158e6dd906cd","quantity":1,"ratePlanChargeId":"40289f7b7321f5ce0173229d792c00c8","startDate":"2020-01-01","subscriptionNumber":"A-S00000287"}],"name":"Year 1","netTcb":120,"netTcv":120,"startDate":"2020-01-01"},{"description":"","discountTcb":0,"discountTcv":0,"endDate":"2021-12-31","grossTcb":120,"grossTcv":120,"intervalMetrics":[{"chargeNumber":"C-00000202","discountTcb":0,"discountTcv":0,"endDate":"2021-12-31","grossTcb":120,"grossTcv":120,"mrr":[{"discount":0,"endDate":"2021-12-31","gross":10,"net":10,"startDate":"2021-01-01"}],"netTcb":120,"netTcv":120,"productRatePlanChargeId":"40289f7b7115832f0171158e6dd906cd","quantity":1,"ratePlanChargeId":"40289f7b7321f5ce0173229d792c00c8","startDate":"2021-01-01","subscriptionNumber":"A-S00000287"}],"name":"Year 2","netTcb":120,"netTcv":120,"startDate":"2021-01-01"}],"name":"Two Years Ramp","netTcb":240,"netTcv":240,"number":"R-00000268"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1ramps~1{rampNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/200/content/application~1json/examples/response":{"value":{"ramps":[{"charges":[{"chargeNumber":"C-00000202"}],"description":"","id":"40289f7b7321f5ce0173229d798300cf","intervals":[{"description":"","endDate":"2020-12-31","name":"Year 1","startDate":"2020-01-01"},{"description":"","endDate":"2021-12-31","name":"Year 2","startDate":"2021-01-01"}],"name":"Two Years Ramp","number":"R-00000268","subscriptionNumber":"A-S00000287"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramps/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/200/content/application~1json/examples/response":{"value":{"rampMetrics":{"description":"","discountTcb":0,"discountTcv":0,"grossTcb":240,"grossTcv":240,"intervals":[{"description":"","discountTcb":0,"discountTcv":0,"endDate":"2020-12-31","grossTcb":120,"grossTcv":120,"intervalMetrics":[{"chargeNumber":"C-00000202","discountTcb":0,"discountTcv":0,"endDate":"2020-12-31","grossTcb":120,"grossTcv":120,"mrr":[{"discount":0,"endDate":"2020-12-31","gross":10,"net":10,"startDate":"2020-01-01"}],"netTcb":120,"netTcv":120,"productRatePlanChargeId":"40289f7b7115832f0171158e6dd906cd","quantity":1,"ratePlanChargeId":"40289f7b7321f5ce0173229d792c00c8","startDate":"2020-01-01","subscriptionNumber":"A-S00000287"}],"name":"Year 1","netTcb":120,"netTcv":120,"startDate":"2020-01-01"},{"description":"","discountTcb":0,"discountTcv":0,"endDate":"2021-12-31","grossTcb":120,"grossTcv":120,"intervalMetrics":[{"chargeNumber":"C-00000202","discountTcb":0,"discountTcv":0,"endDate":"2021-12-31","grossTcb":120,"grossTcv":120,"mrr":[{"discount":0,"endDate":"2021-12-31","gross":10,"net":10,"startDate":"2021-01-01"}],"netTcb":120,"netTcv":120,"productRatePlanChargeId":"40289f7b7115832f0171158e6dd906cd","quantity":1,"ratePlanChargeId":"40289f7b7321f5ce0173229d792c00c8","startDate":"2021-01-01","subscriptionNumber":"A-S00000287"}],"name":"Year 2","netTcb":120,"netTcv":120,"startDate":"2021-01-01"}],"name":"Two Years Ramp","netTcb":240,"netTcv":240,"number":"R-00000268"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionKey}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response":{"value":{"rampMetrics":[{"description":"","discountTcb":0,"discountTcv":0,"grossTcb":240,"grossTcv":240,"intervals":[{"description":"","discountTcb":0,"discountTcv":0,"endDate":"2020-12-31","grossTcb":120,"grossTcv":120,"intervalDeltaMetrics":[{"chargeNumber":"C-00000204","deltaDiscountTcb":0,"deltaDiscountTcv":0,"deltaGrossTcb":120,"deltaGrossTcv":120,"deltaMrr":[{"discount":0,"endDate":"2020-12-31","gross":10,"net":10,"startDate":"2020-01-01"}],"deltaNetTcb":120,"deltaNetTcv":120,"deltaQuantity":[{"amount":1,"endDate":"2020-12-31","startDate":"2020-01-01"}],"productRatePlanChargeId":"40289f7b7115832f0171158e6dd906cd","subscriptionNumber":"A-S00000289"}],"intervalMetrics":[{"chargeNumber":"C-00000204","discountTcb":0,"discountTcv":0,"endDate":"2020-12-31","grossTcb":120,"grossTcv":120,"mrr":[{"discount":0,"endDate":"2020-12-31","gross":10,"net":10,"startDate":"2020-01-01"}],"netTcb":120,"netTcv":120,"productRatePlanChargeId":"40289f7b7115832f0171158e6dd906cd","quantity":1,"ratePlanChargeId":"40289f7b7322a15901732392a904000a","startDate":"2020-01-01","subscriptionNumber":"A-S00000289"}],"name":"Year 1","netTcb":120,"netTcv":120,"startDate":"2020-01-01"},{"description":"","discountTcb":0,"discountTcv":0,"endDate":"2021-12-31","grossTcb":120,"grossTcv":120,"intervalDeltaMetrics":[{"chargeNumber":"C-00000204","deltaDiscountTcb":0,"deltaDiscountTcv":0,"deltaGrossTcb":120,"deltaGrossTcv":120,"deltaMrr":[{"discount":0,"endDate":"2021-12-31","gross":10,"net":10,"startDate":"2021-01-01"}],"deltaNetTcb":120,"deltaNetTcv":120,"deltaQuantity":[{"amount":1,"endDate":"2021-12-31","startDate":"2021-01-01"}],"productRatePlanChargeId":"40289f7b7115832f0171158e6dd906cd","subscriptionNumber":"A-S00000289"}],"intervalMetrics":[{"chargeNumber":"C-00000204","discountTcb":0,"discountTcv":0,"endDate":"2021-12-31","grossTcb":120,"grossTcv":120,"mrr":[{"discount":0,"endDate":"2021-12-31","gross":10,"net":10,"startDate":"2021-01-01"}],"netTcb":120,"netTcv":120,"productRatePlanChargeId":"40289f7b7115832f0171158e6dd906cd","quantity":1,"ratePlanChargeId":"40289f7b7322a15901732392a904000a","startDate":"2021-01-01","subscriptionNumber":"A-S00000289"}],"name":"Year 2","netTcb":120,"netTcv":120,"startDate":"2021-01-01"}],"name":"Two Years Ramp","netTcb":240,"netTcv":240,"number":"R-00000270"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1orders~1{orderNumber}~1ramp-metrics/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1preview/post/responses/200/content/application~1json/examples/response":{"value":{"success":true,"contractedMrr":14.99,"totalContractedValue":179.88,"amount":14.99,"amountWithoutTax":14.99,"taxAmount":0,"invoiceTargetDate":"2024-07-11","documentDate":"2024-07-11","invoiceItems":[{"serviceStartDate":"2024-07-01","serviceEndDate":"2024-07-31","chargeAmount":14.99,"taxAmount":0,"chargeDescription":"","chargeName":"Monthly Fee","productName":"Music Service","productRatePlanChargeId":"8ad097b4909708e001909b41bb085d38","quantity":1,"unitOfMeasure":""}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1preview/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1preview/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1preview/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1preview/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1preview/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/200/content/application~1json/example":{"value":{"invoices":[{"invoiceNumber":"Preview Invoice","amount":10,"amountWithoutTax":10,"taxAmount":0,"targetDate":"2024-02-01","status":null,"isFromExistingInvoice":false,"invoiceItems":[{"serviceStartDate":"2024-01-01","serviceEndDate":"2024-01-31","amountWithoutTax":10,"taxAmount":0,"chargeDescription":"Recurring Flat Fee Pricing","chargeName":"Recurring_Flat Fee Pricing1628472350306","chargeNumber":"C-0000001","productName":"P_1628472348863","productRatePlanChargeId":"402881547b216168017b2884182f12e7","processingType":"Charge","unitPrice":10,"quantity":1,"unitOfMeasure":null}]}],"creditMemos":[{"creditMemoNumber":"Preview Credit Memo","amount":10,"amountWithoutTax":10,"taxAmount":0,"targetDate":"2024-02-01","status":null,"isFromExistingCreditMemo":false,"creditMemoItems":[{"serviceStartDate":"2024-01-01","serviceEndDate":"2024-01-31","amountWithoutTax":10,"taxAmount":0,"chargeDescription":"Recurring Flat Fee Pricing","chargeName":"Recurring_Flat Fee Pricing1628472350306","chargeNumber":"C-0000001","productName":"P_1628472348863","productRatePlanChargeId":"402881547b216168017b2884182f12e7","processingType":"Charge","unitPrice":10,"quantity":1,"unitOfMeasure":null}]}],"success":true},"id":"paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/200/content/application~1json/example"},"paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1preview/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions/post/responses/200/content/application~1json/examples/response":{"value":{"success":true,"subscriptionId":"8ad087d290a5e7330190b98577936eaf","subscriptionNumber":"A-S00000141","contractedMrr":14.99,"totalContractedValue":179.88},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response":{"value":{"subscriptions":[{"accountId":"8a8082c45aa81b51015ad64396090f5c","accountName":"ABCD","accountNumber":"A00002641","autoRenew":true,"billToContact":{"address1":"","address2":"","city":"","country":null,"county":null,"fax":"","firstName":"Test","homePhone":"","id":"2c9081a03c6d7b51013c6d7e46c80a17","lastName":"Test","mobilePhone":"","nickname":"","otherPhone":"","otherPhoneType":null,"personalEmail":"","state":"","taxRegion":null,"workEmail":"contact@example.com","workPhone":"","zipCode":""},"contractEffectiveDate":"2017-01-01","contractedMrr":8.33,"contractedNetMrr":8.33,"asOfDayGrossMrr":8.33,"asOfDayNetMrr":8.33,"netTotalContractedValue":8.33,"currency":"USD","currentTerm":12,"currentTermPeriodType":"Month","customerAcceptanceDate":"2017-01-01","id":"8a8082c45aa81b51015ad68743ec0fdb","initialTerm":12,"initialTermPeriodType":"Month","invoiceGroupNumber":"N-0001","invoiceOwnerAccountId":"8a8082c45aa81b51015ad64396090f5c","invoiceOwnerAccountName":"ABCD","invoiceOwnerAccountNumber":"A00002641","invoiceScheduleId":"ec6f0d5dc8af451ab95343fb3c588c1a","invoiceSeparately":false,"invoiceTemplateId":"2c9081a03c638994013c63978baf002b","invoiceTemplateName":"InvoiceTemplateName","notes":"","paymentTerm":"Net 30","ratePlans":[{"id":"8a8082c45aa81b51015ad68744030fe3","productId":"8a8082c45aa81b51015ad5a2d07d0e89","productName":"ABC","productRatePlanId":"8a8082c45aa81b51015ad5a473fb0e8d","productSku":"SKU-00000987","contractedNetMrr":8.33,"contractedMrr":8.33,"asOfDayGrossMrr":8.33,"asOfDayNetMrr":8.33,"netTotalContractedValue":8.33,"ratePlanCharges":[{"applyDiscountTo":null,"billingDay":"DefaultFromCustomer","billingPeriod":"Annual","billingPeriodAlignment":"AlignToCharge","billingTiming":"IN_ADVANCE","chargedThroughDate":null,"currency":"USD","description":"","discountAmount":null,"discountApplyDetails":null,"discountClass":null,"discountLevel":null,"discountPercentage":null,"dmrc":8.333333,"done":false,"dtcv":100,"effectiveEndDate":"2018-01-01","effectiveStartDate":"2017-01-01","endDateCondition":"Subscription_End","id":"8a8082c45aa81b51015ad68744160fe4","includedUnits":null,"invoiceScheduleId":"8a8082c45aa81b51015ad68744240ff5","listPriceBase":"Per_Billing_Period","model":"FlatFee","mrr":8.333333,"name":"Annual Charge","number":"C-00032238","numberOfPeriods":null,"originalChargeId":"8a8082c45aa81b51015ad68744160fe4","overageCalculationOption":null,"overagePrice":null,"overageUnusedUnitsCreditOption":null,"price":100,"priceChangeOption":"NoChange","priceIncreasePercentage":null,"pricingSummary":"USD100","processedThroughDate":null,"productRatePlanChargeId":"8a8082c45aa81b51015ad5a655c00e8f","quantity":1,"segment":1,"smoothingModel":null,"specificBillingPeriod":null,"specificEndDate":null,"tcv":100,"tiers":null,"triggerDate":null,"triggerEvent":"ContractEffective","type":"Recurring","unusedUnitsCreditRates":null,"uom":null,"upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"version":1},{"applyDiscountTo":"ONETIMERECURRINGUSAGE","billingDay":"DefaultFromCustomer","billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","billingTiming":null,"chargedThroughDate":null,"currency":"USD","description":"","discountAmount":10,"discountApplyDetails":[{"appliedProductName":"ABC","appliedProductRatePlanChargeId":"8a8082c45aa81b51015ad5a655c00e8f","appliedProductRatePlanChargeName":"Annual Charge","appliedProductRatePlanId":"8a8082c45aa81b51015ad5a473fb0e8d","appliedProductRatePlanName":"RatePlan 1"},{"appliedProductName":"ABC","appliedProductRatePlanChargeId":"8a8082c45aa81b51015ad5a655c00e8f","appliedProductRatePlanChargeName":"Annual Charge","appliedProductRatePlanId":"8a8082c45aa81b51015ad5a473fb0e8d","appliedProductRatePlanName":"RatePlan 1"}],"discountClass":"VIP Discount","discountLevel":"subscription","discountPercentage":null,"dmrc":0,"done":false,"dtcv":0,"effectiveEndDate":"2018-01-01","effectiveStartDate":"2017-01-01","endDateCondition":"Subscription_End","id":"8a8082c45aa81b51015ad68744240fe5","includedUnits":null,"invoiceScheduleId":"8a8082c45aa81b51015ad68744240ff5","listPriceBase":null,"model":"DiscountFixedAmount","mrr":0,"name":"Discount-Fixed 10","number":"C-00032239","numberOfPeriods":null,"originalChargeId":"8a8082c45aa81b51015ad68744240fe5","overageCalculationOption":null,"overagePrice":null,"overageUnusedUnitsCreditOption":null,"price":null,"priceChangeOption":null,"priceIncreasePercentage":null,"pricingSummary":"USD10 fixed amount discount","processedThroughDate":null,"productRatePlanChargeId":"8a8082c45aa81b51015ad683bc590fd8","quantity":null,"segment":1,"smoothingModel":null,"specificBillingPeriod":null,"specificEndDate":null,"tcv":0,"tiers":null,"triggerDate":null,"triggerEvent":"ContractEffective","type":"Recurring","unusedUnitsCreditRates":null,"uom":null,"upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"version":1},{"amendedByOrderOn":null,"applyDiscountTo":null,"billingDay":"DefaultFromCustomer","billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","billingTiming":"IN_ADVANCE","chargeModelConfiguration":null,"chargedThroughDate":null,"currency":"USD","description":"","discountAmount":null,"discountApplyDetails":null,"discountClass":null,"discountLevel":null,"discountPercentage":null,"dmrc":38.571428571,"done":false,"dtcv":468,"effectiveEndDate":"2026-01-01","effectiveStartDate":"2024-12-31","endDateCondition":"Subscription_End","id":"4028818386ba85070186bab54f99573d","includedUnits":null,"inputArgumentId":null,"invoiceScheduleId":"8a8082c45aa81b51015ad68744240ff5","listPriceBase":"Per_Billing_Period","model":"Delivery","mrr":38.571428571,"name":"Delivery Charge","number":"C-00032240","numberOfDeliveries":52,"numberOfPeriods":null,"originalChargeId":"4028818386ba85070186bab54f065731","originalOrderDate":"2023-01-01","overageCalculationOption":null,"overagePrice":null,"overageUnusedUnitsCreditOption":null,"price":9,"priceChangeOption":null,"priceIncreasePercentage":null,"pricingSummary":"","processedThroughDate":null,"productRatePlanChargeId":"4028818386b61be50186b6293eb30017","quantity":1,"ratingGroup":null,"segment":3,"smoothingModel":null,"specificBillingPeriod":null,"specificEndDate":null,"subscriptionChargeDeliverySchedule":{"dayOfMonth":null,"frequency":"Weekly","friday":false,"monday":false,"monthOfYear":null,"saturday":false,"sunday":true,"thursday":false,"tuesday":false,"wednesday":false},"subscriptionChargeIntervalPricing":[{"duration":365,"price":5,"sequence":1,"subscriptionChargeIntervalPriceTiers":[],"type":"Day"},{"duration":365,"price":7,"sequence":2,"subscriptionChargeIntervalPriceTiers":[],"type":"Day"},{"duration":null,"price":9,"sequence":3,"subscriptionChargeIntervalPriceTiers":[],"type":"Infinity"}],"tcv":468,"tiers":null,"triggerDate":null,"triggerEvent":"ContractEffective","type":"Recurring","unusedUnitsCreditRates":null,"uom":null,"upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"version":1}],"ratePlanName":"RatePlan 1"}],"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerm":12,"renewalTermPeriodType":"Month","revision":"1.0","sequenceSetId":"6abcc30846de11e990900242ac1f0003","sequenceSetName":"DEFAULT","serviceActivationDate":"2017-01-01","soldToContact":{"address1":"","address2":"","city":"","country":null,"county":null,"fax":"","firstName":"Test","homePhone":"","id":"2c9081a03c6d7b51013c6d7e46c80a17","lastName":"Test","mobilePhone":"","nickname":"","otherPhone":"","otherPhoneType":null,"personalEmail":"","state":"","taxRegion":null,"workEmail":"contact@example.com","workPhone":"","zipCode":""},"status":"Active","subscriptionNumber":"A-S00007412","subscriptionStartDate":"2017-01-01","termEndDate":"2018-01-01","termStartDate":"2017-01-01","termType":"TERMED","totalNumberOfChargeSegments":10,"totalContractedValue":100,"version":1}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1accounts~1{account-key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"8a8082c45aa81b51015ad64396090f5c","accountName":"ABCD","accountNumber":"A00002641","accountOwnerDetails":{"accountNumber":"A00000001","batch":"Batch1","communicationProfileId":"303d186840e611df817c002185d714e1","crmId":"","id":"402892c74c9193cd014c91d35b0a0132","invoiceTemplateId":null,"name":"Test","notes":"","partnerAccount":false,"profileNumber":"CP-00000012","salesRep":"","sequenceSetId":null,"status":"Active","summaryStatementTemplateId":null,"purchaseOrderNumber":""},"invoiceOwnerAccountDetails":{"accountNumber":"A00000001","batch":"Batch1","communicationProfileId":"303d186840e611df817c002185d714e1","crmId":"","defaultPaymentMethodId":"301892c74c9193cd014c91d35b0a0132","id":"402892c74c9193cd014c91d35b0a0132","invoiceTemplateId":null,"name":"Test","notes":"","partnerAccount":false,"profileNumber":"CP-00000012","salesRep":"","sequenceSetId":null,"status":"Active"},"autoRenew":true,"contractEffectiveDate":"2017-01-01","contractedMrr":8.33,"contractedNetMrr":8.33,"asOfDayGrossMrr":8.33,"asOfDayNetMrr":8.33,"netTotalContractedValue":8.33,"currency":"USD","currentTerm":12,"currentTermPeriodType":"Month","customerAcceptanceDate":"2017-01-01","id":"8a8082c45aa81b51015ad68743ec0fdb","initialTerm":12,"initialTermPeriodType":"Month","invoiceGroupNumber":"N-0001","invoiceOwnerAccountId":"8a8082c45aa81b51015ad64396090f5c","invoiceOwnerAccountName":"ABCD","invoiceOwnerAccountNumber":"A00002641","invoiceScheduleId":"ec6f0d5dc8af451ab95343fb3c588c1a","invoiceSeparately":false,"invoiceTemplateId":"2c9081a03c638994013c63978baf002b","invoiceTemplateName":"InvoiceTemplateName","notes":"","paymentTerm":"Net 30","ratePlans":[{"id":"8a8082c45aa81b51015ad68744030fe3","productId":"8a8082c45aa81b51015ad5a2d07d0e89","productName":"ABC","productRatePlanId":"8a8082c45aa81b51015ad5a473fb0e8d","productSku":"SKU-00000987","contractedNetMrr":8.33,"contractedMrr":8.33,"asOfDayGrossMrr":8.33,"asOfDayNetMrr":8.33,"netTotalContractedValue":8.33,"ratePlanCharges":[{"applyDiscountTo":null,"billingDay":"DefaultFromCustomer","billingPeriod":"Annual","billingPeriodAlignment":"AlignToCharge","billingTiming":"IN_ADVANCE","chargedThroughDate":null,"currency":"USD","description":"","discountAmount":null,"discountApplyDetails":null,"discountClass":null,"discountLevel":null,"discountPercentage":null,"dmrc":8.333333,"done":false,"dtcv":100,"effectiveEndDate":"2018-01-01","effectiveStartDate":"2017-01-01","endDateCondition":"Subscription_End","id":"8a8082c45aa81b51015ad68744160fe4","includedUnits":null,"invoiceScheduleId":"8a8082c45aa81b51015ad68744240ff5","listPriceBase":"Per_Billing_Period","model":"FlatFee","mrr":8.333333,"name":"Annual Charge","number":"C-00032238","numberOfPeriods":null,"originalChargeId":"8a8082c45aa81b51015ad68744160fe4","overageCalculationOption":null,"overagePrice":null,"overageUnusedUnitsCreditOption":null,"price":100,"priceChangeOption":"NoChange","priceIncreasePercentage":null,"pricingSummary":"USD100","processedThroughDate":null,"productRatePlanChargeId":"8a8082c45aa81b51015ad5a655c00e8f","quantity":1,"segment":1,"smoothingModel":null,"specificBillingPeriod":null,"specificEndDate":null,"tcv":100,"tiers":null,"triggerDate":null,"triggerEvent":"ContractEffective","type":"Recurring","unusedUnitsCreditRates":null,"uom":null,"upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"version":1},{"applyDiscountTo":"ONETIMERECURRINGUSAGE","billingDay":"DefaultFromCustomer","billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","billingTiming":null,"chargedThroughDate":null,"currency":"USD","description":"","discountAmount":10,"discountApplyDetails":[{"appliedProductName":"ABC","appliedProductRatePlanChargeId":"8a8082c45aa81b51015ad5a655c00e8f","appliedProductRatePlanChargeName":"Annual Charge","appliedProductRatePlanId":"8a8082c45aa81b51015ad5a473fb0e8d","appliedProductRatePlanName":"RatePlan 1"}],"discountClass":"VIP Discount","discountLevel":"subscription","discountPercentage":null,"dmrc":0,"done":false,"dtcv":0,"effectiveEndDate":"2018-01-01","effectiveStartDate":"2017-01-01","endDateCondition":"Subscription_End","id":"8a8082c45aa81b51015ad68744240fe5","includedUnits":null,"invoiceScheduleId":"8a8082c45aa81b51015ad68744240ff5","listPriceBase":null,"model":"DiscountFixedAmount","mrr":0,"name":"Discount-Fixed 10","number":"C-00032239","numberOfPeriods":null,"originalChargeId":"8a8082c45aa81b51015ad68744240fe5","overageCalculationOption":null,"overagePrice":null,"overageUnusedUnitsCreditOption":null,"price":null,"priceChangeOption":null,"priceIncreasePercentage":null,"pricingSummary":"USD10 fixed amount discount","processedThroughDate":null,"productRatePlanChargeId":"8a8082c45aa81b51015ad683bc590fd8","quantity":null,"segment":1,"smoothingModel":null,"specificBillingPeriod":null,"specificEndDate":null,"tcv":0,"tiers":null,"triggerDate":null,"triggerEvent":"ContractEffective","type":"Recurring","unusedUnitsCreditRates":null,"uom":null,"upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"version":1},{"amendedByOrderOn":null,"applyDiscountTo":null,"billingDay":"DefaultFromCustomer","billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","billingTiming":"IN_ADVANCE","chargeModelConfiguration":null,"chargedThroughDate":null,"currency":"USD","description":"","discountAmount":null,"discountApplyDetails":null,"discountClass":null,"discountLevel":null,"discountPercentage":null,"dmrc":38.571428571,"done":false,"dtcv":468,"effectiveEndDate":"2026-01-01","effectiveStartDate":"2024-12-31","endDateCondition":"Subscription_End","id":"4028818386ba85070186bab54f99573d","includedUnits":null,"inputArgumentId":null,"invoiceScheduleId":"8a8082c45aa81b51015ad68744240ff5","listPriceBase":"Per_Billing_Period","model":"Delivery","mrr":38.571428571,"name":"Delivery Charge","number":"C-00032240","numberOfDeliveries":52,"numberOfPeriods":null,"originalChargeId":"4028818386ba85070186bab54f065731","originalOrderDate":"2023-01-01","overageCalculationOption":null,"overagePrice":null,"overageUnusedUnitsCreditOption":null,"price":9,"priceChangeOption":null,"priceIncreasePercentage":null,"pricingSummary":"","processedThroughDate":null,"productRatePlanChargeId":"4028818386b61be50186b6293eb30017","quantity":1,"ratingGroup":null,"segment":3,"smoothingModel":null,"specificBillingPeriod":null,"specificEndDate":null,"subscriptionChargeDeliverySchedule":{"dayOfMonth":null,"frequency":"Weekly","friday":false,"monday":false,"monthOfYear":null,"saturday":false,"sunday":true,"thursday":false,"tuesday":false,"wednesday":false},"subscriptionChargeIntervalPricing":[{"duration":365,"price":5,"sequence":1,"subscriptionChargeIntervalPriceTiers":[],"type":"Day"},{"duration":365,"price":7,"sequence":2,"subscriptionChargeIntervalPriceTiers":[],"type":"Day"},{"duration":null,"price":9,"sequence":3,"subscriptionChargeIntervalPriceTiers":[],"type":"Infinity"}],"tcv":468,"tiers":null,"triggerDate":null,"triggerEvent":"ContractEffective","type":"Recurring","unusedUnitsCreditRates":null,"uom":null,"upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"version":1}],"ratePlanName":"RatePlan 1"}],"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerm":12,"renewalTermPeriodType":"Month","revision":"1.0","sequenceSetId":"6abcc30846de11e990900242ac1f0003","sequenceSetName":"DEFAULT","serviceActivationDate":"2017-01-01","billToContact":{"address1":"","address2":"","city":"","country":null,"county":null,"fax":"","firstName":"Test","homePhone":"","id":"2c9081a03c6d7b51013c6d7e46c80a17","lastName":"Test","mobilePhone":"","nickname":"","otherPhone":"","otherPhoneType":null,"personalEmail":"","state":"","taxRegion":null,"workEmail":"contact@example.com","workPhone":"","zipCode":""},"soldToContact":{"address1":"","address2":"","city":"","country":null,"county":null,"fax":"","firstName":"Test","homePhone":"","id":"2c9081a03c6d7b51013c6d7e46c80a17","lastName":"Test","mobilePhone":"","nickname":"","otherPhone":"","otherPhoneType":null,"personalEmail":"","state":"","taxRegion":null,"workEmail":"contact@example.com","workPhone":"","zipCode":""},"status":"Active","subscriptionNumber":"A-S00007412","subscriptionStartDate":"2017-01-01","success":true,"termEndDate":"2018-01-01","termStartDate":"2017-01-01","termType":"TERMED","totalNumberOfChargeSegments":10,"totalContractedValue":100,"version":1},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}/put/responses/200/content/application~1json/examples/response":{"value":{"subscriptionId":"4028bb83510f8ed7015114a503cf0373","success":true,"totalDeltaMrr":100,"totalDeltaTcv":4867.7419355},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"2c9081a03c63c94c013c66688a2c00bf","accountName":"RestAPI","accountNumber":"RestAPI","autoRenew":false,"contractEffectiveDate":"2012-02-01","contractedMrr":26.67,"contractedNetMrr":26.67,"asOfDayGrossMrr":26.67,"asOfDayNetMrr":26.67,"netTotalContractedValue":26.67,"currency":"USD","currentTerm":12,"currentTermPeriodType":"Week","customerAcceptanceDate":"2012-02-01","id":"2c9081a03c63c94c013c687b864e0195","initialTermPeriodType":"Week","invoiceGroupNumber":"N-0001","invoiceScheduleId":"ec6f0d5dc8af451ab95343fb3c588c1a","notes":"","ratePlans":[{"id":"2c9081a03c63c94c013c687b868901a4","productId":"2c9081a03c63c94c013c66499ef0001b","productName":"OneTime","productRatePlanId":"2c9081a03c63c94c013c665102e5003a","productSku":"SKU-00000022","contractedNetMrr":26.67,"contractedMrr":26.67,"asOfDayGrossMrr":26.67,"asOfDayNetMrr":26.67,"netTotalContractedValue":26.67,"ratePlanCharges":[{"applyDiscountTo":null,"billingDay":null,"billingPeriod":null,"billingPeriodAlignment":null,"billingTiming":null,"chargedThroughDate":"2012-02-02","currency":"USD","description":"","discountAmount":null,"discountLevel":null,"discountPercentage":null,"dmrc":null,"done":true,"dtcv":24,"effectiveEndDate":"2012-02-02","effectiveStartDate":"2012-02-01","endDateCondition":"One_Time","id":"2c9081a03c63c94c013c687b868901a5","includedUnits":null,"invoiceScheduleId":"8a8082c45aa81b51015ad68744240ff5","listPriceBase":null,"model":"Tiered","mrr":null,"name":"OT_Tiered","number":"C-00000010","numberOfPeriods":null,"originalChargeId":"2c9081a03c63c94c013c687a92d70175","overageCalculationOption":null,"overagePrice":null,"overageUnusedUnitsCreditOption":null,"price":null,"priceChangeOption":null,"priceIncreasePercentage":null,"pricingSummary":"0 to 10 Each: USD20 flat fee;  11 Each or more: USD4/Each","processedThroughDate":"2012-02-02","productRatePlanChargeId":"2c9081a03c63c94c013c6651d677003c","quantity":11,"segment":1,"smoothingModel":null,"specificBillingPeriod":null,"specificEndDate":null,"tcv":24,"tiers":[{"endingUnit":10,"price":20,"priceFormat":"FlatFee","startingUnit":0,"tier":1},{"endingUnit":null,"price":4,"priceFormat":"PerUnit","startingUnit":11,"tier":2}],"triggerDate":null,"triggerEvent":"ContractEffective","type":"OneTime","unusedUnitsCreditRates":null,"uom":"Each","upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"version":1}],"ratePlanName":"OT_Tiered"}],"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerm":0,"renewalTermPeriodType":"Week","revision":"1.0","serviceActivationDate":"2012-02-01","status":"Active","subscriptionNumber":"A-S00000004","subscriptionStartDate":"2012-02-01","success":true,"termEndDate":"2013-02-01","termStartDate":"2012-02-01","termType":"TERMED","totalNumberOfChargeSegments":10,"totalContractedValue":404,"version":1},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1versions~1{version}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/200/content/application~1json/examples/response":{"value":{"subscriptionId":"2c92c8f83dcbd8b1013dcce0f09100a5","success":true,"termEndDate":"2014-05-01","termStartDate":"2014-02-01"},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1renew/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"cancelledDate":"2019-05-31","invoiceId":"8a8082c453cd2a620153e426c7eb78b3","subscriptionId":"8a8082c453cd2a620154efc7bba0350e","success":true,"totalDeltaMrr":0,"totalDeltaTcv":-703.2258065},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/200/content/application~1json/examples/response":{"value":{"success":true,"subscriptionId":"6429c37b5a392e093172e68779c24021","resumeDate":"2024-11-01","termEndDate":"2025-01-13","totalDeltaTcv":167.070913965},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1resume/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/200/content/application~1json/examples/response":{"value":{"success":true,"subscriptionId":"8ad0937890e7fca00190fd3ff7ca7f08","suspendDate":"2024-07-28","resumeDate":null,"termEndDate":"2025-07-22","totalDeltaTcv":-176.978709679},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1suspend/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscription-key}~1delete/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1{subscriptionNumber}~1versions~1{version}~1customFields/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1subscription-metrics/get/responses/200/content/application~1json/example":{"value":{"subscriptionMetrics":[{"subscriptionNumber":"A-S00000008","contractedMrr":100,"contractedNetMrr":100,"asOfDayGrossMrr":100,"asOfDayNetMrr":100,"netTotalContractedValue":100,"totalContractedValue":100},{"subscriptionNumber":"A-S00000009","contractedMrr":100,"contractedNetMrr":100,"asOfDayGrossMrr":100,"asOfDayNetMrr":100,"netTotalContractedValue":100,"totalContractedValue":100}],"success":true},"id":"paths/~1v1~1subscriptions~1subscription-metrics/get/responses/200/content/application~1json/example"},"paths/~1v1~1subscriptions~1subscription-metrics/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1subscription-metrics/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1subscriptions~1subscription-metrics/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1subscriptions~1subscription-metrics/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1omni-channel-subscriptions/post/responses/200/content/application~1json/example":{"value":{"success":true,"subscriptionId":"54be52bbb1b9288bbf82942e00de0000","subscriptionNumber":"A-S00000001","accountId":"2c98906e9288bc0b0192942dfbdc316d","accountNumber":"AN_1729062894303"},"id":"paths/~1v1~1omni-channel-subscriptions/post/responses/200/content/application~1json/example"},"paths/~1v1~1omni-channel-subscriptions/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1omni-channel-subscriptions/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1omni-channel-subscriptions/post/responses/4XX/content/application~1json/example":{"value":{"processId":"processId","reasons":[{"code":"51001122","message":"'billToContact' may not be null"},{"code":"51000030","message":"If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary"}],"success":false},"id":"paths/~1v1~1omni-channel-subscriptions/post/responses/4XX/content/application~1json/example"},"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/200/content/application~1json/example":{"value":{"success":true,"id":"303d186840e611df817c002185d714e1","subscriptionNumber":"A-S00000001","externalSubscriptionId":"56cc93ed3767476782cf2f150e38249c","accountId":"2c98906e9288bc0b0192942dfbdc316d","externalTransactionReason":"Purchase","externalSourceSystem":"Apple","externalState":"Grace","state":"Active","externalProductId":"874d2a0ef3ad43d5b3402771f56aca1d","externalReplaceByProductId":null,"externalInAppOwnershipType":"Purchase","externalQuantity":1,"currency":"USD","autoRenew":false,"originalPurchaseDate":"2024-02-01 00:01:15","externalPurchaseDate":"2024-03-05 10:42:11","externalActivationDate":"2024-03-01 12:12:12","externalExpirationDate":"2024-06-01 12:12:12","externalApplicationId":"external-application-id","externalBundleId":"external-bundle-id","externalSubscriberId":"external-subscriber-id","externalPrice":100,"externalPurchaseType":"Purchase","externalLastRenewalDate":"2024-03-01 12:12:12","externalNextRenewalDate":"2024-09-01 12:12:12"},"id":"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/200/content/application~1json/example"},"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/4XX/content/application~1json/example":{"value":{"processId":"processId","reasons":[{"code":"51001122","message":"'billToContact' may not be null"},{"code":"51000030","message":"If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary"}],"success":false},"id":"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/get/responses/4XX/content/application~1json/example"},"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/4XX/content/application~1json/example":{"value":{"processId":"processId","reasons":[{"code":"51001122","message":"'billToContact' may not be null"},{"code":"51000030","message":"If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary"}],"success":false},"id":"paths/~1v1~1omni-channel-subscriptions~1{subscriptionKey}/delete/responses/4XX/content/application~1json/example"},"paths/~1v1~1rateplans~1{ratePlanId}/get/responses/200/content/application~1json/examples/response":{"value":{"amendment":{"code":"A-AM00000047","contractEffectiveDate":"2021-12-29","createdBy":"2c9890207c9649c0017c969bc6330002","createdDate":"2021-10-29 19:44:16","customerAcceptanceDate":"2021-12-29","description":null,"effectiveDate":"2021-12-29","id":"402880e47ccbaca1017ccbdd63c818cb","name":"update","serviceActivationDate":"2021-12-29","type":"UpdateProduct","updatedBy":"2c9890207c9649c0017c969bc6330002","updatedDate":"2021-10-29 19:44:16"},"id":"402880e47ccbaca1017ccbdd63aa18c8","lastChangeType":"Update","order":{"id":"402880e47ccbaca1017ccbdd7b0e18fd","orderActions":[{"contractEffectiveDate":"2021-12-29","customerAcceptanceDate":"2021-12-29","id":"402880e47ccbaca1017ccbdd7b1418ff","serviceActivationDate":"2021-12-29","type":"UpdateProduct","updateProduct":{"chargeUpdates":[],"customFields":{},"newRatePlanId":"402880e47ccbaca1017ccbdd63aa18c8","productRatePlanId":"2c9890207c9649c0017c96a0f11001a4","ratePlanId":"402880e47ccbaca1017ccbdd620818ba","specificUpdateDate":null,"uniqueToken":null}}],"orderNumber":"O-00000037"},"productId":"2c9890207c9649c0017c96a0588201a2","productName":"MMORPG game","productRatePlanId":"2c9890207c9649c0017c96a0f11001a4","productSku":"SKU-00000001","ratePlanName":"Rate Plan 1","subscriptionId":"402880e47ccbaca1017ccbdd644d18d0","subscriptionVersion":5,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1rateplans~1{ratePlanId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1rateplans~1{ratePlanId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1rateplans~1{ratePlanId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1rateplans~1{ratePlanId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1rateplans~1{ratePlanId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1commitments/get/responses/200/content/application~1json/example":{"value":{"total":1,"page":1,"page_size":20,"commitments":[{"id":"8ad08ca797ef6ca50197f3cce6267991","status":"Active","version":1,"currency":"USD","startDate":"2020-01-01","endDate":"2020-12-31","totalAmount":100,"orderNumber":"O-0001","orderId":"00989e98483e00030a2733ee989e9815","accountId":"8a8aa0ac7f3b4c1d017f3b4c1d0a0001","accountNumber":"ACC-0001","commitmentNumber":"TW-0001","name":"Example Commitment","type":"MinCommitment","prepaymentType":"NotPrepaid","description":"This a example commitment.","priority":1,"eligibleAccountConditions":{"field":"Account.AccountNumber","operator":"eq","value":"ACC-0001","conditions":[{}],"relation":"and"},"eligibleChargeConditions":{"field":"RatePlanCharge.ChargeNumber","operator":"in","value":"C-0001,C-0002","conditions":[{}],"relation":"and"},"periodAlignmentOption":"SpecificDate","specificPeriodAlignmentDate":"2020-01-15","customFields":{},"aceId":"15837365486485820","excludeItemBookingFromRevenueAccounting":true,"adjustmentLiabilityAccountingCode":"Accounts Receivable","adjustmentRevenueAccountingCode":"Accounts Receivable","contractAssetAccountingCode":"Accounts Receivable","contractLiabilityAccountingCode":"Accounts Receivable","contractRecognizedRevenueAccountingCode":"Accounts Receivable","deferredRevenueAccountingCode":"Accounts Receivable","excludeItemBillingFromRevenueAccounting":false,"isAllocationEligible":true,"isUnbilled":false,"recognizedRevenueAccountingCode":"Accounts Receivable","revenueRecognitionRule":"Recognize upon invoicing","unbilledReceivablesAccountingCode":"Accounts Receivable","revenueRecognitionTiming":"Upon Order Activation Date","revenueAmortizationMethod":"Immediate","accountReceivableAccountingCode":"Accounts Receivable","cancellationPolicy":{"settlementType":"NoSettlement"},"cancellationEffectiveDate":"2020-06-30","childCommitments":[{"id":"8ad08ca797ef6ca50197f3cce6267992","status":"Active","version":1,"currency":"USD","startDate":"2024-01-01","endDate":"2024-12-31","totalAmount":50000,"orderNumber":"O-0001","orderId":"00989e98483e00030a2733ee989e9815","accountId":"8a8aa0ac7f3b4c1d017f3b4c1d0a0001","accountNumber":"ACC-0001","commitmentNumber":"CMT-CHILD-001","name":"Child Commitment","type":"MinCommitment","prepaymentType":"NotPrepaid","description":"Child commitment created from parent","priority":1,"eligibleAccountConditions":{"field":"Account.AccountNumber","operator":"eq","value":"ACC-0001","conditions":[{}],"relation":"and"},"eligibleChargeConditions":{"field":"RatePlanCharge.ChargeNumber","operator":"in","value":"C-0001,C-0002","conditions":[{}],"relation":"and"},"periodAlignmentOption":"SpecificDate","specificPeriodAlignmentDate":"2020-01-15","customFields":{},"aceId":"15837365486485821","excludeItemBookingFromRevenueAccounting":true,"adjustmentLiabilityAccountingCode":"Accounts Receivable","adjustmentRevenueAccountingCode":"Accounts Receivable","contractAssetAccountingCode":"Accounts Receivable","contractLiabilityAccountingCode":"Accounts Receivable","contractRecognizedRevenueAccountingCode":"Accounts Receivable","deferredRevenueAccountingCode":"Accounts Receivable","excludeItemBillingFromRevenueAccounting":false,"isAllocationEligible":true,"isUnbilled":false,"recognizedRevenueAccountingCode":"Accounts Receivable","revenueRecognitionRule":"Recognize upon invoicing","unbilledReceivablesAccountingCode":"Accounts Receivable","revenueRecognitionTiming":"Upon Order Activation Date","revenueAmortizationMethod":"Immediate","accountReceivableAccountingCode":"Accounts Receivable","cancellationPolicy":{"settlementType":"NoSettlement"},"cancellationEffectiveDate":"2020-06-30","childCommitments":[],"taxable":true,"taxCode":"SalesTax_US","taxMode":"TaxInclusive"}],"taxable":true,"taxCode":"SalesTax_US","taxMode":"TaxInclusive"}]},"id":"paths/~1commitments/get/responses/200/content/application~1json/example"},"paths/~1commitments/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commitments/get/responses/500/content/application~1json/examples/response"},"paths/~1commitments/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commitments/get/responses/4XX/content/application~1json/examples/response"},"paths/~1commitments~1{commitmentKey}/get/responses/200/content/application~1json/example":{"value":{"id":"8ad08ca797ef6ca50197f3cce6267991","status":"Active","version":1,"currency":"USD","startDate":"2020-01-01","endDate":"2020-12-31","amount":100,"orderNumber":"O-0001","orderId":"00989e98483e00030a2733ee989e9815","accountId":"8a8aa0ac7f3b4c1d017f3b4c1d0a0001","accountNumber":"ACC-0001","commitmentNumber":"TW-0001","name":"Example Commitment","type":"MinCommitment","prepaymentType":"NotPrepaid","description":"This a example commitment.","priority":1,"eligibleAccountConditions":{"field":"Account.AccountNumber","operator":"eq","value":"ACC-0001","conditions":[{}],"relation":"and"},"eligibleChargeConditions":{"field":"RatePlanCharge.ChargeNumber","operator":"in","value":"C-0001,C-0002","conditions":[{}],"relation":"and"},"periodAlignmentOption":"SpecificDate","specificPeriodAlignmentDate":"2020-01-15","customFields":{},"aceId":"15837365486485820","excludeItemBookingFromRevenueAccounting":true,"adjustmentLiabilityAccountingCode":"Accounts Receivable","adjustmentRevenueAccountingCode":"Accounts Receivable","contractAssetAccountingCode":"Accounts Receivable","contractLiabilityAccountingCode":"Accounts Receivable","contractRecognizedRevenueAccountingCode":"Accounts Receivable","deferredRevenueAccountingCode":"Accounts Receivable","excludeItemBillingFromRevenueAccounting":false,"isAllocationEligible":true,"isUnbilled":false,"recognizedRevenueAccountingCode":"Accounts Receivable","revenueRecognitionRule":"Recognize upon invoicing","unbilledReceivablesAccountingCode":"Accounts Receivable","revenueRecognitionTiming":"Upon Order Activation Date","revenueAmortizationMethod":"Immediate","accountReceivableAccountingCode":"Accounts Receivable","cancellationPolicy":{"settlementType":"NoSettlement"},"cancellationEffectiveDate":"2020-06-30","childCommitments":[{"id":"8ad08ca797ef6ca50197f3cce6267992","status":"Active","version":1,"currency":"USD","startDate":"2024-01-01","endDate":"2024-12-31","totalAmount":50000,"commitmentNumber":"CMT-CHILD-001","name":"Child Commitment","description":"Child commitment created from parent","orderNumber":"O-0001","orderId":"00989e98483e00030a2733ee989e9815","accountId":"8a8aa0ac7f3b4c1d017f3b4c1d0a0001","accountNumber":"ACC-0001","type":"MinCommitment","prepaymentType":"NotPrepaid","priority":1,"eligibleAccountConditions":{"field":"Account.AccountNumber","operator":"eq","value":"ACC-0001","conditions":[{}],"relation":"and"},"eligibleChargeConditions":{"field":"RatePlanCharge.ChargeNumber","operator":"in","value":"C-0001,C-0002","conditions":[{}],"relation":"and"},"periodAlignmentOption":"SpecificDate","specificPeriodAlignmentDate":"2020-01-15","customFields":{},"aceId":"15837365486485821","excludeItemBookingFromRevenueAccounting":true,"adjustmentLiabilityAccountingCode":"Accounts Receivable","adjustmentRevenueAccountingCode":"Accounts Receivable","contractAssetAccountingCode":"Accounts Receivable","contractLiabilityAccountingCode":"Accounts Receivable","contractRecognizedRevenueAccountingCode":"Accounts Receivable","deferredRevenueAccountingCode":"Accounts Receivable","excludeItemBillingFromRevenueAccounting":false,"isAllocationEligible":true,"isUnbilled":false,"recognizedRevenueAccountingCode":"Accounts Receivable","revenueRecognitionRule":"Recognize upon invoicing","unbilledReceivablesAccountingCode":"Accounts Receivable","revenueRecognitionTiming":"Upon Order Activation Date","revenueAmortizationMethod":"Immediate","accountReceivableAccountingCode":"Accounts Receivable","cancellationPolicy":{"settlementType":"NoSettlement"},"cancellationEffectiveDate":"2020-06-30","childCommitments":[],"taxable":true,"taxCode":"SalesTax_US","taxMode":"TaxInclusive"}],"taxable":true,"taxCode":"SalesTax_US","taxMode":"TaxInclusive"},"id":"paths/~1commitments~1{commitmentKey}/get/responses/200/content/application~1json/example"},"paths/~1commitments~1{commitmentKey}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commitments~1{commitmentKey}/get/responses/500/content/application~1json/examples/response"},"paths/~1commitments~1{commitmentKey}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commitments~1{commitmentKey}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1commitments~1periods/get/responses/200/content/application~1json/example":{"value":{"periods":[{"id":"0df89cf12e650006ac13624398764f1b","commitmentId":"8ad08ca797ef6ca50197f3cce6267991","commitmentNumber":"TW-0001","currency":"USD","priority":1,"version":1,"type":"MinCommitment","startDate":"2024-01-01","endDate":"2024-12-31","isProrated":false,"amount":100,"balance":500,"trueUpAmount":0,"expiredAmount":null,"billedTotalSpending":500,"consumedAmount":1000,"overage":200,"status":"ActiveWithDrawdown"}],"total":1,"page":1,"pageSize":1},"id":"paths/~1commitments~1periods/get/responses/200/content/application~1json/example"},"paths/~1commitments~1periods/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commitments~1periods/get/responses/500/content/application~1json/examples/response"},"paths/~1commitments~1periods/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commitments~1periods/get/responses/4XX/content/application~1json/examples/response"},"paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/200/content/application~1json/example":{"value":{"total":1,"page":1,"pageSize":1,"periods":[{"id":"6cf8cc0ddddc0061ac13d7a998bc18bb","status":"ACTIVE_WITH_DRAWDOWN","startDate":"2024-01-01","endDate":"2024-12-31","balance":500,"committedAmount":1000,"totalSpend":500,"trueUpAmount":0,"expiredAmount":null,"billedTotalSpending":500,"consumedAmount":850,"totalConsumedAmount":1200}]},"id":"paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/200/content/application~1json/example"},"paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/500/content/application~1json/examples/response"},"paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commitments~1{commitmentId}~1balancepreview/get/responses/4XX/content/application~1json/examples/response"},"paths/~1commitments~1{commitmentKey}~1schedules/get/responses/200/content/application~1json/example":{"value":{"schedules":[{"id":"0df89cf12e650006ac13624398764f1b","commitmentId":"8ad08ca797ef6ca50197f3cce6267991","commitmentNumber":"TW-0001","version":1,"startDate":"2020-01-01","endDate":"2020-12-31","prepaymentDefinition":{"prepaymentFrequency":"Specific_Months","specificFrequency":4,"customFields":{}},"totalAmount":300,"amount":200,"amountBase":"CommitmentPeriod","periodType":"SpecificMonths","specificPeriodLength":4,"status":"Active"}],"total":1,"page":1,"pageSize":20},"id":"paths/~1commitments~1{commitmentKey}~1schedules/get/responses/200/content/application~1json/example"},"paths/~1commitments~1{commitmentKey}~1schedules/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commitments~1{commitmentKey}~1schedules/get/responses/500/content/application~1json/examples/response"},"paths/~1commitments~1{commitmentKey}~1schedules/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commitments~1{commitmentKey}~1schedules/get/responses/4XX/content/application~1json/examples/response"},"paths/~1prepayments~1{prepaymentId}~1expire/put/responses/200/content/application~1json/example":{"value":{"success":true,"id":"8ad08ca797ef6ca50197f3cce6267991","prepaymentDefinitionId":"8ad08ca797ef6ca50197f3cce6267992","commitmentId":"8ad08ca797ef6ca50197f3cce6267993","commitmentNumber":"C-00000001","commitmentScheduleId":"8ad08ca797ef6ca50197f3cce6267994","commitmentPeriodId":"8ad08ca797ef6ca50197f3cce6267995","amount":1200,"billedAmount":600,"spendAmount":1200,"balance":0,"overageAmount":0,"currency":"USD"},"id":"paths/~1prepayments~1{prepaymentId}~1expire/put/responses/200/content/application~1json/example"},"paths/~1prepayments~1{prepaymentId}~1expire/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1prepayments~1{prepaymentId}~1expire/put/responses/500/content/application~1json/examples/response"},"paths/~1prepayments~1{prepaymentId}~1expire/put/responses/4XX/content/application~1json/example":{"value":{"success":false,"processId":"738CBB9234B47A47","reasons":[{"code":"50000040","message":"Cannot find prepayment by id: 8ad08ca797ef6ca50197f3cce6267991"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1prepayments~1{prepaymentId}~1expire/put/responses/4XX/content/application~1json/example"},"paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/200/content/application~1json/example":{"value":{"commitmentChanges":[{"commitmentNumber":"CMT-00083518","orderNumber":"O-00007435","version":2,"changeDate":"2026-02-12T01:18:09Z","changes":{"status":{"oldValue":"ACTIVE","newValue":"CANCELLED"},"totalAmount":{"oldValue":39.67,"newValue":0}},"scheduleChanges":[{"scheduleId":"cbcc50e081dd00010a100b679c50e07f","version":2,"changes":{"status":{"oldValue":"ACTIVE","newValue":"CANCELLED"},"totalAmount":{"oldValue":39.67,"newValue":0}},"periodChanges":[{"periodId":"cbcc50e0824c00020a100b679c50e07f","version":2,"changes":{"status":{"oldValue":"ACTIVE","newValue":"CANCELLED"}}},{"periodId":"cbcc50e0825300030a100b679c50e07f","version":2,"changes":{"status":{"oldValue":"ACTIVE","newValue":"CANCELLED"}}},{"periodId":"cbcc50e0825700040a100b679c50e07f","version":2,"changes":{"status":{"oldValue":"ACTIVE","newValue":"CANCELLED"}}},{"periodId":"cbcc50e0825a00050a100b679c50e07f","version":2,"changes":{"status":{"oldValue":"ACTIVE","newValue":"CANCELLED"}}}]}],"associatedCommitmentChanges":[{"action":"REMOVE","commitmentNumbers":["CMT-00000024"]}]},{"commitmentNumber":"CMT-00083518","orderNumber":"O-00007353","version":1,"changeDate":"2026-02-12T00:03:38Z","changes":{"name":{"oldValue":null,"newValue":"Commitment Notif Test 2"},"type":{"oldValue":null,"newValue":"MIN_COMMITMENT"},"status":{"oldValue":null,"newValue":"ACTIVE"},"endDate":{"oldValue":null,"newValue":"2026-04-30"},"currency":{"oldValue":null,"newValue":"USD"},"priority":{"oldValue":null,"newValue":1},"accountId":{"oldValue":null,"newValue":"8a90ff92993b0d2801993c9d77ac15de"},"startDate":{"oldValue":null,"newValue":"2026-01-01"},"isUnbilled":{"oldValue":null,"newValue":true},"description":{"oldValue":null,"newValue":""},"totalAmount":{"oldValue":null,"newValue":39.67},"accountNumber":{"oldValue":null,"newValue":"A00000249"},"commitmentNumber":{"oldValue":null,"newValue":"CMT-00083518"},"periodAlignmentOption":{"oldValue":null,"newValue":"COMMITMENT_START_DATE"},"revenueRecognitionRule":{"oldValue":null,"newValue":"Recognize upon invoicing"},"isAllocationEligible":{"oldValue":null,"newValue":true},"revenueRecognitionTiming":{"oldValue":null,"newValue":"Upon Billing Document Posting Date"},"eligibleAccountConditions":{"oldValue":null,"newValue":{"field":"Account.AccountNumber","operator":"eq","value":"A00000249","conditions":null,"relation":null}},"revenueAmortizationMethod":{"oldValue":null,"newValue":"Immediate"},"contractAssetAccountingCode":{"oldValue":null,"newValue":"Accounts Receivable"},"deferredRevenueAccountingCode":{"oldValue":null,"newValue":"Subscription Revenue"},"accountReceivableAccountingCode":{"oldValue":null,"newValue":"Accounts Receivable"},"adjustmentRevenueAccountingCode":{"oldValue":null,"newValue":"Credit Card"},"contractLiabilityAccountingCode":{"oldValue":null,"newValue":"Accounts Receivable"},"recognizedRevenueAccountingCode":{"oldValue":null,"newValue":"Subscription Revenue"},"adjustmentLiabilityAccountingCode":{"oldValue":null,"newValue":"Accounts Receivable"},"unbilledReceivablesAccountingCode":{"oldValue":null,"newValue":"Accounts Receivable"},"contractRecognizedRevenueAccountingCode":{"oldValue":null,"newValue":"Subscription Revenue"},"excludeItemBillingFromRevenueAccounting":{"oldValue":null,"newValue":true}},"scheduleChanges":[{"scheduleId":"cbcc50e081dd00010a100b679c50e07f","version":1,"changes":{"amount":{"oldValue":null,"newValue":10},"status":{"oldValue":null,"newValue":"ACTIVE"},"endDate":{"oldValue":null,"newValue":"2026-04-30"},"startDate":{"oldValue":null,"newValue":"2026-01-01"},"amountBase":{"oldValue":null,"newValue":"COMMITMENT_PERIOD"},"periodType":{"oldValue":null,"newValue":"MONTH"},"totalAmount":{"oldValue":null,"newValue":39.67},"commitmentId":{"oldValue":null,"newValue":"cbcc50e081ce00000a100b679c50e07f"},"commitmentNumber":{"oldValue":null,"newValue":"CMT-00083518"},"specificPeriodLength":{"oldValue":null,"newValue":null}},"periodChanges":[{"periodId":"cbcc50e0824c00020a100b679c50e07f","version":1,"changes":{"status":{"oldValue":null,"newValue":"ACTIVE"},"endDate":{"oldValue":null,"newValue":"2026-01-31"},"startDate":{"oldValue":null,"newValue":"2026-01-01"},"commitmentId":{"oldValue":null,"newValue":"cbcc50e081ce00000a100b679c50e07f"},"committedAmount":{"oldValue":null,"newValue":10},"commitmentNumber":{"oldValue":null,"newValue":"CMT-00083518"},"commitmentPriority":{"oldValue":null,"newValue":1}}},{"periodId":"cbcc50e0825300030a100b679c50e07f","version":1,"changes":{"status":{"oldValue":null,"newValue":"ACTIVE"},"endDate":{"oldValue":null,"newValue":"2026-02-28"},"startDate":{"oldValue":null,"newValue":"2026-02-01"},"commitmentId":{"oldValue":null,"newValue":"cbcc50e081ce00000a100b679c50e07f"},"committedAmount":{"oldValue":null,"newValue":10},"commitmentNumber":{"oldValue":null,"newValue":"CMT-00083518"},"commitmentPriority":{"oldValue":null,"newValue":1}}},{"periodId":"cbcc50e0825700040a100b679c50e07f","version":1,"changes":{"status":{"oldValue":null,"newValue":"ACTIVE"},"endDate":{"oldValue":null,"newValue":"2026-03-31"},"startDate":{"oldValue":null,"newValue":"2026-03-01"},"commitmentId":{"oldValue":null,"newValue":"cbcc50e081ce00000a100b679c50e07f"},"committedAmount":{"oldValue":null,"newValue":10},"commitmentNumber":{"oldValue":null,"newValue":"CMT-00083518"},"commitmentPriority":{"oldValue":null,"newValue":1}}},{"periodId":"cbcc50e0825a00050a100b679c50e07f","version":1,"changes":{"status":{"oldValue":null,"newValue":"ACTIVE"},"endDate":{"oldValue":null,"newValue":"2026-04-29"},"startDate":{"oldValue":null,"newValue":"2026-04-01"},"commitmentId":{"oldValue":null,"newValue":"cbcc50e081ce00000a100b679c50e07f"},"committedAmount":{"oldValue":null,"newValue":9.67},"commitmentNumber":{"oldValue":null,"newValue":"CMT-00083518"},"commitmentPriority":{"oldValue":null,"newValue":1}}}]}],"associatedItemChanges":[{"itemId":"1873a10929b9f39b944f39e7ac640006","version":1,"changes":{"itemId":{"oldValue":null,"newValue":"1873a10929b9f39b944f39e7ac640006"},"status":{"oldValue":null,"newValue":"ACTIVE"},"itemType":{"oldValue":null,"newValue":"SUBSCRIPTION_CHARGE"},"itemNumber":{"oldValue":null,"newValue":"C-00000238"},"invoiceOwnerId":{"oldValue":null,"newValue":"8a90ff929f35bc19019f39ae5136225f"},"subscriptionNumber":{"oldValue":null,"newValue":"A-S00000162"},"subscriptionVersion":{"oldValue":null,"newValue":1}}}],"associatedAccountChanges":[{"accountId":"8a90bbe7a007a30f01a00c48bcce0888","version":1,"changes":{"status":{"oldValue":null,"newValue":"ACTIVE"},"accountId":{"oldValue":null,"newValue":"8a90bbe7a007a30f01a00c48bcce0888"},"accountType":{"oldValue":null,"newValue":"SUBSCRIPTION_OWNER"},"accountNumber":{"oldValue":null,"newValue":"A00000118"}}}],"associatedCommitmentChanges":[{"action":"ADD","commitmentNumbers":["CMT-00000024"]}]}],"total":2,"page":1,"pageSize":20},"id":"paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/200/content/application~1json/example"},"paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/500/content/application~1json/examples/response"},"paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1commitments~1{commitmentKey}~1commitmentChanges/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1ppdd~1reverse-rollover/post/responses/200/content/application~1json/examples/response":{"value":{"message":"Reverse rollover is done","reverseRolloverFundCount":1,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1ppdd~1reverse-rollover/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1ppdd~1reverse-rollover/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1ppdd~1reverse-rollover/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1ppdd~1reverse-rollover/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1ppdd~1reverse-rollover/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1ppdd~1rollover/post/responses/200/content/application~1json/examples/response":{"value":{"message":"Rollover is done","rolloverFundCount":1,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1ppdd~1rollover/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1ppdd~1rollover/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1ppdd~1rollover/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1ppdd~1rollover/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1ppdd~1rollover/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/200/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[],"requestId":"d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6","success":true,"fundIds":[{"fundId":"4028818c8d3ade79018d3ae1048a5e10","status":"success","message":"The fund balance is depleted.","depleteDate":"2026-08-31"},{"fundId":"4028818c8d3ade79018d3ae1048a5ef8","status":"success","message":"The fund balance is depleted.","depleteDate":"2026-08-31"}]},"key":"response","summary":"response","id":"paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1prepaid-balance-funds~1deplete/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1usage/post/responses/200/content/application~1json/examples/response":{"value":{"checkImportStatus":"/v1/usage/2c92c8f83dcbd8b1013dcce1159900cc/status","size":316,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1usage/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1usage/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1usage/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1usage/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1usage/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/200/content/application~1json/examples/response":{"value":{"data":{"amountWithoutTax":58,"chargeNumber":"C-00000001","invoiceId":"402880e57f725d85017f7267c44c0028","invoiceItemId":"402880e57f725d85017f7267c4ad002b","invoiceNumber":"INV00000007","listPrice":"Tier / From / To / List Price / Price Format\n1 / 0 / 9 / 0.00 / Per Unit\n2 / 10 / 20 / 1.00 / Per Unit\n3 / 21 / 30 / 2.00 / Flat Fee\n4 / 31 /   / 3.00 / Per Unit\n","quantity":45,"rateDetail":"Tier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00\nTier 2: 10-20, 11 Each(s) x $1.00/Each = $11.00\nTier 3: 21-30, $2.00 Flat Fee\nTier 4: >=31, 15 Each(s) x $3.00/Each = $45.00\nTotal = $58.00","servicePeriod":"03/01/2022-03/31/2022","uom":"Each"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1invoice-item~1{invoice-item-id}~1usage-rate-detail/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1object~1usage/post/responses/200/content/application~1json/examples/response":{"value":{"Id":"8ad08ae29085a77b0190908bfdd67abb","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1usage/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1usage/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}],"Success":false},"key":"response","summary":"response","id":"paths/~1v1~1object~1usage/post/responses/400/content/application~1json/examples/response"},"paths/~1v1~1object~1usage/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1usage/post/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1usage~1{id}/delete/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1usage~1{id}/delete/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1usage~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"AccountId":"2c92c0f956bc8fb40156d502fc3718b1","AccountNumber":"A00000030","ChargeId":"2c92c0f956bc8fcb0156d5039e275aa9","ChargeNumber":"C-00000229","CreatedById":"2c92c0f958fffd7d015914aeefc71a5d","CreatedDate":"2019-07-18T15:36:43.000+08:00","Description":"test","Id":"2c92c0f86bf50ca0016c040309316ca4","Quantity":9,"RbeStatus":"Pending","SourceType":"API","StartDateTime":"2017-12-01T23:41:36.000+08:00","SubmissionDateTime":"2019-07-18T15:36:43.000+08:00","SubscriptionId":"2c92c0f956bc8fcb0156d5039e0a5aa0","SubscriptionNumber":"A-S00000100","UOM":"Each","UpdatedById":"2c92c0f958fffd7d015914aeefc71a5d","UpdatedDate":"2019-07-18T15:36:43.000+08:00"},"key":"response","summary":"response","id":"paths/~1v1~1object~1usage~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1usage~1{id}/get/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1usage~1{id}/get/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1usage~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"done":true,"records":{},"size":0},"key":"response","summary":"response","id":"paths/~1v1~1object~1usage~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1object~1usage~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"Id":"8ad08ae29085a77b0190908bfdd67abb","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1usage~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1usage~1{id}/put/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1usage~1{id}/put/responses/401/content/application~1json/examples/response"},"paths/~1meters~1run~1{meterId}~1{version}/post/responses/200/content/application~1json/examples/success":{"value":{"success":true,"data":{"id":"5468","sessionId":"R-00005468","jobId":"da0b43468d6a41eaad03e559d6aecceb","meterId":2470,"version":"0.0.1","revision":1,"runType":1,"runTypeDescription":"NORMAL","startTime":"2025-03-31T09:17:21.192927441Z","status":10,"statusDescription":"INITIALIZING","canExportSummary":false,"hasLineageEnabled":false},"previousPage":"null","nextPage":"null"},"key":"success","summary":"Meter run success example","id":"paths/~1meters~1run~1{meterId}~1{version}/post/responses/200/content/application~1json/examples/success"},"paths/~1meters~1stop~1{meterId}~1{version}/post/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1meters~1stop~1{meterId}~1{version}/post/responses/200/content/application~1json/example"},"paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/meterNotFound":{"value":{"success":false,"error":{"code":"70002103","message":"Meter does not exist."}},"key":"meterNotFound","summary":"Meter does not exist","id":"paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/meterNotFound"},"paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/versionNotFound":{"value":{"success":false,"error":{"code":"70002104","message":"Meter version does not exist."}},"key":"versionNotFound","summary":"Meter version does not exist","id":"paths/~1meters~1stop~1{meterId}~1{version}/post/responses/400/content/application~1json/examples/versionNotFound"},"paths/~1meters~1{meterId}~1summary/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"requestId":"91d46fea-67de-4abe-9cc3-6ef076bbb7ea","requestTime":"2025-11-20T16:41:27.858661268Z","query":{"runType":"NORMAL","sessionIds":null,"operatorIds":null,"groupBy":["sessionId"],"queryFromTime":null,"queryToTime":null},"output":[{"dimensions":{"sessionId":"R-00002283"},"output":10000000,"totalErrorCount":0},{"dimensions":{"sessionId":"R-00002340"},"output":10000000,"totalErrorCount":0}]},"previousPage":null,"nextPage":null},"id":"paths/~1meters~1{meterId}~1summary/post/responses/200/content/application~1json/example"},"paths/~1meters~1{meterId}~1auditTrail~1entries/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"errorTime":"1753296408775","errorCode":"","errorMessage":"","payload":{"event time":"2025-07-01","charge number":"C-00000017","qty":10,"ratedAmount":"10.0"},"eventId":"601f65ca-67f5-11f0-9e3a-5d9d6cbeef3e|0","traceId":"601f65ca-67f5-11f0-9e3a-5d9d6cbeef3e|0_a_b_e_d_o7normal","operatorType":"BILLING-RATING","operatorName":"Rating","operatorId":"15004c16-6242-4f50-9faf-cb1a0fe6e0f5"}],"previousPage":null,"nextPage":"eyJjdXJzb3IiOi4uLn0="},"id":"paths/~1meters~1{meterId}~1auditTrail~1entries/get/responses/200/content/application~1json/example"},"paths/~1meters~1{meterId}~1auditTrail~1export/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"page":1,"pageSize":5,"jobs":[{"requestId":"cd3367fb-019d-4600-863f-07c51b7c9e10","meterId":709,"query":{"operatorIds":[],"exportType":"SAMPLE","runType":"NORMAL","queryToTime":"2025-11-20T23:59:59Z","queryFromTime":"2025-11-13T07:02:11Z","format":"csv","statuses":null,"sessionIds":[]},"status":"FINISHED","count":15001524,"creationTime":"2025-11-20T16:40:58Z","completionTime":"2025-11-20T16:49:01Z","fileList":["cd3367fb-019d-4600-863f-07c51b7c9e10/audit_trail.csv"]}]},"previousPage":null,"nextPage":null},"id":"paths/~1meters~1{meterId}~1auditTrail~1export/get/responses/200/content/application~1json/example"},"paths/~1meters~1{meterId}~1auditTrail~1export/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"requestId":"cd3367fb-019d-4600-863f-07c51b7c9e10"},"previousPage":null,"nextPage":null},"id":"paths/~1meters~1{meterId}~1auditTrail~1export/post/responses/200/content/application~1json/example"},"paths/~1meters~1auditTrail~1presignedUrl/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":"https://s3.us-west-2.amazonaws.com/example-bucket/tenant-exports/12345/audit-trail/export-2025-01-01/errors_SAMPLE.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAEXAMPLE123456789%2F20250101%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20250101T000000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0000000000000000000000000000000000000000000000000000000000000000"},"id":"paths/~1meters~1auditTrail~1presignedUrl/get/responses/200/content/application~1json/example"},"paths/~1meters~1{meterId}~1prefetchAudit/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"jobId":123456,"operatorId":"2c734651-1ca5-4a87-b104-fecba5bf1c35","definitionId":789,"duration":45000,"completedTime":"2026-01-15T10:30:45Z","startTime":"2026-01-15T10:30:00Z","dataFreshness":"2026-01-15T10:00:00Z","status":"FINISHED","triggerType":"AUTOMATIC","error":null}],"nextPage":"null","previousPage":"null"},"id":"paths/~1meters~1{meterId}~1prefetchAudit/get/responses/200/content/application~1json/example"},"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"queryId":"3ff468bf0abb4b359733fad8f8ccb4d0"},"previousPage":null,"nextPage":null},"id":"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/200/content/application~1json/example"},"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/400/content/application~1json/example":{"value":{"success":false,"previousPage":null,"nextPage":null,"error":{"code":"70002023","message":"Parameter invalid: eventStoreId"}},"id":"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/400/content/application~1json/example"},"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/404/content/application~1json/example":{"value":{"success":false,"previousPage":null,"nextPage":null,"error":{"code":"70002651","message":"Event Store does not exist"}},"id":"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/404/content/application~1json/example"},"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterWriting":{"value":{"success":false,"previousPage":null,"nextPage":null,"error":{"code":"70002648","message":"Another meter is currently writing data to this Event Store. Try again later."}},"key":"meterWriting","summary":"Another meter is writing data","id":"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterWriting"},"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/deletionInProgress":{"value":{"success":false,"previousPage":null,"nextPage":null,"error":{"code":"70002647","message":"Data is currently being deleted from an event store within this meter. Please try again later."}},"key":"deletionInProgress","summary":"A deletion job is already running","id":"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/deletionInProgress"},"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterRunning":{"value":{"success":false,"previousPage":null,"nextPage":null,"error":{"code":"70002653","message":"Event Store cannot be modified because it is in use by a running Meter."}},"key":"meterRunning","summary":"A meter using this store is running","id":"paths/~1meters~1events~1stores~1{eventStoreId}~1truncate/post/responses/409/content/application~1json/examples/meterRunning"},"paths/~1meters~1event-store-queries/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"queryId":"b9a5b91ab34c42b1b9399c0e76245e3f7f76610637ec4d17abdcd4214493814e"},"previousPage":"null","nextPage":"null"},"id":"paths/~1meters~1event-store-queries/post/responses/200/content/application~1json/example"},"paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful query results":{"value":{"success":true,"data":{"totalCount":1,"columns":[{"name":"value 1","logicalType":{"type":"VARCHAR","nullable":true,"length":2147483647},"comment":null},{"name":"value 2","logicalType":{"type":"VARCHAR","nullable":true,"length":2147483647},"comment":null}],"rows":[{"kind":"INSERT","fields":[10,"20%"]}],"ready":true}},"key":"Successful query results","summary":"Successful query results","id":"paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful query results"},"paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful paginated results (page 2 of 2)":{"value":{"success":true,"data":{"totalCount":63,"columns":[{"name":"value 1","logicalType":{"type":"VARCHAR","nullable":true,"length":2147483647},"comment":null},{"name":"value 2","logicalType":{"type":"VARCHAR","nullable":true,"length":2147483647},"comment":null}],"rows":[{"kind":"INSERT","fields":[51,"some value"]},{"kind":"INSERT","fields":[63,"another value"]}],"ready":true}},"key":"Successful paginated results (page 2 of 2)","summary":"Successful paginated results (page 2 of 2)","id":"paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Successful paginated results (page 2 of 2)"},"paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Failed query execution":{"value":{"success":true,"data":{"isFailed":true,"message":"<error message description>","ready":true}},"key":"Failed query execution","summary":"Failed query execution","id":"paths/~1meters~1event-store-queries~1{queryId}/get/responses/200/content/application~1json/examples/Failed query execution"},"paths/~1v1~1adjustments/get/responses/200/content/application~1json/examples/response":{"value":{"adjustments":[{"adjustmentId":"4028818886a2149b0186a237d0ff003b","adjustmentNumber":"ADJ-00000001","amount":-5,"billingDate":"2023-02-26","chargeNumber":"C-00000001","creditMemoNumber":"CM00000001","deferredRevenueAccountingCode":"string","deliveryDate":"2023-02-26","deliveryDay":"sunday","reason":"string","recognizedRevenueAccountingCode":"string","revenueRecognitionRuleName":"string","status":"Billed","subscriptionNumber":"A-S00000001"},{"adjustmentId":"4028818886a2149b0186a2404f67003c","adjustmentNumber":"ADJ-00000002","amount":-5,"billingDate":"2023-02-27","chargeNumber":"C-00000001","creditMemoNumber":"CM00000002","debitMemoNumber":"DM00000002","deferredRevenueAccountingCode":"string","deliveryDate":"2023-02-27","deliveryDay":"monday","reason":"string","recognizedRevenueAccountingCode":"string","revenueRecognitionRuleName":"string","status":"Cancelled","subscriptionNumber":"A-S00000001"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1adjustments/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1adjustments/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1adjustments/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1adjustments/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1adjustments/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1adjustments/post/responses/200/content/application~1json/examples/response":{"value":{"adjustments":[{"adjustmentId":"4028818886a2149b0186a237d0ff003b","adjustmentNumber":"ADJ-00000001","amount":-5,"billingDate":"2023-02-26","chargeNumber":"C-00000001","creditMemoNumber":"CM00000001","deferredRevenueAccountingCode":"string","deliveryDate":"2023-02-26","deliveryDay":"sunday","eligible":true,"reason":"string","recognizedRevenueAccountingCode":"string","revenueRecognitionRuleName":"string","status":"Billed","subscriptionNumber":"A-S00000001"}],"ineligibleAdjustments":[{"adjustmentId":null,"adjustmentNumber":null,"amount":null,"billingDate":null,"chargeNumber":"C-00000001","deferredRevenueAccountingCode":"string","deliveryDate":"2023-02-27","deliveryDay":"monday","eligible":false,"errorMessage":"Subscription does not have a delivery scheduled for this day","reason":"string","recognizedRevenueAccountingCode":"string","revenueRecognitionRuleName":"string","status":null,"subscriptionNumber":"A-S00000001"}],"success":true,"totalAmount":-5,"totalNumberOfDeliveries":1},"key":"response","summary":"response","id":"paths/~1v1~1adjustments/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1adjustments/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1adjustments/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1adjustments/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1adjustments/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1adjustments~1preview/post/responses/200/content/application~1json/examples/response":{"value":{"adjustments":[{"adjustmentId":"null","adjustmentNumber":"null","amount":-5,"billingDate":"2023-02-26","chargeNumber":"C-00000001","creditMemoNumber":null,"deferredRevenueAccountingCode":"string","deliveryDate":"2023-02-26","deliveryDay":"sunday","eligible":true,"reason":"string","recognizedRevenueAccountingCode":"string","revenueRecognitionRuleName":"string","status":null,"subscriptionNumber":"A-S00000001"}],"ineligibleAdjustments":[{"adjustmentId":null,"adjustmentNumber":null,"amount":null,"billingDate":null,"chargeNumber":"C-00000001","deferredRevenueAccountingCode":"string","deliveryDate":"2023-02-27","deliveryDay":"monday","eligible":false,"errorMessage":"Subscription does not have a delivery scheduled for this day","reason":"string","recognizedRevenueAccountingCode":"string","revenueRecognitionRuleName":"string","status":null,"subscriptionNumber":"A-S00000001"}],"success":true,"totalAmount":-5,"totalNumberOfDeliveries":1},"key":"response","summary":"response","id":"paths/~1v1~1adjustments~1preview/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1adjustments~1preview/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1adjustments~1preview/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1adjustments~1preview/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1adjustments~1preview/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1adjustments~1{adjustment-key}/get/responses/200/content/application~1json/examples/response":{"value":{"adjustmentId":"4028818886a2149b0186a2404f67003c","adjustmentNumber":"ADJ-00000001","amount":-5,"billingDate":"2023-02-26","chargeNumber":"C-00000001","creditMemoNumber":"CM00000001","deferredRevenueAccountingCode":"string","deliveryDate":"2023-02-26","deliveryDay":"sunday","reason":"string","recognizedRevenueAccountingCode":"string","revenueRecognitionRuleName":"string","status":"Billed","subscriptionNumber":"A-S00000001"},"key":"response","summary":"response","id":"paths/~1v1~1adjustments~1{adjustment-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1adjustments~1{adjustment-key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1adjustments~1{adjustment-key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1adjustments~1{adjustment-key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1adjustments~1{adjustment-key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"debitMemoNumber":"DM00000001","success":true},"key":"response","summary":"response","id":"paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1adjustments~1{adjustmentId}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1billing-documents/get/responses/200/content/application~1json/examples/response":{"value":{"documents":[{"accountId":"4028905f5e4feb38bbb50af9aa002d1","accountNumber":"A00000001","amount":100,"balance":90,"documentDate":"2017-10-01","documentNumber":"INV-0000001","documentType":"Invoice","id":"4028905f5e4jjj015e50af9aa002d1","status":"Posted","currency":"USD"},{"accountId":"4028905f5e4feb38b111b50af9aa002d1","accountNumber":"A00000001","amount":100,"balance":90,"documentDate":"2017-09-01","documentNumber":"CM-0000001","documentType":"CreditMemo","id":"4028905f5e4jbbb015e50af9aa002d1","status":"Posted","currency":"USD"},{"accountId":"4028905f5e4feb3833b50af9aa002d1","accountNumber":"A00000001","amount":100,"balance":90,"documentDate":"2017-07-01","documentNumber":"DM-0000001","documentType":"DebitMemo","id":"4028905f5e4jccc015e50af9aa002d1","status":"Posted","currency":"USD"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1billing-documents/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1billing-documents/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1billing-documents/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1billing-documents/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1billing-documents/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/200/content/application~1json/examples/response":{"value":{"id":"2c92c8f83dc4f752013dc72c24ee016c","status":"Pending","success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"2c92c8f83dc4f752013dc72c24ee016c","status":"Pending","success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1billing-documents~1files~1deletion-jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/200/content/application~1json/examples/response":{"value":{"invoices":[{"id":"8ad084db909fae930190a121c84957ff"}],"creditMemos":[],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounts~1{key}~1billing-documents~1generate/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad084db909fae930190a121c84957ff","invoiceNumber":"INV00000155","accountId":"8ad09be48db5aba7018db604776d4854","amount":100,"amountWithoutTax":100,"discount":0,"invoiceDate":"2024-07-30","dueDate":"2024-08-29","autoPay":false,"comments":null,"status":"Draft","taxAmount":0,"taxExemptAmount":0,"transferredToAccounting":null,"sourceType":"Standalone","billToContactId":null,"soldToContactId":null,"templateId":null,"paymentTerm":null,"sequenceSetId":null,"adjustmentAmount":0,"balance":100,"billToContactSnapshotId":null,"creditMemoAmount":0,"includesOneTime":true,"includesRecurring":true,"includesUsage":true,"lastEmailSentDate":null,"paymentAmount":0,"postedBy":null,"postedDate":null,"refundAmount":0,"soldToContactSnapshotId":null,"source":"API","sourceId":null,"targetDate":null,"taxMessage":null,"taxStatus":"Complete","createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2024-07-11 02:31:04","updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-07-11 02:31:04","billRunId":null,"currency":"USD","invoiceGroupNumber":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1batch/post/responses/200/content/application~1json/examples/response":{"value":{"invoices":[{"IntegrationId__NS":"string","IntegrationStatus__NS":"string","SyncDate__NS":"string","accountId":"4028818484f483d20184f4f7efc40001","adjustmentAmount":0,"amount":700,"amountWithoutTax":700,"autoPay":true,"balance":700,"billRunId":"4028818484f483d20184f50064950035","billToContactSnapshotId":"402881e522cf4f9b0122cf5d82860004","comments":"","complexity__c":"Middle","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2022-12-08 19:49:16","currency":"USD","description__c":"description","discount":0,"dueDate":"2022-11-30","id":"4028818484f483d20184f5006b97003f","includesOneTime":true,"includesRecurring":true,"includesUsage":true,"invoiceDate":"2022-10-31","invoiceGroupNumber":"N-0001","invoiceNumber":"INV00000001","lastEmailSentDate":"2022-12-08 19:51:16","paymentAmount":0,"postedBy":"402881e522cf4f9b0122cf5d82860002","postedDate":"2022-12-09","refundAmount":0,"sequenceSetId":"402881e522cf4f9b0122cf5d82860003","soldToContactSnapshotId":"402881e522cf4f9b0122cf5d82860005","source":"BillRun","sourceId":"BR-00000001","sourceType":"Subscription","status":"Posted","success":true,"targetDate":"2022-10-31","transferredToAccounting":"string","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2022-12-08 19:51:23"},{"objectIndex":1,"processId":"CA037C0B8C5B0682","reasons":[{"code":58490020,"message":"No account is found with accountId ff8080817cda56fa017cda87aaa2071f."}],"success":false}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1batch/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1batch/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1batch/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1batch/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1batch/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1bulk-post/post/responses/200/content/application~1json/examples/response":{"value":{"invoices":[{"id":"402890555a7e9791015a7f15fe440123","success":true},{"id":"402890555a7e9791015a7f15fe44013a","success":true},{"id":"ff808081804f25b001804f2d8971079f","processId":"F3D4DAF98E6CE569","reasons":[{"code":59210020,"message":"Only invoices with Draft status can be posted."}],"success":false}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1bulk-post/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1bulk-post/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1bulk-post/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1bulk-post/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1bulk-post/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1pdf-status/get/responses/200/content/application~1json/example":{"value":{"invoiceFiles":[{"invoiceId":"402824aa8cc894d5018cc8a120576881","invoiceNumber":"INV00000003","pdfGenerationStatus":"Generated","createdOn":"2024-01-01 11:35:56","updatedOn":"2024-01-01 11:35:56","pdfFileUrl":"/v1/files/2c98901f62d7d83d0162d7facea6262d"},{"invoiceId":"2c98908a904dfc2601904e6e14090241","invoiceNumber":"INV00000004","pdfGenerationStatus":"Error","createdOn":"2024-01-02 10:14:13","updatedOn":"2024-01-02 10:14:13","errorCode":"INVALID_TEMPLATE","errorMessage":"Unknown merge filed chargeNumber__c"},{"invoiceId":"513935bb9dd905e6129dd9b231687992","invoiceNumber":"INV00000005","pdfGenerationStatus":"Pending","createdOn":"2024-01-01 11:35:56","updatedOn":"2024-01-01 11:35:56"}],"success":true},"id":"paths/~1v1~1invoices~1pdf-status/get/responses/200/content/application~1json/example"},"paths/~1v1~1invoices~1pdf-status/get/responses/400/content/application~1json/example":{"value":{"processId":"processId","reasons":[{"code":"50000020","message":"Credit memo key is required"}],"success":false},"id":"paths/~1v1~1invoices~1pdf-status/get/responses/400/content/application~1json/example"},"paths/~1v1~1invoices~1pdf-status/get/responses/401/content/application~1json/example":{"value":{"message":"Authentication error"},"id":"paths/~1v1~1invoices~1pdf-status/get/responses/401/content/application~1json/example"},"paths/~1v1~1invoices~1pdf-status/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1pdf-status/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1pdf-status/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1pdf-status/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}/delete/responses/200/content/application~1json/examples/response":{"value":{"id":"40288ae9600808280160081dc9c13f15","jobId":"40288ae9600808280160081db1533506","jobStatus":"Completed","success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}/get/responses/200/content/application~1json/examples/response":{"value":{"IntegrationId__NS":"string","IntegrationStatus__NS":"string","SyncDate__NS":"string","accountId":"4028818484f483d20184f4f7efc40001","adjustmentAmount":0,"amount":700,"amountWithoutTax":700,"autoPay":true,"balance":700,"billRunId":"4028818484f483d20184f50064950035","billToContactSnapshotId":"402881e522cf4f9b0122cf5d82860010","comments":"","complexity__c":"Middle","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2022-12-08 19:49:16","currency":"USD","description__c":"description","discount":0,"dueDate":"2022-11-30","id":"4028818484f483d20184f5006b97003f","includesOneTime":true,"includesRecurring":true,"includesUsage":true,"invoiceDate":"2022-10-31","invoiceGroupNumber":"N-0001","invoiceNumber":"INV00000001","lastEmailSentDate":"2022-12-08 19:51:16","paymentAmount":0,"postedBy":"402881e522cf4f9b0122cf5d82860002","postedDate":"2022-12-09","refundAmount":0,"sequenceSetId":"402881e522cf4f9b0122cf5d82860009","soldToContactSnapshotId":"402881e522cf4f9b0122cf5d82860011","source":"BillRun","sourceId":"BR-00000001","sourceType":"Subscription","status":"Posted","success":true,"targetDate":"2022-10-31","transferredToAccounting":"string","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2022-12-08 19:51:23"},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}/put/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad084db909fae930190a121c84957ff","number":"INV00000155","accountId":"8ad09be48db5aba7018db604776d4854","invoiceDate":"2024-07-30","currency":"USD","targetDate":null,"dueDate":"2024-08-29","postedOn":null,"postedById":null,"status":"Draft","amount":105,"taxAmount":0,"totalTaxExemptAmount":0,"balance":105,"discount":0,"comment":null,"autoPay":false,"transferredToAccounting":false,"creditBalanceAdjustmentAmount":0,"createdDate":"2024-07-11 02:31:04","createdById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-07-11 02:43:45","updatedById":"b243314d594646d3b2651aeedd4be47e","cancelledOn":null,"cancelledById":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"id":"40288ae9600808280160081dc9c13f15","jobId":"40288ae9600808280160081db1533506","jobStatus":"Completed","success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/200/content/application~1json/examples/response":{"value":{"applicationParts":[{"appliedAmount":22,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2018-01-02 11:42:16","creditMemoId":"4028905f60a165a50160b4f632ff023d","paymentId":null,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2018-01-02 11:42:16"},{"appliedAmount":11,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2018-01-02 11:41:38","creditMemoId":null,"paymentId":"4028905f60a165a50160b4f5d5cb0229","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2018-01-02 11:41:38"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1application-parts/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1emails/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/200/content/application~1json/examples/response":{"value":{"invoiceFiles":[{"id":"2c98901f62d7d83d0162d7facec2262f","pdfFileUrl":"/v1/files/2c98901f62d7d83d0162d7facea6262d","versionNumber":1524041954479},{"id":"2c98901f62d7d83d0162d7f4a9792629","pdfFileUrl":"/v1/files/2c98901f62d7d83d0162d7f4a95c2627","versionNumber":1524041551946},{"id":"2c98901f62d7d83d0162d7f491ea2626","pdfFileUrl":"/v1/files/2c98901f62d7d83d0162d7f490f22624","versionNumber":1524041544112}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1files/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/200/content/application~1json/examples/response":{"value":{"fileId":"40289f466463d683016463ef8b7301a2","success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1files/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/200/content/application~1json/examples/response":{"value":{"invoiceItems":[{"appliedToItemId":null,"balance":21.1,"chargeAmount":21.1,"chargeDate":"2015-11-20 19:53:00","chargeDescription":"","chargeId":"2c92c0f9511f56b2015126814af832d2","chargeName":"Annual Fee","chargeType":"Recurring","description":"","commitmentId":"4028819f9a4dfdf1019a4e04acfb7e63","commitmentPeriodId":"4028819f9a4dfdf1019a4e06f04a402c","excludeItemBillingFromRevenueAccounting":true,"id":"2c92c095511f5b4401512682dd017989","invoiceScheduleId":"402881e522cf4f9b0122cf5d82860005","invoiceScheduleItemId":"402881e522cf4f9b0122cf5d82860006","numberOfDeliveries":1,"processingType":"Charge","productName":"TeamCollab Enterprise","quantity":1,"serviceEndDate":"2015-11-30","serviceStartDate":"2015-11-20","soldToContactId":"2c92c0f9511f56b2015126814ad532cd","soldToContactSnapshotId":"2c92c0f9511f56b2015126814ad532cd","sourceItemType":"SubscriptionComponent","subscriptionId":"2c92c0f9511f56b2015126814ad532cc","subscriptionName":"A-S00000004","taxAmount":0,"taxationItems":{"data":[{"balance":2.11,"creditAmount":0,"exemptAmount":0,"id":"2c98901a68ff26800168ffce6eeb0ffe","jurisdiction":"County","locationCode":"000-1","name":"taxName","paymentAmount":0,"taxAmount":2.11,"taxCode":"TAXCODE-1","taxCodeDescription":null,"taxDate":"2015-11-20","taxRate":0.1,"taxRateDescription":"","taxRateType":"Percentage"}]},"unitOfMeasure":"","unitPrice":21.1},{"appliedToItemId":"2c92c095511f5b4401512682dd017989","chargeAmount":-2.1,"chargeDate":"2015-11-20 19:53:00","chargeDescription":"","chargeId":"1b3dede652fa47db833a83be55d850a5","chargeName":"Discount","chargeType":"OneTime","description":"","commitmentId":"4028819f9a4dfdf1019a4e04acfb7e63","commitmentPeriodId":"4028819f9a4dfdf1019a4e06f04a402c","excludeItemBillingFromRevenueAccounting":true,"id":"3e28d61d442f433797e268e2b7c11eeb","invoiceScheduleId":"402881e522cf4f9b0122cf5d82860005","invoiceScheduleItemId":"402881e522cf4f9b0122cf5d82860006","numberOfDeliveries":1,"processingType":"Discount","productName":"TeamCollab Enterprise","quantity":0,"serviceEndDate":"2015-11-30","serviceStartDate":"2015-11-20","soldToContactId":"2c92c0f9511f56b2015126814ad532cd","soldToContactSnapshotId":"2c92c0f9511f56b2015126814ad532cd","sourceItemType":"SubscriptionComponent","subscriptionId":"c2d9a5768db440cbbf2709a55c614bed","subscriptionName":"A-S00000004","taxAmount":0,"taxationItems":{"data":[{"balance":0.21,"creditAmount":0,"exemptAmount":0,"id":"2c98901a68ff26800168ffce6eeb0ffe","jurisdiction":"County","locationCode":"000-1","name":"taxName","paymentAmount":0,"taxAmount":0.21,"taxCode":"TAXCODE-1","taxCodeDescription":null,"taxDate":"2015-11-20","taxRate":0.1,"taxRateDescription":"","taxRateType":"Percentage"}]},"unitOfMeasure":"","unitPrice":10}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1items/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"balance":10,"creditAmount":0,"exemptAmount":0,"id":"2c98901a68ff26800168ffce84e3102c","jurisdiction":"test","locationCode":"code - 001","name":"test","paymentAmount":0,"taxAmount":10,"taxCode":"taxcode","taxCodeDescription":"description","taxDate":"2019-02-18","taxRate":2,"taxRateDescription":"test","taxRateType":"FlatFee"},{"balance":10,"creditAmount":0,"exemptAmount":0,"id":"2c98901a68ff26800168ffce85d6102e","jurisdiction":"test","locationCode":"code - 001","name":"test","paymentAmount":0,"taxAmount":10,"taxCode":"taxcode","taxCodeDescription":"description","taxDate":"2019-02-18","taxRate":2,"taxRateDescription":"test","taxRateType":"FlatFee"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1items~1{itemId}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/200/content/application~1json/examples/response":{"value":{"creditMemo":{"id":"402890555a40ca7f015a5b099b0e307a"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1reverse/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/200/content/application~1json/example":{"value":{"response":{"id":"8a90b9ce9cda030a019cdc3e8a455fc5","jobId":"8a90ff929cda0319019cdc458e8d669c","jobStatus":"Completed","invoices":[{"id":"8a90ff929cda0319019cdc458ee6669e","invoiceNumber":"INV00049021","invoiceDate":"2026-02-01","amount":50},{"id":"8a90ff929cda0319019cdc458ef266a1","invoiceNumber":"INV00049022","invoiceDate":"2026-02-15","amount":80}],"success":true}},"id":"paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/200/content/application~1json/example"},"paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1split/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/200/content/application~1json/examples/response":{"value":{"success":true,"taxationItems":[{"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 10:08:43","exemptAmount":0,"financeInformation":{"accountsReceivableAccountingCode":"Check","accountsReceivableAccountingCodeType":"Cash","salesTaxPayableAccountingCode":"Check","salesTaxPayableAccountingCodeType":"Cash"},"id":"402890555a7e9791015a87a072880062","invoiceItemId":"402890555a7e9791015a879f064d0055","jurisdiction":"CALIFORNIA","locationCode":"06","name":"STATE TAX","taxAmount":0.1,"taxCode":"ServiceTaxCode","taxCodeDescription":"This is tax code description!","taxDate":"2016-09-30","taxMode":"TaxExclusive","taxRate":0.0625,"taxRateDescription":"This is tax rate description!","taxRateType":"Percentage","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 10:08:43"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/200/content/application~1json/example":{"value":{"id":"40288ae9600808280160081dc9c13f15","status":"Pending","operationType":"AsyncCreditMemoApply","referenceId":"4028905f5a890526015a8d73f73d0015","referenceType":"CreditMemo","error":null,"creditMemo":{"id":"402890555a40ca7f015a5b099b0e307a"},"success":true},"id":"paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/200/content/application~1json/example"},"paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"processId","reasons":[{"code":"51000030","message":"You do not have permission to perform this operation."}],"success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1write-off-async/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/200/content/application~1json/example":{"value":{"id":"40288ae9600808280160081dc9c13f15","status":"Processed","operationType":"AsyncCreditMemoApply","referenceId":"4028905f5a890526015a8d73f73d0015","referenceType":"CreditMemo","error":null,"creditMemo":{"id":"402890555a40ca7f015a5b099b0e307a"},"success":true},"id":"paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/200/content/application~1json/example"},"paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/4XX/content/application~1json/example":{"value":{"code":71012514,"message":"You do not have permission to perform this operation."},"id":"paths/~1v1~1invoices~1write-off-async-jobs~1{asyncJobId}/get/responses/4XX/content/application~1json/example"},"paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/200/content/application~1json/examples/response":{"value":{"creditMemo":{"id":"402890555a40ca7f015a5b099b0e307a"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1write-off/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/synchronous":{"value":{"jobId":"2c92c8955bd63cc1015bd7c151af0300","jobStatus":"Completed","invoice":{"id":"2c92c8955bd63cc1015bd7c151af02ab","accountId":"2c92c8955bd63cc1015bd7c151af0100","invoiceNumber":"INV-0000001","status":"Draft","invoiceDate":"2024-03-01","dueDate":"2024-03-31","amount":100,"balance":100},"success":true},"key":"synchronous","summary":"Invoice unposted synchronously","id":"paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/synchronous"},"paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/asynchronous":{"value":{"jobId":"2c92c8955bd63cc1015bd7c151af0300","jobStatus":"Pending","invoice":null,"success":true},"key":"asynchronous","summary":"Invoice unpost submitted for asynchronous processing","id":"paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/200/content/application~1json/examples/asynchronous"},"paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"51001122","message":"Invoice must be in Posted status to unpost"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos/get/responses/200/content/application~1json/examples/response":{"value":{"creditmemos":[{"accountId":"2c92c8f95bd63b98015bd7ab09ef0926","accountNumber":"A00000001","amount":23,"appliedAmount":0,"autoApplyUponPosting":false,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"","createdById":"2c92c8f95b79c9ad015b80614273052c","createdDate":"2017-05-05 01:39:30","creditMemoDate":"2017-05-05","currency":"USD","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","excludeFromAutoApplyRules":false,"id":"2c92c8f95bd63b94015bd7c39289112e","invoiceGroupNumber":"N-0001","latestPDFFileId":"2c92c8955bd63b6c015bd7c395e90023","number":"CM00000002","postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredInvoiceId":null,"refundAmount":0,"reversed":false,"sequenceSetId":null,"source":"BillRun","sourceId":"BR-00000024","sourceType":"Standalone","status":"Draft","targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","unappliedAmount":23,"updatedById":"2c92c8f95b79c9ad015b80614273052c","updatedDate":"2017-05-05 01:39:30"},{"accountId":"2c92c8f95bd63b98015bd7ab09ef0926","accountNumber":"A00000001","amount":10,"appliedAmount":0,"autoApplyUponPosting":false,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"","createdById":"2c92c8f95b79c9ad015b80614273052c","createdDate":"2017-05-05 01:15:23","creditMemoDate":"2017-05-01","currency":"USD","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","excludeFromAutoApplyRules":false,"id":"2c92c8f95bd63b9d015bd7ad7fe206f9","invoiceGroupNumber":"N-0001","latestPDFFileId":"2c92c8955bd63b6c015bd7ad8921001d","number":"CM00000001","postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredInvoiceId":"2c92c8955bd63cc1015bd7c151af02ab","refundAmount":0,"reversed":false,"sequenceSetId":null,"source":"AdhocFromInvoice","sourceId":null,"sourceType":"Standalone","status":"Draft","targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","unappliedAmount":10,"updatedById":"2c92c8f95b79c9ad015b80614273052c","updatedDate":"2017-05-05 01:15:24"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad08f0091698a7a01916e70df165b3b","number":"CM00000010","accountId":"8ad09be48db5aba7018db604776d4854","accountNumber":"A00000097","currency":"USD","creditMemoDate":"2024-08-19","targetDate":null,"postedById":null,"postedOn":null,"status":"Draft","amount":10,"taxAmount":0,"totalTaxExemptAmount":0,"unappliedAmount":10,"refundAmount":0,"appliedAmount":0,"comment":null,"source":"AdhocFromPrpc","sourceId":null,"referredInvoiceId":null,"reasonCode":"Correcting invoice error","createdDate":"2024-08-19 23:19:36","createdById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-08-19 23:19:36","updatedById":"b243314d594646d3b2651aeedd4be47e","cancelledOn":null,"cancelledById":null,"latestPDFFileId":"ac1ebc24569sd","transferredToAccounting":"No","excludeFromAutoApplyRules":false,"autoApplyUponPosting":false,"reversed":false,"taxStatus":"Complete","sourceType":"Standalone","taxMessage":null,"billToContactId":null,"billToContactSnapshotId":null,"sequenceSetId":null,"invoiceGroupNumber":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1bulk/post/responses/200/content/application~1json/examples/response":{"value":{"memos":[{"accountId":"ff8080817fe9d7b9017fe9e5234d04cb","accountNumber":"A00000001","amount":100,"appliedAmount":0,"autoApplyUponPosting":false,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"test","createdById":"ff8080817fe9d7b9017fe9e41732030e","createdDate":"2022-04-02 18:49:47","creditMemoDate":"2022-04-02","currency":"USD","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","excludeFromAutoApplyRules":false,"id":"ff8080817fe9d7b9017fe9e5382f04f5","invoiceGroupNumber":"N-0001","latestPDFFileId":"ac1ebc24569sd","number":"CM00000001","postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredInvoiceId":"ff8080817fe9d7b9017fe9e5317f04e0","refundAmount":0,"reversed":false,"sequenceSetId":null,"source":"AdhocFromInvoice","sourceId":null,"sourceType":"Invoice","status":"Draft","success":true,"targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","unappliedAmount":100,"updatedById":"ff8080817fe9d7b9017fe9e41732030e","updatedDate":"2022-04-02 18:49:47"},{"objectIndex":1,"processId":"0356073CB721291A","reasons":[{"code":50000040,"message":"Cannot find a Invoice instance with id test."}],"success":false}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1bulk/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1bulk/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1bulk/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1bulk/put/responses/200/content/application~1json/examples/response":{"value":{"memos":[{"accountId":"ff8080817fe9d7b9017fe9e5234d04cb","accountNumber":"A00000001","amount":100,"appliedAmount":0,"autoApplyUponPosting":false,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"test","createdById":"ff8080817fe9d7b9017fe9e41732030e","createdDate":"2022-04-02 18:49:47","creditMemoDate":"2022-04-02","currency":"USD","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","excludeFromAutoApplyRules":false,"id":"ff8080817fe9d7b9017fe9e5382f04f5","invoiceGroupNumber":"N-0001","latestPDFFileId":"ac1ebc24569sd","number":"CM00000001","postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredInvoiceId":"ff8080817fe9d7b9017fe9e5317f04e0","refundAmount":0,"reversed":false,"sequenceSetId":null,"source":"AdhocFromInvoice","sourceId":null,"sourceType":"Invoice","status":"Draft","success":true,"targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","unappliedAmount":100,"updatedById":"ff8080817fe9d7b9017fe9e41732030e","updatedDate":"2022-04-02 18:49:47"},{"id":"ff8080817fe9d7b9017fe9e41732030f","objectIndex":1,"processId":"0356073CB721291A","reasons":[{"code":50000040,"message":"Cannot find a Invoice instance with id."}],"success":false}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1bulk/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1bulk/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1bulk/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1pdf-status/get/responses/200/content/application~1json/example":{"value":{"creditMemoFiles":[{"creditMemoId":"402824aa8cc894d5018cc8a120576881","creditMemoNumber":"CM00000003","pdfGenerationStatus":"Generated","createdOn":"2024-01-01 11:35:56","updatedOn":"2024-01-01 11:35:56","pdfFileUrl":"/v1/files/2c98901f62d7d83d0162d7facea6262d"},{"creditMemoId":"2c98908a904dfc2601904e6e14090241","creditMemoNumber":"CM00000004","pdfGenerationStatus":"Error","createdOn":"2024-01-02 10:14:13","updatedOn":"2024-01-02 10:14:13","errorCode":"INVALID_TEMPLATE","errorMessage":"Unknown merge filed chargeNumber__c"},{"creditMemoId":"514936bb7dd014e6230dd0c342798103","creditMemoNumber":"CM00000005","pdfGenerationStatus":"Pending","createdOn":"2024-01-01 11:35:56","updatedOn":"2024-01-01 11:35:56"}],"success":true},"id":"paths/~1v1~1credit-memos~1pdf-status/get/responses/200/content/application~1json/example"},"paths/~1v1~1credit-memos~1pdf-status/get/responses/400/content/application~1json/example":{"value":{"processId":"processId","reasons":[{"code":"50000020","message":"Credit memo key is required"}],"success":false},"id":"paths/~1v1~1credit-memos~1pdf-status/get/responses/400/content/application~1json/example"},"paths/~1v1~1credit-memos~1pdf-status/get/responses/401/content/application~1json/example":{"value":{"message":"Authentication error"},"id":"paths/~1v1~1credit-memos~1pdf-status/get/responses/401/content/application~1json/example"},"paths/~1v1~1credit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"appliedAmount":0,"exemptAmount":10,"financeInformation":{"onAccountAccountingCode":"Check","onAccountAccountingCodeType":"Cash","salesTaxPayableAccountingCode":"Check","salesTaxPayableAccountingCodeType":"Cash"},"id":"2c98901a68ff2680016903216a271a67","jurisdiction":"Jurisdiction","locationCode":"8","name":"taxName_0","refundAmount":0,"sourceTaxItemId":null,"taxAmount":10,"taxCode":"taxCode","taxCodeDescription":"taxCodeDescription","taxDate":"2016-10-10","taxRate":0.1,"taxRateDescription":"taxRateDescription","taxRateType":"Percentage","unappliedAmount":10}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoId}~1items~1{cmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/200/content/application~1json/examples/response":{"value":{"debitMemo":{"id":"4028905f5a87c0ff015a87e49e6b0062"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoId}~1write-off/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"402890555a7e9791015a7f15fe44001c","accountNumber":"A00000001","amount":3.1,"appliedAmount":0,"autoApplyUponPosting":false,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 10:07:10","creditMemoDate":"2017-03-01","currency":"USD","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","excludeFromAutoApplyRules":false,"id":"402890555a7e9791015a879f064a0054","invoiceGroupNumber":"N-0001","latestPDFFileId":"402890555a7e9791015a879f07fb005e","number":"CM00000012","postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredInvoiceId":"402890555a7e9791015a7f1756aa0035","refundAmount":0,"reversed":false,"sequenceSetId":null,"source":"API","sourceId":null,"sourceType":"Standalone","status":"Draft","success":true,"targetDate":null,"taxAmount":0.1,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","unappliedAmount":3.1,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 10:08:43"},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad081dd91698b2801916e637b19583f","number":"CM00000008","accountId":"8ad09be48db5aba7018db604776d4854","accountNumber":"A00000097","currency":"USD","creditMemoDate":"2024-08-19","targetDate":null,"postedById":null,"postedOn":null,"status":"Draft","amount":14.99,"taxAmount":0,"totalTaxExemptAmount":0,"unappliedAmount":14.99,"refundAmount":0,"appliedAmount":0,"comment":"Details about this Credit Memo","source":"AdhocFromPrpc","sourceId":null,"referredInvoiceId":null,"reasonCode":"Ad hoc credit","createdDate":"2024-08-19 23:04:59","createdById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-19 23:05:55","updatedById":"b243314d594646d3b2651aeedd4be47e","cancelledOn":null,"cancelledById":null,"latestPDFFileId":"ac1ebc24569sd","transferredToAccounting":"No","excludeFromAutoApplyRules":true,"autoApplyUponPosting":false,"reversed":false,"taxStatus":"Complete","sourceType":"Standalone","taxMessage":null,"billToContactId":null,"billToContactSnapshotId":null,"sequenceSetId":null,"invoiceGroupNumber":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad081dd91698b2801916e5a84b65653","number":"CM00000007","accountId":"8ad09be48db5aba7018db604776d4854","accountNumber":"A00000097","currency":"USD","creditMemoDate":"2024-08-19","targetDate":null,"postedById":"8ad09fc28193c189018194da28be74ba","postedOn":"2024-08-19 22:55:11","status":"Posted","amount":14.99,"taxAmount":0,"totalTaxExemptAmount":0,"unappliedAmount":3.99,"refundAmount":0,"appliedAmount":11,"comment":"","source":"AdhocFromPrpc","sourceId":null,"referredInvoiceId":null,"reasonCode":"Ad hoc credit","createdDate":"2024-08-19 22:55:11","createdById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-19 22:59:54","updatedById":"b243314d594646d3b2651aeedd4be47e","cancelledOn":null,"cancelledById":null,"latestPDFFileId":"ac1ebc24569sd","transferredToAccounting":"No","excludeFromAutoApplyRules":true,"autoApplyUponPosting":false,"reversed":false,"taxStatus":"Complete","sourceType":"Standalone","taxMessage":null,"billToContactId":null,"billToContactSnapshotId":null,"sequenceSetId":null,"invoiceGroupNumber":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1apply/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"402890555a7e9791015a7f15fe44001c","accountNumber":"A00000001","amount":2020,"appliedAmount":0,"autoApplyUponPosting":false,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":"402881e522cf4f9b0122cf5d82860002","cancelledOn":"2017-09-03 19:59:07","comment":"the comment","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 15:31:10","creditMemoDate":"2017-10-17","currency":"USD","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","excludeFromAutoApplyRules":false,"id":"402890555a87d7f5015a88c7a6830022","invoiceGroupNumber":"N-0001","latestPDFFileId":"402890555a87d7f5015a88c7a7a2002a","number":"CM00000015","postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredInvoiceId":null,"refundAmount":0,"reversed":false,"sequenceSetId":null,"source":"AdhocFromPrpc","sourceId":null,"sourceType":"Standalone","status":"Canceled","success":true,"targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","unappliedAmount":2020,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 15:36:57"},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/200/content/application~1json/examples/response":{"value":{"fileId":"40289f466463d683016463ef8b7301a4","success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/200/content/application~1json/examples/response":{"value":{"creditMemoFiles":[{"id":"8a90a24f8e128020018e12cf610f03f9","pdfFileUrl":"/v1/files/8a90a24f8e128020018e12cf610903f8","versionNumber":1709712563443},{"id":"8a90b5148c6d127b018c6d1e3c6e022e","pdfFileUrl":"/v1/files/8a90b5148c6d127b018c6d1e3c68022d","versionNumber":1702637739555}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/200/content/application~1json/examples/response":{"value":{"items":[{"amount":1,"amountWithoutTax":0,"appliedAmount":0,"appliedToItemId":null,"comment":"","commitmentId":"4028819f9a4dfdf1019a4e04acfb7e63","commitmentPeriodId":"4028819f9a4dfdf1019a4e06f04a402c","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 10:07:10","creditFromItemId":"402880e97a56f30b017a574012e50085","creditFromItemSource":"CreditMemoItem","excludeItemBillingFromRevenueAccounting":true,"financeInformation":{"deferredRevenueAccountingCode":null,"deferredRevenueAccountingCodeType":null,"onAccountAccountingCode":null,"onAccountAccountingCodeType":null,"recognizedRevenueAccountingCode":null,"recognizedRevenueAccountingCodeType":null},"id":"402890555a7e9791015a879f064d0055","invoiceScheduleId":"402881e522cf4f9b0122cf5d82860005","invoiceScheduleItemId":"402881e522cf4f9b0122cf5d82860006","numberOfDeliveries":1,"processingType":"Charge","quantity":1,"refundAmount":0,"serviceEndDate":"2017-03-26","serviceStartDate":"2017-02-27","sku":"SKU-00000001","skuName":"New Component","soldToContactId":"402881e522cf4f9b0122cf5d82860003","soldToContactSnapshotId":"402881e522cf4f9b0122cf5d82860004","sourceItemId":"402890555a7e9791015a7f1756bc0037","sourceItemType":"InvoiceDetail","subscriptionId":"402890d25bec1155015bec35cc7c0bc7","taxMode":"TaxExclusive","taxationItems":{"data":[{"appliedAmount":0,"exemptAmount":0,"financeInformation":{"onAccountAccountingCode":"Check","onAccountAccountingCodeType":"Cash","salesTaxPayableAccountingCode":"Check","salesTaxPayableAccountingCodeType":"Cash"},"id":"402890555a7e9791015a87a072880062","jurisdiction":"CALIFORNIA","locationCode":"06","name":"STATE TAX","refundAmount":0,"sourceTaxItemId":null,"taxAmount":0.1,"taxCode":"ServiceTaxCode","taxCodeDescription":"This is tax code description!","taxDate":"2016-09-30","taxRate":0.0625,"taxRateDescription":"This is tax rate description!","taxRateType":"Percentage","unappliedAmount":0.1}]},"unappliedAmount":1,"unitOfMeasure":"Each","unitPrice":1,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 10:08:43"},{"amount":2,"amountWithoutTax":2,"appliedAmount":0,"appliedToItemId":null,"comment":"","commitmentId":"4028819f9a4dfdf1019a4e04acfb7e63","commitmentPeriodId":"4028819f9a4dfdf1019a4e06f04a402c","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 10:07:10","creditFromItemId":"402880e97a56f30b017a574012f00086","creditFromItemSource":"CreditMemoItem","excludeItemBillingFromRevenueAccounting":true,"financeInformation":{"deferredRevenueAccountingCode":null,"deferredRevenueAccountingCodeType":null,"onAccountAccountingCode":null,"onAccountAccountingCodeType":null,"recognizedRevenueAccountingCode":null,"recognizedRevenueAccountingCodeType":null},"id":"402890555a7e9791015a879f06610056","invoiceScheduleId":"402881e522cf4f9b0122cf5d82860005","invoiceScheduleItemId":"402881e522cf4f9b0122cf5d82860006","numberOfDeliveries":1,"processingType":"Charge","quantity":1,"refundAmount":0,"serviceEndDate":"2017-03-26","serviceStartDate":"2017-02-27","sku":"SKU-00000001","skuName":"New Component","soldToContactId":"402881e522cf4f9b0122cf5d82860003","soldToContactSnapshotId":"402881e522cf4f9b0122cf5d82860004","sourceItemId":"402890555a7e9791015a7f1756bd0038","sourceItemType":"InvoiceDetail","subscriptionId":"402890d25bec1155015bec35cc7c0bc7","taxMode":"TaxExclusive","taxationItems":{"data":[]},"unappliedAmount":2,"unitOfMeasure":"Each","unitPrice":2,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 10:07:10"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/200/content/application~1json/examples/response":{"value":{"amount":1,"amountWithoutTax":1,"appliedAmount":0,"appliedToItemId":null,"comment":"","commitmentId":"4028819f9a4dfdf1019a4e04acfb7e63","commitmentPeriodId":"4028819f9a4dfdf1019a4e06f04a402c","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 10:07:10","creditFromItemId":"402880e97a56f30b017a574012f00086","creditFromItemSource":"CreditMemoItem","excludeItemBillingFromRevenueAccounting":true,"financeInformation":{"deferredRevenueAccountingCode":"Check","deferredRevenueAccountingCodeType":null,"onAccountAccountingCode":null,"onAccountAccountingCodeType":null,"recognizedRevenueAccountingCode":null,"recognizedRevenueAccountingCodeType":null},"id":"402890555a7e9791015a879f064d0055","invoiceScheduleId":"402881e522cf4f9b0122cf5d82860005","invoiceScheduleItemId":"402881e522cf4f9b0122cf5d82860006","numberOfDeliveries":1,"processingType":"Charge","quantity":1,"refundAmount":0,"serviceEndDate":"2017-03-26","serviceStartDate":"2017-02-27","sku":"SKU-00000001","skuName":"New Component","soldToContactId":"402881e522cf4f9b0122cf5d82860003","soldToContactSnapshotId":"402881e522cf4f9b0122cf5d82860004","sourceItemId":"402890555a7e9791015a7f1756bc0037","sourceItemType":"InvoiceDetail","subscriptionId":"402890d25bec1155015bec35cc7c0bc7","success":true,"taxMode":"TaxExclusive","taxationItems":{"data":[]},"unappliedAmount":1,"unitOfMeasure":"Each","unitPrice":1,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 10:08:43"},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1items~1{cmitemid}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/200/content/application~1json/examples/response":{"value":{"parts":[{"amount":3.66,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-02 13:21:55","debitMemoId":null,"id":"4028905f5a890526015a8d77adea0029","invoiceId":null,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-02 13:21:55"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response":{"value":{"amount":1,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-02 14:00:21","debitMemoId":null,"id":"4028905f5a890526015a8d9adeb30059","invoiceId":"4028905f5a87c0ff015a87d3f8f10043","success":true,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-02 14:00:21"},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"402890555a7e9791015a7f15fe44001c","accountNumber":"A00000001","amount":3.1,"appliedAmount":0,"autoApplyUponPosting":false,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 10:07:10","creditMemoDate":"2017-03-01","currency":"USD","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","excludeFromAutoApplyRules":false,"id":"402890555a7e9791015a879f064a0054","invoiceGroupNumber":"N-0001","latestPDFFileId":"ac1ebc24569sd","number":"CM00000012","postedById":"402881e522cf4f9b0122cf5d82860002","postedOn":"2017-03-01 14:28:06","reasonCode":"Correcting invoice error","referredInvoiceId":"402890555a7e9791015a7f1756aa0035","refundAmount":0,"reversed":false,"sequenceSetId":null,"source":"API","sourceId":null,"sourceType":"Standalone","status":"Posted","success":true,"targetDate":null,"taxAmount":0.1,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","unappliedAmount":3.1,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 14:28:06"},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad0937890e7fca00190e8c290d46fad","number":"R-00000001","status":"Processed","type":"Electronic","methodType":"CreditCard","accountId":"8ad09be48db5aba7018db604776d4854","amount":10,"refundDate":"2024-07-25","comment":null,"paymentMethodId":"8ad084db90a5e73b0190c02783f552fa","paymentMethodSnapshotId":"8ad0937890e7fca00190e8c290b86fab","paymentId":null,"paymentNumber":null,"creditMemoId":"8ad0835290c4bb2f0190d9955e414e62","reasonCode":null,"gatewayId":"2c92c0f972bc6aa90172bc77ccaf379a","paymentGatewayNumber":null,"gatewayResponse":"This transaction has been approved by Test gateway.","gatewayResponseCode":"approve","gatewayState":"Submitted","markedForSubmissionOn":null,"referenceId":"70028533","secondRefundReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":"2024-07-25 00:19:43","settledOn":null,"cancelledOn":null,"createdDate":"2024-07-25 00:19:43","createdById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-07-25 00:19:43","updatedById":"b243314d594646d3b2651aeedd4be47e","refundTransactionTime":"2024-07-25 00:19:43","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":"Accounts Receivable","unappliedPaymentAccountingCodeType":"AccountsReceivable","transferredToAccounting":"No"},"gatewayReconciliationStatus":null,"gatewayReconciliationReason":null,"payoutId":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1refund/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/200/content/application~1json/examples/response":{"value":{"debitMemo":{"id":"402890555a40ca7f015a5b099b0e307a"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1reverse/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response":{"value":{"taxationItems":[{"createdById":"8ad084a67f9c7138017fab8a8b511b5a","createdDate":"2024-11-15 14:41:04","exemptAmount":0,"id":"8ad0980c932a209d01932e8dcbf83bc8","memoItemId":"8ad086fa932a0b5401932e82ab1f1fb3","invoiceItemId":"8ad086fa932a0b5401932e82a3e5b211","sourceTaxItemId":null,"jurisdiction":"CALIFORNIA","locationCode":null,"name":"STATE TAX","taxAmount":0.5,"applicableTaxUnRounded":0.5,"country":null,"taxCode":"ServiceTaxCode","taxCodeDescription":null,"taxDate":"2024-11-15","taxRate":0.05,"taxMode":"TaxExclusive","taxRateDescription":null,"taxRateType":"Percentage","updatedById":"8ad084a67f9c7138017fab8a8b511b5a","updatedDate":"2024-11-15 14:41:04","financeInformation":{"salesTaxPayableAccountingCode":"Sales Tax Payable","salesTaxPayableAccountingCodeType":"SalesTaxPayable","accountsReceivableAccountingCode":"Accounts Receivable","accountsReceivableAccountingCodeType":"AccountsReceivable"}}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90aac892dc8c3a0192dce41af10077","number":"CM00000619","accountId":"8a90b4488e7d5c0f018e7db3892400b2","accountNumber":"A00000370","currency":"USD","creditMemoDate":"2024-10-30","targetDate":null,"postedById":"2c92c8f95e2d6ebb015e325df48e02da","postedOn":"2024-10-30 18:06:30","status":"Posted","amount":15,"taxAmount":0,"totalTaxExemptAmount":0,"unappliedAmount":1,"refundAmount":0,"appliedAmount":14,"comment":"","source":"AdhocFromInvoice","sourceId":null,"referredInvoiceId":"8a90d7a892d82d920192dbcb314501c7","reasonCode":"Correcting invoice error","createdDate":"2024-10-30 18:06:29","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-10-30 18:08:37","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","cancelledOn":null,"cancelledById":null,"latestPDFFileId":null,"transferredToAccounting":"No","excludeFromAutoApplyRules":false,"autoApplyUponPosting":false,"reversed":false,"taxStatus":"Complete","sourceType":"Invoice","eInvoiceStatus":"Failed","eInvoiceErrorCode":"IntegrationError","eInvoiceErrorMessage":"Input string was null.","eInvoiceFileId":null,"taxMessage":null,"billToContactId":null,"billToContactSnapshotId":"8a90b4488e7d5c0f018e7dbef1f900c9","sequenceSetId":null,"invoiceGroupNumber":null,"revenueImpacting":"Yes","success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"402890555a7e9791015a7f15fe44001c","accountNumber":"A00000001","amount":3.1,"appliedAmount":0,"autoApplyUponPosting":false,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 10:07:10","creditMemoDate":"2017-03-01","currency":"USD","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","excludeFromAutoApplyRules":false,"id":"402890555a7e9791015a879f064a0054","invoiceGroupNumber":"N-0001","latestPDFFileId":"ac1ebc24569sd","number":"CM00000012","postedById":"402881e522cf4f9b0122cf5d82860002","postedOn":"2017-03-01 14:28:06","reasonCode":"Correcting invoice error","referredInvoiceId":"402890555a7e9791015a7f1756aa0035","refundAmount":0,"reversed":false,"sequenceSetId":null,"source":"API","sourceId":null,"sourceType":"Standalone","status":"Draft","success":true,"targetDate":null,"taxAmount":0.1,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","unappliedAmount":3.1,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 14:28:06"},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90e4a792d82d8c0192dbda90671d66","number":"CM00000618","accountId":"8a90b4488e7d5c0f018e7db3892400b2","accountNumber":"A00000370","currency":"USD","creditMemoDate":"2024-10-30","targetDate":null,"postedById":null,"postedOn":null,"status":"Draft","amount":10,"taxAmount":0,"totalTaxExemptAmount":0,"unappliedAmount":10,"refundAmount":0,"appliedAmount":0,"comment":null,"source":"AdhocFromInvoice","sourceId":null,"referredInvoiceId":"8a90d7a892d82d920192dbcb314501c7","reasonCode":"Correcting invoice error","createdDate":"2024-10-30 13:16:27","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-10-30 13:16:27","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","cancelledOn":null,"cancelledById":null,"latestPDFFileId":null,"transferredToAccounting":"No","excludeFromAutoApplyRules":false,"autoApplyUponPosting":false,"reversed":false,"taxStatus":"Complete","sourceType":"Invoice","eInvoiceStatus":null,"eInvoiceErrorCode":null,"eInvoiceErrorMessage":null,"eInvoiceFileId":null,"taxMessage":null,"billToContactId":null,"billToContactSnapshotId":null,"sequenceSetId":null,"invoiceGroupNumber":null,"revenueImpacting":"Yes","success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/200/content/application~1json/example":{"value":{"id":"8a92ade496140e830196148cd0af000a","status":"Processed","operationType":"AsyncCreditMemoUnapply","referenceId":"4028905f5a890526015a8d73f73d0015","referenceType":"CreditMemo","error":null,"success":true},"id":"paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/200/content/application~1json/example"},"paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1unapply-async-jobs~1{unapplyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/200/content/application~1json/example":{"value":{"id":"8a92ade496140e830196141f6cfa0001","status":"Processed","operationType":"AsyncCreditMemoApply","referenceId":"4028905f5a890526015a8d73f73d0015","referenceType":"CreditMemo","error":null,"success":true},"id":"paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/200/content/application~1json/example"},"paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1apply-async-jobs~1{applyAsyncJobId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/200/content/application~1json/example":{"value":{"id":"402881e522cf4f9b0122cf5d82860002","status":"Pending","operationType":"AsyncCreditMemoApply","referenceId":"4028905f5a890526015a8d73f73d0015","referenceType":"CreditMemo","error":null,"success":true},"id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/200/content/application~1json/example"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1apply-async/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/200/content/application~1json/example":{"value":{"id":"8a92ade496140e830196148cd0af000a","status":"Pending","operationType":"AsyncCreditMemoUnapply","referenceId":"8a8082e65b27f6c3015ba45ff82c7172","referenceType":"CreditMemo","error":null,"success":true},"id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/200/content/application~1json/example"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1unapply-async/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos/get/responses/200/content/application~1json/examples/response":{"value":{"debitmemos":[{"accountId":"402890555a7e9791015a7f15fe44001c","accountNumber":"AN_1679649466484","amount":50,"autoPay":true,"balance":50,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"the comment","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 17:24:14","currency":"USD","debitMemoDate":"2017-10-17","dueDate":"2017-11-16","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"402890555a87d7f5015a892f2ba10057","invoiceGroupNumber":"N-0001","latestPDFFileId":"402890555a87d7f5015a892f2c5c0060","number":"DM00000006","paymentTerm":null,"postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredInvoiceId":null,"sequenceSetId":null,"sourceType":"Standalone","status":"Draft","targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 17:24:14"},{"accountId":"402890555a7d4022015a7dabf5f60088","accountNumber":"AN_1679649466488","amount":0.01,"autoPay":true,"balance":0.01,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"the comment","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 17:13:15","currency":"USD","debitMemoDate":"2017-11-30","dueDate":"2017-12-30","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"402890555a87d7f5015a89251edc0045","invoiceGroupNumber":"N-0001","latestPDFFileId":"ac1ebc24569sd","number":"DM00000003","paymentTerm":null,"postedById":null,"postedOn":null,"reasonCode":"Charge Dispute","referredInvoiceId":"402890555a7d4022015a7dadb3b300a4","sequenceSetId":null,"sourceType":"Standalone","status":"Draft","targetDate":null,"taxAmount":0.01,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 17:13:15"},{"accountId":"402890555a7d4022015a7dabf5f60088","accountNumber":"AN_1679649466488","amount":9,"autoPay":true,"balance":9,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 17:01:00","currency":"USD","debitMemoDate":"2017-03-01","dueDate":"2017-03-31","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"402890555a87d7f5015a8919e4fe002e","invoiceGroupNumber":"N-0001","latestPDFFileId":"402890555a87d7f5015a8919e95d003a","number":"DM00000002","paymentTerm":null,"postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredCreditMemoId":"1a2b3c4d5e6f","referredInvoiceId":"402890555a7d4022015a7dadb3b300a4","sequenceSetId":null,"sourceType":"Standalone","status":"Draft","targetDate":null,"taxAmount":8,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 17:01:00"},{"accountId":"402890555a7e9791015a7f15fe44001c","accountNumber":"AN_1679649466684","amount":8.02,"autoPay":true,"balance":8.02,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 10:26:16","currency":"USD","debitMemoDate":"2017-03-01","dueDate":"2017-03-31","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"402890555a7e9791015a87b082940067","invoiceGroupNumber":"N-0001","latestPDFFileId":"402890555a7e9791015a87b083f00072","number":"DM00000001","paymentTerm":null,"postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredCreditMemoId":"1a2b3c4d5e6f","referredInvoiceId":"402890555a7e9791015a7f1756aa0035","sequenceSetId":null,"sourceType":"Standalone","status":"Draft","targetDate":null,"taxAmount":0.02,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 10:45:03"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad093789169a0c001916e6be7cf7113","number":"DM00000002","accountId":"8ad09be48db5aba7018db604776d4854","accountNumber":"A00000097","debitMemoDate":"2024-08-19","currency":"USD","targetDate":null,"dueDate":"2024-09-18","postedOn":null,"postedById":null,"status":"Draft","amount":10,"taxAmount":0,"totalTaxExemptAmount":0,"balance":10,"beAppliedAmount":0,"autoPay":true,"comment":null,"referredInvoiceId":null,"transferredToAccounting":"No","reasonCode":"Correcting invoice error","createdDate":"2024-08-19 23:14:11","createdById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-08-19 23:14:11","updatedById":"b243314d594646d3b2651aeedd4be47e","cancelledOn":null,"cancelledById":null,"referredCreditMemoId":"1a2b3c4d5e6f","latestPDFFileId":"ac1ebc24569sd","taxStatus":"Complete","sourceType":"Standalone","taxMessage":null,"billToContactId":null,"billToContactSnapshotId":null,"paymentTerm":null,"sequenceSetId":null,"invoiceGroupNumber":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1bulk/post/responses/200/content/application~1json/examples/response":{"value":{"memos":[{"accountId":"4028ab1f87121698018712fef63e33cb","accountNumber":"AN_Test11679650911374","amount":100,"autoPay":true,"balance":100,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"This is a comment","createdById":"3e2bcd869cea43eeb00d7a20cc1cb72b","createdDate":"2023-03-24 15:12:01","currency":"USD","debitMemoDate":"2023-03-24","dueDate":"2023-03-24","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"4028ab1f87121698018712ff1b0633e2","invoiceGroupNumber":"N-0001","latestPDFFileId":"ac1ebc24569sd","number":"DM00000001","organizationLabel":"MS US","paymentTerm":null,"postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredCreditMemoId":"1a2b3c4d5e6f","referredInvoiceId":null,"sequenceSetId":null,"sourceType":"Standalone","status":"Draft","success":true,"targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"3e2bcd869cea43eeb00d7a20cc1cb72b","updatedDate":"2023-03-24 15:12:01"},{"objectIndex":1,"processId":"0356073CB721291A","reasons":[{"code":50000040,"message":"Cannot find a Invoice instance with id test."}],"success":false}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1bulk/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1bulk/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1bulk/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1bulk/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1bulk/put/responses/200/content/application~1json/examples/response":{"value":{"memos":[{"accountId":"4028ab1f87121698018726851cc765ee","accountNumber":"AN_Test11679978470016","amount":100,"autoPay":true,"balance":100,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"new comment123","createdById":"aff81dbb5dd846868685592640363b5b","createdDate":"2023-03-28 10:11:45","currency":"USD","debitMemoDate":"2023-03-27","dueDate":"2023-03-27","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"4028ab1f8712169801872685a5f46605","invoiceGroupNumber":"N-0001","latestPDFFileId":"ac1ebc24569sd","number":"DM00000001","organizationLabel":"MS US","paymentTerm":null,"postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredCreditMemoId":"1a2b3c4d5e6f","referredInvoiceId":null,"sequenceSetId":null,"sourceType":"Standalone","status":"Draft","success":true,"targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"aff81dbb5dd846868685592640363b5b","updatedDate":"2023-03-28 10:12:37"},{"id":"2c98907562482a8301624b9c0a1a0056","objectIndex":1,"processId":"string","reasons":[{"code":"string","message":"string"}],"success":false}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1bulk/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1bulk/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1bulk/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1bulk/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1pdf-status/get/responses/200/content/application~1json/example":{"value":{"debitMemoFiles":[{"debitMemoId":"402824aa8cc894d5018cc8a120576881","debitMemoNumber":"DM00000003","pdfGenerationStatus":"Generated","createdOn":"2024-01-01 11:32:19","updatedOn":"2024-01-01 11:32:19","pdfFileUrl":"/v1/files/2c98901f62d7d83d0162d7facea6262d"},{"debitMemoId":"2c98908a904dfc2601904e6e14090241","debitMemoNumber":"DM00000004","pdfGenerationStatus":"Error","createdOn":"2024-01-02 10:14:13","updatedOn":"2024-01-02 10:14:13","errorCode":"INVALID_TEMPLATE","errorMessage":"Unknown merge filed chargeNumber__c"},{"debitMemoId":"623935cc6ee105f7341ee1d453809214","debitMemoNumber":"DM00000005","pdfGenerationStatus":"Pending","createdOn":"2024-01-01 11:35:56","updatedOn":"2024-01-01 11:35:56"}],"success":true},"id":"paths/~1v1~1debit-memos~1pdf-status/get/responses/200/content/application~1json/example"},"paths/~1v1~1debit-memos~1pdf-status/get/responses/400/content/application~1json/example":{"value":{"processId":"processId","reasons":[{"code":"50000020","message":"Credit memo key is required"}],"success":false},"id":"paths/~1v1~1debit-memos~1pdf-status/get/responses/400/content/application~1json/example"},"paths/~1v1~1debit-memos~1pdf-status/get/responses/401/content/application~1json/example":{"value":{"message":"Authentication error"},"id":"paths/~1v1~1debit-memos~1pdf-status/get/responses/401/content/application~1json/example"},"paths/~1v1~1debit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1pdf-status/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1pdf-status/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/200/content/application~1json/examples/response":{"value":{"applicationParts":[{"appliedAmount":22,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2018-01-02 11:42:16","creditMemoId":"4028905f60a165a50160b4f632ff023d","paymentId":null,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2018-01-02 11:42:16"},{"appliedAmount":11,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2018-01-02 11:41:38","creditMemoId":null,"paymentId":"4028905f60a165a50160b4f5d5cb0229","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2018-01-02 11:41:38"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoId}~1application-parts/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"balance":10,"creditAmount":0,"exemptAmount":10,"financeInformation":{"salesTaxPayableAccountingCode":"Check","salesTaxPayableAccountingCodeType":"Cash"},"id":"402883836904567d01690530df760231","jurisdiction":"Jurisdiction","locationCode":"8","name":"taxName_0","paymentAmount":0,"sourceTaxItemId":null,"taxAmount":10,"taxCode":"taxCode","taxCodeDescription":"taxCodeDescription","taxDate":"2016-10-10","taxRate":0.1,"taxRateDescription":"taxRateDescription","taxRateType":"Percentage"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoId}~1items~1{dmitemid}~1taxation-items/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028ab1f87121698018722ff25be58a1","accountNumber":"AN_Test11679919358984","amount":100,"autoPay":true,"balance":100,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"This is a comment","createdById":"0124a1a5d0f84d4288d875fc3b34b1e1","createdDate":"2023-03-27 17:46:01","currency":"USD","debitMemoDate":"2023-03-27","dueDate":"2023-03-27","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"4028ab1f87121698018722ff2bff58b8","invoiceGroupNumber":"N-0001","latestPDFFileId":"ac1ebc24569sd","number":"DM00000001","organizationLabel":"MS US","paymentTerm":null,"postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredCreditMemoId":"1a2b3c4d5e6f","referredInvoiceId":null,"sequenceSetId":null,"sourceType":"Standalone","status":"Draft","success":true,"targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"0124a1a5d0f84d4288d875fc3b34b1e1","updatedDate":"2023-03-27 17:46:01"},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028ab1f87121698018722f82d133fe4","accountNumber":"AN_Test11679918902100","amount":100,"autoPay":true,"balance":100,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"Details about this Debit Memo","createdById":"97e12d40f0ab4418a95a93118b272fb6","createdDate":"2023-03-27 17:38:24","currency":"USD","debitMemoDate":"2023-03-27","dueDate":"2023-03-27","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"4028ab1f87121698018722f8335b3ffb","invoiceGroupNumber":"N-0001","latestPDFFileId":"ac1ebc24569sd","number":"DM00000001","organizationLabel":"MS US","paymentTerm":null,"postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredCreditMemoId":"1a2b3c4d5e6f","referredInvoiceId":null,"sequenceSetId":null,"sourceType":"Standalone","status":"Draft","success":true,"targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"97e12d40f0ab4418a95a93118b272fb6","updatedDate":"2023-03-27 17:38:27"},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028ab1f87121698018722fd2e705066","accountNumber":"AN_Test11679919230033","amount":100,"autoPay":true,"balance":100,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":"bc0211e8ca1440eb97a0aff808f87293","cancelledOn":"2023-03-27 17:43:59","comment":"This is a comment","createdById":"bc0211e8ca1440eb97a0aff808f87293","createdDate":"2023-03-27 17:43:52","currency":"USD","debitMemoDate":"2023-03-27","dueDate":"2023-03-27","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"4028ab1f87121698018722fd34c6507d","invoiceGroupNumber":"N-0001","latestPDFFileId":"4028ab1f87121698018722fd39fe5087","number":"DM00000001","organizationLabel":"MS US","paymentTerm":null,"postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredCreditMemoId":"1a2b3c4d5e6f","referredInvoiceId":null,"sequenceSetId":null,"sourceType":"Standalone","status":"Canceled","success":true,"targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"bc0211e8ca1440eb97a0aff808f87293","updatedDate":"2023-03-27 17:43:59"},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/200/content/application~1json/examples/response":{"value":{"debitMemo":{"id":"8ad0912492f64b9001931936cac36351","number":"DM00000001"},"appliedCreditMemos":[],"appliedPayments":[],"processedPayment":{"id":"8ad0869992f632860193249dfe1a0ead","number":"P-00001541","status":"Processed","amount":10,"paymentMethodId":"8ad09bce83f1da020183f97e24821c4b","gatewayId":"8ad095dd813e750f0181461a8e350ce7","gatewayResponse":"This transaction has been approved by the gateway.","gatewayResponseCode":"approve"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1collect/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1emails/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/200/content/application~1json/examples/response":{"value":{"fileId":"40289f466463d683016463ef8b7301a3","success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/200/content/application~1json/examples/response":{"value":{"debitMemoFiles":[{"id":"8a90a24f8e128020018e12ebcd010470","pdfFileUrl":"/v1/files/8a90a24f8e128020018e12ebccfa046f","versionNumber":1709714426109},{"id":"8a90b5148c6d127b018c6d1e46160230","pdfFileUrl":"/v1/files/8a90b5148c6d127b018c6d1e4610022f","versionNumber":1702637741618}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1files/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/200/content/application~1json/examples/response":{"value":{"items":[{"amount":1,"amountWithoutTax":1,"appliedToItemId":"402890555a7d4022015a2dadb3b700a6","balance":1,"beAppliedAmount":0,"comment":"This is comment!","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 17:13:15","excludeItemBillingFromRevenueAccounting":true,"financeInformation":{"deferredRevenueAccountingCode":"Subscription Revenue","deferredRevenueAccountingCodeType":"SalesRevenue","recognizedRevenueAccountingCode":"Subscription Revenue","recognizedRevenueAccountingCodeType":"SalesRevenue"},"id":"402890555a87d7f5015a89251ede0046","processingType":"Charge","quantity":1,"serviceEndDate":"2017-11-30","serviceStartDate":"2017-11-01","sku":"SKU-00000002","skuName":"SKU-30","soldToContactId":"402881e522cf4f9b0122cf5d82860003","soldToContactSnapshotId":"402881e522cf4f9b0122cf5d82860004","sourceItemId":"402890555a7d4022015a7dadb3b700a6","sourceItemType":"InvoiceDetail","subscriptionId":null,"taxMode":"TaxExclusive","taxationItems":{"data":[{"balance":0.01,"creditAmount":0,"exemptAmount":0,"financeInformation":{"salesTaxPayableAccountingCode":"Check","salesTaxPayableAccountingCodeType":"Cash"},"id":"402890555a87d7f5015a89251ef10047","jurisdiction":"CALIFORNIA","locationCode":"06","name":"STATE TAX","paymentAmount":0,"sourceTaxItemId":"402890555a7d4022015a7dadb39b00a1","taxAmount":0.01,"taxCode":"ZtaxCode","taxCodeDescription":"","taxDate":"2017-11-30","taxRate":0.0625,"taxRateDescription":"This is tax rate description!","taxRateType":"Percentage"}]},"unitOfMeasure":"Each","unitPrice":1,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 17:13:15"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1items/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/200/content/application~1json/examples/response":{"value":{"amount":1,"amountWithoutTax":1,"appliedToItemId":"402890555a7d4022015a2dadb3b700a6","balance":1,"beAppliedAmount":0,"comment":"aa","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 17:01:00","excludeItemBillingFromRevenueAccounting":true,"financeInformation":{"deferredRevenueAccountingCode":"Subscription Revenue","deferredRevenueAccountingCodeType":"SalesRevenue","recognizedRevenueAccountingCode":"Subscription Revenue","recognizedRevenueAccountingCodeType":"SalesRevenue"},"id":"402890555a87d7f5015a8919e500002f","processingType":"Charge","quantity":1,"serviceEndDate":"2017-03-26","serviceStartDate":"2017-02-27","sku":"SKU-00000002","skuName":"ZTax Component","soldToContactId":"402881e522cf4f9b0122cf5d82860003","soldToContactSnapshotId":"402881e522cf4f9b0122cf5d82860004","sourceItemId":"402890555a7d4022015a7dadb3b700a6","sourceItemType":"InvoiceDetail","subscriptionId":null,"success":true,"taxMode":"TaxExclusive","taxationItems":{"data":[{"balance":5,"creditAmount":0,"exemptAmount":0,"financeInformation":{"salesTaxPayableAccountingCode":"Check","salesTaxPayableAccountingCodeType":"Cash"},"id":"402890555a87d7f5015a8919e8450031","jurisdiction":"USA","locationCode":"","name":"my tax","paymentAmount":0,"sourceTaxItemId":"402890555a7d4022015a7dadb39b00a1","taxAmount":5,"taxCode":"ZtaxCode","taxCodeDescription":"","taxDate":"2017-02-27","taxRate":5,"taxRateDescription":"desc3","taxRateType":"FlatFee"}]},"unitOfMeasure":"Each","unitPrice":1,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 17:01:00"},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1items~1{dmitemid}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1pdfs/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028ab1f87121698018722fa86dc4823","accountNumber":"AN_Test11679919056161","amount":100,"autoPay":true,"balance":100,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"This is a comment","createdById":"e758a64e80f54439913241f9aa537127","createdDate":"2023-03-27 17:40:58","currency":"USD","debitMemoDate":"2023-03-27","dueDate":"2023-03-27","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"4028ab1f87121698018722fa8d73483a","invoiceGroupNumber":"N-0001","latestPDFFileId":"ac1ebc24569sd","number":"DM00000001","organizationLabel":"MS US","paymentTerm":null,"postedById":"e758a64e80f54439913241f9aa537127","postedOn":"2023-03-27 17:41:03","reasonCode":"Correcting invoice error","referredCreditMemoId":"1a2b3c4d5e6f","referredInvoiceId":null,"sequenceSetId":null,"sourceType":"Standalone","status":"Posted","success":true,"targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"e758a64e80f54439913241f9aa537127","updatedDate":"2023-03-27 17:41:03"},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1post/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response":{"value":{"taxationItems":[{"createdById":"8ad084a67f9c7138017fab8a8b511b5a","createdDate":"2024-11-18 11:32:56","exemptAmount":0,"id":"8ad0980c93300db701933d549f355262","memoItemId":"8ad093f793300daf01933d50a548781f","invoiceItemId":null,"sourceTaxItemId":null,"jurisdiction":"CALIFORNIA","locationCode":null,"name":"STATE TAX","taxAmount":0.5,"applicableTaxUnRounded":0.5,"country":null,"taxCode":"ServiceTaxCode","taxCodeDescription":null,"taxDate":"2024-11-18","taxRate":0.05,"taxMode":"TaxExclusive","taxRateDescription":null,"taxRateType":"Percentage","updatedById":"8ad084a67f9c7138017fab8a8b511b5a","updatedDate":"2024-11-18 11:32:56","financeInformation":{"onAccountAccountingCode":null,"onAccountAccountingCodeType":null,"salesTaxPayableAccountingCode":"Sales Tax Payable","salesTaxPayableAccountingCodeType":"SalesTaxPayable","accountsReceivableAccountingCode":"Accounts Receivable","accountsReceivableAccountingCodeType":"AccountsReceivable"}}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1taxation-items/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028ab1f87121698018722f3af193744","accountNumber":"AN_Test11679918607694","amount":100,"autoPay":true,"balance":100,"beAppliedAmount":0,"billToContactId":null,"billToContactSnapshotId":null,"cancelledById":null,"cancelledOn":null,"comment":"This is a comment","createdById":"c24f12918d5b45d0b7f9da297b8b7a9d","createdDate":"2023-03-27 17:33:29","currency":"USD","debitMemoDate":"2023-03-27","dueDate":"2023-03-27","einvoiceErrorCode":null,"einvoiceErrorMessage":null,"einvoiceFileId":null,"einvoiceStatus":"Processing","id":"4028ab1f87121698018722f3b60c375b","invoiceGroupNumber":"N-0001","latestPDFFileId":"4028ab1f87121698018722f3bb0b376b","number":"DM00000001","organizationLabel":"MS US","paymentTerm":null,"postedById":null,"postedOn":null,"reasonCode":"Correcting invoice error","referredCreditMemoId":"1a2b3c4d5e6f","referredInvoiceId":null,"sequenceSetId":null,"sourceType":"Standalone","status":"Draft","success":true,"targetDate":null,"taxAmount":0,"taxMessage":null,"taxStatus":"Complete","totalTaxExemptAmount":0,"transferredToAccounting":"No","updatedById":"c24f12918d5b45d0b7f9da297b8b7a9d","updatedDate":"2023-03-27 17:33:42"},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1unpost/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90a19d9310bb3c0193197cb4700501","number":"DM00000045","accountId":"8a90b4488e7d5c0f018e7db3892400b2","accountNumber":"A00000370","debitMemoDate":"2024-11-11","currency":"USD","targetDate":null,"dueDate":"2024-12-11","postedOn":null,"postedById":null,"status":"Draft","amount":10,"taxAmount":0,"totalTaxExemptAmount":0,"balance":10,"beAppliedAmount":0,"autoPay":true,"comment":null,"referredInvoiceId":"8a90cc5c9301541f01930186636b1400","transferredToAccounting":false,"reasonCode":"Correcting invoice error","createdDate":"2024-11-11 12:30:23","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-11-11 12:30:23","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","cancelledOn":null,"cancelledById":null,"referredCreditMemoId":null,"latestPDFFileId":null,"taxStatus":null,"sourceType":"Invoice","taxMessage":null,"billToContactId":"8a90b4488e7d5c0f018e7db3896100b4","billToContactSnapshotId":null,"soldToContactId":null,"soldToContactSnapshotId":null,"paymentTerm":"Net 30","eInvoiceStatus":null,"eInvoiceErrorCode":null,"eInvoiceErrorMessage":null,"eInvoiceFileId":null,"sequenceSetId":"acd16fac492111e9a0d70cc47a32b062","invoiceGroupNumber":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1invoice~1{invoiceKey}/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/200/content/application~1json/examples/response":{"value":{"creditMemo":{"id":"402890555a40ca7f015a5b099b0e307a"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1write-off/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers/get/responses/200/content/application~1json/examples/response":{"value":{"serviceProviders":[{"id":"4028948972a2bf990172bc9b27724eef","name":"Sovos e-invoice service","provider":"Sovos","serviceProviderNumber":"EISP-00000001","test":"false","companyIdentifier":"CompanySample1"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers/post/responses/200/content/application~1json/examples/response":{"value":{"id":"4028948972a2bf990172bc9b27724eef","name":"Sovos e-invoice service","provider":"Sovos","serviceProviderNumber":"EISP-00000001","test":"false","companyIdentifier":"CompanySample1","apiKey":"SampleApiKey","use_certificate":false,"clientCertificate":"U3dhZ2dlciByb2Nrcw==","clientCertificateType":"PKCS12"},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers~1{key}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"4028948972a2bf990172bc9b27724eef","name":"Sovos e-invoice service","provider":"Sovos","serviceProviderNumber":"EISP-00000001","test":"false","companyIdentifier":"CompanySample1"},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers~1{key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/200/content/application~1json/examples/response":{"value":{"id":"4028948972a2bf990172bc9b27724eef","name":"Sovos e-invoice service","provider":"Sovos","serviceProviderNumber":"EISP-00000001","test":"true","companyIdentifier":"CompanySample1","apiKey":"SampleApiKey","use_certificate":false,"clientCertificate":"U3dhZ2dlciByb2Nrcw==","clientCertificateType":"PKCS12"},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1service-providers~1{key}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions/get/responses/200/content/application~1json/examples/response":{"value":{"regions":[{"id":"8ad083528ee62fe1018eea6c5dd11e01","country":"AU","businessName":"Avalara Inc.","businessNumber":"74004085818","businessNumberSchemeId":"0151","tradeName":"Test trade","endpointId":"74004085818","endpointSchemeId":"0151","taxRegisterNumber":"1577240348","state":"","city":"","postalCode":"","addressLine1":"","addressLine2":"","contactName":"","phoneNumber":"","email":"","serviceProviderId":"8ad093788ea359ca018ea75fb12a6348","businessRegionNumber":"EIBR-00000010","digitalSignatureEnable":false,"digitalSignatureBoxEnable":false,"digitalSignatureBoxPosX":0,"digitalSignatureBoxPosY":0,"responseMapping":"{}","processType":"PEPPOLNetwork","invoiceEnabled":true,"creditMemoEnabled":true,"debitMemoEnabled":true,"invoiceFilters":null,"creditMemoFilters":null,"debitMemoFilters":null,"fileFormat":{"B2B":["XML"],"B2C":[""],"B2G":["XML"]}},{"id":"8ad081dd8f7c5447018f7fdff3a75823","country":"BR","businessName":"Seller business name","businessNumber":"02593165000140","businessNumberSchemeId":"","tradeName":"Seller trade name","endpointId":"Seller end point id 08992","endpointSchemeId":"099","taxRegisterNumber":"TAX393982838","state":"","city":"","postalCode":"1","addressLine1":"","addressLine2":"","contactName":"","phoneNumber":"","email":"","serviceProviderId":"8ad097b4905a5adf01907433df216e37","businessRegionNumber":"EIBR-00000012","digitalSignatureEnable":false,"digitalSignatureBoxEnable":false,"digitalSignatureBoxPosX":0,"digitalSignatureBoxPosY":0,"responseMapping":{},"processType":"ClearanceWithCancellation","invoiceEnabled":true,"creditMemoEnabled":false,"debitMemoEnabled":false,"invoiceFilters":null,"creditMemoFilters":null,"debitMemoFilters":null,"fileFormat":null}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions/post/responses/200/content/application~1json/examples/response":{"value":{"addressLine1":"","addressLine2":"","businessName":"legal business name","businessNumber":"20002039","businessNumberSchemaId":"88","businessRegionNumber":"EIBR-00000002","city":"Tokyo","contactName":"","country":"JP","digitalSignatureEnable":false,"digitalSignatureBoxEnable":false,"digitalSignatureBoxPosX":0,"digitalSignatureBoxPosY":0,"email":"","id":"4028b2aa8890c524018890c7e9ef3826","invoiceFilters":[{"objectType":"Invoice","condition":{"field":"SoldToContact.Country","operator":"eq","value":"India"}}],"phoneNumber":"","postalCode":"368779","responseMapping":{},"serviceProviderId":"4028948972a2bf990172bc9b27724ddc","state":"","taxRegisterNumber":"TAX393999","tradeName":"Zuora","fileFormat":{"B2B":["XML"],"B2C":[""],"B2G":["XML"]}},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response":{"value":[{"id":"8ad083528ee62fe1018eea6c5dd11e01","country":"AU","businessName":"Avalara Inc.","businessNumber":"74004085818","businessNumberSchemeId":"0151","tradeName":"Test trade","endpointId":"74004085818","endpointSchemeId":"0151","taxRegisterNumber":"1577240348","state":"","city":"","postalCode":"","addressLine1":"","addressLine2":"","contactName":"","phoneNumber":"","email":"","serviceProviderId":"8ad093788ea359ca018ea75fb12a6348","businessRegionNumber":"EIBR-00000010","digitalSignatureEnable":"false","digitalSignatureBoxEnable":"false","digitalSignatureBoxPosX":"0","digitalSignatureBoxPosY":"0","responseMapping":"{}","processType":"PEPPOLNetwork","invoiceEnabled":"true","creditMemoEnabled":"true","debitMemoEnabled":"true","invoiceFilters":"null","creditMemoFilters":"null","debitMemoFilters":"null","fileFormat":{"B2B":["XML"],"B2C":[""],"B2G":["XML"]}}],"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response":{"value":{"addressLine1":null,"addressLine2":null,"businessName":"legal business name","businessNumber":"20002039","businessNumberSchemaId":"88","businessRegionNumber":"EIBR-00000002","city":"Tokyo","contactName":null,"country":"JP","digitalSignatureEnable":false,"digitalSignatureBoxEnable":false,"digitalSignatureBoxPosX":0,"digitalSignatureBoxPosY":0,"email":null,"endpointId":"8992","endpointSchemeId":"88","phoneNumber":null,"postalCode":"368779","responseMapping":{},"serviceProviderId":"4028948972a2bf990172bc9b27724ddc","state":null,"taxRegisterNumber":"TAX393999","tradeName":"Zuora","fileFormat":{"B2B":["XML"],"B2C":[""],"B2G":["XML"]}},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Success":{"value":{"data":[{"countryCode":"AU","fileFormats":["OASIS_UBL_XML","XML"],"category":"B2B","processType":"PEPPOLNetwork","defaultFileFormats":"null"},{"countryCode":"AU","fileFormats":["OASIS_UBL_XML","XML"],"category":"B2G","processType":"PEPPOLNetwork","defaultFileFormats":"null"}],"success":true},"key":"Success","summary":"Success","id":"paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Validation Error#1":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"Mandate details are available only if Avalara is Integrated as service provider"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#1","summary":"Validation Error#1","id":"paths/~1v1~1e-invoice~1mandates/get/responses/200/content/application~1json/examples/Validation Error#1"},"paths/~1v1~1e-invoice~1mandates/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-invoice~1mandates/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-invoice~1mandates/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-invoice~1mandates/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success":{"value":{"countryCode":"AU","fileFormats":["XML","OASIS_UBL_XM"],"category":"B2G","defaultFileFormats":["XML"],"processType":"PEPPOLNetwork","success":true},"key":"Success","summary":"Success","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"E-Invoice for the document [<document-key>] is not submitted to Avalara and hence this request cannot be accepted"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#1","summary":"Validation Error#1","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success":{"value":{"countryCode":"AU","fileFormats":["XML","OASIS_UBL_XML"],"category":"B2G","defaultFileFormats":["XML"],"processType":"PEPPOLNetwork","success":true},"key":"Success","summary":"Success","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"E-Invoice for the document [<document-key>] is not submitted to Avalara and hence this request cannot be accepted"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#1","summary":"Validation Error#1","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success":{"value":{"countryCode":"AU","fileFormats":["XML","OASIS_UBL_XML"],"category":"B2G","defaultFileFormats":["XML"],"processType":"PEPPOLNetwork","success":true},"key":"Success","summary":"Success","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"E-Invoice for the document [<document-key>] is not submitted to Avalara and hence this request cannot be accepted"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#1","summary":"Validation Error#1","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/200/content/application~1json/examples/Validation Error#1"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1mandate/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success":{"value":{},"key":"Success","summary":"Success","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"File Format 'application/pdf' is not supported by Avalara for the document [<document-number>]. Supported values are [application/vnd.oasis.ubl+xml, application/xml]"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#1","summary":"Validation Error#1","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"File download operation is supported only if the E-Invoice status is Success"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#2","summary":"Validation Error#2","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"Avalara Service is down at the moment. Please try again later"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#3","summary":"Validation Error#3","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success":{"value":{},"key":"Success","summary":"Success","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"File Format 'application/pdf' is not supported by Avalara for the document [<document-number>]. Supported values are [application/vnd.oasis.ubl+xml, application/xml]"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#1","summary":"Validation Error#1","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"File download operation is supported only if the E-Invoice status is Success"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#2","summary":"Validation Error#2","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"Avalara Service is down at the moment. Please try again later"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#3","summary":"Validation Error#3","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success":{"value":{},"key":"Success","summary":"Success","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Success"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"File Format 'application/pdf' is not supported by Avalara for the document [<document-number>]. Supported values are [application/vnd.oasis.ubl+xml, application/xml]"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#1","summary":"Validation Error#1","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#1"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"File download operation is supported only if the E-Invoice status is Success"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#2","summary":"Validation Error#2","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#2"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3":{"value":{"success":false,"processId":"A214477BE49D98ED","reasons":{"code":"50000020","message":"Avalara Service is down at the moment. Please try again later"},"requestId":"0e9c4ba6-a118-4f64-90df-23f7ce3d004c"},"key":"Validation Error#3","summary":"Validation Error#3","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/200/content/application~1json/examples/Validation Error#3"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1download/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/200/content/application~1json/example"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates/get/responses/200/content/application~1json/examples/response":{"value":{"success":true,"templates":[{"country":"SA","documentType":"Invoice","id":"402833ec89d46b390189d51402d937b0","name":"EInvoice Template Name","provider":"Sovos","templateNumber":"EITEMP-00000006"},{"country":"SA","documentType":"CreditMemo","id":"402833ec89d46b390189d514030537b2","name":"EInvoice Template Name","provider":"Sovos","templateNumber":"EITEMP-00000008"},{"country":"SA","documentType":"DebitMemo","id":"402833ec89d46b390189d514032037b4","name":"EInvoice Template Name","provider":"Sovos","templateNumber":"EITEMP-00000009"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates/post/responses/200/content/application~1json/examples/response":{"value":{"content":"base64 encoded content","country":"IN","documentType":"Invoice","id":"4028818484f483d20184f5006b97003f","name":"Sovos e-invoice service","provider":"Sovos","success":true,"templateNumber":"EITEMP-00000003"},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates~1{key}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates~1{key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates~1{key}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates~1{key}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates~1{key}/get/responses/200/content/application~1json/examples/response":{"value":{"content":"base64 encoded content","country":"IN","documentType":"Invoice","id":"4028818484f483d20184f5006b97003f","name":"Sovos e-invoice service","provider":"Sovos","success":true,"templateNumber":"EITEMP-00000003"},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates~1{key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates~1{key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates~1{key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates~1{key}/put/responses/200/content/application~1json/examples/response":{"value":{"content":"base64 encoded content","country":"IN","documentType":"Invoice","id":"4028818484f483d20184f5006b97003f","name":"Sovos e-invoice service","provider":"Sovos","success":true,"templateNumber":"EITEMP-00000003"},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates~1{key}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates~1{key}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates~1{key}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1einvoice~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1einvoice~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample":{"value":{"message":"Authentication error"},"key":"UnauthorizedExample","summary":"UnauthorizedExample","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample"},"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample":{"value":{"code":71012514,"message":"User does not have permission to delete custom objects."},"key":"PermissionErrorExample","summary":"PermissionErrorExample","id":"paths/~1v1~1invoices~1{invoiceKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample":{"value":{"message":"Authentication error"},"key":"UnauthorizedExample","summary":"UnauthorizedExample","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample":{"value":{"code":71012514,"message":"User does not have permission to delete custom objects."},"key":"PermissionErrorExample","summary":"PermissionErrorExample","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/200/content/application~1json/example"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample":{"value":{"message":"Authentication error"},"key":"UnauthorizedExample","summary":"UnauthorizedExample","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/UnauthorizedExample"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample":{"value":{"code":71012514,"message":"User does not have permission to delete custom objects."},"key":"PermissionErrorExample","summary":"PermissionErrorExample","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1sync-status/put/responses/4XX/content/application~1json/examples/PermissionErrorExample"},"paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoices~1{invoiceKey}~1einvoice~1generate/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1credit-memos~1{creditMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1debit-memos~1{debitMemoKey}~1e-invoice~1generate/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/200/content/application~1json/examples/response":{"value":{"success":true,"id":"8a8cd4a39f9936d6019fa709a0233f55","sourceObjectId":"8a8c9e479f286002019f36413cf25edd","sourceObjectType":"INVOICE","requestedStatus":"Completed","status":"Scheduled"},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/4XX/content/application~1json/examples/response":{"value":{"success":false,"processId":"B28BD8BAB9E93EE3","reasons":[{"code":"50000020","message":"Invalid requested status: Rejected. Allowed values: [Completed, Cancelled, DirectPaymentRequest, Affidaute, AffiledConfidential, ChangeOfAccountToPay, NotBilled]"}],"requestId":"bd837194-dd20-4780-b1ff-31bfd742c08b"},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1lifecycle~1status-update/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/200/content/application~1json/examples/response":{"value":{"success":true,"statusUpdates":[{"id":"8a8c827fa06c56ee01a07f6976b90f36","sourceObjectId":"8a8cd4a3a06c5cdf01a07f696f9129b6","sourceObjectNumber":"P-00000676","sourceObjectType":"PAYMENT","paymentId":"8a8cd4a3a06c5cdf01a07f696f5e29b1","paymentNumber":"P-00000676","parentObjectId":"8a8cd4a3a043275601a0462b1290077c","parentObjectNumber":"INV00012903","parentObjectType":"Invoice","serviceProviderId":"8a8cd4a39c3803ed019c462f37b21a47","serviceProviderType":"AVALARA","sequenceId":"6","userRequestedAction":"PAYMENT_STATUS_UPDATE","userRequestStatus":"PaymentCollected","status":"Completed","triggeredBy":"PAYMENT_APPLIED","einvoiceBusinessStatus":"Not Factored","authorityStatus":"TA_Accepted","businessReasonCode":"212","transactionId":"fr-1298f1a2-6b0a-4200-b253-8a33a78aab82","taskExecutionId":"8a8c827fa06c56ee01a07f6976cc0f37","snapshotFileId":"8a8c827fa06c56ee01a07f6aa03f0f39","createdDate":"2026-09-08T05:06:53Z","updatedDate":"2026-09-08T05:12:06Z"},{"id":"8a8cd4a3a06c5cdf01a07f4eadc129a8","sourceObjectId":"8a8cd4a3a06c5cdf01a07f42eb34299c","sourceObjectNumber":"INV00013245","sourceObjectType":"INVOICE","serviceProviderId":"8a8cd4a39c3803ed019c462f37b21a47","serviceProviderType":"AVALARA","userRequestedAction":"ON_DEMAND_BUSINESS_STATUS_SYNC","userRequestStatus":"","status":"Completed","triggeredBy":"USER_MANUAL","einvoiceBusinessStatus":"Refused","einvoiceBusinessStatusCode":"TX_TVA_ERR","einvoiceBusinessStatusReason":"Il y a une erreur de surfacturation sur cette facture.","transactionId":"fr-bdf0b8d0-db25-462f-8b4d-0d7e61d852b7","taskExecutionId":"8a8cd4a3a06c5cdf01a07f4eadde29a9","snapshotFileId":"8a8c827fa06c56ee01a07f4f27e00f35","createdDate":"2026-09-08T04:37:37Z","updatedDate":"2026-09-08T04:38:09Z"},{"id":"8a8c9724a06c5cd701a07f43c86443ab","sourceObjectId":"8a8cd4a3a06c5cdf01a07f42eb34299c","sourceObjectNumber":"INV00013245","sourceObjectType":"INVOICE","serviceProviderId":"8a8cd4a39c3803ed019c462f37b21a47","serviceProviderType":"AVALARA","userRequestedAction":"MONITORING","userRequestStatus":"Scheduled","status":"Scheduled","triggeredBy":"EINVOICE_SUCCESS","taskExecutionId":"8a8c9724a06c5cd701a07f43c86b43ac","createdDate":"2026-09-08T04:25:43Z","updatedDate":"2026-09-08T04:25:43Z"},{"id":"8a8cd4a3a057c09901a05c6aa8257ae2","sourceObjectId":"8a8cd4a3a043275601a0462b1290077c","sourceObjectNumber":"INV00012903","sourceObjectType":"INVOICE","serviceProviderId":"8a8cd4a39c3803ed019c462f37b21a47","serviceProviderType":"AVALARA","sequenceId":"5","userRequestedAction":"SELLER_STATUS_UPDATE","userRequestStatus":"NotBilled","status":"Completed","reason":"2112","triggeredBy":"USER_MANUAL","einvoiceBusinessStatus":"Not Factored","authorityStatus":"TA_Accepted","businessReasonCode":"228","transactionId":"fr-d643bf05-2447-485a-92bf-940774f3a87c","taskExecutionId":"8a8cd4a3a057c09901a05c6aa8397ae3","snapshotFileId":"8a8c827fa057bace01a05c6b421a41b8","createdDate":"2026-09-01T10:01:28Z","updatedDate":"2026-09-01T10:16:07Z"},{"id":"8a8c8a44a04318c501a04664c3360bd8","sourceObjectId":"8a8cd4a3a043275601a0462b1290077c","sourceObjectNumber":"INV00012903","sourceObjectType":"INVOICE","serviceProviderId":"8a8cd4a39c3803ed019c462f37b21a47","serviceProviderType":"AVALARA","sequenceId":"4","userRequestedAction":"SELLER_STATUS_UPDATE","userRequestStatus":"ChangeOfAccountToPay","status":"Completed","reason":"444","triggeredBy":"USER_MANUAL","einvoiceBusinessStatus":"Change of Account to Pay","authorityStatus":"TA_Admissible","businessReasonCode":"227","transactionId":"fr-1e940262-7545-4b00-9079-e838670fe455","taskExecutionId":"8a8c8a44a04318c501a04664c3490bd9","snapshotFileId":"8a8c9b52a043219301a0466571531d29","createdDate":"2026-08-28T03:23:23Z","updatedDate":"2026-08-28T03:28:06Z"},{"id":"8a8cd4a3a043275601a04662761d0a02","sourceObjectId":"8a8cd4a3a043275601a0462b1290077c","sourceObjectNumber":"INV00012903","sourceObjectType":"INVOICE","serviceProviderId":"8a8cd4a39c3803ed019c462f37b21a47","serviceProviderType":"AVALARA","sequenceId":"3","userRequestedAction":"SELLER_STATUS_UPDATE","userRequestStatus":"Affidaute","status":"Completed","reason":"222","triggeredBy":"USER_MANUAL","einvoiceBusinessStatus":"Change of Account to Pay","authorityStatus":"TA_Admissible","businessReasonCode":"225","transactionId":"fr-18d603f1-e6c6-4ad5-8359-c3eb6b93da0c","taskExecutionId":"8a8cd4a3a043275601a04662762f0a03","snapshotFileId":"8a8c827fa04321a601a046639b481c00","createdDate":"2026-08-28T03:20:53Z","updatedDate":"2026-08-28T03:26:06Z"},{"id":"8a8cd4a3a043275601a0465bc0e10a00","sourceObjectId":"8a8cd4a3a043275601a0462b1290077c","sourceObjectNumber":"INV00012903","sourceObjectType":"INVOICE","serviceProviderId":"8a8cd4a39c3803ed019c462f37b21a47","serviceProviderType":"AVALARA","sequenceId":"2","userRequestedAction":"SELLER_STATUS_UPDATE","userRequestStatus":"Cancelled","status":"Completed","reason":"111","triggeredBy":"USER_MANUAL","einvoiceBusinessStatus":"Cancelled","authorityStatus":"TA_Admissible","businessReasonCode":"220","transactionId":"fr-c3baa688-45cd-4965-ba5c-4261c4f5d462","taskExecutionId":"8a8cd4a3a043275601a0465bc0f80a01","snapshotFileId":"8a8c9b52a043219301a0465c4c8f1751","createdDate":"2026-08-28T03:13:33Z","updatedDate":"2026-08-28T03:18:08Z"},{"id":"8a8cd4a3a043275601a0465b423309fe","sourceObjectId":"8a8cd4a3a043275601a0462b1290077c","sourceObjectNumber":"INV00012903","sourceObjectType":"INVOICE","serviceProviderId":"8a8cd4a39c3803ed019c462f37b21a47","serviceProviderType":"AVALARA","sequenceId":"1","userRequestedAction":"SELLER_STATUS_UPDATE","userRequestStatus":"Completed","status":"Completed","reason":"000","triggeredBy":"USER_MANUAL","einvoiceBusinessStatus":"Cancelled","authorityStatus":"TA_Admissible","businessReasonCode":"209","transactionId":"fr-b7d79c3b-ebd5-4e48-af8b-c4d0bc5b35a5","taskExecutionId":"8a8cd4a3a043275601a0465b424b09ff","snapshotFileId":"8a8c827fa04321a601a0465c4d411ba9","createdDate":"2026-08-28T03:13:00Z","updatedDate":"2026-08-28T03:18:08Z"},{"id":"8a8c9e47a04318c901a0462bfa64025d","sourceObjectId":"8a8cd4a3a043275601a0462b1290077c","sourceObjectNumber":"INV00012903","sourceObjectType":"INVOICE","serviceProviderId":"8a8cd4a39c3803ed019c462f37b21a47","serviceProviderType":"AVALARA","userRequestedAction":"MONITORING","userRequestStatus":"Scheduled","status":"Completed","triggeredBy":"EINVOICE_SUCCESS","taskExecutionId":"8a8c9e47a04318c901a0462bfa69025e","createdDate":"2026-08-28T02:21:22Z","updatedDate":"2026-09-04T02:42:06Z"},{"id":"8a8c827fa03df1ac01a043194f6d2150","sourceObjectId":"8a8c8a44a038cb4501a03c7e24130c23","sourceObjectNumber":"INV00012894","sourceObjectType":"INVOICE","serviceProviderType":"AVALARA","userRequestedAction":"MONITORING"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1lifecycle~1status-updates/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/200/content/application~1json/examples/response":{"value":{"success":true,"statusUpdate":{"id":"8a8c827fa06c56ee01a07f6976b90f36","sourceObjectId":"8a8cd4a3a06c5cdf01a07f696f9129b6","sourceObjectNumber":"P-00000676","sourceObjectType":"PAYMENT","paymentId":"8a8cd4a3a06c5cdf01a07f696f5e29b1","paymentNumber":"P-00000676","parentObjectId":"8a8cd4a3a043275601a0462b1290077c","parentObjectNumber":"INV00012903","parentObjectType":"Invoice","serviceProviderId":"8a8cd4a39c3803ed019c462f37b21a47","serviceProviderType":"AVALARA","sequenceId":"6","userRequestedAction":"PAYMENT_STATUS_UPDATE","userRequestStatus":"PaymentCollected","status":"Completed","triggeredBy":"PAYMENT_APPLIED","einvoiceBusinessStatus":"Not Factored","authorityStatus":"TA_Accepted","businessReasonCode":"212","transactionId":"fr-1298f1a2-6b0a-4200-b253-8a33a78aab82","taskExecutionId":"8a8c827fa06c56ee01a07f6976cc0f37","snapshotFileId":"8a8c827fa06c56ee01a07f6aa03f0f39","createdDate":"2026-09-08T05:06:53Z","updatedDate":"2026-09-08T05:12:06Z"}},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1lifecycle~1status-updates~1{key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1reconcile/post/responses/200/content/application~1json/examples/response":{"value":{"requestId":"e4c081829f938b4c019f939770660089","success":true},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1reconcile/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1reconcile/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1reconcile/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1reconcile/post/responses/4XX/content/application~1json/examples/response":{"value":{"success":false,"processId":"4E004DDE0C146693","reasons":[{"code":"50000040","message":"Document not found: e4c081829f3b3c68019f3bd8d6161363 (type: INVOICE)"}],"requestId":"b5d7039a-7297-4c8b-a2b9-2639fecadf6c"},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1reconcile/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1trigger/post/responses/200/content/application~1json/examples/response":{"value":{"success":true,"eReportingRequest":{"id":"8a90f508885201ad018856a2d9070163","status":"ReportScheduled","sourceObjectType":"INVOICE"}},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1trigger/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1trigger/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1trigger/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1trigger/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to access e-compliance requests."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1trigger/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1regenerate/post/responses/200/content/application~1json/examples/response":{"value":{"success":true,"eReportingRequest":{"id":"8a90f508885201ad018856a2d9070163","status":"ReportScheduled","sourceObjectType":"INVOICE"}},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1regenerate/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1regenerate/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1regenerate/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1regenerate/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to access e-compliance requests."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1regenerate/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates/get/responses/200/content/application~1json/examples/response":{"value":{"success":true,"templates":[{"id":"8a90f508885201ad018856a2d9070163","name":"FR_B2B_INVOICE_REPORTING","ereportingSupplierId":"4028948972a2bf990172bc9b27724ddc","sourceObjectType":"INVOICE","businessCategory":"B2B","status":"ACTIVE"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to delete custom objects."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90f508885201ad018856a2d9070163","name":"FR_B2B_INVOICE_REPORTING","ereportingSupplierId":"4028948972a2bf990172bc9b27724ddc","sourceObjectType":"INVOICE","businessCategory":"B2B","status":"DRAFT","content":"PGh0bWw+dGVtcGxhdGU8L2h0bWw+","templateNumber":"ERTEMP-00000001","createdOn":"2024-01-01T00:00:00.000Z","updatedOn":"2024-01-01T00:00:00.000Z","success":true},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to delete custom objects."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to delete custom objects."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates~1{key}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates~1{key}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90f508885201ad018856a2d9070163","name":"FR_B2B_INVOICE_REPORTING","ereportingSupplierId":"4028948972a2bf990172bc9b27724ddc","sourceObjectType":"INVOICE","businessCategory":"B2B","status":"ACTIVE","content":"PGh0bWw+dGVtcGxhdGU8L2h0bWw+","templateNumber":"ERTEMP-00000001","createdOn":"2024-01-01T00:00:00.000Z","updatedOn":"2024-01-01T00:00:00.000Z","success":true},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates~1{key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates~1{key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates~1{key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to delete custom objects."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates~1{key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates~1{key}/put/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90f508885201ad018856a2d9070163","name":"FR_B2B_INVOICE_REPORTING","ereportingSupplierId":"4028948972a2bf990172bc9b27724ddc","sourceObjectType":"INVOICE","businessCategory":"B2B","status":"ACTIVE","content":"PGh0bWw+dGVtcGxhdGU8L2h0bWw+","templateNumber":"ERTEMP-00000001","createdOn":"2024-01-01T00:00:00.000Z","updatedOn":"2024-01-01T00:00:00.000Z","success":true},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates~1{key}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates~1{key}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates~1{key}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to delete custom objects."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1templates~1{key}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions/get/responses/200/content/application~1json/examples/response":{"value":{"regions":{"businessName":"Acme Corp Spain","businessNumber":"12345678A","businessNumberSchemeId":"ES:VAT","tradeName":"Acme Spain","endpointId":"9908:es-acme","endpointSchemeId":"9908","taxRegisterNumber":"ES12345678A","country":"ES","state":"","city":"Madrid","postalCode":"28013","addressLine1":"Gran Via 1","addressLine2":"Floor 2","contactName":"Maria Garcia","phoneNumber":"+34 555 0101","email":"maria.garcia@example.com","id":"4028948972a2bf990172bc9b27724aaa","invoiceEnabled":true,"mode":"INDIVIDUAL","natureKey":"es-sii-main","reportingScheme":"SII","engineId":"4028948972a2bf990172bc9b27724ddc"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to delete custom objects."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions/post/responses/200/content/application~1json/examples/response":{"value":{"businessName":"Acme Corp Spain","businessNumber":"12345678A","businessNumberSchemeId":"ES:VAT","tradeName":"Acme Spain","endpointId":"9908:es-acme","endpointSchemeId":"9908","taxRegisterNumber":"ES12345678A","country":"ES","state":"","city":"Madrid","postalCode":"28013","addressLine1":"Gran Via 1","addressLine2":"Floor 2","contactName":"Maria Garcia","phoneNumber":"+34 555 0101","email":"maria.garcia@example.com","id":"4028948972a2bf990172bc9b27724aaa","invoiceEnabled":true,"mode":"INDIVIDUAL","natureKey":"es-sii-main","reportingScheme":"SII","engineId":"4028948972a2bf990172bc9b27724ddc","success":true},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to delete custom objects."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to delete custom objects."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions~1{key}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response":{"value":{"businessName":"Acme Corp Spain","businessNumber":"12345678A","businessNumberSchemeId":"ES:VAT","tradeName":"Acme Spain","endpointId":"9908:es-acme","endpointSchemeId":"9908","taxRegisterNumber":"ES12345678A","country":"ES","state":"","city":"Madrid","postalCode":"28013","addressLine1":"Gran Via 1","addressLine2":"Floor 2","contactName":"Maria Garcia","phoneNumber":"+34 555 0101","email":"maria.garcia@example.com","id":"4028948972a2bf990172bc9b27724aaa","invoiceEnabled":true,"mode":"INDIVIDUAL","natureKey":"es-sii-main","reportingScheme":"SII","engineId":"4028948972a2bf990172bc9b27724ddc","success":true},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to delete custom objects."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions~1{key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response":{"value":{"businessName":"Acme Corp Spain","businessNumber":"12345678A","businessNumberSchemeId":"ES:VAT","tradeName":"Acme Spain","endpointId":"9908:es-acme","endpointSchemeId":"9908","taxRegisterNumber":"ES12345678A","country":"ES","state":"","city":"Madrid","postalCode":"28013","addressLine1":"Gran Via 1","addressLine2":"Floor 2","contactName":"Maria Garcia","phoneNumber":"+34 555 0101","email":"maria.garcia@example.com","id":"4028948972a2bf990172bc9b27724aaa","invoiceEnabled":true,"mode":"INDIVIDUAL","natureKey":"es-sii-main","reportingScheme":"SII","engineId":"4028948972a2bf990172bc9b27724ddc","success":true},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to delete custom objects."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-reporting~1business-regions~1{key}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1e-reporting~1requests/get/responses/200/content/application~1json/examples/response":{"value":{"success":true,"requests":[{"id":"8a90f508885201ad018856a2d9070163","status":"ReportSubmitted","sourceObjectType":"INVOICE"}],"page":1,"pageSize":20,"total":1},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1e-reporting~1requests/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/200/content/application~1json/examples/response":{"value":{"success":true,"request":{"id":"8a90f508885201ad018856a2d9070163","status":"ReportSubmitted","sourceObjectType":"INVOICE"}},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to access e-compliance requests."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1e-reporting~1requests~1{key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response":{"value":{"schema":{"type":"string","format":"binary"}},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to access e-compliance requests."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1{complianceType}~1files~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response":{"value":{"schema":{"type":"array","items":{"type":"object"}}},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"71012514","message":"User does not have permission to access e-compliance requests."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1e-compliance~1{complianceType}~1snapshots~1{sourceObjectType}~1{sourceObjectId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules/post/responses/200/content/application~1json/examples/response":{"value":{"actualAmount":70200,"additionalSubscriptionsToBill":["S-00000001","S-00000002"],"billedAmount":0,"currency":"USD","id":"e2441b3e24eb42859194be7da2403b38","invoiceSeparately":false,"nextRunDate":"2022-02-24","notes":"2022 Billing Schedule","number":"IS-00000004","orders":["O-00000007","O-00000008"],"scheduleItems":[{"actualAmount":50000,"amount":50000,"id":"8a8881aa82118bec018211daf9f01680","percentage":null,"runDate":"2022-02-24","status":"Pending","targetDateForAdditionalSubscriptions":"2022-02-24"},{"actualAmount":14000,"amount":14000,"id":"8a8881aa82118bec018211daf9f11681","percentage":null,"runDate":"2022-10-17","status":"Pending","targetDateForAdditionalSubscriptions":"2022-10-17"},{"actualAmount":6200,"amount":6200,"id":"8a8881aa82118bec018211daf9f11682","percentage":null,"runDate":"2022-11-14","status":"Pending","targetDateForAdditionalSubscriptions":"2022-11-14"}],"specificSubscriptions":[{"orderKey":"O-00000008","subscriptionKey":"S-00000008"}],"status":"Pending","success":true,"totalAmount":70200,"unbilledAmount":70200},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/200/content/application~1json/examples/response":{"value":{"actualAmount":20200,"additionalSubscriptionsToBill":["S-00000001","S-00000002"],"billedAmount":50000,"currency":"USD","id":"e2441b3e24eb42859194be7da2403b38","invoiceSeparately":false,"nextRunDate":"2022-10-17","notes":"2022 Billing Schedule","number":"IS-00000004","orders":["O-00000007","O-00000008"],"scheduleItems":[{"actualAmount":0,"amount":50000,"id":"8a8881aa82118bec018211daf9f01680","invoiceId":"8a8881aa82118bec018211dafc1e1695","percentage":null,"runDate":"2022-02-24","status":"Processed","targetDateForAdditionalSubscriptions":"2022-02-24"},{"actualAmount":14000,"amount":14000,"id":"8a8881aa82118bec018211daf9f11681","percentage":null,"runDate":"2022-10-17","status":"Pending","targetDateForAdditionalSubscriptions":"2022-10-17"},{"actualAmount":6200,"amount":6200,"id":"8a8881aa82118bec018211daf9f11682","percentage":null,"runDate":"2022-11-14","status":"Pending","targetDateForAdditionalSubscriptions":"2022-11-14"}],"specificSubscriptions":[{"orderKey":"O-00000008","subscriptionKey":"S-00000008"}],"status":"PartiallyProcessed","success":true,"totalAmount":70200,"unbilledAmount":20200},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/200/content/application~1json/examples/response":{"value":{"actualAmount":70200,"additionalSubscriptionsToBill":["S-00000001","S-00000002"],"billedAmount":0,"currency":"USD","id":"e2441b3e24eb42859194be7da2403b38","invoiceSeparately":false,"nextRunDate":"2022-02-24","notes":"2022 Billing Schedule","number":"IS-00000004","orders":["O-00000007","O-00000008"],"scheduleItems":[{"actualAmount":54000,"amount":54000,"id":"8a8881aa82118bec018211daf9f01680","percentage":null,"runDate":"2022-02-24","status":"Pending","targetDateForAdditionalSubscriptions":"2022-02-24"},{"actualAmount":10000,"amount":10000,"id":"8a8881aa82118bec018211daf9f11681","percentage":null,"runDate":"2022-10-17","status":"Pending","targetDateForAdditionalSubscriptions":"2022-10-17"},{"actualAmount":6200,"amount":6200,"id":"8a8881aa82118bec018211daf9f11682","percentage":null,"runDate":"2022-11-14","status":"Pending","targetDateForAdditionalSubscriptions":"2022-11-14"}],"specificSubscriptions":[{"orderKey":"O-00000008","subscriptionKey":"S-00000008"}],"status":"Pending","success":true,"totalAmount":70200,"unbilledAmount":70200},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoEmail/examples/response":{"value":false,"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoEmail/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoPost/examples/response":{"value":false,"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoPost/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoRenewal/examples/response":{"value":false,"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/autoRenewal/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/billRunFilters/examples/response":{"value":[{"accountId":"8ad09c4b82b5c6330182c5ccab3570e6","filterType":"InvoiceSchedule"}],"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/billRunFilters/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/billRunNumber/examples/response":{"value":"BR-00001017","key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/billRunNumber/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/createdById/examples/response":{"value":"2c92c0f84298ac5901429dea196212be","key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/createdById/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/createdDate/examples/response":{"value":"2022-08-22 06:47:18","key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/createdDate/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/id/examples/response":{"value":"8ad0823f82b5b2520182c5cec5fe40fb","key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/id/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/invoiceDate/examples/response":{"value":"2022-02-24","key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/invoiceDate/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/noEmailForZeroAmountInvoice/examples/response":{"value":false,"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/noEmailForZeroAmountInvoice/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/status/examples/response":{"value":"Pending","key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/status/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/success/examples/response":{"value":true,"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/success/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/targetDate/examples/response":{"value":"2022-02-24","key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/targetDate/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/updatedById/examples/response":{"value":"2c92c0f84298ac5901429dea196212be","key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/updatedById/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/updatedDate/examples/response":{"value":"2022-08-22 06:47:18","key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/200/content/updatedDate/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1execute/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/200/content/application~1json/examples/response":{"value":{"actualAmount":20200,"billedAmount":50000,"currency":"USD","id":"e2441b3e24eb42859194be7da2403b38","nextRunDate":"2022-10-17","notes":"2022 Billing Schedule","number":"IS-00000004","orders":["O-00000007","O-00000008"],"scheduleItems":[{"actualAmount":0,"amount":50000,"id":"8a8881aa82118bec018211daf9f01680","invoiceId":"8a8881aa82118bec018211dafc1e1695","percentage":null,"runDate":"2022-02-24","status":"Processed","targetDateForAdditionalSubscriptions":"2022-02-24"},{"actualAmount":14000,"amount":14000,"id":"8a8881aa82118bec018211daf9f11681","percentage":null,"runDate":"2022-10-17","status":"Pending","targetDateForAdditionalSubscriptions":"2022-10-17"},{"actualAmount":6200,"amount":6200,"id":"8a8881aa82118bec018211daf9f11682","percentage":null,"runDate":"2022-11-14","status":"Pending","targetDateForAdditionalSubscriptions":"2022-11-14"}],"specificSubscriptions":[{"orderKey":"O-00000008","subscriptionKey":"S-00000008"}],"status":"Paused","success":true,"totalAmount":70200,"unbilledAmount":20200},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1pause/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/200/content/application~1json/examples/response":{"value":{"actualAmount":20200,"billedAmount":50000,"currency":"USD","id":"e2441b3e24eb42859194be7da2403b38","nextRunDate":"2022-10-17","notes":"2022 Billing Schedule","number":"IS-00000004","orders":["O-00000007","O-00000008"],"scheduleItems":[{"actualAmount":0,"amount":50000,"id":"8a8881aa82118bec018211daf9f01680","invoiceId":"8a8881aa82118bec018211dafc1e1695","percentage":null,"runDate":"2022-02-24","status":"Processed","targetDateForAdditionalSubscriptions":"2022-02-24"},{"actualAmount":14000,"amount":14000,"id":"8a8881aa82118bec018211daf9f11681","percentage":null,"runDate":"2022-10-17","status":"Pending","targetDateForAdditionalSubscriptions":"2022-10-17"},{"actualAmount":6200,"amount":6200,"id":"8a8881aa82118bec018211daf9f11682","percentage":null,"runDate":"2022-11-14","status":"Pending","targetDateForAdditionalSubscriptions":"2022-11-14"}],"specificSubscriptions":[{"orderKey":"O-00000008","subscriptionKey":"S-00000008"}],"status":"PartiallyProcessed","success":true,"totalAmount":70200,"unbilledAmount":20200},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1resume/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1detach/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1invoice-schedules~1{scheduleKey}~1attach/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1object~1taxation-item/post/responses/200/content/application~1json/examples/response":{"value":{"Id":"2c93808457d787030157e0306f413a96","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1taxation-item/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1taxation-item/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}],"Success":false},"key":"response","summary":"response","id":"paths/~1v1~1object~1taxation-item/post/responses/400/content/application~1json/examples/response"},"paths/~1v1~1object~1taxation-item/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1taxation-item/post/responses/401/content/application~1json/examples/response"},"paths/~1v1~1taxation-items~1{id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1taxation-items~1{id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1taxation-items~1{id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1taxation-items~1{id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1taxation-items~1{id}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1taxation-items~1{id}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1taxation-items~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-02-27 11:52:03","exemptAmount":0,"financeInformation":{"onAccountAccountingCode":"Check","onAccountAccountingCodeType":"Cash","salesTaxPayableAccountingCode":"Check","salesTaxPayableAccountingCodeType":"Cash"},"id":"402890555a7d4022015a7db254e200c8","jurisdiction":null,"locationCode":null,"memoItemId":"402890555a7d4022015a7db254d800c7","name":"my tax","sourceTaxItemId":"402890555a7d4022015a7db254e200c1","success":true,"taxAmount":1,"taxCode":"ZtaxCode","taxCodeDescription":"","taxDate":"2017-02-27","taxRate":5,"taxRateDescription":null,"taxRateType":"FlatFee","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-02-27 11:52:03"},"key":"response","summary":"response","id":"paths/~1v1~1taxation-items~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1taxation-items~1{id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1taxation-items~1{id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1taxation-items~1{id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1taxation-items~1{id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1taxation-items~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"createdById":"8ad084a67f9c7138017fab8a8b511b5a","createdDate":"2024-11-04 10:53:16","exemptAmount":0,"id":"8ad09d9392e0a4430192f51746d121f6","memoItemId":null,"invoiceItemId":"8ad086fa92d66ffe0192dc7e5dd65161","sourceTaxItemId":null,"jurisdiction":"CALIFORNIA","locationCode":null,"name":"CA TAX","taxAmount":3,"applicableTaxUnRounded":3,"country":null,"taxCode":null,"taxCodeDescription":null,"taxDate":"2024-11-04","taxRate":3,"taxMode":"TaxExclusive","taxRateDescription":"Details of the tax rate","taxRateType":"FlatFee","updatedById":"8ad084a67f9c7138017fab8a8b511b5a","updatedDate":"2024-11-04 10:57:51","financeInformation":{"onAccountAccountingCode":null,"onAccountAccountingCodeType":null,"salesTaxPayableAccountingCode":"Sales Tax Payable","salesTaxPayableAccountingCodeType":"SalesTaxPayable"},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1taxation-items~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1taxation-items~1{id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1taxation-items~1{id}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1taxation-items~1{id}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1taxation-items~1{id}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets/get/responses/200/content/application~1json/examples/response":{"value":{"sequenceSets":[{"creditMemo":{"prefix":"CM","startNumber":11},"debitMemo":{"prefix":"DM","startNumber":12},"id":"2c98906c69be199c0169be74ed210afd","invoice":{"prefix":"INV","startNumber":10},"name":"DEFAULT","payment":{"prefix":"P-","startNumber":13},"refund":{"prefix":"R-","startNumber":14}},{"creditMemo":{"prefix":"FCM","startNumber":11},"debitMemo":{"prefix":"FDM","startNumber":12},"id":"2c98906c69be199c0169be74ed211afd","invoice":{"prefix":"FINV","startNumber":10},"name":"FR","payment":{"prefix":"FP-","startNumber":13},"refund":{"prefix":"FR-","startNumber":14}},{"creditMemo":{"prefix":"ITACM","startNumber":11},"debitMemo":{"prefix":"ITADM","startNumber":12},"id":"2c98906c69be199c0169be74ed212afd","invoice":{"prefix":"ITAINV","startNumber":10},"name":"ITA","payment":{"prefix":"ITAP-","startNumber":13},"refund":{"prefix":"ITAR-","startNumber":14}}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets/post/responses/200/content/application~1json/examples/response":{"value":{"sequenceSets":[{"id":"402892c74c9193cd014c96bbe7c101f9","name":"FR","creditMemo":{"prefix":"FCM","startNumber":10},"debitMemo":{"prefix":"FDM","startNumber":10},"invoice":{"prefix":"FINV","startNumber":10},"payment":{"prefix":"FP-","startNumber":10},"refund":{"prefix":"FR-","startNumber":10}}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets~1{id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets~1{id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets~1{id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets~1{id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets~1{id}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets~1{id}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"creditMemo":{"prefix":"FCM","startNumber":11},"debitMemo":{"prefix":"FDM","startNumber":12},"invoice":{"prefix":"FINV","startNumber":10},"name":"FR","payment":{"prefix":"FP-","startNumber":13},"refund":{"prefix":"FR-","startNumber":14},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets~1{id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets~1{id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets~1{id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets~1{id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets~1{id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets~1{id}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1sequence-sets~1{id}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1sequence-sets~1{id}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1operations~1billing-preview/post/responses/200/content/application~1json/examples/response":{"value":{"accountId":"8ad09bce83f1da020183f97e245c1c47","invoiceItems":[{"id":"d573746814a14da0a0a0abda2a41d65a","subscriptionName":"A-S00000346","subscriptionId":"8ad08ad58e35d490018e36a0f1ca2a9c","subscriptionNumber":"A-S00000346","serviceStartDate":"2024-08-01","serviceEndDate":"2024-08-31","chargeAmount":10,"chargeDescription":"","chargeName":"Monthly Fee","chargeNumber":"C-00000950","chargeId":"8ad08ad58e35d490018e36a0f2252aa5","productName":"Music service","quantity":1,"taxAmount":0,"unitOfMeasure":"","chargeDate":"2024-07-09 17:06:58","chargeType":"Recurring","processingType":"Charge","appliedToItemId":null,"numberOfDeliveries":0},{"id":"c86c42ee4f5b42bd86351f4a99bf230e","subscriptionName":"A-S00000346","subscriptionId":"8ad08ad58e35d490018e36a0f1ca2a9c","subscriptionNumber":"A-S00000346","serviceStartDate":"2024-09-01","serviceEndDate":"2024-09-30","chargeAmount":10,"chargeDescription":"","chargeName":"Monthly Fee","chargeNumber":"C-00000950","chargeId":"8ad08ad58e35d490018e36a0f2252aa5","productName":"Music service","quantity":1,"taxAmount":0,"unitOfMeasure":"","chargeDate":"2024-07-09 17:06:58","chargeType":"Recurring","processingType":"Charge","appliedToItemId":null,"numberOfDeliveries":0}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1operations~1billing-preview/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1operations~1billing-preview/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1operations~1billing-preview/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1operations~1billing-preview/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1operations~1billing-preview/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1operations~1invoice-collect/post/responses/200/content/application~1json/examples/response":{"value":{"amountCollected":801.73,"creditMemos":[{"id":"402890555a7e9791015a879f064a0054","totalAmount":801.73,"memoNumber":"CM00000012"}],"invoices":[{"invoiceAmount":801.73,"invoiceId":"4028925a4cb74ec9014cb7540988002e","invoiceNumber":"INV00000091"}],"paymentId":"402892053e100406013e1024ab7c00e3","success":true},"key":"response","summary":"response","id":"paths/~1v1~1operations~1invoice-collect/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1operations~1invoice-collect/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1operations~1invoice-collect/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1operations~1invoice-collect/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1operations~1invoice-collect/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1operations~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"4028818484a949680184a95174cb0019","objectId":"4028818484a949680184a9510c960009","objectType":"Invoice","operationType":"Delete","status":"Completed","success":true},"key":"response","summary":"response","id":"paths/~1v1~1operations~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1operations~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1operations~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1operations~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1operations~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1operations~1bulk-pdf/post/responses/200/content/application~1json/example":{"value":{"jobId":"402880de8ce7edc3018ce7f18404312a","jobName":"BulkPDFGenerationJobV1","status":"Completed","stepStatus":"PostProcessing","fileUrls":"<s3-url>","skippedDocuments":[{"docType":"Invoice","objectIds":["8a90a04d8e323748018e327b4a0825a0"]},{"docType":"CreditMemo","objectIds":["402880de8ce7edc3018ce7f18404315a"]}],"createdBy":"2c92c8fb7a2d26b6017a2eaa64c72dea","createdOn":"2024-04-19 05:19:32","success":true},"id":"paths/~1v1~1operations~1bulk-pdf/post/responses/200/content/application~1json/example"},"paths/~1v1~1operations~1bulk-pdf/post/responses/400/content/application~1json/example":{"value":{"processId":"processId","reasons":[{"code":"51580020","message":"All Document IDs provided in this request were either invalid or the billing document is not available."}],"success":false,"requestId":"d4b8c683-04ff-407d-964a-a63ae7917483"},"id":"paths/~1v1~1operations~1bulk-pdf/post/responses/400/content/application~1json/example"},"paths/~1v1~1operations~1bulk-pdf/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1operations~1bulk-pdf/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1operations~1bulk-pdf/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1operations~1bulk-pdf/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/200/content/application~1json/example":{"value":{"jobId":"2c92c8955bd63cc1015bd7c151af02ab","jobName":"BulkPDFGenerationJobV1","status":"Completed","stepStatus":"PostProcessing","fileUrls":["https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_1.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99","https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_2.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99"],"createdOn":"2024-01-08 12:52:05","createdBy":"caf630704a6f4100818601625ecffe0b","success":true},"id":"paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/200/content/application~1json/example"},"paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1operations~1bulk-pdf~1{jobId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example1":{"value":{"description":"This is a sample response for accounts from a batch with a billCycleDay of 01.","runType":"AdHoc","targetAccountCategory":"AllAccounts","batchName":"Batch1","billCycleDay":"01","dateRangeType":"PreviousOneCalendarMonth","autoEmailEnabled":false},"key":"Example1","summary":"Example1","id":"paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example1"},"paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example2":{"value":{"description":"This is a sample response for accounts from a batch with open invoices.","runType":"AdHoc","targetAccountCategory":"AccountsWithOpenInvoices","batchName":"Batch1","dateRangeType":"PreviousOneCalendarMonth","autoEmailEnabled":false},"key":"Example2","summary":"Example2","id":"paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example2"},"paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example3":{"value":{"description":"This is a sample response for accounts from a batch with a billCycleDay of 01 that has open invoices.","runType":"AdHoc","targetAccountCategory":"AccountsWithOpenInvoices","batchName":"Batch1","dateRangeType":"PreviousOneCalendarMonth","autoEmailEnabled":false},"key":"Example3","summary":"Example3","id":"paths/~1v1~1summary-statement-runs/post/requestBody/content/application~1json/examples/Example3"},"paths/~1v1~1summary-statement-runs/post/responses/200/content/application~1json/examples/response":{"value":{"id":"402881869169397401916d8ff8d218c5","statementRunNumber":"SSR-00000004","targetAccountCategory":"AllAccounts","accountKey":null,"runType":"AdHoc","batchName":"Batch51","billCycleDay":null,"dateRangeType":"PreviousThreeCalendarMonth","startDate":"2024-05-01 19:13:57","endDate":"2024-07-31 19:13:57","autoEmailEnabled":false,"description":"HelloWorld","status":"Pending","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2024-08-19 19:13:57","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2024-08-20 10:13:57.586","success":true},"key":"response","summary":"response","id":"paths/~1v1~1summary-statement-runs/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1summary-statement-runs/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1summary-statement-runs/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1summary-statement-runs/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null","requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false}]},"key":"response","summary":"response","id":"paths/~1v1~1summary-statement-runs/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/200/content/application~1json/example"},"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidStatementStatus":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Summary statement SS-00001 with status Processing cannot be deleted. Only Completed, Canceled, Error, or Previewing summary statements can be deleted."}]},"key":"invalidStatementStatus","summary":"invalidStatementStatus","id":"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidStatementStatus"},"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidRunStatus":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Statement cannot be deleted when the parent summary statement run, ID: 2c92c8955bd63cc1015bd7c151af02ab, has status Processing. Only summary statements from Completed, Error, or Terminated runs can be deleted."}]},"key":"invalidRunStatus","summary":"invalidRunStatus","id":"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/invalidRunStatus"},"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/authenticationError":{"value":{"success":false,"reasons":[{"code":"UNAUTHORIZED","message":"Authentication error"}]},"key":"authenticationError","summary":"authenticationError","id":"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/authenticationError"},"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/notFound":{"value":{"success":false,"reasons":[{"code":"NOT_FOUND","message":"Summary statement not found"}]},"key":"notFound","summary":"notFound","id":"paths/~1v1~1summary-statements~1{summaryStatementKey}/delete/responses/4XX/content/application~1json/examples/notFound"},"paths/~1v1~1bill-runs/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1bill-runs/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunId}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunId}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunId}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunId}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunId}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunId}~1post/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1bill-runs~1{billRunKey}~1emails/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1billing-preview-runs/post/responses/200/content/application~1json/examples/response":{"value":{"billingPreviewRunId":"402890b757d1ec1b0157d5aa3d6802aa","success":true},"key":"response","summary":"response","id":"paths/~1v1~1billing-preview-runs/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1billing-preview-runs/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1billing-preview-runs/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1billing-preview-runs/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1billing-preview-runs/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/200/content/application~1json/examples/response":{"value":{"assumeRenewal":"Autorenew","batches":"","chargeTypeToExclude":"OneTime","createdById":"4028906d58240f960158241132be0003","createdDate":"2016-11-04 16:18:56","endDate":"2016-11-04 16:19:00","errorMessage":null,"includingDraftItems":false,"includingEvergreenSubscription":true,"resultFileUrl":"https://rest.zuora.com/v1/files/4028906d582d21a101582e6b663c0a65","runNumber":"BPR-00000010","startDate":"2016-11-04 16:19:00","status":"Completed","succeededAccounts":7,"success":true,"targetDate":"2016-12-01","totalAccounts":7,"updatedById":"4028906d58240f960158241132be0003","updatedDate":"2016-11-04 16:19:00"},"key":"response","summary":"response","id":"paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1billing-preview-runs~1{billingPreviewRunId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods/post/responses/200/content/application~1json/examples/response":{"value":{"id":"2c92a09650a7a80a0150ab50a5b746bd","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1decryption/post/responses/200/content/application~1json/examples/response":{"value":{"paymentMethodId":"2c92c8f83dcbd8b1013dcce1d6a600ce","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1decryption/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1decryption/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1decryption/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1decryption/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1decryption/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/200/content/application~1json/examples/response":{"value":{"AA_PICKLIST__c":null,"accountHolderInfo":{"accountHolderName":"John Smith","addressLine1":"ABC","addressLine2":"EFT","city":"Example City","country":"United States","email":"example@google.com","phone":"86123456789","state":"Example State","zipCode":"844000"},"accountKey":"4028839f7ca29000017ca29c1ce8003f","bankIdentificationNumber":"411111","cardBinInfo":{"brand":"Visa","cardClass":"Credit","productType":"Consumer_Card","issuer":"JPMORGAN CHASE BANK N.A.","issuingCountryCode":"US"},"cardNumber":"************1111","createdBy":"402881e522cf4f9b0122cf5d82860002","createdDate":"2021-11-15 18:59:08","creditCardType":"Visa","deviceSessionId":null,"existingMandate":null,"expirationMonth":11,"expirationYear":2027,"id":"4028839f7d26a155017d26af16ef0001","identityNumber":"97370192024","ipAddress":null,"isDefault":true,"lastFailedSaleTransactionDate":null,"lastTransaction":"Approved","lastTransactionDateTime":"2021-11-15 18:59:08","lastTransactionStatus":"Approved","mandateInfo":{"mitConsentAgreementRef":null,"mitConsentAgreementSrc":null,"mitProfileAction":null,"mitProfileAgreedOn":null,"mitProfileType":null,"mitTransactionId":null},"maxConsecutivePaymentFailures":null,"numConsecutiveFailures":0,"paymentRetryWindow":null,"status":"Active","success":true,"totalNumberOfErrorPayments":0,"totalNumberOfProcessedPayments":0,"type":"CreditCard","updatedBy":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2021-11-15 18:59:08","useDefaultRetryRule":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/200/content/application~1json/examples/response":{"value":{"id":"2c92c0f86c99b4eb016cae1ee301728f","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/200/content/application~1json/examples/response":{"value":{"paymentMethodId":"402890765d9ce329015da18034ee0057","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1verify/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1scrub/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/200/content/application~1json/examples/response":{"value":{"success":true,"currency":"USD","availableBalance":100,"currentBalance":110.55},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"Only ACH payment method is supported to check balance."}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1balance/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/200/content/application~1json/examples/response":{"value":{"profiles":[{"activatedOn":"2019-03-06 07:45:55","agreedOn":"2019-03-06 07:45:55","brand":"Visa","cancelledOn":"2019-03-13 07:52:16","consentAgreementRef":"ACCT1338AgreementV1.pdf","consentAgreementSrc":"External","expiredOn":null,"number":1,"paymentMethodId":"402881836953a3c7016953aec290000d","status":"Cancelled","type":"Recurring"},{"activatedOn":"2019-03-13 07:55:08","agreedOn":"2019-03-13 07:55:08","brand":"Visa","cancelledOn":null,"consentAgreementRef":"ACCT1338AgreementV2.pdf","consentAgreementSrc":"External","expiredOn":null,"number":2,"paymentMethodId":"402881836953a3c7016953aec290000d","status":"Active","type":"Recurring"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/200/content/application~1json/examples/response":{"value":{"number":3,"paymentMethodId":"402881836953a3c7016953aec290000d","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/200/content/application~1json/examples/response":{"value":{"number":1,"paymentMethodId":"402881836953a3c7016953aec290000d","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1cancel/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/200/content/application~1json/examples/response":{"value":{"number":2,"paymentMethodId":"402881836953a3c7016953aec290000d","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1expire/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/200/content/application~1json/examples/response":{"value":{"id":"402881836953a3c7016953aec290000e","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"authGateway may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1profiles~1{profile-number}~1profile-data/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1wallet~1domains/get/responses/200/content/application~1json/examples/response":{"value":{"domains":[{"createdBy":"402881e522cf4f9b0122cf5d82860002","createdOn":"2023-07-05 00:44:51","domainIdentifier":"zuora_19_pimi_1","domainName":"testapplepay.zuora.com","domainVerified":true,"id":"402881a38924ff1001892502da090021","updatedBy":"402881e522cf4f9b0122cf5d82860002","updatedOn":"2023-07-05 00:44:51","walletType":"ApplePay"},{"createdBy":"402881e522cf4f9b0122cf5d82860002","createdOn":"2023-07-04 01:02:12","domainIdentifier":"zuora_19_pimi_1","domainName":"test1.zuora.com","domainVerified":false,"id":"402881a3891fe7b401891fec61d40036","updatedBy":"402881e522cf4f9b0122cf5d82860002","updatedOn":"2023-07-04 01:02:12","walletType":"ApplePay"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1wallet~1domains/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1wallet~1domains/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1wallet~1domains/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1wallet~1domains/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1wallet~1domains/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1wallet~1domains/post/responses/200/content/application~1json/examples/response":{"value":{"domainName":"testapplepay.zuora.com","domainVerified":true,"id":"402881a38924ff1001892502da090021","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1wallet~1domains/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1wallet~1domains/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1wallet~1domains/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1wallet~1domains/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1wallet~1domains/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1wallet~1domains~1{id}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1web-payments~1sessions/post/responses/200/content/application~1json/examples/response":{"value":{"token":"LTljuuLaDQnHxeVpWaX6zq2xY2FJ6sSE"},"key":"response","summary":"response","id":"paths/~1web-payments~1sessions/post/responses/200/content/application~1json/examples/response"},"paths/~1web-payments~1sessions/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1web-payments~1sessions/post/responses/500/content/application~1json/examples/response"},"paths/~1web-payments~1sessions/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1web-payments~1sessions/post/responses/4XX/content/application~1json/examples/response"},"paths/~1open-payment-method-types/post/responses/200/content/application~1json/examples/response":{"value":{"paymentMethodType":"AmazonPay__C_12368","publishDate":"","revision":1,"status":"Draft"},"key":"response","summary":"response","id":"paths/~1open-payment-method-types/post/responses/200/content/application~1json/examples/response"},"paths/~1open-payment-method-types~1publish~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response":{"value":{"entityId":"","fields":[{"checksum":true,"defaultValue":null,"description":"The Token value","editable":true,"index":1,"label":"AmazonToken","maxLength":100,"minLength":1,"name":"AmazonToken","representer":true,"required":true,"type":"string","visible":true},{"checksum":true,"defaultValue":null,"description":"The Type of Token, e.g. GoCardlessToken","editable":true,"index":2,"label":"Amazon TokenType","maxLength":100,"minLength":1,"name":"AmazonTokenType","representer":true,"required":true,"type":"string","visible":true}],"internalName":"AmazonPay","label":"ZuoraQA Amazon Pay","methodReferenceIdField":"AmazonToken","revision":1,"status":"Published","subTypeField":"AmazonTokenType","tenantId":"9","userReferenceIdField":"AmazonAccount","version":"2021-11-22"},"key":"response","summary":"response","id":"paths/~1open-payment-method-types~1publish~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response"},"paths/~1open-payment-method-types~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response":{"value":{"paymentMethodType":"AmazonPay__c_12368","publishDate":"","revision":2,"status":"Draft"},"key":"response","summary":"response","id":"paths/~1open-payment-method-types~1{paymentMethodTypeName}/put/responses/200/content/application~1json/examples/response"},"paths/~1open-payment-method-types~1{paymentMethodTypeName}~1draft~1{revisionNumber}/get/responses/200/content/application~1json/examples/response":{"value":{"entityId":"f707d981-3ad2-4484-9c24-a93bf6b83411","fields":[{"checksum":true,"defaultValue":null,"description":"The Token value","editable":true,"index":1,"label":"AmazonToken","maxLength":100,"minLength":1,"name":"AmazonToken","representer":true,"required":true,"type":"string","visible":true},{"checksum":true,"defaultValue":null,"description":"The Type of Token, e.g. GoCardlessToken","editable":true,"index":2,"label":"Amazon TokenType","maxLength":100,"minLength":1,"name":"AmazonTokenType","representer":true,"required":true,"type":"string","visible":true}],"internalName":"AmazonPay","label":"ZuoraQA Amazon Pay","methodReferenceIdField":"AmazonToken","revision":1,"status":"Published","subTypeField":"AmazonTokenType","tenantId":"9","userReferenceIdField":"AmazonAccount","version":"2021-11-22"},"key":"response","summary":"response","id":"paths/~1open-payment-method-types~1{paymentMethodTypeName}~1draft~1{revisionNumber}/get/responses/200/content/application~1json/examples/response"},"paths/~1open-payment-method-types~1{paymentMethodTypeName}~1published/get/responses/200/content/application~1json/examples/response":{"value":{"entityId":"f707d981-3ad2-4484-9c24-a93bf6b83411","fields":[{"checksum":true,"defaultValue":null,"description":"The Token value","editable":true,"index":1,"label":"AmazonToken","maxLength":100,"minLength":1,"name":"AmazonToken","representer":true,"required":true,"type":"string","visible":true},{"checksum":true,"defaultValue":null,"description":"The Type of Token, e.g. GoCardlessToken","editable":true,"index":2,"label":"Amazon TokenType","maxLength":100,"minLength":1,"name":"AmazonTokenType","representer":true,"required":true,"type":"string","visible":true}],"internalName":"AmazonPay","label":"ZuoraQA Amazon Pay","methodReferenceIdField":"AmazonToken","revision":1,"status":"Published","subTypeField":"AmazonTokenType","tenantId":"9","userReferenceIdField":"AmazonAccount","version":"2021-11-22"},"key":"response","summary":"response","id":"paths/~1open-payment-method-types~1{paymentMethodTypeName}~1published/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-method-updaters/get/responses/200/content/application~1json/examples/response":{"value":{"success":true,"updaters":[{"daysToUpdateBeforeBcd":7,"id":"418734b01fbb11ee821f0e4e5eec84cf","isActive":true,"isDefault":true,"isTest":true,"processAssociatedGwOnly":true,"processAutopayDefaultPmOnly":true,"processMastercard":true,"processVisa":true,"updaterGatewayType":"CyberSource","updaterName":"CyberSourceUpdater"},{"daysToUpdateBeforeBcd":8,"id":"418739741fbb11ee821f0e4e5eec84cf","isActive":true,"isDefault":false,"isTest":true,"processAssociatedGwOnly":true,"processAutopayDefaultPmOnly":true,"processMastercard":true,"processVisa":true,"updaterGatewayType":"WorldPay","updaterName":"WorldPayUpdater"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-method-updaters/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-method-updaters/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-method-updaters/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-method-updaters/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-method-updaters/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-method-updaters~1batches/post/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-method-updaters~1batches/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-method-updaters~1batches/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-method-updaters~1batches/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-method-updaters~1batches/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-method-updaters~1batches/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"AccountId":"2c93808457d787030157e0314c0945d4","BankIdentificationNumber":"411111","CompanyName":"","CreditCardAddress1":"312 2nd Ave W","CreditCardCity":"Seattle","CreditCardCountry":"United States","CreditCardExpirationMonth":12,"CreditCardExpirationYear":2020,"CreditCardHolderName":"Somebody","CreditCardMaskNumber":"************1111","CreditCardPostalCode":"98119","CreditCardState":"Washington","CreditCardType":"Visa","Id":"2c93808457d787030157e0314f2245d8","IdentityNumber":"","IsCompany":false,"NumConsecutiveFailures":0,"PaymentMethodId":"2c93808457d787030157e0314e8145d7","PaymentMethodStatus":"Active","TotalNumberOfErrorPayments":0,"TotalNumberOfProcessedPayments":0,"Type":"CreditCard","UseDefaultRetryRule":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"done":true,"records":{},"size":0},"key":"response","summary":"response","id":"paths/~1v1~1object~1payment-method-snapshot~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"done":true,"records":{},"size":0},"key":"response","summary":"response","id":"paths/~1v1~1object~1payment-method-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1hostedpages/get/responses/200/content/application~1json/examples/response":{"value":{"hostedpages":[{"pageId":"8a85858f49a3f2230149abccaa2e004a","pageType":"ACH","pageVersion":2},{"pageId":"8a85858f49a3f2230149abcd99090057","pageType":"Bank Transfer","pageVersion":2},{"pageId":"8a85858f49a3f2230149a71083d40019","pageType":"Credit Card","pageVersion":2}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1hostedpages/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1hostedpages/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1hostedpages/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1hostedpages/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1hostedpages/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1rsa-signatures/post/responses/200/content/application~1json/examples/response":{"value":{"key":"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWRFTwxQOqaG4JDZSQF/NJWvCDoSXm3TYilNzoN8nBbuvhKa7SZBBS+VP6rFqcbIU38Fu+Rf09vqyYOxuasPJe7yhqeOiStWB/aCPLhwXBeKt37L/qkwpNOKb1FETtUgrc+UjbtT0pnl55wCfi+Ik//X5SQi0B+c0ei1DQv99qmPJJErrhnBtdxeaWAT0EYAo42AOQ5cp0UWDY6OdOYL6+RyFOUFIs1yEgtfg4VMMSpSOKBOhYclQYuSC7nBF5Cc18ydtzsBpf7l49gCLTFzG45NCDAocada8KihFNpGXbauV9V4EPRD4lofaXdsXJ5Tw8/+KCsrUlvIQI3vcEv9LQIDAQAB","signature":"VpCAFL2hHC2irxbhWYGLJmdBigjARsCStwHZiQ78z5LyVuBCFr2lkie0db/7E8n38MXaq12Ng5As5Qj+9Nhz6RBsSEWLod7c7hvwNI28OcgBZtcV/wscbWU69EP/+/XrQnF3ZUbHbqmcmhE8C/zNnc2zvHckfArroDW2HxxmATfMJS0xKUm5TrHi4tiILZVMYY1KIUqQTyuXV6uRWYzkqMkFkZDNCxSxf0XwzuBI/VOgTCmFZb0c3+bk/q6+7d/azFCrrg8C3dquCNJRfUeaBou+SLUa4TW3hV4rGd2zpvSrD/425x4qFNGV6JQ7wvIleIdrXU4qbh9nCmYoApMODA==","success":true,"tenantId":"12270","token":"E2BJEle7YrAlw93SjkaKthTmzMvXF341"},"key":"response","summary":"response","id":"paths/~1v1~1rsa-signatures/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1rsa-signatures/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1rsa-signatures/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1rsa-signatures/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1rsa-signatures/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1rsa-signatures~1decrypt/post/responses/200/content/application~1json/examples/response":{"value":{"decryptedSignature":"/apps/publichostedpagelite.do#12270#tpyeSbjfUdpZpY4EMSCy7CrupvuhIdvM#1473658419005#2c92c0f855e2b4630155ec9e6a1b6eec","publicKey":"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWRFTwxQOqaG4JDZSQF/NJWvCDoSXm3TYilNzoN8nBbuvhKa7SZBBS+VP6rFqcbIU38Fu+Rf09vqyYOxuasPJe7yhqeOiStWB/aCPLhwXBeKt37L/qkwpNOKb1FETtUgrc+UjbtT0pnl55wCfi+Ik//X5SQi0B+c0ei1DQv99qmPJJErrhnBtdxeaWAT0EYAo42AOQ5cp0UWDY6OdOYL6+RyFOUFIs1yEgtfg4VMMSpSOKBOhYclQYuSC7nBF5Cc18ydtzsBpf7l49gCLTFzG45NCDAocada8KihFNpGXbauV9V4EPRD4lofaXdsXJ5Tw8/+KCsrUlvIQI3vcEv9LQIDAQAB","signature":"BeNYuHFkp/sbfm3clYyCkKEqd7XVTRDOJ1/5rL0tpkqxiSq+maqYkDz5kA+lN64ipoefQuJ7Rdm5TpICErufeJfa2sfTmGARDJ0hr+StXfLsIxHmDoNH5dqcXv3W6MR4kaljEqPVuhzGQ0We98DG52JcHWqqN53oHwTyuZuXocQqnmiE23IPm8UrU3g4hX/OLat0R81wDQ1SslZ+4pnqlncpTpopCK4FxeG3B0gYMhZcYd17Cmf0N3tEHVXHDlJIm4rOx0OVT+YBnjbKYLM0jxYu7PRKRis+yzN1BoappOEB0gmPjznIeiYF0u/fJdZWoEwK7d9mrfJeOBbpFyRoHA==","success":true},"key":"response","summary":"response","id":"paths/~1v1~1rsa-signatures~1decrypt/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1rsa-signatures~1decrypt/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1rsa-signatures~1decrypt/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1rsa-signatures~1decrypt/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1rsa-signatures~1decrypt/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1authorize/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-methods~1{payment-method-id}~1voidAuthorize/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1paymentgateways/get/responses/200/content/application~1json/examples/response":{"value":{"paymentgateways":[{"id":"4028905f5702783601570291e14c0015","isActive":true,"isDefault":true,"name":"Test Gateway Adapter","type":"Test Gateway"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1paymentgateways/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1paymentgateways/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1paymentgateways/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1paymentgateways/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1paymentgateways/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"98F4A32E685BABCD","reasons":[{"code":"52307120","message":"Pre debit notification has already been sent for the invoice with ID:c2289d0a8d3af0f2018d3b2b1fdb00b2"}],"requestId":"b74fe34e-083c-4386-8284-ce1685a00000","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-gateways~1pre-debit-notification/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad0987e92f64ccb01931a35c06b46d6","number":"R-00000027","status":"Processed","type":"External","methodType":"CreditCard","accountId":"8ad09bce83f1da020183f97e245c1c47","amount":10,"refundDate":"2024-11-11","comment":null,"paymentMethodId":"8ad09bce83f1da020183f97e24821c4b","paymentMethodSnapshotId":null,"paymentId":"8ad0943792d670bc0192dc396bac151f","paymentNumber":"P-00001538","creditMemoId":null,"reasonCode":"Payment Reversal","gatewayId":null,"paymentGatewayNumber":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"Settled","markedForSubmissionOn":null,"referenceId":null,"secondRefundReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":null,"settledOn":"2024-11-11 15:52:30","cancelledOn":null,"createdDate":"2024-11-11 15:52:30","createdById":"8ad084a67f9c7138017fab8a8b511b5a","updatedDate":"2024-11-11 15:52:30","updatedById":"8ad084a67f9c7138017fab8a8b511b5a","refundTransactionTime":null,"financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":"Accounts Receivable","unappliedPaymentAccountingCodeType":"AccountsReceivable","transferredToAccounting":false},"gatewayReconciliationStatus":null,"gatewayReconciliationReason":null,"payoutId":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1chargeback/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad0875992e093310192e70ccaa0589b","number":"R-00000026","status":"Processed","type":"External","methodType":"CreditCard","accountId":"8ad09bce83f1da020183f97e245c1c47","amount":10,"refundDate":"2024-11-01","comment":null,"paymentMethodId":"8ad09bce83f1da020183f97e24821c4b","paymentMethodSnapshotId":null,"paymentId":"8ad0987e92e0a44a0192e646f4de27b1","paymentNumber":"P-00001539","creditMemoId":null,"reasonCode":"Payment Rejection","gatewayId":null,"paymentGatewayNumber":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"Settled","markedForSubmissionOn":null,"referenceId":null,"secondRefundReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":null,"settledOn":"2024-11-01 17:27:08","cancelledOn":null,"createdDate":"2024-11-01 17:27:08","createdById":"8ad084a67f9c7138017fab8a8b511b5a","updatedDate":"2024-11-01 17:27:08","updatedById":"8ad084a67f9c7138017fab8a8b511b5a","refundTransactionTime":null,"financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":"Accounts Receivable","unappliedPaymentAccountingCodeType":"AccountsReceivable","transferredToAccounting":false},"gatewayReconciliationStatus":null,"gatewayReconciliationReason":null,"payoutId":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1reject/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad097b490c4e5aa0190d937784723b5","number":"P-00000020","status":"Processed","type":"Electronic","accountId":"8ad09be48db5aba7018db604776d4854","accountNumber":"A00000097","amount":110.5,"appliedAmount":110.5,"unappliedAmount":0,"refundAmount":0,"creditBalanceAmount":0,"currency":"USD","effectiveDate":"2024-07-21","comment":"","paymentMethodId":"8ad084db90a5e73b0190c02783f552fa","paymentMethodSnapshotId":"8ad097b490c4e5aa0190d937783e23b4","authTransactionId":null,"bankIdentificationNumber":"411111","gatewayId":"2c92c0f972bc6aa90172bc77ccaf379a","paymentGatewayNumber":null,"gatewayOrderId":null,"gatewayResponse":"This transaction has been approved by Test gateway.","gatewayResponseCode":"approve","gatewayState":"Settled","markedForSubmissionOn":null,"referenceId":"7290220.496916332","secondPaymentReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":"2024-07-21 23:53:29","settledOn":"2024-07-21 23:54:38","cancelledOn":null,"createdDate":"2024-07-21 23:53:29","createdById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-07-21 23:54:38","updatedById":"b243314d594646d3b2651aeedd4be47e","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":"Accounts Receivable","unappliedPaymentAccountingCodeType":"AccountsReceivable","transferredToAccounting":false},"gatewayReconciliationStatus":null,"gatewayReconciliationReason":"paid","payoutId":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1gateway-settlement~1payments~1{payment-key}~1settle/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refund-key}~1reconcile/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments/get/responses/200/content/application~1json/examples/response":{"value":{"payments":[{"accountId":"4028905f5a87c0ff015a87d25ae90025","accountNumber":"A00000001","amount":44.1,"appliedAmount":44.1,"authTransactionId":null,"bankIdentificationNumber":null,"cancelledOn":null,"comment":"normal payment","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","creditBalanceAmount":0,"currency":"USD","effectiveDate":"2017-03-01","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"transferredToAccounting":"No","unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null},"gatewayId":null,"gatewayOrderId":null,"gatewayReconciliationReason":null,"gatewayReconciliationStatus":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","id":"4028905f5a87c0ff015a87eb6b75007f","markedForSubmissionOn":null,"number":"P-00000001","paymentGatewayNumber":"PG-00000001","paymentMethodId":"402881e522cf4f9b0122cf5dc4020045","paymentMethodSnapshotId":null,"payoutId":null,"referenceId":null,"refundAmount":0,"secondPaymentReferenceId":null,"settledOn":null,"softDescriptor":null,"softDescriptorPhone":null,"status":"Processed","submittedOn":null,"type":"External","unappliedAmount":0,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 11:30:37"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payments/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90a04d914ac24801914b29e47f0777","number":"P-00000389","status":"Processed","type":"External","accountId":"8a90b4488e7d5c0f018e7db3892400b2","accountNumber":"A00000370","amount":14.99,"appliedAmount":14.99,"unappliedAmount":0,"refundAmount":0,"creditBalanceAmount":0,"currency":"USD","effectiveDate":"2024-08-13","comment":null,"paymentMethodId":"2c92c8f95e2d6ebb015e325df7a70356","paymentMethodSnapshotId":null,"authTransactionId":null,"bankIdentificationNumber":null,"gatewayId":null,"paymentGatewayNumber":null,"gatewayOrderId":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","markedForSubmissionOn":null,"referenceId":null,"secondPaymentReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":null,"settledOn":null,"cancelledOn":null,"createdDate":"2024-08-13 17:55:22","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-08-13 17:55:22","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null,"transferredToAccounting":false},"gatewayReconciliationStatus":null,"gatewayReconciliationReason":null,"payoutId":null,"prepayment":false,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payments/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028905f5a87c0ff015a88889fe500a8","accountNumber":"A00000001","amount":44.1,"appliedAmount":0,"authTransactionId":null,"bankIdentificationNumber":null,"cancelledOn":null,"comment":"Details about this payment","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","creditBalanceAmount":0,"currency":"USD","effectiveDate":"2017-03-01","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"transferredToAccounting":"No","unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null},"gatewayId":null,"gatewayOrderId":null,"gatewayReconciliationReason":null,"gatewayReconciliationStatus":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","id":"4028905f5a87c0ff015a87eb6b75007f","markedForSubmissionOn":null,"number":"P-00000001","paymentGatewayNumber":"PG-00000001","paymentMethodId":"402881e522cf4f9b0122cf5dc4020045","paymentMethodSnapshotId":null,"payoutId":null,"referenceId":null,"refundAmount":0,"secondPaymentReferenceId":null,"settledOn":null,"softDescriptor":null,"softDescriptorPhone":null,"status":"Processed","submittedOn":null,"success":true,"type":"External","unappliedAmount":44.1,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 14:25:34"},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028905f5a87c0ff015a87d25ae90025","accountNumber":"A00000001","amount":44.1,"appliedAmount":44.1,"authTransactionId":null,"bankIdentificationNumber":null,"cancelledOn":null,"comment":"normal payment","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","creditBalanceAmount":0,"currency":"USD","effectiveDate":"2017-03-01","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"transferredToAccounting":"No","unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null},"gatewayId":null,"gatewayOrderId":null,"gatewayReconciliationReason":null,"gatewayReconciliationStatus":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","id":"4028905f5a87c0ff015a87eb6b75007f","markedForSubmissionOn":null,"number":"P-00000001","paymentGatewayNumber":"PG-00000001","paymentMethodId":"402881e522cf4f9b0122cf5dc4020045","paymentMethodSnapshotId":null,"payoutId":null,"referenceId":null,"refundAmount":0,"secondPaymentReferenceId":null,"settledOn":null,"softDescriptor":null,"softDescriptorPhone":null,"status":"Processed","submittedOn":null,"success":true,"type":"External","unappliedAmount":0,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 11:30:37"},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad0835290c4bb2f0190c9b5407c52a3","number":"P-00000018","status":"Processed","type":"External","accountId":"8ad097b490c4e5aa0190c9612d9c7034","accountNumber":"A00000122","amount":14.99,"appliedAmount":12,"unappliedAmount":2.99,"refundAmount":0,"creditBalanceAmount":0,"currency":"USD","effectiveDate":"2024-07-18","comment":null,"paymentMethodId":"2c92c0f86cccaa59016cd5e0c41c0e89","paymentMethodSnapshotId":null,"authTransactionId":null,"bankIdentificationNumber":null,"gatewayId":null,"paymentGatewayNumber":null,"gatewayOrderId":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","markedForSubmissionOn":null,"referenceId":null,"secondPaymentReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":null,"settledOn":null,"cancelledOn":null,"createdDate":"2024-07-18 23:36:57","createdById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-07-18 23:41:55","updatedById":"b243314d594646d3b2651aeedd4be47e","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":"Accounts Receivable","unappliedPaymentAccountingCodeType":"AccountsReceivable","transferredToAccounting":false},"gatewayReconciliationStatus":null,"gatewayReconciliationReason":null,"payoutId":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1apply/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028905f5a87c0ff015a88889fe500a8","accountNumber":"A00000001","amount":44.1,"appliedAmount":0,"authTransactionId":null,"bankIdentificationNumber":null,"cancelledOn":null,"comment":"new comment","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","creditBalanceAmount":0,"currency":"USD","effectiveDate":"2017-03-01","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"transferredToAccounting":"No","unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null},"gatewayId":null,"gatewayOrderId":null,"gatewayReconciliationReason":null,"gatewayReconciliationStatus":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","id":"4028905f5a87c0ff015a87eb6b75007f","markedForSubmissionOn":null,"number":"P-00000001","paymentGatewayNumber":"PG-00000001","paymentMethodId":"402881e522cf4f9b0122cf5dc4020045","paymentMethodSnapshotId":null,"payoutId":null,"referenceId":null,"refundAmount":0,"secondPaymentReferenceId":null,"settledOn":null,"softDescriptor":null,"softDescriptorPhone":null,"status":"Canceled","submittedOn":null,"success":true,"type":"External","unappliedAmount":44.1,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 14:26:57"},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/200/content/application~1json/examples/response":{"value":{"parts":[{"amount":4.1,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","debitMemoId":"4028905f5a87c0ff015a87e49e6b0062","id":"4028905f5a87c0ff015a87eb6beb008d","invoiceId":null,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 11:30:37"},{"amount":40,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","debitMemoId":null,"id":"4028905f5a87c0ff015a87eb6beb008c","invoiceId":"4028905f5a87c0ff015a87d3f8f10043","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 11:30:37"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response":{"value":{"amount":4.1,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","debitMemoId":"4028905f5a87c0ff015a87e49e6b0062","id":"4028905f5a87c0ff015a87eb6beb008d","invoiceId":null,"success":true,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 11:30:37"},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/200/content/application~1json/examples/response":{"value":{"itemParts":[{"amount":4,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","debitMemoItemId":"4028905f5a87c0ff015a87e49e7a0063","id":"4028905f5a87c0ff015a87eb6bd8008a","invoiceItemId":null,"taxItemId":null,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 11:30:37"},{"amount":0.1,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","debitMemoItemId":null,"id":"4028905f5a87c0ff015a87eb6bd8008b","invoiceItemId":null,"taxItemId":"4028905f5a87c0ff015a87e49f5e0065","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 11:30:37"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response":{"value":{"amount":4,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","debitMemoItemId":"4028905f5a87c0ff015a87e49e7a0063","id":"4028905f5a87c0ff015a87eb6bd8008a","invoiceItemId":null,"success":true,"taxItemId":null,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 11:30:37"},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1parts~1{partid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90a04d90de54810190debe8e3b5a2c","number":"R-00000287","status":"Processed","type":"Electronic","methodType":"CreditCard","accountId":"8a90b4488e7d5c0f018e7db3892400b2","amount":10,"refundDate":"2024-07-23","comment":null,"paymentMethodId":"8a90e5e490c9ceb80190d8e9df930bf0","paymentMethodSnapshotId":"8a90a04d90de54810190debe8e0c5a29","paymentId":"8a90e5e490c9ceb80190d91837840c1d","paymentNumber":"P-00000387","creditMemoId":null,"reasonCode":null,"gatewayId":"8a90d6128ddbaf39018de2d9fe0d2660","paymentGatewayNumber":"PG-00000001","gatewayResponse":"Approved","gatewayResponseCode":"OK","gatewayState":"Submitted","markedForSubmissionOn":null,"referenceId":null,"secondRefundReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":"2024-07-23 16:39:09","settledOn":null,"cancelledOn":null,"createdDate":"2024-07-23 16:39:08","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-07-23 16:39:12","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","refundTransactionTime":"2024-07-23 16:39:09","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null,"transferredToAccounting":false},"gatewayReconciliationStatus":null,"gatewayReconciliationReason":null,"payoutId":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1refunds/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90e4a79310d4b00193196d987670fe","number":"R-00000289","status":"Processed","type":"Electronic","methodType":"CreditCard","accountId":"8a90b4488e7d5c0f018e7db3892400b2","amount":10,"refundDate":"2024-11-11","comment":null,"paymentMethodId":"8a90b44890c9bb0d0190d960b9191eea","paymentMethodSnapshotId":"8a90e4a79310d4b00193196d981370fb","paymentId":"8a90f26f92f732c70192fb5323d227ad","paymentNumber":"P-00000394","creditMemoId":null,"reasonCode":null,"gatewayId":"8a90d6128ddbaf39018de2d9fe0d2660","paymentGatewayNumber":"PG-00000001","gatewayResponse":"Approved","gatewayResponseCode":"OK","gatewayState":"Submitted","markedForSubmissionOn":null,"referenceId":"","secondRefundReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":"2024-11-11 12:13:53","settledOn":null,"cancelledOn":null,"createdDate":"2024-11-11 12:13:52","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-11-11 12:14:03","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","refundTransactionTime":"2024-11-11 12:13:53","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null,"transferredToAccounting":false},"gatewayReconciliationStatus":null,"gatewayReconciliationReason":null,"payoutId":null,"writeOff":false,"writeOffResults":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1refunds~1unapply/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028905f5a87c0ff015a88889fe500a8","accountNumber":"A00000001","amount":44.1,"appliedAmount":0,"authTransactionId":null,"bankIdentificationNumber":null,"cancelledOn":null,"comment":"normal payment","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 11:30:37","creditBalanceAmount":0,"currency":"USD","effectiveDate":"2017-03-01","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"transferredToAccounting":"No","unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null},"gatewayId":null,"gatewayOrderId":null,"gatewayReconciliationReason":null,"gatewayReconciliationStatus":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","id":"4028905f5a87c0ff015a87eb6b75007f","markedForSubmissionOn":null,"number":"P-00000001","paymentGatewayNumber":"PG-00000001","paymentMethodId":"402881e522cf4f9b0122cf5dc4020045","paymentMethodSnapshotId":null,"payoutId":null,"referenceId":null,"refundAmount":0,"secondPaymentReferenceId":null,"settledOn":null,"softDescriptor":null,"softDescriptorPhone":null,"status":"Processed","submittedOn":null,"success":true,"type":"External","unappliedAmount":44.1,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 14:22:58"},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1transfer/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad0835290c4bb2f0190c9b5407c52a3","number":"P-00000018","status":"Processed","type":"External","accountId":"8ad097b490c4e5aa0190c9612d9c7034","accountNumber":"A00000122","amount":14.99,"appliedAmount":0,"unappliedAmount":14.99,"refundAmount":0,"creditBalanceAmount":0,"currency":"USD","effectiveDate":"2024-07-18","comment":null,"paymentMethodId":"2c92c0f86cccaa59016cd5e0c41c0e89","paymentMethodSnapshotId":null,"authTransactionId":null,"bankIdentificationNumber":null,"gatewayId":null,"paymentGatewayNumber":null,"gatewayOrderId":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","markedForSubmissionOn":null,"referenceId":null,"secondPaymentReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":null,"settledOn":null,"cancelledOn":null,"createdDate":"2024-07-18 23:36:57","createdById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-07-19 00:03:20","updatedById":"b243314d594646d3b2651aeedd4be47e","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":"Accounts Receivable","unappliedPaymentAccountingCodeType":"AccountsReceivable","transferredToAccounting":false},"gatewayReconciliationStatus":null,"gatewayReconciliationReason":null,"payoutId":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payments~1{paymentKey}~1unapply/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"Gateway":"TEST gateway name1476935063101","GatewayReasonCode":"approve","GatewayReasonCodeDescription":"This transaction has been approved by Test gateway.","GatewayState":"Submitted","GatewayTransactionType":"Sale","Id":"2c93808457d787030157e030b2703dcd","PaymentId":"2c93808457d787030157e030b2673dcc","TransactionDate":"2016-10-20T05:44:30.000+02:00","TransactionId":"874200.071357285"},"key":"response","summary":"response","id":"paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"done":true,"records":{},"size":0},"key":"response","summary":"response","id":"paths/~1v1~1object~1payment-transaction-log~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1payment-runs/get/responses/200/content/application~1json/examples/response":{"value":{"nextPage":"/payment-runs?page=2","paymentRuns":[{"applyCreditBalance":false,"collectPayment":true,"completedOn":"2017-12-28 13:00:00","consolidatedPayment":false,"createdById":"2c92c0f956bc8fcb0156f8eee04b4d54","createdDate":"2017-12-27 13:00:00","executedOn":"2017-12-28 13:00:00","id":"2c92c0856078bbcb016096576ccb75ca","number":"PR-00002121","processPaymentWithClosedPM":false,"runDate":null,"status":"Completed","targetDate":"2017-12-28","updatedById":"2c92c0f956bc8fcb0156f8eee04b4d54","updatedDate":"2017-12-28 13:00:00"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-runs/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-runs/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad0835290e7dcf90190fd37f43e4bd8","number":"PR-00000006","targetDate":"2024-07-24","runDate":null,"status":"Pending","accountId":"8ad09be48db5aba7018db604776d4854","executedOn":null,"completedOn":null,"autoApplyCreditMemo":false,"autoApplyUnappliedPayment":false,"consolidatedPayment":false,"processPaymentWithClosedPM":false,"collectPayment":true,"useCustomPaymentMethods":true,"createdDate":"2024-07-28 23:40:21","createdById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-07-28 23:40:21","updatedById":"b243314d594646d3b2651aeedd4be47e","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-runs/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-runs~1{paymentRunKey}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-runs~1{paymentRunKey}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-runs~1{paymentRunKey}/get/responses/200/content/application~1json/examples/response":{"value":{"applyCreditBalance":false,"collectPayment":true,"completedOn":"2017-12-28 09:00:06","consolidatedPayment":false,"createdById":"2c92c0f958fffd7d015914aeefc71a5d","createdDate":"2017-12-27 09:00:02","executedOn":"2017-12-28 09:00:06","id":"2c92c0856078bbcb0160957bbb8f0b32","number":"PR-00002120","processPaymentWithClosedPM":false,"runDate":null,"status":"Completed","success":true,"targetDate":"2017-12-28","updatedById":"2c92c0f958fffd7d015914aeefc71a5d","updatedDate":"2017-12-28 09:00:06"},"key":"response","summary":"response","id":"paths/~1v1~1payment-runs~1{paymentRunKey}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-runs~1{paymentRunKey}/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"402890245f097f39015f0e9fcdd60558","autoApplyCreditMemo":true,"autoApplyUnappliedPayment":true,"collectPayment":true,"completedOn":null,"consolidatedPayment":true,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-09-22 12:37:22","executedOn":null,"id":"402890245f097f39015f0f074a2e0566","number":"PR-00000391","processPaymentWithClosedPM":true,"rundate":null,"status":"Pending","success":true,"targetDate":"2017-10-12","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-09-22 12:37:22"},"key":"response","summary":"response","id":"paths/~1v1~1payment-runs~1{paymentRunKey}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-runs~1{paymentRunKey}~1data/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"accountId":"402881ed738ddf2001738def8db50058","amount":80,"amountCollected":80,"amountToCollect":80,"comment":"Comment1","customField1__c":"cf_value1","customField2__c":"cf_value2","documentId":"402881ed738ddf2001738df388fd009e","documentType":"Invoice","paymentGatewayId":"402881ed738ddf2001738def8b630050","paymentMethodId":"402881ed738ddf2001738def8e60005b","result":"Processed","transactions":[{"amount":40,"appliedAmount":40,"id":"402881ed738ddf2001738dfafad6012c","status":"Processed","type":"Payment"},{"appliedAmount":10,"id":"402881ed738ddf2001738df7572400e6","type":"CreditMemo"},{"appliedAmount":30,"id":"402881ed738ddf2001738df715d800dd","type":"UnappliedPayment"}]},{"accountId":"402881ed738ddf2001738def8db50058","amount":70,"amountCollected":70,"amountToCollect":70,"comment":"Comment2","customField1__c":"cf_value3","customField2__c":"cf_value4","documentId":"402881ed738ddf2001738df5b90a00c0","documentType":"DebitMemo","paymentGatewayId":"402881ed738ddf2001738def8b630050","paymentMethodId":"402881ed738ddf2001738df97dbe00fe","result":"Processed","transactions":[{"amount":70,"appliedAmount":70,"id":"402881ed738ddf2001738dfafcbd013b","status":"Processed","type":"Payment"}]},{"accountId":"c49b85cd8ba742edb5ab4b3da90fc4c0","comment":"Comment3","customField1__c":"cf_value5","customField2__c":"cf_value6","documentId":"7dab18d036dc4c94bbec853afb12affb","documentType":"Invoice","errorCode":"Invalid_Request_Data","errorMessage":"Payment method is closed","paymentGatewayId":"768929c2f51947e79e73703bfc9bca7d","paymentMethodId":"1906df6f56f049c8b7457dc31f62d0ec","result":"Error"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-runs~1{paymentRunKey}~1data/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-runs~1{paymentRunKey}~1summary/get/responses/200/content/application~1json/examples/response":{"value":{"numberOfCreditBalanceAdjustments":0,"numberOfCreditMemos":1,"numberOfDebitMemos":1,"numberOfErrors":0,"numberOfInvoices":0,"numberOfPayments":1,"numberOfReceivables":1,"numberOfUnappliedPayments":1,"numberOfUnprocessedDebitMemos":0,"numberOfUnprocessedInvoices":0,"numberOfUnprocessedReceivables":0,"success":true,"totalValues":[{"totalValueOfCreditBalance":"0 USD","totalValueOfCreditMemos":"100 USD","totalValueOfDebitMemos":"256 USD","totalValueOfErrors":"0 USD","totalValueOfInvoices":"0 USD","totalValueOfPayments":"56 USD","totalValueOfReceivables":"256 USD","totalValueOfUnappliedPayments":"100 USD","totalValueOfUnprocessedDebitMemos":"0 USD","totalValueOfUnprocessedInvoices":"0 USD","totalValueOfUnprocessedReceivables":"0 USD"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-runs~1{paymentRunKey}~1summary/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/200/content/application~1json/examples/response":{"value":{"items":[{"amount":null,"createdById":null,"createdDate":null,"currency":null,"description":null,"errorMessage":"Can not retry because payment Processed status is not allowed.","id":"402882e97f24bc36017f2986654f0253","paymentGatewayId":null,"paymentId":null,"paymentMethodId":null,"paymentScheduleId":"string","paymentScheduleNumber":"string","runHour":null,"scheduledDate":null,"status":null,"updatedById":null,"updatedDate":null},{"PSIPaymentDate__c":"2022-02-22","PSIPaymentPicklist__c":"1","PSIPaymentText__c":"Payment Text From PSI via API Payment Error","PSIPicklist__c":"1","PSIText__c":"PSI Text Value","amount":2,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2022-02-23 18:19:07","currency":"USD","description":null,"errorMessage":null,"id":"402882e97f24bc36017f298665570254","paymentGatewayId":"402883827d097a28017d09b41f690261","paymentId":"402882e97f24bc36017f298efb360277","paymentMethodId":"402882e97f24bc36017f258c2ff20076","paymentScheduleId":"string","paymentScheduleNumber":"string","runHour":0,"scheduledDate":"2022-02-22","status":"Processed","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2022-02-23 18:28:30"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1retry-payment/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"amount":30,"billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"cancellationReason":"Skip Payment","createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-22 00:43:42","currency":"USD","description":"","errorMessage":null,"id":"8a90857b822459cd018224dcb9ec13bf","number":1,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90857b822459cd018224dcb9eb13be","paymentScheduleNumber":"PS-00000007","runHour":23,"scheduledDate":"2022-11-01","standalone":false,"status":"Canceled","success":true,"updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-29 02:54:54"},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{item-id}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/200/content/application~1json/examples/response":{"value":{"amount":30,"billingDocument":null,"cancellationReason":"Skip Payment","cf1__c":null,"cf2__c":null,"createdById":"402892f9423062950142306f2f530002","createdDate":"2022-09-22 00:59:17","currency":"USD","description":"","errorMessage":null,"id":"402881a683642cff018364354abf12b6","number":7,"paymentGatewayId":null,"paymentMethodId":"402892f9423062950142306f326c0056","paymentScheduleId":"402881a68361af72018361d4be120047","paymentScheduleNumber":"PS-00000004","runHour":3,"scheduledDate":"2022-11-04","standalone":true,"status":"Pending","success":true,"updatedById":"402892f9423062950142306f2f530002","updatedDate":"2022-09-22 00:59:17"},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{item-id}~1skip/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/200/content/application~1json/examples/response":{"value":{"amount":30,"billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"cancellationReason":null,"cancelledById":null,"cancelledOn":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-22 00:43:42","currency":"USD","description":"","errorMessage":null,"id":"8a90857b822459cd018224dcb9ec13bf","number":1,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90857b822459cd018224dcb9eb13be","paymentScheduleNumber":"PS-00000007","runHour":23,"scheduledDate":"2022-07-31","standalone":false,"status":"Pending","success":true,"updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-22 00:43:42"},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{psi-id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90d61290c9ceb60190d8eac80e125a","number":1,"paymentScheduleId":"8a90d61290c9ceb60190d8eac80b1259","paymentScheduleNumber":"PS-00000001","scheduledDate":"2024-07-31","runHour":0,"paymentMethodId":"8a90b44890c9bb0d0190d960b9191eea","paymentGatewayId":null,"paymentGatewayNumber":null,"amount":14.99,"balance":14.99,"currency":"USD","status":"Pending","errorMessage":null,"paymentId":null,"billingDocument":{"id":"8a90b44890c9bb0d0190d8c048a90da6","number":"INV00001823","type":"Invoice"},"description":null,"cancellationReason":null,"cancelledById":null,"cancelledOn":null,"createdDate":"2024-07-22 13:29:43","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-07-22 15:40:21","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{psi-id}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedule-items~1{psi-id}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules/get/responses/200/content/application~1json/examples/response":{"value":[{"accountId":"8a90a2fd8074995801807816dbac52a4","accountNumber":"A00000002","billingDocument":null,"billingDocuments":[{"id":"8a26e082802185b201976199e1991521","number":"INV-001","type":"Invoice"},{"id":"8a11e082802185b901126e34713407d2","number":"INV-002","type":"Invoice"}],"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-22 00:43:42","description":"","id":"8a90857b822459cd018224dcb9eb13be","isCustom":true,"items":[{"amount":30,"billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-22 00:43:42","currency":"USD","description":"","errorMessage":null,"id":"8a90857b822459cd018224dcb9ec13bf","number":1,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90857b822459cd018224dcb9eb13be","paymentScheduleNumber":"PS-00000007","runHour":23,"scheduledDate":"2022-07-31","standalone":false,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-22 00:43:42"},{"amount":10,"billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-22 00:45:35","currency":"USD","description":"","errorMessage":null,"id":"8a90a2fd822459ec018224de77a0359d","number":2,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90857b822459cd018224dcb9eb13be","paymentScheduleNumber":"PS-00000007","runHour":20,"scheduledDate":"2022-08-31","standalone":false,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-22 00:45:35"}],"nextPaymentDate":"2022-07-31","occurrences":2,"paymentScheduleNumber":"PS-00000007","period":null,"recentPaymentDate":null,"runHour":0,"standalone":false,"startDate":"2022-07-31","status":"Active","totalAmount":50,"totalPaymentsErrored":0,"totalPaymentsProcessed":0,"updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-22 00:45:36"},{"accountId":"8a90a2fd8074995801807816dbac52a4","accountNumber":"A00000002","billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-20 21:24:40","description":"test update ps Xiaokai","id":"8a90e0828219a57101821f00287a3abd","isCustom":false,"items":[{"amount":10,"billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-20 21:24:40","currency":"USD","description":"test update ps","errorMessage":null,"id":"8a90e0828219a57101821f00287a3abf","number":1,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":"8a90e86d821fd6d1018221eae795158b","paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e0828219a57101821f00287a3abd","paymentScheduleNumber":"PS-00000006","runHour":11,"scheduledDate":"2022-07-21","standalone":false,"status":"Processed","updatedById":"3","updatedDate":"2022-07-21 11:00:19"},{"amount":10,"billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-20 21:24:40","currency":"USD","description":"test update ps","errorMessage":null,"id":"8a90e0828219a57101821f00287b3ac0","number":2,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e0828219a57101821f00287a3abd","paymentScheduleNumber":"PS-00000006","runHour":11,"scheduledDate":"2022-08-04","standalone":false,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-20 21:26:26"},{"amount":10,"billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-20 21:24:40","currency":"USD","description":"test update ps","errorMessage":null,"id":"8a90e0828219a57101821f00287b3ac1","number":3,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e0828219a57101821f00287a3abd","paymentScheduleNumber":"PS-00000006","runHour":11,"scheduledDate":"2022-08-18","standalone":false,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-20 21:26:26"},{"amount":10,"billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-20 21:26:26","currency":"USD","description":"test update ps","errorMessage":null,"id":"8a90e0828219a57101821f01c5447f04","number":4,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e0828219a57101821f00287a3abd","paymentScheduleNumber":"PS-00000006","runHour":11,"scheduledDate":"2022-09-01","standalone":false,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-20 21:26:26"}],"nextPaymentDate":"2022-08-04","occurrences":4,"paymentScheduleNumber":"PS-00000006","period":"BiWeekly","recentPaymentDate":"2022-07-21","runHour":11,"standalone":false,"startDate":"2022-07-21","status":"Active","totalAmount":40,"totalPaymentsErrored":0,"totalPaymentsProcessed":1,"updatedById":"3","updatedDate":"2022-07-21 11:00:21"}],"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90d61290c9ceb60190d8eac80b1259","paymentScheduleNumber":"PS-00000001","accountId":"8a90b4488e7d5c0f018e7db3892400b2","accountNumber":"A00000370","startDate":"2024-07-31","runHour":0,"period":null,"occurrences":1,"status":"Active","totalAmount":14.99,"nextPaymentDate":"2024-07-31","recentPaymentDate":null,"totalPaymentsProcessed":0,"totalPaymentsErrored":0,"description":null,"isCustom":true,"prepayment":false,"billingDocument":{"id":"8a90b44890c9bb0d0190d8c048a90da6","number":"INV00001823","type":"Invoice"},"billingDocuments":[{"id":"8a90b44890c9bb0d0190d8c048a90da6","number":"INV00001823","type":"Invoice"}],"createdDate":"2024-07-22 13:29:43","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-07-22 13:29:43","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","cancelledById":null,"cancelledOn":null,"cancelDate":null,"items":[{"id":"8a90d61290c9ceb60190d8eac80e125a","number":1,"paymentScheduleId":"8a90d61290c9ceb60190d8eac80b1259","paymentScheduleNumber":"PS-00000001","scheduledDate":"2024-07-31","runHour":0,"paymentMethodId":null,"paymentGatewayId":null,"paymentGatewayNumber":null,"amount":14.99,"balance":14.99,"currency":"USD","status":"Pending","errorMessage":null,"paymentId":null,"billingDocument":{"id":"8a90b44890c9bb0d0190d8c048a90da6","number":"INV00001823","type":"Invoice"},"description":null,"cancellationReason":null,"cancelledById":null,"cancelledOn":null,"createdDate":"2024-07-22 13:29:43","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-07-22 13:29:43","updatedById":"2c92c8f95e2d6ebb015e325df48e02da"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1batch/post/responses/200/content/application~1json/examples/response":{"value":{"paymentSchedules":[{"id":"402880e741112b310149b7343ef81234","paymentScheduleNumber":"PS-00311401"},{"id":"402880e741112b310149b7343ef81234","paymentScheduleNumber":"PS-00311402"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1batch/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1batch/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1batch/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1batch/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1batch/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/200/content/application~1json/examples/response":{"value":{"date":"2022-07-29","paymentRuns":[],"paymentScheduleItems":{"error":0,"pending":0,"processed":0},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1statistics~1{yyyy-mm-dd}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"8a90a2fd8074995801807816dbac52a4","accountNumber":"A00000002","billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"billingDocuments":[{"id":"8a26e082802185b201976199e1991521","number":"INV-001","type":"Invoice"},{"id":"8a11e082802185b901126e34713407d2","number":"INV-002","type":"Invoice"}],"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-22 00:43:42","description":"","id":"8a90857b822459cd018224dcb9eb13be","isCustom":true,"items":[{"amount":30,"billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-22 00:43:42","currency":"USD","description":"","errorMessage":null,"id":"8a90857b822459cd018224dcb9ec13bf","number":1,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90857b822459cd018224dcb9eb13be","paymentScheduleNumber":"PS-00000007","runHour":23,"scheduledDate":"2022-07-31","standalone":false,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-22 00:43:42","cancelledById":null,"cancelledOn":null},{"amount":10,"billingDocument":{"id":"8a90a2fd819503b50181959525e5205d","number":"INV00000001","type":"Invoice"},"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-22 00:45:35","currency":"USD","description":"","errorMessage":null,"id":"8a90a2fd822459ec018224de77a0359d","number":2,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90857b822459cd018224dcb9eb13be","paymentScheduleNumber":"PS-00000007","runHour":20,"scheduledDate":"2022-08-31","standalone":false,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-22 00:45:35","cancelledById":null,"cancelledOn":null}],"nextPaymentDate":"2022-07-31","occurrences":2,"paymentScheduleNumber":"PS-00000007","period":null,"recentPaymentDate":null,"runHour":0,"standalone":false,"startDate":"2022-07-31","status":"Active","success":true,"totalAmount":40,"totalPaymentsErrored":0,"totalPaymentsProcessed":0,"updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-22 00:45:36","cancellationReason":null,"cancelledById":null,"cancelledOn":null,"cancelDate":"2022-07-28 00:00:00"},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"8a90a2fd8074995801807816dbac52a4","accountNumber":"A00000002","billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-10 01:46:33","description":"Details of this payment schedule","id":"8a90e08281e10bb00181e749f4db01b8","isCustom":false,"items":[{"amount":100,"billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-10 01:46:33","currency":"USD","description":"test xiaokai","errorMessage":null,"id":"8a90e08281e10bb00181e749f4dd01b9","number":1,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e08281e10bb00181e749f4db01b8","paymentScheduleNumber":"PS-00000002","runHour":12,"scheduledDate":"2022-07-10","standalone":true,"status":"Canceled","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"},{"amount":100,"billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-10 01:46:33","currency":"USD","description":"test xiaokai","errorMessage":null,"id":"8a90e08281e10bb00181e749f4e501ba","number":2,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e08281e10bb00181e749f4db01b8","paymentScheduleNumber":"PS-00000002","runHour":12,"scheduledDate":"2022-08-10","standalone":true,"status":"Canceled","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"},{"amount":10,"billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-10 01:46:33","currency":"USD","description":"test xiaokai","errorMessage":null,"id":"8a90e08281e10bb00181e749f4e601bb","number":3,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e08281e10bb00181e749f4db01b8","paymentScheduleNumber":"PS-00000002","runHour":23,"scheduledDate":"2022-11-01","standalone":true,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"},{"amount":10,"billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-24 20:07:12","currency":"USD","description":"test xiaokai","errorMessage":null,"id":"8a908de6822b2e1501823352ac745b53","number":4,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e08281e10bb00181e749f4db01b8","paymentScheduleNumber":"PS-00000002","runHour":23,"scheduledDate":"2022-12-01","standalone":true,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"},{"amount":10,"billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-28 06:12:39","currency":"USD","description":"test xiaokai","errorMessage":null,"id":"8a90e082824456ae018244f00e0317eb","number":5,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e08281e10bb00181e749f4db01b8","paymentScheduleNumber":"PS-00000002","runHour":23,"scheduledDate":"2023-01-01","standalone":true,"status":"Pending","updatedById":"8a90e082802185b901802199e159021d","updatedDate":"2022-07-28 06:12:39"}],"nextPaymentDate":"2022-11-01","occurrences":5,"paymentScheduleNumber":"PS-00000002","period":"Monthly","recentPaymentDate":null,"runHour":23,"standalone":true,"startDate":"2022-07-10","status":"Active","success":true,"totalAmount":230,"totalPaymentsErrored":0,"totalPaymentsProcessed":0,"updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"402880e741112b310149b7343ef81234","accountNumber":"A-00000001","cf1__c":"v1","createdById":"402892f942306295014230a4ab4909bf","createdDate":"2021-11-01 19:40:00","description":null,"errorCount":0,"id":"402880e749b72b310149b7343ef80005","items":[{"accountId":"402880e741112b310149b7343ef81234","amount":10,"cf1__c":"v1","createdById":"402892f942306295014230a4ab4909bf","createdDate":"2021-11-01 19:40:00","currency":"USD","description":null,"errorMessage":null,"id":"412880e749b72b310149b7343ef81346","number":1,"paymentGatewayId":"abc","paymentId":null,"paymentMethodId":"123","paymentScheduleId":"string","paymentScheduleNumber":"string","runHour":1,"scheduledDate":"2021-11-01","status":"Canceled","updatedById":"402892f942306295014230a4ab4909bf","updatedDate":"2021-11-01 19:40:00"},{"accountId":"402880e741112b310149b7343ef81234","amount":10,"cf1__c":"v1","createdById":"402892f942306295014230a4ab4909bf","createdDate":"2021-11-01 19:40:00","currency":"USD","description":null,"errorMessage":null,"id":"412880e749b72b310149b7343ef81347","number":2,"paymentGatewayId":"abc","paymentId":null,"paymentMethodId":"123","paymentScheduleId":"string","paymentScheduleNumber":"string","runHour":1,"scheduledDate":"2021-12-01","status":"Canceled","updatedById":"402892f942306295014230a4ab4909bf","updatedDate":"2021-11-01 19:40:00"}],"nextProcessDate":"2021-11-01","occurrences":2,"paymentScheduleNumber":"PS-00000001","period":"Monthly","processedCount":0,"recentProcessedDate":null,"runHour":1,"startDate":"2021-11-01","status":"Canceled","success":true,"totalAmount":20,"updatedById":"402892f942306295014230a4ab4909bf","updatedDate":"2021-11-01 19:40:00"},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90aac892f70c8f0192fb48a8e80281","paymentScheduleNumber":"PS-00000003","accountId":"8a90b4488e7d5c0f018e7db3892400b2","accountNumber":"A00000370","startDate":"2024-11-22","runHour":0,"period":null,"occurrences":2,"status":"Active","totalAmount":150,"nextPaymentDate":"2024-11-22","recentPaymentDate":null,"totalPaymentsProcessed":0,"totalPaymentsErrored":0,"description":"","isCustom":true,"prepayment":false,"billingDocument":null,"billingDocuments":[],"createdDate":"2024-11-05 15:44:56","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-11-05 15:46:04","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","cancelledById":null,"cancelledOn":null,"cancelDate":null,"items":[{"id":"8a90aac892f70c8f0192fb48a9150282","number":"1","paymentScheduleId":"8a90aac892f70c8f0192fb48a8e80281","paymentScheduleNumber":"PS-00000003","scheduledDate":"2024-11-22","runHour":0,"paymentMethodId":null,"paymentGatewayId":null,"paymentGatewayNumber":null,"amount":100,"balance":100,"currency":"USD","status":"Pending","errorMessage":null,"paymentId":null,"psiPayments":[],"prepayment":false,"billingDocument":null,"description":"","cancellationReason":null,"cancelledById":null,"cancelledOn":null,"createdDate":"2024-11-05 15:44:56","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-11-05 15:44:56","updatedById":"2c92c8f95e2d6ebb015e325df48e02da"},{"id":"8a9084f992f70ca40192fb49b64d5704","number":"2","paymentScheduleId":"8a90aac892f70c8f0192fb48a8e80281","paymentScheduleNumber":"PS-00000003","scheduledDate":"2024-11-22","runHour":0,"paymentMethodId":null,"paymentGatewayId":null,"paymentGatewayNumber":null,"amount":50,"balance":50,"currency":"USD","status":"Pending","errorMessage":null,"paymentId":null,"psiPayments":[],"prepayment":false,"billingDocument":null,"description":null,"cancellationReason":null,"cancelledById":null,"cancelledOn":null,"createdDate":"2024-11-05 15:46:04","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-11-05 15:46:04","updatedById":"2c92c8f95e2d6ebb015e325df48e02da"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1items/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"8a90a2fd8074995801807816dbac52a4","accountNumber":"A00000002","billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-10 01:46:33","description":"test xiaokai","id":"8a90e08281e10bb00181e749f4db01b8","isCustom":false,"items":[{"amount":100,"billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-10 01:46:33","currency":"USD","description":"test xiaokai","errorMessage":null,"id":"8a90e08281e10bb00181e749f4dd01b9","number":1,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e08281e10bb00181e749f4db01b8","paymentScheduleNumber":"PS-00000002","runHour":12,"scheduledDate":"2022-07-10","standalone":true,"status":"Canceled","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"},{"amount":100,"billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-10 01:46:33","currency":"USD","description":"test xiaokai","errorMessage":null,"id":"8a90e08281e10bb00181e749f4e501ba","number":2,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e08281e10bb00181e749f4db01b8","paymentScheduleNumber":"PS-00000002","runHour":12,"scheduledDate":"2022-08-10","standalone":true,"status":"Canceled","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"},{"amount":10,"billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-10 01:46:33","currency":"USD","description":"test xiaokai","errorMessage":null,"id":"8a90e08281e10bb00181e749f4e601bb","number":3,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e08281e10bb00181e749f4db01b8","paymentScheduleNumber":"PS-00000002","runHour":23,"scheduledDate":"2022-11-01","standalone":true,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"},{"amount":10,"billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-24 20:07:12","currency":"USD","description":"test xiaokai","errorMessage":null,"id":"8a908de6822b2e1501823352ac745b53","number":4,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e08281e10bb00181e749f4db01b8","paymentScheduleNumber":"PS-00000002","runHour":23,"scheduledDate":"2022-12-01","standalone":true,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"},{"amount":10,"billingDocument":null,"createdById":"8a90e082802185b901802199e15902d1","createdDate":"2022-07-28 06:12:39","currency":"USD","description":"test xiaokai","errorMessage":null,"id":"8a90e082824456ae018244f00e0317eb","number":5,"paymentGatewayId":"8a90a2fd807499580180781775c452a8","paymentId":null,"paymentMethodId":"8a90a2fd8074995801807817ebed52aa","paymentScheduleId":"8a90e08281e10bb00181e749f4db01b8","paymentScheduleNumber":"PS-00000002","runHour":23,"scheduledDate":"2023-01-01","standalone":true,"status":"Pending","updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"}],"nextPaymentDate":"2022-11-01","occurrences":5,"paymentScheduleNumber":"PS-00000002","period":"Monthly","recentPaymentDate":null,"runHour":23,"standalone":true,"startDate":"2022-07-10","status":"Active","success":true,"totalPaymentsErrored":0,"totalPaymentsProcessed":0,"updatedById":"8a90e082802185b901802199e15902d1","updatedDate":"2022-07-28 06:12:39"},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-schedules~1{paymentScheduleKey}~1preview/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1refunds/get/responses/200/content/application~1json/examples/response":{"value":{"refunds":[{"accountId":"4028905f5a87c0ff015a87d25ae90025","amount":4,"cancelledOn":null,"comment":"update comment","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 14:46:03","creditMemoId":null,"financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"transferredToAccounting":"No","unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null},"gatewayId":null,"gatewayReconciliationReason":null,"gatewayReconciliationStatus":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","id":"4028905f5a87c0ff015a889e590e00c9","markedForSubmissionOn":null,"methodType":"CreditCard","number":"R-00000001","paymentId":"4028905f5a87c0ff015a889ddfb800c0","paymentMethodId":null,"paymentMethodSnapshotId":null,"payoutId":null,"reasonCode":"Standard Refund","referenceId":null,"refundDate":"2017-03-01","refundTransactionTime":null,"secondRefundReferenceId":null,"settledOn":null,"softDescriptor":null,"softDescriptorPhone":null,"status":"Processed","submittedOn":null,"type":"External","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 16:56:41"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1refunds/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1refunds/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1refunds/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1refunds/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1refunds/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}/put/responses/200/content/application~1json/examples/response":{"value":{"id":"8a90a04d90de54810190debe8e3b5a2c","number":"R-00000287","status":"Processed","type":"Electronic","methodType":"CreditCard","accountId":"8a90b4488e7d5c0f018e7db3892400b2","amount":10,"refundDate":"2024-07-23","comment":null,"paymentMethodId":"8a90e5e490c9ceb80190d8e9df930bf0","paymentMethodSnapshotId":"8a90a04d90de54810190debe8e0c5a29","paymentId":"8a90e5e490c9ceb80190d91837840c1d","paymentNumber":"P-00000387","creditMemoId":null,"reasonCode":"Other","gatewayId":"8a90d6128ddbaf39018de2d9fe0d2660","paymentGatewayNumber":"PG-00000001","gatewayResponse":"Approved","gatewayResponseCode":"OK","gatewayState":"Submitted","markedForSubmissionOn":null,"referenceId":null,"secondRefundReferenceId":null,"softDescriptor":null,"softDescriptorPhone":null,"submittedOn":"2024-07-23 16:39:09","settledOn":null,"cancelledOn":null,"createdDate":"2024-07-23 16:39:08","createdById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2024-07-23 16:49:00","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","refundTransactionTime":"2024-07-23 16:39:09","financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null,"transferredToAccounting":false},"gatewayReconciliationStatus":null,"gatewayReconciliationReason":null,"payoutId":null,"success":true},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028905f5a87c0ff015a87d25ae90025","amount":4,"cancelledOn":null,"comment":"Create a refund for unapplied payment.","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 14:46:03","creditMemoId":null,"financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"transferredToAccounting":"No","unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null},"gatewayId":null,"gatewayReconciliationReason":null,"gatewayReconciliationStatus":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","id":"4028905f5a87c0ff015a889e590e00c9","markedForSubmissionOn":null,"methodType":"CreditCard","number":"R-00000001","paymentId":"4028905f5a87c0ff015a889ddfb800c0","paymentMethodId":null,"paymentMethodSnapshotId":null,"payoutId":null,"reasonCode":"Standard Refund","referenceId":null,"refundDate":"2017-03-01","refundTransactionTime":null,"secondRefundReferenceId":null,"settledOn":null,"softDescriptor":null,"softDescriptorPhone":null,"status":"Processed","submittedOn":null,"success":true,"type":"External","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 14:46:03"},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"accountId":"4028905f5a87c0ff015a87d25ae90025","amount":4,"cancelledOn":"2017-03-01 17:03:07","comment":"update comment","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 14:46:03","creditMemoId":null,"financeInformation":{"bankAccountAccountingCode":null,"bankAccountAccountingCodeType":null,"transferredToAccounting":"No","unappliedPaymentAccountingCode":null,"unappliedPaymentAccountingCodeType":null},"gatewayId":null,"gatewayReconciliationReason":null,"gatewayReconciliationStatus":null,"gatewayResponse":null,"gatewayResponseCode":null,"gatewayState":"NotSubmitted","id":"4028905f5a87c0ff015a889e590e00c9","markedForSubmissionOn":null,"methodType":"CreditCard","number":"R-00000001","paymentId":"4028905f5a87c0ff015a889ddfb800c0","paymentMethodId":null,"paymentMethodSnapshotId":null,"payoutId":null,"reasonCode":"Standard Refund","referenceId":null,"refundDate":"2017-03-01","refundTransactionTime":null,"secondRefundReferenceId":null,"settledOn":null,"softDescriptor":null,"softDescriptorPhone":null,"status":"Canceled","submittedOn":null,"success":true,"type":"External","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 17:03:07"},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/200/content/application~1json/examples/response":{"value":{"parts":[{"amount":4,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 14:46:03","creditMemoId":null,"id":"4028905f5a87c0ff015a889e592b00cf","paymentId":"4028905f5a87c0ff015a889ddfb800c0","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 14:46:03"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/200/content/application~1json/examples/response":{"value":{"amount":4,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 14:46:03","creditMemoId":null,"id":"4028905f5a87c0ff015a889e592b00cf","paymentId":"4028905f5a87c0ff015a889ddfb800c0","success":true,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 14:46:03"},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/200/content/application~1json/examples/response":{"value":{"itemParts":[{"amount":4,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 14:46:03","creditMemoItemId":null,"creditTaxItemId":null,"id":"4028905f5a87c0ff015a889e592a00ce","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 14:46:03"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response":{"value":{"amount":4,"createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2017-03-01 14:46:03","creditMemoItemId":null,"creditTaxItemId":null,"id":"4028905f5a87c0ff015a889e592a00ce","success":true,"updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2017-03-01 14:46:03"},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1refunds~1{refundKey}~1parts~1{refundpartid}~1item-parts~1{itempartid}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1payment-profile/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1payment-profile/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1payment-profile/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1payment-profile/put/responses/4XX/content/application~1json/examples/response"},"paths/~1object-query~1accounts/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTEyLTE2VDE3OjU1OjA1LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOWJlNDhkYjVhYmE3MDE4ZGI2MDQ3NzZkNDg1NCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountNumber":"A00000130","allowInvoiceEdit":false,"autoPay":false,"balance":7300,"batch":"Batch1","bcdSettingOption":"ManualSet","billCycleDay":1,"billToId":"8ad08eb292f6328c019318dcd45521b1","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2024-11-10T17:35:45-08:00","creditBalance":0,"currency":"USD","id":"8ad08eb292f6328c019318dcd43821b0","invoiceDeliveryPrefsEmail":false,"invoiceDeliveryPrefsPrint":false,"invoiceTemplateId":"2c92c0f86cccaa59016cd5e0f500111d","lastInvoiceDate":"2025-03-21","mrr":2950,"name":"Bella Lawrence","partnerAccount":false,"paymentMethodCascadingConsent":false,"paymentTerm":"Net 30","soldToId":"8ad08eb292f6328c019318dcd47421b3","status":"Active","taxExemptStatus":"No","totalDebitMemoBalance":0,"totalInvoiceBalance":7300,"unappliedBalance":0,"unappliedCreditMemoAmount":0,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-21T03:24:15-07:00"}]},"id":"paths/~1object-query~1accounts/get/responses/200/content/application~1json/example"},"paths/~1object-query~1accounts/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1accounts/get/responses/500/content/application~1json/example"},"paths/~1object-query~1accounts/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1accounts/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1accounts~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountNumber":"A00000130","allowInvoiceEdit":false,"autoPay":false,"balance":7300,"batch":"Batch1","bcdSettingOption":"ManualSet","billCycleDay":1,"billToId":"8ad08eb292f6328c019318dcd45521b1","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2024-11-10T17:35:45-08:00","creditBalance":0,"currency":"USD","id":"8ad08eb292f6328c019318dcd43821b0","invoiceDeliveryPrefsEmail":false,"invoiceDeliveryPrefsPrint":false,"invoiceTemplateId":"2c92c0f86cccaa59016cd5e0f500111d","lastInvoiceDate":"2025-03-21","mrr":2950,"name":"Bella Lawrence","partnerAccount":false,"paymentMethodCascadingConsent":false,"paymentTerm":"Net 30","soldToId":"8ad08eb292f6328c019318dcd47421b3","status":"Active","taxExemptStatus":"No","totalDebitMemoBalance":0,"totalInvoiceBalance":7300,"unappliedBalance":0,"unappliedCreditMemoAmount":0,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-21T03:24:15-07:00"},"id":"paths/~1object-query~1accounts~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1accounts~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1accounts~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1accounts~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1accounts~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1amendments/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI1LTAyLTA2VDIzOjA5OjExLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmNmVhOWQ4Nzk0ZGE5Mzg2NGRmM2RiODU4MTcxOSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"bookingDate":"2025-02-01","code":"A-AM00000890","contractEffectiveDate":"2025-02-01","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","currentTermPeriodType":"Month","customerAcceptanceDate":"2025-02-01","effectiveDate":"2025-02-01","id":"f94fb52490e95cd65925cd7b733100b7","name":"auto generated","renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTermPeriodType":"Month","serviceActivationDate":"2025-02-01","status":"Completed","type":"Composite","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00"}]},"id":"paths/~1object-query~1amendments/get/responses/200/content/application~1json/example"},"paths/~1object-query~1amendments/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1amendments/get/responses/500/content/application~1json/example"},"paths/~1object-query~1amendments/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1amendments/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1amendments~1{key}/get/responses/200/content/application~1json/example":{"value":{"bookingDate":"2024-08-29","code":"A-AM00000553","contractEffectiveDate":"2024-08-29","createdById":"8ad09fc28193c189018194da28be74ba","createdDate":"2024-08-29T00:31:37-07:00","currentTerm":12,"currentTermPeriodType":"Month","customerAcceptanceDate":"2024-08-29","effectiveDate":"2024-08-29","id":"8ad097b49198384c01919d0c08d42c35","name":"auto generated","renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerm":0,"renewalTermPeriodType":"Month","serviceActivationDate":"2024-08-29","status":"Completed","subscriptionId":"8ad08ae29198249d01919d00a4c93b18","termStartDate":"2024-08-29","type":"Cancellation","updatedById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-29T00:31:37-07:00"},"id":"paths/~1object-query~1amendments~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1amendments~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1amendments~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1amendments~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1amendments~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1billing-runs/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTA4LTI4VDIzOjA1OjA0LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxOTgyNDkyMDE5MTljYjdmNWNjMjgxZSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"2c92c0f87270a5970172747e289a5e66","autoEmail":false,"autoPost":false,"autoRenewal":true,"billingRunNumber":"BR-00000005","billingRunType":"Regular","createdById":"2c92c0f97a98ca23017a990996124672","createdDate":"2022-04-25T19:08:32-07:00","endDate":"2022-04-25T19:08:37-07:00","executedDate":"2022-04-25T19:08:34-07:00","id":"8ad0887e805061c8018063a09fe2685a","includeOrderLineItems":true,"includeSubscriptions":true,"invoiceDate":"2022-04-25","invoicesEmailed":false,"noEmailForZeroAmountInvoice":false,"numberOfAccounts":1,"numberOfCreditMemos":0,"numberOfInvoices":1,"startDate":"2022-04-25T19:08:34-07:00","status":"Completed","targetDate":"2022-07-30","targetType":"SingleAccount","totalTime":3384,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-02-06T23:10:15-08:00"}]},"id":"paths/~1object-query~1billing-runs/get/responses/200/content/application~1json/example"},"paths/~1object-query~1billing-runs/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1billing-runs/get/responses/500/content/application~1json/example"},"paths/~1object-query~1billing-runs/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1billing-runs/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1billing-runs~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"2c92c0f87270a5970172747e289a5e66","autoEmail":false,"autoPost":false,"autoRenewal":true,"billingRunNumber":"BR-00000005","billingRunType":"Regular","createdById":"2c92c0f97a98ca23017a990996124672","createdDate":"2022-04-25T19:08:32-07:00","endDate":"2022-04-25T19:08:37-07:00","executedDate":"2022-04-25T19:08:34-07:00","id":"8ad0887e805061c8018063a09fe2685a","includeOrderLineItems":true,"includeSubscriptions":true,"invoiceDate":"2022-04-25","invoicesEmailed":false,"noEmailForZeroAmountInvoice":false,"numberOfAccounts":1,"numberOfCreditMemos":0,"numberOfInvoices":1,"startDate":"2022-04-25T19:08:34-07:00","status":"Completed","targetDate":"2022-07-30","targetType":"SingleAccount","totalTime":3384,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-02-06T23:10:15-08:00"},"id":"paths/~1object-query~1billing-runs~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1billing-runs~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1billing-runs~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1billing-runs~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1billing-runs~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1contacts/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTExLTEwVDA0OjQ3OjM2LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODc1OTkyZjYzMjhlMDE5MzE2MWQ5MWEzMjdlNiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"8ad087599521829e0195226d641312bd","address1":"101 Redwood Shores Pkwy","city":"Redwood City","country":"United States","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-02-20T00:15:49-08:00","firstName":"Amy","id":"8ad087599521829e0195226d642112be","lastName":"Lawrence","state":"California","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-02-20T00:15:49-08:00","workEmail":"amy.lawrence@zuora.com"}]},"id":"paths/~1object-query~1contacts/get/responses/200/content/application~1json/example"},"paths/~1object-query~1contacts/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1contacts/get/responses/500/content/application~1json/example"},"paths/~1object-query~1contacts/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1contacts/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1contacts~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad087599521829e0195226d641312bd","address1":"101 Redwood Shores Pkwy","city":"Redwood City","country":"United States","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-02-20T00:15:49-08:00","firstName":"Amy","id":"8ad087599521829e0195226d642112be","lastName":"Lawrence","state":"California","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-02-20T00:15:49-08:00","workEmail":"amy.lawrence@zuora.com"},"id":"paths/~1object-query~1contacts~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1contacts~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1contacts~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1contacts~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1contacts~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1credit-memos/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTA3LTIxVDIwOjEzOjQwLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODdkMjkwYzRiYjJhMDE5MGQ4NmUzNTkzNzAyZiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"8ad09be48db5aba7018db604776d4854","appliedAmount":112.43,"autoApplyUponPosting":false,"balance":0,"billToContactId":"8ad09be48db5aba7018db60477a84855","createdById":"8ad09fc28193c189018194da28be74ba","createdDate":"2024-08-28T23:32:58-07:00","currency":"USD","discountAmount":0,"exchangeRateDate":"2024-08-28","excludeFromAutoApplyRules":false,"id":"8ad097b49198384c01919cd658d21c46","invoiceId":"8ad084db909fae930190a12599477394","memoDate":"2024-09-27","memoNumber":"CM00000013","postedById":"8ad09fc28193c189018194da28be74ba","postedOn":"2024-08-28T23:32:58-07:00","reasonCode":"Write-off","refundAmount":0,"revenueImpacting":"Yes","reversed":false,"sequenceSetId":"2c92c0f86cccaa59016cd5e0faa91145","source":"AdhocFromInvoice","sourceType":"Invoice","status":"Posted","taxAmount":0,"taxAutoCalculation":true,"totalAmount":112.43,"totalAmountWithoutTax":112.43,"totalTaxExemptAmount":0,"updatedById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-28T23:32:59-07:00"}]},"id":"paths/~1object-query~1credit-memos/get/responses/200/content/application~1json/example"},"paths/~1object-query~1credit-memos/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memos/get/responses/500/content/application~1json/example"},"paths/~1object-query~1credit-memos/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memos/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1credit-memos~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad09be48db5aba7018db604776d4854","appliedAmount":112.43,"autoApplyUponPosting":false,"balance":0,"billToContactId":"8ad09be48db5aba7018db60477a84855","createdById":"8ad09fc28193c189018194da28be74ba","createdDate":"2024-08-28T23:32:58-07:00","currency":"USD","discountAmount":0,"exchangeRateDate":"2024-08-28","excludeFromAutoApplyRules":false,"id":"8ad097b49198384c01919cd658d21c46","invoiceId":"8ad084db909fae930190a12599477394","memoDate":"2024-09-27","memoNumber":"CM00000013","postedById":"8ad09fc28193c189018194da28be74ba","postedOn":"2024-08-28T23:32:58-07:00","reasonCode":"Write-off","refundAmount":0,"revenueImpacting":"Yes","reversed":false,"sequenceSetId":"2c92c0f86cccaa59016cd5e0faa91145","source":"AdhocFromInvoice","sourceType":"Invoice","status":"Posted","taxAmount":0,"taxAutoCalculation":true,"totalAmount":112.43,"totalAmountWithoutTax":112.43,"totalTaxExemptAmount":0,"updatedById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-28T23:32:59-07:00"},"id":"paths/~1object-query~1credit-memos~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1credit-memos~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memos~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1credit-memos~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memos~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1credit-memo-applications/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTA4LTE5VDIyOjU1OjExLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxNjk4YjI4MDE5MTZlNWE4NTYyNTY1OCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"8ad09be48db5aba7018db604776d4854","amount":112.43,"applicationGroupId":"8ad097b49198384c01919cd659b31c58","createdById":"8ad09fc28193c189018194da28be74ba","createdDate":"2024-08-28T23:32:59-07:00","creditMemoId":"8ad097b49198384c01919cd658d21c46","effectiveDate":"2024-09-27","id":"8ad097b49198384c01919cd659be1c64","updatedById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-28T23:32:59-07:00"}]},"id":"paths/~1object-query~1credit-memo-applications/get/responses/200/content/application~1json/example"},"paths/~1object-query~1credit-memo-applications/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memo-applications/get/responses/500/content/application~1json/example"},"paths/~1object-query~1credit-memo-applications/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memo-applications/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1credit-memo-applications~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad09be48db5aba7018db604776d4854","amount":112.43,"applicationGroupId":"8ad097b49198384c01919cd659b31c58","createdById":"8ad09fc28193c189018194da28be74ba","createdDate":"2024-08-28T23:32:59-07:00","creditMemoId":"8ad097b49198384c01919cd658d21c46","effectiveDate":"2024-09-27","id":"8ad097b49198384c01919cd659be1c64","updatedById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-28T23:32:59-07:00"},"id":"paths/~1object-query~1credit-memo-applications~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1credit-memo-applications~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memo-applications~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1credit-memo-applications~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memo-applications~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1credit-memo-items/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTA4LTE5VDIyOjU5OjU0LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxNjk4YjI4MDE5MTZlNWE4NGU2NTY1NCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","amount":105,"amountWithoutTax":105,"appliedToOthersAmount":105,"beAppliedByOthersAmount":0,"chargeDate":"2024-08-28T23:32:58-07:00","chargeName":"Monthly Fee","createdById":"8ad09fc28193c189018194da28be74ba","createdDate":"2024-08-28T23:32:58-07:00","creditFromItemId":"8ad084db909fae930190a12599697395","creditFromItemSource":"InvoiceItem","creditMemoId":"8ad097b49198384c01919cd658d21c46","deferredRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","excludeItemBillingFromRevenueAccounting":false,"id":"8ad097b49198384c01919cd659211c4a","invoiceItemId":"8ad084db909fae930190a12599697395","numberOfDeliveries":0,"processingType":"0","productRatePlanChargeId":"8ad097b4909708e001909b41bb085d38","quantity":1,"recognizedRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","reflectDiscountInNetAmount":false,"revenueImpacting":"Yes","serviceEndDate":"2024-07-11","serviceStartDate":"2024-07-11","sku":"SKUE-00000026","sourceItemType":"InvoiceDetail","taxAmount":0,"taxExemptAmount":0,"taxMode":"TaxExclusive","unappliedAmount":0,"unitOfMeasure":"","unitPrice":0,"updatedById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-28T23:33:00-07:00"}]},"id":"paths/~1object-query~1credit-memo-items/get/responses/200/content/application~1json/example"},"paths/~1object-query~1credit-memo-items/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memo-items/get/responses/500/content/application~1json/example"},"paths/~1object-query~1credit-memo-items/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memo-items/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1credit-memo-items~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","amount":105,"amountWithoutTax":105,"appliedToOthersAmount":105,"beAppliedByOthersAmount":0,"chargeDate":"2024-08-28T23:32:58-07:00","chargeName":"Monthly Fee","createdById":"8ad09fc28193c189018194da28be74ba","createdDate":"2024-08-28T23:32:58-07:00","creditFromItemId":"8ad084db909fae930190a12599697395","creditFromItemSource":"InvoiceItem","creditMemoId":"8ad097b49198384c01919cd658d21c46","deferredRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","excludeItemBillingFromRevenueAccounting":false,"id":"8ad097b49198384c01919cd659211c4a","invoiceItemId":"8ad084db909fae930190a12599697395","numberOfDeliveries":0,"processingType":"0","productRatePlanChargeId":"8ad097b4909708e001909b41bb085d38","quantity":1,"recognizedRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","reflectDiscountInNetAmount":false,"revenueImpacting":"Yes","serviceEndDate":"2024-07-11","serviceStartDate":"2024-07-11","sku":"SKUE-00000026","sourceItemType":"InvoiceDetail","taxAmount":0,"taxExemptAmount":0,"taxMode":"TaxExclusive","unappliedAmount":0,"unitOfMeasure":"","unitPrice":0,"updatedById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-28T23:33:00-07:00"},"id":"paths/~1object-query~1credit-memo-items~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1credit-memo-items~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memo-items~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1credit-memo-items~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1credit-memo-items~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1daily-consumption-summaries/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1daily-consumption-summaries/get/responses/500/content/application~1json/example"},"paths/~1object-query~1daily-consumption-summaries/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1daily-consumption-summaries/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/200/content/application~1json/example":{"value":{"chargeSegmentNumber":2,"createdById":"00000000000000000000000000000003","createdDate":"2024-02-28T01:36:50-08:00","dailyConsumptionAmount":0,"dailyGroupSummaryId":"1dc86d68f6095de88ad084f08858a719","dailyTotalQuantity":45,"id":"8ad093c18deeb97e018def12ea3b3fcb","originChargeId":"8ad098317f3a75bf017f3edfbb402b57","ratingResultId":"8ad093c18deeb97e018def12ea353fca","transactionDate":"2023-05-16","updatedById":"00000000000000000000000000000003","updatedDate":"2024-02-28T01:36:50-08:00","usageChargeName":"usage-per unit","usageChargeNumber":"C-00000274"},"id":"paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1daily-consumption-summaries~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1debit-memos/get/responses/200/content/application~1json/example":{"value":{"data":[{"accountId":"8ad09be48db5aba7018db604776d4854","autoPay":true,"balance":10,"createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2024-08-19T23:14:11-07:00","currency":"USD","discountAmount":0,"dueDate":"2024-09-18","id":"8ad093789169a0c001916e6be7cf7113","memoDate":"2024-08-19","memoNumber":"DM00000002","reasonCode":"Correcting invoice error","source":"AdhocFromPrpc","sourceType":"Standalone","status":"Draft","taxAmount":0,"taxAutoCalculation":true,"taxStatus":"Complete","totalAmount":10,"totalAmountWithoutTax":10,"totalTaxExemptAmount":0,"updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-08-19T23:14:11-07:00"}]},"id":"paths/~1object-query~1debit-memos/get/responses/200/content/application~1json/example"},"paths/~1object-query~1debit-memos/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1debit-memos/get/responses/500/content/application~1json/example"},"paths/~1object-query~1debit-memos/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1debit-memos/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1debit-memos~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad09be48db5aba7018db604776d4854","autoPay":true,"balance":10,"createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2024-08-19T23:14:11-07:00","currency":"USD","discountAmount":0,"dueDate":"2024-09-18","id":"8ad093789169a0c001916e6be7cf7113","memoDate":"2024-08-19","memoNumber":"DM00000002","reasonCode":"Correcting invoice error","source":"AdhocFromPrpc","sourceType":"Standalone","status":"Draft","taxAmount":0,"taxAutoCalculation":true,"taxStatus":"Complete","totalAmount":10,"totalAmountWithoutTax":10,"totalTaxExemptAmount":0,"updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-08-19T23:14:11-07:00"},"id":"paths/~1object-query~1debit-memos~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1debit-memos~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1debit-memos~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1debit-memos~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1debit-memos~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1debit-memo-items/get/responses/200/content/application~1json/example":{"value":{"data":[{"accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","amount":10,"amountWithoutTax":10,"appliedToOthersAmount":0,"balance":10,"beAppliedByOthersAmount":0,"chargeDate":"2024-08-19T23:14:11-07:00","chargeName":"Monthly Fee","createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2024-08-19T23:14:11-07:00","debitMemoId":"8ad093789169a0c001916e6be7cf7113","deferredRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","description":"","excludeItemBillingFromRevenueAccounting":false,"id":"8ad093789169a0c001916e6be8127114","itemSoldToContactId":"8ad09be48db5aba7018db60477a84855","processingType":"0","productRatePlanChargeId":"8ad097b4909708e001909b41bb085d38","quantity":1,"recognizedRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","serviceEndDate":"2030-04-01","serviceStartDate":"2024-05-21","sku":"SKUE-00000026","sourceItemType":"ProductRatePlanCharge","taxAmount":0,"taxExemptAmount":0,"unitOfMeasure":"","unitPrice":10,"updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-08-19T23:14:11-07:00"}]},"id":"paths/~1object-query~1debit-memo-items/get/responses/200/content/application~1json/example"},"paths/~1object-query~1debit-memo-items/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1debit-memo-items/get/responses/500/content/application~1json/example"},"paths/~1object-query~1debit-memo-items/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1debit-memo-items/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1debit-memo-items~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","amount":10,"amountWithoutTax":10,"appliedToOthersAmount":0,"balance":10,"beAppliedByOthersAmount":0,"chargeDate":"2024-08-19T23:14:11-07:00","chargeName":"Monthly Fee","createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2024-08-19T23:14:11-07:00","debitMemoId":"8ad093789169a0c001916e6be7cf7113","deferredRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","description":"","excludeItemBillingFromRevenueAccounting":false,"id":"8ad093789169a0c001916e6be8127114","itemSoldToContactId":"8ad09be48db5aba7018db60477a84855","processingType":"0","productRatePlanChargeId":"8ad097b4909708e001909b41bb085d38","quantity":1,"recognizedRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","serviceEndDate":"2030-04-01","serviceStartDate":"2024-05-21","sku":"SKUE-00000026","sourceItemType":"ProductRatePlanCharge","taxAmount":0,"taxExemptAmount":0,"unitOfMeasure":"","unitPrice":10,"updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-08-19T23:14:11-07:00"},"id":"paths/~1object-query~1debit-memo-items~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1debit-memo-items~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1debit-memo-items~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1debit-memo-items~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1debit-memo-items~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1delivery-adjustments/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTAzLTE5VDE1OjMzOjAzKzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YTkwYTA0ZDhlNTU0ODNkMDE4ZTU1YTBjNzY4NDRiZSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"8a90f13b8da1afeb018da27a1e7c1122","adjustmentNumber":"ADJ-00000209","amount":-1.7,"amountPerUnit":1.7,"billingDate":"2025-05-19","chargeId":"edcad42faf796eabde76eb9b87e30028","chargeNumber":"C-00034922","createdById":"2c92c8f95e2d6ebb015e325df48e02da","createdDate":"2025-05-20T10:55:40+08:00","creditMemoId":"8a90def796ead18a0196eb9e47164124","creditMemoNumber":"CM00000698","date":"2025-05-12","deferredAccountingCode":"","deliveryDay":"monday","id":"8a90def796ead18a0196eb9e465b4123","invoiceOwnerAccountId":"8a90f13b8da1afeb018da27a1e7c1122","numberOfDeliveries":1,"originalSubId":"edcad42faf796eabde76eb9b87e30026","reason":"","recognizedRevenueAccountingCode":"","revenueRecognitionRuleName":"","segmentId":"edcad42faf796eabde76eb9b87e30028","status":"Billed","subscriptionId":"edcad42faf796eabde76eb9b87e30026","subscriptionNumber":"A-S00004451","type":"DeliveryCredit","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2025-05-20T10:55:40+08:00"}]},"id":"paths/~1object-query~1delivery-adjustments/get/responses/200/content/application~1json/example"},"paths/~1object-query~1delivery-adjustments/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1delivery-adjustments/get/responses/500/content/application~1json/example"},"paths/~1object-query~1delivery-adjustments/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1delivery-adjustments/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1delivery-adjustments~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8a90f13b8da1afeb018da27a1e7c1122","adjustmentNumber":"ADJ-00000209","amount":-1.7,"amountPerUnit":1.7,"billingDate":"2025-05-19","chargeId":"edcad42faf796eabde76eb9b87e30028","chargeNumber":"C-00034922","createdById":"2c92c8f95e2d6ebb015e325df48e02da","createdDate":"2025-05-20T10:55:40+08:00","creditMemoId":"8a90def796ead18a0196eb9e47164124","creditMemoNumber":"CM00000698","date":"2025-05-12","deferredAccountingCode":"","deliveryDay":"monday","id":"8a90def796ead18a0196eb9e465b4123","invoiceOwnerAccountId":"8a90f13b8da1afeb018da27a1e7c1122","numberOfDeliveries":1,"originalSubId":"edcad42faf796eabde76eb9b87e30026","reason":"","recognizedRevenueAccountingCode":"","revenueRecognitionRuleName":"","segmentId":"edcad42faf796eabde76eb9b87e30028","status":"Billed","subscriptionId":"edcad42faf796eabde76eb9b87e30026","subscriptionNumber":"A-S00004451","type":"DeliveryCredit","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2025-05-20T10:55:40+08:00"},"id":"paths/~1object-query~1delivery-adjustments~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1delivery-adjustments~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1delivery-adjustments~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1delivery-adjustments~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1delivery-adjustments~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1fulfillments/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTExLTEzVDIzOjA0OjQ5KzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YTkwZDdhODkzMjU2ZGZkMDE5MzI2MGU0NWNiMDBkYiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"billTargetDate":"2025-07-14","createdById":"a0933229dfcd41f3a977efa52be31667","createdDate":"2025-07-14T12:01:58+08:00","excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"fulfillmentDate":"2025-07-14","fulfillmentNumber":"F-00000166","fulfillmentType":"Delivery","id":"8a90f48297fbc4bf01980718bd9a0034","orderLineItemId":"8a90ff9297fbc4ee01980714649212d6","quantity":100,"state":"SentToBilling","updatedById":"a0933229dfcd41f3a977efa52be31667","updatedDate":"2025-07-14T12:01:58+08:00"}]},"id":"paths/~1object-query~1fulfillments/get/responses/200/content/application~1json/example"},"paths/~1object-query~1fulfillments/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1fulfillments/get/responses/500/content/application~1json/example"},"paths/~1object-query~1fulfillments/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1fulfillments/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1fulfillments~1{key}/get/responses/200/content/application~1json/example":{"value":{"billTargetDate":"2025-07-14","createdById":"a0933229dfcd41f3a977efa52be31667","createdDate":"2025-07-14T12:01:58+08:00","excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"fulfillmentDate":"2025-07-14","fulfillmentNumber":"F-00000166","fulfillmentType":"Delivery","id":"8a90f48297fbc4bf01980718bd9a0034","orderLineItemId":"8a90ff9297fbc4ee01980714649212d6","quantity":100,"state":"SentToBilling","updatedById":"a0933229dfcd41f3a977efa52be31667","updatedDate":"2025-07-14T12:01:58+08:00"},"id":"paths/~1object-query~1fulfillments~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1fulfillments~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1fulfillments~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1fulfillments~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1fulfillments~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1invoices/get/responses/200/content/application~1json/example":{"value":{"nextPage":"MTA=","data":[{"accountId":"8ad0875995a3ed800195a43a2ea40437","adjustmentAmount":0,"amount":7300,"amountWithoutTax":7300,"autoPay":true,"balance":7300,"billToContactId":"8ad0875995a3ed800195a43a2ed30438","comments":"","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-21T01:42:47-07:00","creditBalanceAdjustmentAmount":0,"creditMemoAmount":0,"currency":"USD","dueDate":"2025-04-20","id":"8ad0875995aa292e0195b7de80796305","includesOneTime":true,"includesRecurring":true,"includesUsage":true,"invoiceDate":"2025-03-21","invoiceNumber":"INV00000255","paymentAmount":0,"paymentTerm":"Net 30","postedBy":"2c92c0f972a852360172bbe22ac551b6","postedDate":"2025-03-21T01:42:47-07:00","refundAmount":0,"reversed":false,"sequenceSetId":"2c92c0f86cccaa59016cd5e0faa91145","source":"API","sourceType":"Subscription","status":"Posted","targetDate":"2025-03-21","taxAmount":0,"taxExemptAmount":0,"templateId":"2c92c0f86cccaa59016cd5e0f500111d","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-21T01:42:47-07:00"}]},"id":"paths/~1object-query~1invoices/get/responses/200/content/application~1json/example"},"paths/~1object-query~1invoices/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoices/get/responses/500/content/application~1json/example"},"paths/~1object-query~1invoices/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoices/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1invoices~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad0875995a3ed800195a43a2ea40437","adjustmentAmount":0,"amount":7300,"amountWithoutTax":7300,"autoPay":true,"balance":7300,"billToContactId":"8ad0875995a3ed800195a43a2ed30438","comments":"","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-21T01:42:47-07:00","creditBalanceAdjustmentAmount":0,"creditMemoAmount":0,"currency":"USD","dueDate":"2025-04-20","id":"8ad0875995aa292e0195b7de80796305","includesOneTime":true,"includesRecurring":true,"includesUsage":true,"invoiceDate":"2025-03-21","invoiceNumber":"INV00000255","paymentAmount":0,"paymentTerm":"Net 30","postedBy":"2c92c0f972a852360172bbe22ac551b6","postedDate":"2025-03-21T01:42:47-07:00","refundAmount":0,"reversed":false,"sequenceSetId":"2c92c0f86cccaa59016cd5e0faa91145","source":"API","sourceType":"Subscription","status":"Posted","targetDate":"2025-03-21","taxAmount":0,"taxExemptAmount":0,"templateId":"2c92c0f86cccaa59016cd5e0f500111d","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-21T01:42:47-07:00"},"id":"paths/~1object-query~1invoices~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1invoices~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoices~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1invoices~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoices~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1invoice-items/get/responses/200/content/application~1json/example":{"value":{"nextPage":"MTA=","data":[{"accountId":"2c92c0f87270a5970172747e289a5e66","accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","accountingCode":"Subscription Revenue","appliedToInvoiceItemId":"8ad0875995cd65b60195cd7b76771f12","balance":0,"billToContactId":"2c92c0f87270a5970172747e28aa5e67","chargeAmount":-200,"chargeDate":"2025-03-25T06:26:15-07:00","chargeName":"Percentage discount","chargeNumber":"C-00000522","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:15-07:00","defaultPaymentMethodId":"2c92c0f872bc58ec0172c06fe2f07422","deferredRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","description":"","discountAmount":0,"excludeItemBillingFromRevenueAccounting":false,"id":"8ad0875995cd65b60195cd7b76771f13","invoiceId":"8ad0875995cd65b60195cd7b76621f03","itemSoldToContactId":"2c92c0f87270a5970172747e28aa5e67","numberOfDeliveries":0,"processingType":"1","productId":"8ad08ea194da7ba00194df52a41f04c6","productRatePlanChargeId":"f94f16628be952195f3522404efb0010","productRatePlanId":"f94fbebf61e952182765223a7a1d0000","quantity":1,"ratePlanChargeId":"f94fb52490e95cd65925cd7b737600c1","ratePlanId":"f94fb52490e95cd65925cd7b73df00c6","recognizedRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","reflectDiscountInNetAmount":false,"sKU":"SKU-001","serviceEndDate":"2025-02-28","serviceStartDate":"2025-02-01","soldToContactId":"2c92c0f87270a5970172747e28aa5e67","sourceItemType":"SubscriptionComponent","subscriptionId":"f94fb52490e95cd65925cd7b737400bd","subscriptionNumber":"A-S00000159","subscriptionOwnerId":"2c92c0f87270a5970172747e289a5e66","taxAmount":0,"taxExemptAmount":0,"uOM":"","unitPrice":20,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:16-07:00"}]},"id":"paths/~1object-query~1invoice-items/get/responses/200/content/application~1json/example"},"paths/~1object-query~1invoice-items/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoice-items/get/responses/500/content/application~1json/example"},"paths/~1object-query~1invoice-items/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoice-items/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1invoice-items~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"2c92c0f87270a5970172747e289a5e66","accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","accountingCode":"Subscription Revenue","appliedToInvoiceItemId":"8ad0875995cd65b60195cd7b76771f12","balance":0,"billToContactId":"2c92c0f87270a5970172747e28aa5e67","chargeAmount":-200,"chargeDate":"2025-03-25T06:26:15-07:00","chargeName":"Percentage discount","chargeNumber":"C-00000522","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:15-07:00","defaultPaymentMethodId":"2c92c0f872bc58ec0172c06fe2f07422","deferredRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","description":"","discountAmount":0,"excludeItemBillingFromRevenueAccounting":false,"id":"8ad0875995cd65b60195cd7b76771f13","invoiceId":"8ad0875995cd65b60195cd7b76621f03","itemSoldToContactId":"2c92c0f87270a5970172747e28aa5e67","numberOfDeliveries":0,"processingType":"1","productId":"8ad08ea194da7ba00194df52a41f04c6","productRatePlanChargeId":"f94f16628be952195f3522404efb0010","productRatePlanId":"f94fbebf61e952182765223a7a1d0000","quantity":1,"ratePlanChargeId":"f94fb52490e95cd65925cd7b737600c1","ratePlanId":"f94fb52490e95cd65925cd7b73df00c6","recognizedRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","reflectDiscountInNetAmount":false,"sKU":"SKU-001","serviceEndDate":"2025-02-28","serviceStartDate":"2025-02-01","soldToContactId":"2c92c0f87270a5970172747e28aa5e67","sourceItemType":"SubscriptionComponent","subscriptionId":"f94fb52490e95cd65925cd7b737400bd","subscriptionNumber":"A-S00000159","subscriptionOwnerId":"2c92c0f87270a5970172747e289a5e66","taxAmount":0,"taxExemptAmount":0,"uOM":"","unitPrice":20,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:16-07:00"},"id":"paths/~1object-query~1invoice-items~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1invoice-items~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoice-items~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1invoice-items~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoice-items~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1invoice-schedules/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWQYXJ0aWFsbHlQcm9jZXNzZWQiLCJvcmRlckJ5pZWxkIjoiU3RhdHVzIiwib3JkZXIiOiJBU0MifX0seyJ2YWx1ZSI6IjZjNDAwYTk0N2FiOTE2NTgwMjM3MTlhYjk2Iiwib3JkZXJCeSI6eyJmaWVsZCI6IklkIIiOiJBU0MifX1d","data":[{"accountId":"8a90d6128dfe2666018e08990ccb1267","actualAmount":25,"additionalSubscriptionsToBill":"[]","billedAmount":0,"createdById":"09539a92259e4f0886d67ed036798c96","createdDate":"2025-04-07T02:33:50-07:00","currency":"EUR","id":"06e21039c80241a280e6e65e73b6f3dd","nextRunDate":"2025-08-29","notes":"","number":"IS-00000032","status":"Pending","totalAmount":25,"unbilledAmount":25,"updatedById":"09539a92259e4f0886d67ed036798c96","updatedDate":"2025-04-07T02:33:51-07:00"}]},"id":"paths/~1object-query~1invoice-schedules/get/responses/200/content/application~1json/example"},"paths/~1object-query~1invoice-schedules/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoice-schedules/get/responses/500/content/application~1json/example"},"paths/~1object-query~1invoice-schedules/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoice-schedules/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1invoice-schedules~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8a90d6128dfe2666018e08990ccb1267","actualAmount":25,"additionalSubscriptionsToBill":"[]","billedAmount":0,"createdById":"09539a92259e4f0886d67ed036798c96","createdDate":"2025-04-07T02:33:50-07:00","currency":"EUR","id":"06e21039c80241a280e6e65e73b6f3dd","nextRunDate":"2025-08-29","notes":"","number":"IS-00000032","status":"Pending","totalAmount":25,"unbilledAmount":25,"updatedById":"09539a92259e4f0886d67ed036798c96","updatedDate":"2025-04-07T02:33:51-07:00"},"id":"paths/~1object-query~1invoice-schedules~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1invoice-schedules~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoice-schedules~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1invoice-schedules~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1invoice-schedules~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1order-actions/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI1LTAyLTE5VDIzOjMwOjE1LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmYjUyNDljMTk1MjE4MjdiNTIyNDNhY2QzMGQyZiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"autoRenew":true,"contractEffectiveDate":"2025-02-01","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","currentTerm":12,"currentTermPeriodType":"Month","customerAcceptanceDate":"2025-02-01","id":"f94fb52490e95cd65925cd7b733100b8","orderId":"f94fb52490e95cd65925cd7b733100b6","renewSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerm":12,"renewalTermPeriodType":"Month","sequence":0,"serviceActivationDate":"2025-02-01","subscriptionId":"f94fb52490e95cd65925cd7b737400bd","subscriptionNumber":"A-S00000159","subscriptionVersionAmendmentId":"f94fb52490e95cd65925cd7b733100b7","termType":"TERMED","type":"CreateSubscription","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00"}]},"id":"paths/~1object-query~1order-actions/get/responses/200/content/application~1json/example"},"paths/~1object-query~1order-actions/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1order-actions/get/responses/500/content/application~1json/example"},"paths/~1object-query~1order-actions/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1order-actions/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1order-actions~1{key}/get/responses/200/content/application~1json/example":{"value":{"autoRenew":true,"contractEffectiveDate":"2025-02-01","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","currentTerm":12,"currentTermPeriodType":"Month","customerAcceptanceDate":"2025-02-01","id":"f94fb52490e95cd65925cd7b733100b8","orderId":"f94fb52490e95cd65925cd7b733100b6","renewSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerm":12,"renewalTermPeriodType":"Month","sequence":0,"serviceActivationDate":"2025-02-01","subscriptionId":"f94fb52490e95cd65925cd7b737400bd","subscriptionNumber":"A-S00000159","subscriptionVersionAmendmentId":"f94fb52490e95cd65925cd7b733100b7","termType":"TERMED","type":"CreateSubscription","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00"},"id":"paths/~1object-query~1order-actions~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1order-actions~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1order-actions~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1order-actions~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1order-actions~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1order-line-items/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDIzLTA2LTI4VDAzOjM5OjM1LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOGQyOTg4ZmNlYjE4MDE4OTAxOTY0ZjAzMDI1MyIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"amount":23,"amountPerUnit":23,"amountWithoutTax":23,"billTargetDate":"2024-10-24","billToId":"8ad093788fa4fba0018faaaa88d418ae","billToSnapshotId":"8ad093788fa4fba0018faaaa88d518af","billingRule":"TriggerAsFulfillmentOccurs","createdById":"2c92c0f87270a597017273cf21dc64d4","createdDate":"2024-10-24T00:47:36-07:00","currency":"USD","deferredRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","discount":0,"excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"id":"8ad09be492b9e1480192bd7ecbf95a96","inlineDiscountPerUnit":0,"inlineDiscountType":"None","invoiceOwnerAccountId":"8ad093788fa4fba0018faaaa88b618aa","invoiceTemplateId":"2c92c0f86cccaa59016cd5e0f500111d","isAllocationEligible":false,"isUnbilled":false,"itemCategory":"Sales","itemName":"testOLIItem","itemNumber":"1","itemState":"Booked","itemType":"Fee","listPrice":23,"listPricePerUnit":23,"orderId":"8ad09be492b9e1480192bd7ecb9f5a8f","orderNumber":"O-00000970","originalOrderDate":"2024-10-24","ownerAccountId":"8ad093788fa4fba0018faaaa88b618aa","paymentTerm":"Due Upon Receipt","quantity":1,"quantityAvailableForReturn":0,"quantityFulfilled":0,"quantityPendingFulfillment":1,"recognizedRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e108da1207","requiresFulfillment":true,"revenueRecognitionRule":"Recognize daily over time","sequenceSetId":"2c92c0f86cccaa59016cd5e0faa91145","soldTo":"8ad093788fa4fba0018faaaa88d418ae","soldToSnapshotId":"8ad093788fa4fba0018faaaa88d518af","transactionDate":"2024-10-24","transactionEndDate":"2024-10-24","transactionStartDate":"2024-10-24","updatedById":"2c92c0f87270a597017273cf21dc64d4","updatedDate":"2024-10-24T00:47:36-07:00"}]},"id":"paths/~1object-query~1order-line-items/get/responses/200/content/application~1json/example"},"paths/~1object-query~1order-line-items/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1order-line-items/get/responses/500/content/application~1json/example"},"paths/~1object-query~1order-line-items/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1order-line-items/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1order-line-items~1{key}/get/responses/200/content/application~1json/example":{"value":{"amount":23,"amountPerUnit":23,"amountWithoutTax":23,"billTargetDate":"2024-10-24","billToId":"8ad093788fa4fba0018faaaa88d418ae","billToSnapshotId":"8ad093788fa4fba0018faaaa88d518af","billingRule":"TriggerAsFulfillmentOccurs","createdById":"2c92c0f87270a597017273cf21dc64d4","createdDate":"2024-10-24T00:47:36-07:00","currency":"USD","deferredRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","discount":0,"excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"id":"8ad09be492b9e1480192bd7ecbf95a96","inlineDiscountPerUnit":0,"inlineDiscountType":"None","invoiceOwnerAccountId":"8ad093788fa4fba0018faaaa88b618aa","invoiceTemplateId":"2c92c0f86cccaa59016cd5e0f500111d","isAllocationEligible":false,"isUnbilled":false,"itemCategory":"Sales","itemName":"testOLIItem","itemNumber":"1","itemState":"Booked","itemType":"Fee","listPrice":23,"listPricePerUnit":23,"orderId":"8ad09be492b9e1480192bd7ecb9f5a8f","orderNumber":"O-00000970","originalOrderDate":"2024-10-24","ownerAccountId":"8ad093788fa4fba0018faaaa88b618aa","paymentTerm":"Due Upon Receipt","quantity":1,"quantityAvailableForReturn":0,"quantityFulfilled":0,"quantityPendingFulfillment":1,"recognizedRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e108da1207","requiresFulfillment":true,"revenueRecognitionRule":"Recognize daily over time","sequenceSetId":"2c92c0f86cccaa59016cd5e0faa91145","soldTo":"8ad093788fa4fba0018faaaa88d418ae","soldToSnapshotId":"8ad093788fa4fba0018faaaa88d518af","transactionDate":"2024-10-24","transactionEndDate":"2024-10-24","transactionStartDate":"2024-10-24","updatedById":"2c92c0f87270a597017273cf21dc64d4","updatedDate":"2024-10-24T00:47:36-07:00"},"id":"paths/~1object-query~1order-line-items~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1order-line-items~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1order-line-items~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1order-line-items~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1order-line-items~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1orders/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1orders/get/responses/500/content/application~1json/example"},"paths/~1object-query~1orders/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1orders/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1orders~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"2c92c0f87270a5970172747e289a5e66","createdById":"2c92c0f972a852360172bbe22ac551b6","createdByMigration":false,"createdDate":"2025-03-25T06:26:14-07:00","description":"One Time Volume charge will be billed immediately, but recurring charge delayed until specified date, 15 days later. The specific date override changes the default -bill on the Contract Effective Date behavior- defined on the charge in the product catalog.","id":"f94fb52490e95cd65925cd7b733100b6","orderDate":"2025-02-01","orderNumber":"O-00000895","reversionOrder":false,"state":"Complete","status":"Completed","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:15-07:00"},"id":"paths/~1object-query~1orders~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1orders~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1orders~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1orders~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1orders~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payments/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTA3LTIxVDIyOjUxOjUwLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOTcwNDkwYzRlNTk3MDE5MGQ4ZmYwNmJkMzNlMCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"8ad09be48db5aba7018db604776d4854","amount":14.99,"appliedAmount":14.99,"appliedCreditBalanceAmount":0,"bankIdentificationNumber":"411111","comment":"","createdById":"8ad09fc28193c189018194da28be74ba","createdDate":"2024-08-29T00:53:29-07:00","currency":"USD","effectiveDate":"2024-08-29","gateway":"test","gatewayResponse":"This transaction has been approved by Test gateway.","gatewayResponseCode":"approve","gatewayState":"Submitted","id":"8ad097b49198384c01919d200fb53143","isStandalone":false,"lastEmailDateTime":"2024-08-29T00:53:32-07:00","paymentMethodId":"8ad084db90a5e73b0190c02783f552fa","paymentMethodSnapshotId":"8ad097b49198384c01919d200fab3141","paymentNumber":"P-00000026","prepayment":false,"referenceId":"3217674.800792635","refundAmount":0,"source":"Manually","status":"Processed","submittedOn":"2024-08-29T00:53:30-07:00","type":"Electronic","unappliedAmount":0,"updatedById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-29T00:53:30-07:00"}]},"id":"paths/~1object-query~1payments/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payments/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payments/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payments/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payments/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payments~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad09be48db5aba7018db604776d4854","amount":14.99,"appliedAmount":14.99,"appliedCreditBalanceAmount":0,"bankIdentificationNumber":"411111","comment":"","createdById":"8ad09fc28193c189018194da28be74ba","createdDate":"2024-08-29T00:53:29-07:00","currency":"USD","effectiveDate":"2024-08-29","gateway":"test","gatewayResponse":"This transaction has been approved by Test gateway.","gatewayResponseCode":"approve","gatewayState":"Submitted","id":"8ad097b49198384c01919d200fb53143","isStandalone":false,"lastEmailDateTime":"2024-08-29T00:53:32-07:00","paymentMethodId":"8ad084db90a5e73b0190c02783f552fa","paymentMethodSnapshotId":"8ad097b49198384c01919d200fab3141","paymentNumber":"P-00000026","prepayment":false,"referenceId":"3217674.800792635","refundAmount":0,"source":"Manually","status":"Processed","submittedOn":"2024-08-29T00:53:30-07:00","type":"Electronic","unappliedAmount":0,"updatedById":"8ad09fc28193c189018194da28be74ba","updatedDate":"2024-08-29T00:53:30-07:00"},"id":"paths/~1object-query~1payments~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payments~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payments~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payments~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payments~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-applications/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTA4LTI4VDIzOjQzOjU1LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxOTgyNDkyMDE5MTljZTA1ZDA5MzU1MCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"8ad0875992f6328e0193161d917527e5","accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","applicationGroupId":"8ad0980c92f64cda019318c7d84d46dc","applyAmount":100,"billingDocumentOwnerId":"8ad0875992f6328e0193161d917527e5","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2024-11-10T17:12:50-08:00","effectiveDate":"2024-11-10","id":"8ad0980c92f64cda019318c7d84d46de","invoiceId":"8ad08eb292f6328c019316356a7d5ab3","paymentApplicationStatus":"Processed","paymentId":"8ad0980c92f64cda019318c7d82d46da","unappliedPaymentAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2024-11-10T17:12:50-08:00"}]},"id":"paths/~1object-query~1payment-applications/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-applications/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-applications/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-applications/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-applications/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-applications~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad0875992f6328e0193161d917527e5","accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","applicationGroupId":"8ad0980c92f64cda019318c7d84d46dc","applyAmount":100,"billingDocumentOwnerId":"8ad0875992f6328e0193161d917527e5","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2024-11-10T17:12:50-08:00","effectiveDate":"2024-11-10","id":"8ad0980c92f64cda019318c7d84d46de","invoiceId":"8ad08eb292f6328c019316356a7d5ab3","paymentApplicationStatus":"Processed","paymentId":"8ad0980c92f64cda019318c7d82d46da","unappliedPaymentAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2024-11-10T17:12:50-08:00"},"id":"paths/~1object-query~1payment-applications~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-applications~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-applications~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-applications~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-applications~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-methods/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTA3LTE4VDIxOjIxOjMxLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkwYzRiYWZlMDE5MGM5Mzk0NDQ0N2I5NCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"active":false,"bankIdentificationNumber":"411111","cardBrand":"Visa","cardClass":"Credit","cardIssuingBank":"UNKNOWN","cardIssuingCountry":"ZZ","cardProductType":"Consumer_Card","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-16T18:51:00-07:00","creditCardExpirationMonth":12,"creditCardExpirationYear":2028,"creditCardHolderName":"Amy Lawrence","creditCardMaskNumber":"************1111","creditCardType":"Visa","id":"8ad0869995911c870195a1cc10fb7930","isCompany":false,"isSystem":false,"lastTransactionDateTime":"2025-03-16T18:51:00-07:00","lastTransactionStatus":"Approved","numConsecutiveFailures":0,"paymentMethodStatus":"Active","totalNumberOfErrorPayments":0,"totalNumberOfProcessedPayments":0,"type":"CreditCard","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-16T18:51:00-07:00","useDefaultRetryRule":true}]},"id":"paths/~1object-query~1payment-methods/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-methods/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-methods/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-methods/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-methods/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-methods~1{key}/get/responses/200/content/application~1json/example":{"value":{"active":false,"bankIdentificationNumber":"411111","cardBrand":"Visa","cardClass":"Credit","cardIssuingBank":"UNKNOWN","cardIssuingCountry":"ZZ","cardProductType":"Consumer_Card","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-16T18:51:00-07:00","creditCardExpirationMonth":12,"creditCardExpirationYear":2028,"creditCardHolderName":"Amy Lawrence","creditCardMaskNumber":"************1111","creditCardType":"Visa","id":"8ad0869995911c870195a1cc10fb7930","isCompany":false,"isSystem":false,"lastTransactionDateTime":"2025-03-16T18:51:00-07:00","lastTransactionStatus":"Approved","numConsecutiveFailures":0,"paymentMethodStatus":"Active","totalNumberOfErrorPayments":0,"totalNumberOfProcessedPayments":0,"type":"CreditCard","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-16T18:51:00-07:00","useDefaultRetryRule":true},"id":"paths/~1object-query~1payment-methods~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-methods~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-methods~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-methods~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-methods~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-method-snapshots/get/responses/200/content/application~1json/example":{"value":{"data":[{"accountId":"2c92c0f87270a5970172747e289a5e66","achAbaCode":"11111111111111111111","achAccountName":"Amy Lawrence","achAccountNumberMask":"************7777","achAccountType":"BusinessChecking","achBankName":"abc","createdDate":"2020-07-14T01:58:56-07:00","creditCardAddress1":"","creditCardAddress2":"","creditCardCity":"","creditCardCountry":"Brazil","creditCardPostalCode":"","creditCardState":"","email":"","id":"2c92c0fa732df2a001734c8c68073a21","isCompany":false,"lastTransactionDateTime":"2020-07-13T01:11:16-07:00","lastTransactionStatus":"Approved","numConsecutiveFailures":0,"paymentMethodId":"2c92c0f872bc58ec0172c06fe2f07422","paymentMethodStatus":"Active","phone":"","totalNumberOfErrorPayments":0,"totalNumberOfProcessedPayments":5,"type":"ACH","updatedDate":"2020-07-14T01:58:56-07:00","useDefaultRetryRule":true}]},"id":"paths/~1object-query~1payment-method-snapshots/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-method-snapshots/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-method-snapshots/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-method-snapshots/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-method-snapshots/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"2c92c0f87270a5970172747e289a5e66","achAbaCode":"11111111111111111111","achAccountName":"Amy Lawrence","achAccountNumberMask":"************7777","achAccountType":"BusinessChecking","achBankName":"abc","createdDate":"2020-07-14T01:58:56-07:00","creditCardAddress1":"","creditCardAddress2":"","creditCardCity":"","creditCardCountry":"Brazil","creditCardPostalCode":"","creditCardState":"","email":"","id":"2c92c0fa732df2a001734c8c68073a21","isCompany":false,"lastTransactionDateTime":"2020-07-13T01:11:16-07:00","lastTransactionStatus":"Approved","numConsecutiveFailures":0,"paymentMethodId":"2c92c0f872bc58ec0172c06fe2f07422","paymentMethodStatus":"Active","phone":"","totalNumberOfErrorPayments":0,"totalNumberOfProcessedPayments":5,"type":"ACH","updatedDate":"2020-07-14T01:58:56-07:00","useDefaultRetryRule":true},"id":"paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-method-snapshots~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-runs/get/responses/200/content/application~1json/example":{"value":{"data":[{"applyCreditBalance":false,"autoApplyCreditMemo":false,"autoApplyUnappliedPayment":false,"billingRunId":"BR-00000018","collectPayment":true,"consolidatedPayment":false,"createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2023-06-09T03:16:33-07:00","currency":"1","endDate":"2023-06-09T03:16:35-07:00","executedDate":"2023-06-09T03:16:35-07:00","id":"8ad08d29889f71e901889fa868cf70ef","numberOfCreditBalanceAdjustments":0,"numberOfCreditMemos":0,"numberOfDebitMemos":0,"numberOfDebitMemosUnprocessed":0,"numberOfErrors":0,"numberOfInvoices":0,"numberOfPayments":0,"numberOfUnprocessed":0,"numberofUnappliedPayments":0,"paymentRunNumber":"PR-00000002","processPaymentWithClosedPM":false,"runDate":"2022-07-01","status":"Completed","targetDate":"2022-07-01","totalExecutionTime":535,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2023-06-09T03:16:35-07:00"}]},"id":"paths/~1object-query~1payment-runs/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-runs/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-runs/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-runs/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-runs/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-runs~1{key}/get/responses/200/content/application~1json/example":{"value":{"applyCreditBalance":false,"autoApplyCreditMemo":false,"autoApplyUnappliedPayment":false,"billingRunId":"BR-00000018","collectPayment":true,"consolidatedPayment":false,"createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2023-06-09T03:16:33-07:00","currency":"1","endDate":"2023-06-09T03:16:35-07:00","executedDate":"2023-06-09T03:16:35-07:00","id":"8ad08d29889f71e901889fa868cf70ef","numberOfCreditBalanceAdjustments":0,"numberOfCreditMemos":0,"numberOfDebitMemos":0,"numberOfDebitMemosUnprocessed":0,"numberOfErrors":0,"numberOfInvoices":0,"numberOfPayments":0,"numberOfUnprocessed":0,"numberofUnappliedPayments":0,"paymentRunNumber":"PR-00000002","processPaymentWithClosedPM":false,"runDate":"2022-07-01","status":"Completed","targetDate":"2022-07-01","totalExecutionTime":535,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2023-06-09T03:16:35-07:00"},"id":"paths/~1object-query~1payment-runs~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-runs~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-runs~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-runs~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-runs~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-schedules/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDIzLTAyLTA3VDIwOjUwOjQyLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOGUxYTg2MjU1MTc2MDE4NjJmNWM1MGRjMjFhNyIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"2c92c0f86ac39714016ad3e985c270c8","createdById":"2c92c09467cada0a0167cc79e59c0884","createdDate":"2023-02-07T20:50:24-08:00","description":"Payment Schedule 1","id":"8ad08e1a8625517601862f5c50dc21a7","invoiceId":"8ad098887fd49533017fde9722806ac9","number":"PS-00000002","occurrences":3,"period":"Weekly","prepayment":false,"runHour":2,"startDate":"2025-02-09","status":"Active","totalAmount":0,"totalPaymentsErrored":0,"totalPaymentsProcessed":0,"updatedById":"2c92c09467cada0a0167cc79e59c0884","updatedDate":"2023-02-07T20:50:42-08:00"}]},"id":"paths/~1object-query~1payment-schedules/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-schedules/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-schedules/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-schedules/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-schedules/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-schedules~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"2c92c0f86ac39714016ad3e985c270c8","createdById":"2c92c09467cada0a0167cc79e59c0884","createdDate":"2023-02-07T20:50:24-08:00","description":"Payment Schedule 1","id":"8ad08e1a8625517601862f5c50dc21a7","invoiceId":"8ad098887fd49533017fde9722806ac9","number":"PS-00000002","occurrences":3,"period":"Weekly","prepayment":false,"runHour":2,"startDate":"2025-02-09","status":"Active","totalAmount":0,"totalPaymentsErrored":0,"totalPaymentsProcessed":0,"updatedById":"2c92c09467cada0a0167cc79e59c0884","updatedDate":"2023-02-07T20:50:42-08:00"},"id":"paths/~1object-query~1payment-schedules~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-schedules~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-schedules~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-schedules~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-schedules~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-schedule-items/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI1LTAyLTE2VDIwOjU2OjM0LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODY5Yzk1MDFkMTU1MDE5NTEyNDNlNmI2NTliNCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"2c92c0f86ac39714016ad3e985c270c8","amount":2.78,"balance":0,"createdById":"2c92c09467cada0a0167cc79e59c0884","createdDate":"2025-02-16T20:56:34-08:00","currency":"USD","description":"","id":"8ad0869c9501d15501951243e6a85999","invoiceId":"8ad098887fd49533017fde9722806ac9","number":"8","paymentId":"8ad0975e95b883840195bca74e596721","paymentScheduleId":"8ad0869c9501d15501951243e68a5991","prepayment":false,"runHour":0,"scheduledDate":"2025-03-22","status":"Processed","updatedById":"2c92c09467cada0a0167cc79e59c0884","updatedDate":"2025-03-22T00:00:37-07:00"}]},"id":"paths/~1object-query~1payment-schedule-items/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-schedule-items/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-schedule-items/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-schedule-items/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-schedule-items/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1payment-schedule-items~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"2c92c0f86ac39714016ad3e985c270c8","amount":2.78,"balance":0,"createdById":"2c92c09467cada0a0167cc79e59c0884","createdDate":"2025-02-16T20:56:34-08:00","currency":"USD","description":"","id":"8ad0869c9501d15501951243e6a85999","invoiceId":"8ad098887fd49533017fde9722806ac9","number":"8","paymentId":"8ad0975e95b883840195bca74e596721","paymentScheduleId":"8ad0869c9501d15501951243e68a5991","prepayment":false,"runHour":0,"scheduledDate":"2025-03-22","status":"Processed","updatedById":"2c92c09467cada0a0167cc79e59c0884","updatedDate":"2025-03-22T00:00:37-07:00"},"id":"paths/~1object-query~1payment-schedule-items~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1payment-schedule-items~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-schedule-items~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1payment-schedule-items~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1payment-schedule-items~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1prepaid-balances/get/responses/200/content/application~1json/example":{"value":{"data":[{"accountId":"8ad0889d89969bdd01899b3c286907d4","balance":10,"createdById":"0df518966a824517b146ccd1eb780b20","createdDate":"2024-02-20T22:03:27-08:00","endDate":"2026-02-21","id":"8ad09be48dc99a2b018dca430ad45679","name":"A-S00000125_Each","origSubscriptionId":"8ad09be48dc99a2b018dca4309925663","prepaidBalanceState":"ACTIVE","prepaidType":0,"startDate":"2025-02-21","totalFund":10,"uOM":"Each","updatedById":"0df518966a824517b146ccd1eb780b20","updatedDate":"2024-02-20T22:03:27-08:00"},{"accountId":"2c92c0f87270a5970172747e289a5e66","balance":120,"createdById":"2c92c0f87270a597017273cf21dc64d4","createdDate":"2023-04-03T00:39:32-07:00","endDate":"2026-01-01","id":"8ad098f08736f8100187460e90b02056","name":"A-S00000021_Each","origSubscriptionId":"8ad08cbd8736ed1d0187460e8d4e231f","prepaidBalanceState":"ACTIVE","prepaidType":0,"startDate":"2025-01-01","totalFund":120,"uOM":"Each","updatedById":"2c92c0f87270a597017273cf21dc64d4","updatedDate":"2023-04-03T00:39:32-07:00"}]},"id":"paths/~1object-query~1prepaid-balances/get/responses/200/content/application~1json/example"},"paths/~1object-query~1prepaid-balances/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balances/get/responses/500/content/application~1json/example"},"paths/~1object-query~1prepaid-balances/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balances/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1prepaid-balances~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad0889d89969bdd01899b3c286907d4","balance":10,"createdById":"0df518966a824517b146ccd1eb780b20","createdDate":"2024-02-20T22:03:27-08:00","endDate":"2026-02-21","id":"8ad09be48dc99a2b018dca430ad45679","name":"A-S00000125_Each","origSubscriptionId":"8ad09be48dc99a2b018dca4309925663","prepaidBalanceState":"ACTIVE","prepaidType":0,"startDate":"2025-02-21","totalFund":10,"uOM":"Each","updatedById":"0df518966a824517b146ccd1eb780b20","updatedDate":"2024-02-20T22:03:27-08:00"},"id":"paths/~1object-query~1prepaid-balances~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1prepaid-balances~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balances~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1prepaid-balances~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balances~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-funds/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDIzLTA0LTAzVDAwOjM5OjMyLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOThmMDg3MzZmODEwMDE4NzQ2MGU5MGU2MjA2MSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"8ad0889d89969bdd01899b3c286907d4","balance":10,"chargeSegmentNumber":1,"createdById":"0df518966a824517b146ccd1eb780b20","createdDate":"2024-02-20T22:03:27-08:00","done":0,"endDate":"2025-02-21","fundSourceType":"CHARGE","fundedBalance":10,"fundingPrice":12,"id":"8ad09be48dc99a2b018dca430aeb567b","originalFundingPrice":12,"originalTotalBalance":0,"prepaidBalanceId":"8ad09be48dc99a2b018dca430ad45679","priority":50,"rolloverApplyOption":"ApplyLast","rolloverCount":0,"sourceId":"8ad09be48dc99a2b018dca430a0a566f","startDate":"2024-02-21","totalBalance":0,"totalBilled":0,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2024-12-19T23:27:57-08:00","vpSummaryId":"8ad09be48dc99a2b018dca430aea567a"}]},"id":"paths/~1object-query~1prepaid-balance-funds/get/responses/200/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-funds/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balance-funds/get/responses/500/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-funds/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balance-funds/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad0889d89969bdd01899b3c286907d4","balance":10,"chargeSegmentNumber":1,"createdById":"0df518966a824517b146ccd1eb780b20","createdDate":"2024-02-20T22:03:27-08:00","done":0,"endDate":"2025-02-21","fundSourceType":"CHARGE","fundedBalance":10,"fundingPrice":12,"id":"8ad09be48dc99a2b018dca430aeb567b","originalFundingPrice":12,"originalTotalBalance":0,"prepaidBalanceId":"8ad09be48dc99a2b018dca430ad45679","priority":50,"rolloverApplyOption":"ApplyLast","rolloverCount":0,"sourceId":"8ad09be48dc99a2b018dca430a0a566f","startDate":"2024-02-21","totalBalance":0,"totalBilled":0,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2024-12-19T23:27:57-08:00","vpSummaryId":"8ad09be48dc99a2b018dca430aea567a"},"id":"paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balance-funds~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-transactions/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTEyLTIwVDA2OjE2OjIxLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOTliODkzYmE0ZDFjMDE5M2U0NmQzMTI5NWIwYSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"2c92c0f87270a5970172747e289a5e66","amount":-10,"balance":50,"createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2024-12-20T06:16:21-08:00","fundId":"8ad089b2813e747501814ccc072341b8","id":"8ad099b893ba4d1c0193e46d315c5b20","prepaidBalanceId":"8ad089b2813e747501814c80d78176f1","prepaidBalanceTransactionType":"PREPAYMENT_CREDIT_BACK","sourceId":"8ad0877b813e577401814ccc0093038e","transactionDate":"2022-11-10","transactionSourceType":"CHARGE","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2024-12-20T06:16:21-08:00"}]},"id":"paths/~1object-query~1prepaid-balance-transactions/get/responses/200/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-transactions/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balance-transactions/get/responses/500/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-transactions/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balance-transactions/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"2c92c0f87270a5970172747e289a5e66","amount":-10,"balance":50,"createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2024-12-20T06:16:21-08:00","fundId":"8ad089b2813e747501814ccc072341b8","id":"8ad099b893ba4d1c0193e46d315c5b20","prepaidBalanceId":"8ad089b2813e747501814c80d78176f1","prepaidBalanceTransactionType":"PREPAYMENT_CREDIT_BACK","sourceId":"8ad0877b813e577401814ccc0093038e","transactionDate":"2022-11-10","transactionSourceType":"CHARGE","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2024-12-20T06:16:21-08:00"},"id":"paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1prepaid-balance-transactions~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1processed-usages/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDE3LTA4LTE0VDEwOjAwOjA0KzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiIyYzkyYzA5NDVkYzY5MDE5MDE1ZGRlNzgyZjBlNGMxMiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"billingPeriodEndDate":"2018-01-01T16:00:00+08:00","billingPeriodStartDate":"2017-12-01T16:00:00+08:00","createdById":"2c92c0f956bc8fcb0156f8eee04b4d54","createdDate":"2017-12-13T11:00:04+08:00","id":"2c92c094602f962301604dd098824b76","invoiceItemId":"2c92c094602f962301604dd0988d4b78","ratePlanChargeId":"2c92c0f956bc8fcb0156d5039e275aa9","updatedById":"2c92c0f956bc8fcb0156f8eee04b4d54","updatedDate":"2017-12-13T11:00:04+08:00","usageId":"2c92c08656bc8fdb0156d51204db6993"}]},"id":"paths/~1object-query~1processed-usages/get/responses/200/content/application~1json/example"},"paths/~1object-query~1processed-usages/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1processed-usages/get/responses/500/content/application~1json/example"},"paths/~1object-query~1processed-usages/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1processed-usages/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1processed-usages~1{key}/get/responses/200/content/application~1json/example":{"value":{"billingPeriodEndDate":"2018-01-01T16:00:00+08:00","billingPeriodStartDate":"2017-12-01T16:00:00+08:00","createdById":"2c92c0f956bc8fcb0156f8eee04b4d54","createdDate":"2017-12-13T11:00:04+08:00","id":"2c92c094602f962301604dd098824b76","invoiceItemId":"2c92c094602f962301604dd0988d4b78","ratePlanChargeId":"2c92c0f956bc8fcb0156d5039e275aa9","updatedById":"2c92c0f956bc8fcb0156f8eee04b4d54","updatedDate":"2017-12-13T11:00:04+08:00","usageId":"2c92c08656bc8fdb0156d51204db6993"},"id":"paths/~1object-query~1processed-usages~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1processed-usages~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1processed-usages~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1processed-usages~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1processed-usages~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1products/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDIzLTA3LTEzVDAwOjM5OjI2LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOTZjYTg5NDk1NmUxMDE4OTRlMzBjNzU2NzI0MyIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"allowFeatureChanges":false,"createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-02-06T23:32:02-08:00","description":"Cloud Service provided by ACME Corp.","effectiveEndDate":"2032-10-20","effectiveStartDate":"2022-10-20","id":"8ad08ea194da7ba00194df52a41f04c6","name":"Cloud Service","productNumber":"PC-00000027","sKU":"SKU-001","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-02-06T23:32:02-08:00"}]},"id":"paths/~1object-query~1products/get/responses/200/content/application~1json/example"},"paths/~1object-query~1products/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1products/get/responses/500/content/application~1json/example"},"paths/~1object-query~1products/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1products/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1products~1{key}/get/responses/200/content/application~1json/example":{"value":{"allowFeatureChanges":false,"createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-02-06T23:32:02-08:00","description":"Cloud Service provided by ACME Corp.","effectiveEndDate":"2032-10-20","effectiveStartDate":"2022-10-20","id":"8ad08ea194da7ba00194df52a41f04c6","name":"Cloud Service","productNumber":"PC-00000027","sKU":"SKU-001","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-02-06T23:32:02-08:00"},"id":"paths/~1object-query~1products~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1products~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1products~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1products~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1products~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1product-rate-plans/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDIzLTA3LTEzVDAwOjM2OjUxLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOGM4NDg5NDk0NWQ5MDE4OTRlMmU2OThlNjc2OSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"createdById":"2c92c0f97270b6b6017273cdcdd77ad9","createdDate":"2025-02-19T23:20:12-08:00","description":"","effectiveEndDate":"2028-02-08","effectiveStartDate":"2025-02-01","id":"f94fbebf61e952182765223a7a1d0000","name":"Premium plan - Monthly","productId":"8ad08ea194da7ba00194df52a41f04c6","productRatePlanNumber":"PRP-00000037","updatedById":"2c92c0f97270b6b6017273cdcdd77ad9","updatedDate":"2025-02-19T23:20:12-08:00"}]},"id":"paths/~1object-query~1product-rate-plans/get/responses/200/content/application~1json/example"},"paths/~1object-query~1product-rate-plans/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plans/get/responses/500/content/application~1json/example"},"paths/~1object-query~1product-rate-plans/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plans/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1product-rate-plans~1{key}/get/responses/200/content/application~1json/example":{"value":{"createdById":"2c92c0f97270b6b6017273cdcdd77ad9","createdDate":"2025-02-19T23:20:12-08:00","description":"","effectiveEndDate":"2028-02-08","effectiveStartDate":"2025-02-01","id":"f94fbebf61e952182765223a7a1d0000","name":"Premium plan - Monthly","productId":"8ad08ea194da7ba00194df52a41f04c6","productRatePlanNumber":"PRP-00000037","updatedById":"2c92c0f97270b6b6017273cdcdd77ad9","updatedDate":"2025-02-19T23:20:12-08:00"},"id":"paths/~1object-query~1product-rate-plans~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1product-rate-plans~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plans~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1product-rate-plans~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plans~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charges/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDIzLTA4LTAyVDIwOjM5OjMwLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOTQwODg5YjcxZmMyMDE4OWI5N2FhNjVlMmVhOSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","accountingCode":"Subscription Revenue","applyToBillingPeriodPartially":false,"chargeFunction":"Standard","chargeModel":"Volume Pricing","chargeType":"OneTime","commitmentType":"UNIT","createdById":"2c92c0f97270b6b6017273cdcdd77ad9","createdDate":"2025-02-19T23:44:10-08:00","defaultQuantity":100,"deferredRevenueAccount":"Subscription Revenue","deferredRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","description":"","endDateCondition":"OneTime","excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"id":"f94fbebf60e95218276522506ac30001","includedUnits":0,"isAllocationEligible":false,"isCommitted":false,"isPrepaid":false,"isRollover":false,"isStackedDiscount":false,"isUnbilled":false,"legacyRevenueReporting":false,"listPriceBase":"Per Billing Period","name":"One-time volume charge","numberOfPeriod":1,"overageCalculationOption":"EndOfSmoothingPeriod","overageUnusedUnitsCreditOption":"NoCredit","priceChangeOption":"NoChange","priceIncreasePercentage":0,"priceUpsellQuantityStacked":false,"productRatePlanChargeNumber":"PRPC-00000051","productRatePlanId":"f94fbebf61e952182765223a7a1d0000","recognizedRevenueAccount":"Subscription Revenue","recognizedRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","revenueRecognitionRuleName":"Recognize upon invoicing","rolloverApply":"ApplyLast","rolloverPeriodLength":0,"rolloverPeriods":0,"taxCode":"","taxable":false,"triggerEvent":"ContractEffective","uOM":"Each","upToPeriodsType":"Billing Periods","updatedById":"2c92c0f97270b6b6017273cdcdd77ad9","updatedDate":"2025-02-19T23:44:10-08:00","useTenantDefaultForPriceChange":true,"validityPeriodType":"SubscriptionTerm"}]},"id":"paths/~1object-query~1product-rate-plan-charges/get/responses/200/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charges/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plan-charges/get/responses/500/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charges/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plan-charges/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","accountingCode":"Subscription Revenue","applyToBillingPeriodPartially":false,"chargeFunction":"Standard","chargeModel":"Volume Pricing","chargeType":"OneTime","commitmentType":"UNIT","createdById":"2c92c0f97270b6b6017273cdcdd77ad9","createdDate":"2025-02-19T23:44:10-08:00","defaultQuantity":100,"deferredRevenueAccount":"Subscription Revenue","deferredRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","description":"","endDateCondition":"OneTime","excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"id":"f94fbebf60e95218276522506ac30001","includedUnits":0,"isAllocationEligible":false,"isCommitted":false,"isPrepaid":false,"isRollover":false,"isStackedDiscount":false,"isUnbilled":false,"legacyRevenueReporting":false,"listPriceBase":"Per Billing Period","name":"One-time volume charge","numberOfPeriod":1,"overageCalculationOption":"EndOfSmoothingPeriod","overageUnusedUnitsCreditOption":"NoCredit","priceChangeOption":"NoChange","priceIncreasePercentage":0,"priceUpsellQuantityStacked":false,"productRatePlanChargeNumber":"PRPC-00000051","productRatePlanId":"f94fbebf61e952182765223a7a1d0000","recognizedRevenueAccount":"Subscription Revenue","recognizedRevenueAccountingCodeId":"2c92c0f86cccaa59016cd5e125691213","revenueRecognitionRuleName":"Recognize upon invoicing","rolloverApply":"ApplyLast","rolloverPeriodLength":0,"rolloverPeriods":0,"taxCode":"","taxable":false,"triggerEvent":"ContractEffective","uOM":"Each","upToPeriodsType":"Billing Periods","updatedById":"2c92c0f97270b6b6017273cdcdd77ad9","updatedDate":"2025-02-19T23:44:10-08:00","useTenantDefaultForPriceChange":true,"validityPeriodType":"SubscriptionTerm"},"id":"paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI1LTAyLTE5VDIzOjI2OjM0LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmMTY2MjhiZTk1MjE5NWYzNTIyNDA0ZWZiMDAxMSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"active":false,"createdById":"2c92c0f97270b6b6017273cdcdd77ad9","createdDate":"2025-02-19T23:44:10-08:00","currency":"CAD","endingUnit":10000,"id":"f94fbebf60e95218276522506ac30006","isDefault":true,"price":0,"priceFormat":"Per Unit","productRatePlanChargeId":"f94fbebf60e95218276522506ac30001","startingUnit":1,"tier":1,"updatedById":"2c92c0f97270b6b6017273cdcdd77ad9","updatedDate":"2025-02-19T23:44:10-08:00"}]},"id":"paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/200/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/500/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example":{"value":{"active":false,"createdById":"2c92c0f97270b6b6017273cdcdd77ad9","createdDate":"2025-02-19T23:44:10-08:00","currency":"CAD","endingUnit":10000,"id":"f94fbebf60e95218276522506ac30006","isDefault":true,"price":0,"priceFormat":"Per Unit","productRatePlanChargeId":"f94fbebf60e95218276522506ac30001","startingUnit":1,"tier":1,"updatedById":"2c92c0f97270b6b6017273cdcdd77ad9","updatedDate":"2025-02-19T23:44:10-08:00"},"id":"paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1product-rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1ramps/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI1LTA1LTIwVDE1OjM2OjU0KzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YTkwY2Q2Yzk2ZWFkMThkMDE5NmVjOWZiMzRiMjI2OCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"chargeNumbers":"C-00036028,C-00036029","createdById":"2c92c8f95e2d6ebb015e325df48e02da","createdDate":"2025-07-07T17:10:04+08:00","discountTcb":0,"discountTcv":0,"grossTcb":1100.02,"grossTcv":1099.98,"id":"8a908be797dcd0ab0197e4264a872ea9","metricsProcessingStatus":"Completed","netTcb":1100.02,"netTcv":1099.98,"number":"R-00000464","orderId":"edcaaadd4dd97dcd08b7e4264a1900a1","subscriptionNumbers":"A-S00004629","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2025-07-07T17:10:07+08:00"}]},"id":"paths/~1object-query~1ramps/get/responses/200/content/application~1json/example"},"paths/~1object-query~1ramps/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1ramps/get/responses/500/content/application~1json/example"},"paths/~1object-query~1ramps/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1ramps/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1ramps~1{key}/get/responses/200/content/application~1json/example":{"value":{"chargeNumbers":"C-00036028,C-00036029","createdById":"2c92c8f95e2d6ebb015e325df48e02da","createdDate":"2025-07-07T17:10:04+08:00","discountTcb":0,"discountTcv":0,"grossTcb":1100.02,"grossTcv":1099.98,"id":"8a908be797dcd0ab0197e4264a872ea9","metricsProcessingStatus":"Completed","netTcb":1100.02,"netTcv":1099.98,"number":"R-00000464","orderId":"edcaaadd4dd97dcd08b7e4264a1900a1","subscriptionNumbers":"A-S00004629","updatedById":"2c92c8f95e2d6ebb015e325df48e02da","updatedDate":"2025-07-07T17:10:07+08:00"},"id":"paths/~1object-query~1ramps~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1ramps~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1ramps~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1ramps~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1ramps~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1rate-plans/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI1LTAyLTE5VDIzOjUwOjQxLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmYzM3YjVjODk1MjE4Mjc3NTIyNTY2MTQ0MDM0ZCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","id":"f94fb52490e95cd65925cd7b740200c7","invoiceOwnerId":"2c92c0f87270a5970172747e289a5e66","name":"Monthly rate plan","originalRatePlanId":"f94fb52490e95cd65925cd7b740200c7","productId":"8ad08ea194da7ba00194df52a41f04c6","productRatePlanId":"f94fbebf61e952182765223a7a1d0000","reverted":false,"subscriptionId":"f94fb52490e95cd65925cd7b737400bd","subscriptionOwnerId":"2c92c0f87270a5970172747e289a5e66","subscriptionRatePlanNumber":"SRP-00000349","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00"}]},"id":"paths/~1object-query~1rate-plans/get/responses/200/content/application~1json/example"},"paths/~1object-query~1rate-plans/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plans/get/responses/500/content/application~1json/example"},"paths/~1object-query~1rate-plans/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plans/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1rate-plans~1{key}/get/responses/200/content/application~1json/example":{"value":{"createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","id":"f94fb52490e95cd65925cd7b740200c7","invoiceOwnerId":"2c92c0f87270a5970172747e289a5e66","name":"Monthly rate plan","originalRatePlanId":"f94fb52490e95cd65925cd7b740200c7","productId":"8ad08ea194da7ba00194df52a41f04c6","productRatePlanId":"f94fbebf61e952182765223a7a1d0000","reverted":false,"subscriptionId":"f94fb52490e95cd65925cd7b737400bd","subscriptionOwnerId":"2c92c0f87270a5970172747e289a5e66","subscriptionRatePlanNumber":"SRP-00000349","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00"},"id":"paths/~1object-query~1rate-plans~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1rate-plans~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plans~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1rate-plans~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plans~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1rate-plan-charges/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI1LTAzLTI0VDIxOjIxOjM3LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmYjUyNDk1Zjk1Yjg4MjQ2NWNiODhkNWUxOTRhNyIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","applyDiscountTo":"ONETIMERECURRING","applyToBillingPeriodPartially":false,"billCycleType":"DefaultFromCustomer","billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","chargeModel":"Discount-Percentage","chargeNumber":"C-00000526","chargeType":"Recurring","chargedThroughDate":"2025-04-01","commitmentType":"UNIT","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","dMRC":0,"dTCV":0,"description":"","discountLevel":"rateplan","effectiveEndDate":"2026-02-01","effectiveStartDate":"2025-02-01","endDateCondition":"SubscriptionEnd","excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"id":"f94fb52490e95cd65925cd7b737700c5","invoiceOwnerId":"2c92c0f87270a5970172747e289a5e66","isCommitted":false,"isLastSegment":true,"isPrepaid":false,"isProcessed":false,"isRollover":false,"listPriceBase":"Per Billing Period","mRR":0,"name":"Percentage discount","numberOfPeriods":1,"originalId":"f94fb52490e95cd65925cd7b737700c5","originalOrderDate":"2025-02-01","overageCalculationOption":"EndOfSmoothingPeriod","overageUnusedUnitsCreditOption":"NoCredit","priceChangeOption":"NoChange","priceIncreasePercentage":0,"priceUpsellQuantityStacked":false,"processedThroughDate":"2025-03-01","productRatePlanChargeId":"f94f16628be952195f3522404efb0010","prorationOption":"DefaultFromTenantSetting","quantity":0,"ratePlanId":"f94fb52490e95cd65925cd7b740200c7","reflectDiscountInNetAmount":false,"reverted":false,"rolloverApply":"ApplyLast","rolloverPeriodLength":0,"rolloverPeriods":0,"segment":1,"subscriptionId":"f94fb52490e95cd65925cd7b737400bd","subscriptionOwnerId":"2c92c0f87270a5970172747e289a5e66","tCV":0,"taxable":false,"triggerEvent":"ContractEffective","upToPeriodsType":"Billing Periods","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00","version":1}]},"id":"paths/~1object-query~1rate-plan-charges/get/responses/200/content/application~1json/example"},"paths/~1object-query~1rate-plan-charges/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plan-charges/get/responses/500/content/application~1json/example"},"paths/~1object-query~1rate-plan-charges/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plan-charges/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1rate-plan-charges~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","applyDiscountTo":"ONETIMERECURRING","applyToBillingPeriodPartially":false,"billCycleType":"DefaultFromCustomer","billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","chargeModel":"Discount-Percentage","chargeNumber":"C-00000526","chargeType":"Recurring","chargedThroughDate":"2025-04-01","commitmentType":"UNIT","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","dMRC":0,"dTCV":0,"description":"","discountLevel":"rateplan","effectiveEndDate":"2026-02-01","effectiveStartDate":"2025-02-01","endDateCondition":"SubscriptionEnd","excludeItemBillingFromRevenueAccounting":false,"excludeItemBookingFromRevenueAccounting":false,"id":"f94fb52490e95cd65925cd7b737700c5","invoiceOwnerId":"2c92c0f87270a5970172747e289a5e66","isCommitted":false,"isLastSegment":true,"isPrepaid":false,"isProcessed":false,"isRollover":false,"listPriceBase":"Per Billing Period","mRR":0,"name":"Percentage discount","numberOfPeriods":1,"originalId":"f94fb52490e95cd65925cd7b737700c5","originalOrderDate":"2025-02-01","overageCalculationOption":"EndOfSmoothingPeriod","overageUnusedUnitsCreditOption":"NoCredit","priceChangeOption":"NoChange","priceIncreasePercentage":0,"priceUpsellQuantityStacked":false,"processedThroughDate":"2025-03-01","productRatePlanChargeId":"f94f16628be952195f3522404efb0010","prorationOption":"DefaultFromTenantSetting","quantity":0,"ratePlanId":"f94fb52490e95cd65925cd7b740200c7","reflectDiscountInNetAmount":false,"reverted":false,"rolloverApply":"ApplyLast","rolloverPeriodLength":0,"rolloverPeriods":0,"segment":1,"subscriptionId":"f94fb52490e95cd65925cd7b737400bd","subscriptionOwnerId":"2c92c0f87270a5970172747e289a5e66","tCV":0,"taxable":false,"triggerEvent":"ContractEffective","upToPeriodsType":"Billing Periods","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00","version":1},"id":"paths/~1object-query~1rate-plan-charges~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1rate-plan-charges~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plan-charges~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plan-charges~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1rate-plan-charge-tiers/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI1LTAzLTI1VDA2OjI2OjE0LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmYjUyNDkwZTk1Y2Q2NTkyNWNkN2I3NDJiMDBkNCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","currency":"USD","discountPercentage":20,"id":"f94fb52490e95cd65925cd7b742e00dd","ratePlanChargeId":"f94fb52490e95cd65925cd7b737700c5","tier":1,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00"}]},"id":"paths/~1object-query~1rate-plan-charge-tiers/get/responses/200/content/application~1json/example"},"paths/~1object-query~1rate-plan-charge-tiers/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plan-charge-tiers/get/responses/500/content/application~1json/example"},"paths/~1object-query~1rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plan-charge-tiers/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example":{"value":{"createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","currency":"USD","discountPercentage":20,"id":"f94fb52490e95cd65925cd7b742e00dd","ratePlanChargeId":"f94fb52490e95cd65925cd7b737700c5","tier":1,"updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00"},"id":"paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rate-plan-charge-tiers~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1rating-results/get/responses/200/content/application~1json/example":{"value":{"data":[{"accountId":"2c92c0f97871fb4201787be2536825ac","actualPeriodEndDate":"2023-05-21","actualPeriodStartDate":"2023-05-15","amount":0,"billingCycleDay":2,"chargeSegmentNumber":2,"createdByID":"00000000000000000000000000000003","createdDate":"2024-02-28T01:36:50-08:00","id":"8ad093c18deeb97e018def12ea353fca","isPartial":false,"quantity":45,"ratePlanChargeId":"62bfa4c8fc7954ad35e54c3f711a6bc8","serviceEndDate":"2023-05-21","serviceStartDate":"2023-05-15","status":"Rated","subscriptionId":"62bfa4c8fc7954ad35e54c3f70a16bc2","updatedByID":"00000000000000000000000000000003","updatedDate":"2025-02-28T03:09:48-08:00"}]},"id":"paths/~1object-query~1rating-results/get/responses/200/content/application~1json/example"},"paths/~1object-query~1rating-results/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rating-results/get/responses/500/content/application~1json/example"},"paths/~1object-query~1rating-results/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rating-results/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1rating-results~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"2c92c0f97871fb4201787be2536825ac","actualPeriodEndDate":"2023-05-21","actualPeriodStartDate":"2023-05-15","amount":0,"billingCycleDay":2,"chargeSegmentNumber":2,"createdByID":"00000000000000000000000000000003","createdDate":"2024-02-28T01:36:50-08:00","id":"8ad093c18deeb97e018def12ea353fca","isPartial":false,"quantity":45,"ratePlanChargeId":"62bfa4c8fc7954ad35e54c3f711a6bc8","serviceEndDate":"2023-05-21","serviceStartDate":"2023-05-15","status":"Rated","subscriptionId":"62bfa4c8fc7954ad35e54c3f70a16bc2","updatedByID":"00000000000000000000000000000003","updatedDate":"2025-02-28T03:09:48-08:00"},"id":"paths/~1object-query~1rating-results~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1rating-results~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rating-results~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1rating-results~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rating-results~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1refunds/get/responses/200/content/application~1json/example":{"value":{"data":[{"accountId":"8ad09be48db5aba7018db604776d4854","amount":10,"createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2024-07-25T00:19:43-07:00","currency":"USD","gateway":"test gateway","gatewayResponse":"This transaction has been approved by Test gateway.","gatewayResponseCode":"approve","gatewayState":"Submitted","id":"8ad0937890e7fca00190e8c290d46fad","methodType":"CreditCard","paymentMethodId":"8ad084db90a5e73b0190c02783f552fa","paymentMethodSnapshotId":"8ad0937890e7fca00190e8c290b86fab","referenceID":"7002728053836375","refundDate":"2024-07-25","refundNumber":"R-00000001","refundTransactionTime":"2024-07-25T00:19:43-07:00","sourceType":"CreditMemo","status":"Processed","submittedOn":"2024-07-25T00:19:43-07:00","type":"Electronic","updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-07-25T00:19:43-07:00"}]},"id":"paths/~1object-query~1refunds/get/responses/200/content/application~1json/example"},"paths/~1object-query~1refunds/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refunds/get/responses/500/content/application~1json/example"},"paths/~1object-query~1refunds/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refunds/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1refunds~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad09be48db5aba7018db604776d4854","amount":10,"createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2024-07-25T00:19:43-07:00","currency":"USD","gateway":"test gateway","gatewayResponse":"This transaction has been approved by Test gateway.","gatewayResponseCode":"approve","gatewayState":"Submitted","id":"8ad0937890e7fca00190e8c290d46fad","methodType":"CreditCard","paymentMethodId":"8ad084db90a5e73b0190c02783f552fa","paymentMethodSnapshotId":"8ad0937890e7fca00190e8c290b86fab","referenceID":"7002728053836375","refundDate":"2024-07-25","refundNumber":"R-00000001","refundTransactionTime":"2024-07-25T00:19:43-07:00","sourceType":"CreditMemo","status":"Processed","submittedOn":"2024-07-25T00:19:43-07:00","type":"Electronic","updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-07-25T00:19:43-07:00"},"id":"paths/~1object-query~1refunds~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1refunds~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refunds~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1refunds~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refunds~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1refund-applications/get/responses/200/content/application~1json/example":{"value":{"data":[{"accountId":"8ad09be48db5aba7018db604776d4854","accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","applicationGroupId":"8ad0937890e7fca00190e8c290ef6faf","applyAmount":10,"createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2024-07-25T00:19:43-07:00","creditMemoId":"8ad0835290c4bb2f0190d9955e414e62","effectiveDate":"2024-07-25","id":"8ad0937890e7fca00190e8c290f06fb0","refundId":"8ad0937890e7fca00190e8c290d46fad","unappliedPaymentAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-07-25T00:19:43-07:00"}]},"id":"paths/~1object-query~1refund-applications/get/responses/200/content/application~1json/example"},"paths/~1object-query~1refund-applications/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refund-applications/get/responses/500/content/application~1json/example"},"paths/~1object-query~1refund-applications/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refund-applications/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1refund-applications~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad09be48db5aba7018db604776d4854","accountReceivableAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","applicationGroupId":"8ad0937890e7fca00190e8c290ef6faf","applyAmount":10,"createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2024-07-25T00:19:43-07:00","creditMemoId":"8ad0835290c4bb2f0190d9955e414e62","effectiveDate":"2024-07-25","id":"8ad0937890e7fca00190e8c290f06fb0","refundId":"8ad0937890e7fca00190e8c290d46fad","unappliedPaymentAccountingCodeId":"2c92c0f86cccaa59016cd5e108bf1206","updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2024-07-25T00:19:43-07:00"},"id":"paths/~1object-query~1refund-applications~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1refund-applications~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refund-applications~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1refund-applications~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refund-applications~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1refund-application-items/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refund-application-items/get/responses/500/content/application~1json/example"},"paths/~1object-query~1refund-application-items/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refund-application-items/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1refund-application-items~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refund-application-items~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1refund-application-items~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1refund-application-items~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1summarystatementruns/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"402881869169397401916d8ff8d218c5","createdById":"8a90e0828097f4a80180982735ff041d","createdDate":"2024-09-03T20:20:55-10:00","emailStatus":"Pending","endDate":"2024-09-03","id":"8a90f17a91b7e1800191bbb176a243da","startDate":"2024-09-03","statementDate":"2024-09-03","statementNumber":"SS-00001979","statementRunId":"8a90b44891b7e1670191bbb16cef028a","status":"Completed","updatedById":"8a90e0828097f4a80180982735ff041d","updatedDate":"2024-08-20 10:13:57.586","success":true},"key":"response","summary":"response","id":"paths/~1object-query~1summarystatementruns/get/responses/200/content/application~1json/examples/response"},"paths/~1object-query~1summarystatementruns/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1summarystatementruns/get/responses/500/content/application~1json/example"},"paths/~1object-query~1summarystatementruns/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1summarystatementruns/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1summarystatementruns~1{key}/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"402881869169397401916d8ff8d218c5","statementRunNumber":"SSR-00000004","targetAccountCategory":"AllAccounts","runType":"AdHoc","batchName":"Batch51","billCycleDay":"1","dateRangeType":"PreviousThreeCalendarMonth","startDate":"2024-05-01 19:13:57","endDate":"2024-07-31 19:13:57","autoEmailEnabled":false,"description":"HelloWorld","status":"Pending","createdById":"402881e522cf4f9b0122cf5d82860002","createdDate":"2024-08-19 19:13:57","updatedById":"402881e522cf4f9b0122cf5d82860002","updatedDate":"2024-08-20 10:13:57.586","success":true},"key":"response","summary":"response","id":"paths/~1object-query~1summarystatementruns~1{key}/get/responses/200/content/application~1json/examples/response"},"paths/~1object-query~1summarystatementruns~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1summarystatementruns~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1summarystatementruns~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1summarystatementruns~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1summarystatements/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"402881869169397401916d8ff8d218c5","createdById":"8a90e0828097f4a80180982735ff041d","createdDate":"2024-09-03T20:20:55-10:00","emailStatus":"Pending","endDate":"2024-09-03","id":"8a90f17a91b7e1800191bbb176a243da","startDate":"2024-09-03","statementDate":"2024-09-03","statementNumber":"SS-00001979","statementRunId":"8a90b44891b7e1670191bbb16cef028a","status":"Completed","updatedById":"8a90e0828097f4a80180982735ff041d","updatedDate":"2024-08-20 10:13:57.586","success":true},"key":"response","summary":"response","id":"paths/~1object-query~1summarystatements/get/responses/200/content/application~1json/examples/response"},"paths/~1object-query~1summarystatements/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1summarystatements/get/responses/500/content/application~1json/example"},"paths/~1object-query~1summarystatements/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1summarystatements/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1summarystatements~1{key}/get/responses/200/content/application~1json/examples/response":{"value":{"accountId":"402881869169397401916d8ff8d218c5","createdById":"8a90e0828097f4a80180982735ff041d","createdDate":"2024-09-03T20:20:55-10:00","emailStatus":"Pending","endDate":"2024-09-03","id":"8a90f17a91b7e1800191bbb176a243da","startDate":"2024-09-03","statementDate":"2024-09-03","statementNumber":"SS-00001979","statementRunId":"8a90b44891b7e1670191bbb16cef028a","status":"Completed","updatedById":"8a90e0828097f4a80180982735ff041d","updatedDate":"2024-08-20 10:13:57.586","success":true},"key":"response","summary":"response","id":"paths/~1object-query~1summarystatements~1{key}/get/responses/200/content/application~1json/examples/response"},"paths/~1object-query~1summarystatements~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1summarystatements~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1summarystatements~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1summarystatements~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1subscriptions/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI1LTAyLTA2VDIzOjA5OjExLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmNmVhOWQ4Nzk0ZGE5Mzg2NGRmM2RiODk4MTcxYyIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"2c92c0f87270a5970172747e289a5e66","autoRenew":true,"cMRR":2950,"contractAcceptanceDate":"2025-02-01","contractEffectiveDate":"2025-02-01","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","creatorAccountId":"2c92c0f87270a5970172747e289a5e66","creatorInvoiceOwnerId":"2c92c0f87270a5970172747e289a5e66","currency":"USD","currentTerm":12,"currentTermPeriodType":"Month","id":"f94fb52490e95cd65925cd7b737400bd","initialTerm":12,"initialTermPeriodType":"Month","invoiceOwnerId":"2c92c0f87270a5970172747e289a5e66","isInvoiceSeparate":true,"isLatestVersion":true,"isSingleVersioned":false,"lastBookingDate":"2025-02-01","name":"A-S00000159","orderId":"f94fb52490e95cd65925cd7b733100b6","originalCreatedDate":"2025-03-25T06:26:14-07:00","originalId":"f94fb52490e95cd65925cd7b737400bd","prepayment":false,"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerm":12,"renewalTermPeriodType":"Month","revision":"1.0","serviceActivationDate":"2025-02-01","status":"Active","subscriptionEndDate":"2026-02-01","subscriptionStartDate":"2025-02-01","subscriptionVersionAmendmentId":"f94fb52490e95cd65925cd7b733100b7","termEndDate":"2026-02-01","termStartDate":"2025-02-01","termType":"TERMED","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00","version":1}]},"id":"paths/~1object-query~1subscriptions/get/responses/200/content/application~1json/example"},"paths/~1object-query~1subscriptions/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1subscriptions/get/responses/500/content/application~1json/example"},"paths/~1object-query~1subscriptions/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1subscriptions/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1subscriptions~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"2c92c0f87270a5970172747e289a5e66","autoRenew":true,"cMRR":2950,"contractAcceptanceDate":"2025-02-01","contractEffectiveDate":"2025-02-01","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2025-03-25T06:26:14-07:00","creatorAccountId":"2c92c0f87270a5970172747e289a5e66","creatorInvoiceOwnerId":"2c92c0f87270a5970172747e289a5e66","currency":"USD","currentTerm":12,"currentTermPeriodType":"Month","id":"f94fb52490e95cd65925cd7b737400bd","initialTerm":12,"initialTermPeriodType":"Month","invoiceOwnerId":"2c92c0f87270a5970172747e289a5e66","isInvoiceSeparate":true,"isLatestVersion":true,"isSingleVersioned":false,"lastBookingDate":"2025-02-01","name":"A-S00000159","orderId":"f94fb52490e95cd65925cd7b733100b6","originalCreatedDate":"2025-03-25T06:26:14-07:00","originalId":"f94fb52490e95cd65925cd7b737400bd","prepayment":false,"renewalSetting":"RENEW_WITH_SPECIFIC_TERM","renewalTerm":12,"renewalTermPeriodType":"Month","revision":"1.0","serviceActivationDate":"2025-02-01","status":"Active","subscriptionEndDate":"2026-02-01","subscriptionStartDate":"2025-02-01","subscriptionVersionAmendmentId":"f94fb52490e95cd65925cd7b733100b7","termEndDate":"2026-02-01","termStartDate":"2025-02-01","termType":"TERMED","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-25T06:26:14-07:00","version":1},"id":"paths/~1object-query~1subscriptions~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1subscriptions~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1subscriptions~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1subscriptions~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1subscriptions~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1taxation-items/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDE5LTA3LTEzVDEwOjAwOjE5KzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiIyYzkyYzA5NDZiZTFmOTFlMDE2YmU5MGY0MjAzNGRiOSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountReceivableAccountingCodeId":"2c92c0f946f588620146f8735ee101c8","accountingCode":"Sales Tax Payable","balance":0,"createdById":"8ad084a67f9c7138017fab8a8b511b5a","createdDate":"2024-11-04T10:53:16+08:00","creditAmount":0,"exemptAmount":0,"id":"8ad09d9392e0a4430192f51746d121f6","invoiceItemId":"8ad086fa92d66ffe0192dc7e5dd65161","jurisdiction":"CALIFORNIA","name":"CA TAX","paymentAmount":3,"periodEndDate":"2024-10-30","periodStartDate":"2024-10-30","salesTaxPayableAccountingCodeId":"2c92c0f946f588620146f8735f0a01cd","taxAmount":3,"taxAmountUnrounded":3,"taxDate":"2024-11-04","taxMode":"TaxExclusive","taxRate":3,"taxRateDescription":"Details of the tax rate","taxRateType":"FlatFee","taxableAmount":0,"updatedById":"2c92c0f955e2bcfc0155e3019d0c4963","updatedDate":"2024-11-29T05:00:42+08:00"}]},"id":"paths/~1object-query~1taxation-items/get/responses/200/content/application~1json/example"},"paths/~1object-query~1taxation-items/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1taxation-items/get/responses/500/content/application~1json/example"},"paths/~1object-query~1taxation-items/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1taxation-items/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1taxation-items~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountReceivableAccountingCodeId":"2c92c0f946f588620146f8735ee101c8","accountingCode":"Sales Tax Payable","balance":0,"createdById":"8ad084a67f9c7138017fab8a8b511b5a","createdDate":"2024-11-04T10:53:16+08:00","creditAmount":0,"exemptAmount":0,"id":"8ad09d9392e0a4430192f51746d121f6","invoiceItemId":"8ad086fa92d66ffe0192dc7e5dd65161","jurisdiction":"CALIFORNIA","name":"CA TAX","paymentAmount":3,"periodEndDate":"2024-10-30","periodStartDate":"2025-10-30","salesTaxPayableAccountingCodeId":"2c92c0f946f588620146f8735f0a01cd","taxAmount":3,"taxAmountUnrounded":3,"taxDate":"2024-11-04","taxMode":"TaxExclusive","taxRate":3,"taxRateDescription":"Details of the tax rate","taxRateType":"FlatFee","taxableAmount":0,"updatedById":"2c92c0f955e2bcfc0155e3019d0c4963","updatedDate":"2024-11-29T05:00:42+08:00"},"id":"paths/~1object-query~1taxation-items~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1taxation-items~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1taxation-items~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1taxation-items~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1taxation-items~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1usages/get/responses/200/content/application~1json/example":{"value":{"data":[{"accountId":"8ad09e2089b71fba0189b97aac74494b","accountNumber":"A00000064","createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2023-08-02T20:39:50-07:00","id":"8ad094b989b71fb60189b97af64e48d2","quantity":4,"rbeStatus":"Pending","sourceType":"API","startDateTime":"2023-05-31T17:00:00-07:00","submissionDateTime":"2023-08-02T20:39:50-07:00","subscriptionId":"8ad09e2089b71fba0189b97aba7b4b01","uOM":"Each","updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2023-08-02T20:39:50-07:00"}]},"id":"paths/~1object-query~1usages/get/responses/200/content/application~1json/example"},"paths/~1object-query~1usages/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1usages/get/responses/500/content/application~1json/example"},"paths/~1object-query~1usages/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1usages/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1usages~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad09e2089b71fba0189b97aac74494b","accountNumber":"A00000064","createdById":"b243314d594646d3b2651aeedd4be47e","createdDate":"2023-08-02T20:39:50-07:00","id":"8ad094b989b71fb60189b97af64e48d2","quantity":4,"rbeStatus":"Pending","sourceType":"API","startDateTime":"2023-05-31T17:00:00-07:00","submissionDateTime":"2023-08-02T20:39:50-07:00","subscriptionId":"8ad09e2089b71fba0189b97aba7b4b01","uOM":"Each","updatedById":"b243314d594646d3b2651aeedd4be47e","updatedDate":"2023-08-02T20:39:50-07:00"},"id":"paths/~1object-query~1usages~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1usages~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1usages~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1usages~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1usages~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1validity-period-summaries/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDIzLTA0LTAzVDAwOjM5OjMyLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOThmMDg3MzZmODEwMDE4NzQ2MGU5MGU2MjA2MCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"accountId":"8ad0889d89969bdd01899b3c286907d4","accountNumber":"A00000061","billedBalanceAmount":0,"billingTiming":"In Advance","createdById":"0df518966a824517b146ccd1eb780b20","createdDate":"2024-02-20T22:03:27-08:00","endDate":"2025-02-21","id":"8ad09be48dc99a2b018dca430aea567a","overageRatedAmount":0,"overageRatedQuantity":0,"prepaidBalanceId":"8ad09be48dc99a2b018dca430ad45679","remainingBalance":10,"startDate":"2024-02-21","subscriptionNumber":"A-S00000125","totalBalance":10,"totalBilledAmount":0,"uom":"Each","updatedById":"0df518966a824517b146ccd1eb780b20","updatedDate":"2024-02-20T22:03:27-08:00"}]},"id":"paths/~1object-query~1validity-period-summaries/get/responses/200/content/application~1json/example"},"paths/~1object-query~1validity-period-summaries/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1validity-period-summaries/get/responses/500/content/application~1json/example"},"paths/~1object-query~1validity-period-summaries/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1validity-period-summaries/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1validity-period-summaries~1{key}/get/responses/200/content/application~1json/example":{"value":{"accountId":"8ad0889d89969bdd01899b3c286907d4","accountNumber":"A00000061","billedBalanceAmount":0,"billingTiming":"In Advance","createdById":"0df518966a824517b146ccd1eb780b20","createdDate":"2024-02-20T22:03:27-08:00","endDate":"2025-02-21","id":"8ad09be48dc99a2b018dca430aea567a","overageRatedAmount":0,"overageRatedQuantity":0,"prepaidBalanceId":"8ad09be48dc99a2b018dca430ad45679","remainingBalance":10,"startDate":"2024-02-21","subscriptionNumber":"A-S00000125","totalBalance":10,"totalBilledAmount":0,"uom":"Each","updatedById":"0df518966a824517b146ccd1eb780b20","updatedDate":"2024-02-20T22:03:27-08:00"},"id":"paths/~1object-query~1validity-period-summaries~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1validity-period-summaries~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1validity-period-summaries~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1validity-period-summaries~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1validity-period-summaries~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1{custom-object-name}/get/responses/200/content/application~1json/example":{"value":{"nextPage":"OWVmMGIxYTAtZTM5OC00NmFhLTg1NmYtNzYyNzNiMGQyOTg4","data":[{"createdById":"8ad08c0f7f9c7144017fab88cd2e27d7","createdDate":"2023-05-12T03:44:40.733Z","id":"901e5409-e846-47cf-92af-05ccb0e0be96","mSRP__c":235600,"updatedById":"8ad08c0f7f9c7144017fab88cd2e27d7","updatedDate":"2023-05-12T06:21:41.551Z","brand__c":"Porsche","color__c":"red","model__c":"911"},{"createdById":"8ad08c0f7f9c7144017fab88cd2e27d7","createdDate":"2023-05-12T03:45:33.409Z","id":"79f9080f-0c3a-4b35-a587-eb1447e6e1cc","mSRP__c":60000,"updatedById":"8ad08c0f7f9c7144017fab88cd2e27d7","updatedDate":"2023-05-12T03:45:33.409Z","brand__c":"BMW","color__c":"blue","model__c":"Z4"}]},"id":"paths/~1object-query~1{custom-object-name}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1{custom-object-name}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1{custom-object-name}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1{custom-object-name}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1{custom-object-name}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1{custom-object-name}~1{key}/get/responses/200/content/application~1json/example":{"value":{"createdById":"8ad08c0f7f9c7144017fab88cd2e27d7","createdDate":"2023-05-12T03:44:40.733Z","id":"901e5409-e846-47cf-92af-05ccb0e0be96","mSRP__c":235600,"updatedById":"8ad08c0f7f9c7144017fab88cd2e27d7","updatedDate":"2023-05-12T06:21:41.551Z","brand__c":"Porsche","color__c":"red","model__c":"911"},"id":"paths/~1object-query~1{custom-object-name}~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1{custom-object-name}~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1{custom-object-name}~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1{custom-object-name}~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1{custom-object-name}~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1contact-snapshots/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sidmFsdWUiOiIyMDI0LTEyLTE2VDE3OjU1OjA1LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOWJlNDhkYjVhYmE3MDE4ZGI2MDQ3NzZkNDg1NCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=","data":[{"id":"8ad08eb292f6328c019318dcd43821b0","contactId":"8ad08eb292f6328c019318dcd45521b1","accountId":"8ad08eb292f6328c019318dcd4123456","firstName":"Bella","lastName":"Lawrence","workEmail":"bella.lawrence@example.com","mobilePhone":"+1-555-234-5678","country":"USA","state":"California","postalCode":"94103","address1":"123 Main St","address2":"Suite 200","city":"San Francisco","description":"Primary contact for billing","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2024-11-10T17:35:45-08:00","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-21T03:24:15-07:00"}]},"id":"paths/~1object-query~1contact-snapshots/get/responses/200/content/application~1json/example"},"paths/~1object-query~1contact-snapshots/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1contact-snapshots/get/responses/500/content/application~1json/example"},"paths/~1object-query~1contact-snapshots/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1contact-snapshots/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1contact-snapshots~1{key}/get/responses/200/content/application~1json/example":{"value":{"id":"8ad08eb292f6328c019318dcd43821b0","contactId":"8ad08eb292f6328c019318dcd45521b1","accountId":"8ad08eb292f6328c019318dcd4123456","firstName":"Bella","lastName":"Lawrence","workEmail":"bella.lawrence@example.com","mobilePhone":"+1-555-234-5678","country":"USA","state":"California","postalCode":"94103","address1":"123 Main St","address2":"Suite 200","city":"San Francisco","description":"Primary contact for billing","createdById":"2c92c0f972a852360172bbe22ac551b6","createdDate":"2024-11-10T17:35:45-08:00","updatedById":"2c92c0f972a852360172bbe22ac551b6","updatedDate":"2025-03-21T03:24:15-07:00"},"id":"paths/~1object-query~1contact-snapshots~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1contact-snapshots~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1contact-snapshots~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1contact-snapshots~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1contact-snapshots~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1rating-details/get/responses/200/content/application~1json/example":{"value":{"nextPage":"W3sib3JkZXJCeSI6eyJmaWVsZCI6IkNyZWF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19XQ==","data":[{"id":"rd-001","invoiceItemId":"ii-123","creditMemoItemId":null,"chargeType":"Usage","chargeModel":"FlatFee","formula":"UnitPrice * Quantity","calculation":"10 * 5","calculatedAmount":50,"currency":"USD","unitOfMeasure":"API Calls","quantity":5,"isProration":false,"isCredit":false,"amountWithoutTax":50}]},"id":"paths/~1object-query~1rating-details/get/responses/200/content/application~1json/example"},"paths/~1object-query~1rating-details/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rating-details/get/responses/500/content/application~1json/example"},"paths/~1object-query~1rating-details/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rating-details/get/responses/4XX/content/application~1json/example"},"paths/~1object-query~1rating-details~1{key}/get/responses/200/content/application~1json/example":{"value":{"id":"rd-001","invoiceItemId":"ii-123","creditMemoItemId":null,"chargeType":"Usage","chargeModel":"FlatFee","formula":"UnitPrice * Quantity","calculation":"10 * 5","calculatedAmount":50,"currency":"USD","unitOfMeasure":"API Calls","quantity":5,"isProration":false,"isCredit":false,"amountWithoutTax":50},"id":"paths/~1object-query~1rating-details~1{key}/get/responses/200/content/application~1json/example"},"paths/~1object-query~1rating-details~1{key}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rating-details~1{key}/get/responses/500/content/application~1json/example"},"paths/~1object-query~1rating-details~1{key}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000027,"message":"Invalid filter parameter: id"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2"},"id":"paths/~1object-query~1rating-details~1{key}/get/responses/4XX/content/application~1json/example"},"paths/~1v1~1accounting-codes/get/responses/200/content/application~1json/examples/response":{"value":{"accountingCodes":[{"category":"Assets","createdBy":"e20b074746ec48f40147140f51e30a1a","createdOn":"2014-07-29 02:20:20","glAccountName":null,"glAccountNumber":null,"id":"e20b0747478025a10147816ba1c20097","name":"Accounts Receivable","notes":null,"status":"Active","type":"AccountsReceivable","updatedBy":"e20b074746ec48f40147140f51e30a1a","updatedOn":"2014-07-29 02:20:20"},{"category":"Revenue","createdBy":"e20b074746ec48f40147140f51e30a1a","createdOn":"2014-07-29 02:20:20","glAccountName":null,"glAccountNumber":null,"id":"e20b0747478025a10147816ba21900a0","name":"Discounts","notes":null,"status":"Inactive","type":"SalesDiscounts","updatedBy":"e20b074746ec48f40147140f51e30a1a","updatedOn":"2014-09-27 22:11:07"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8a8081ae547aac1e01547efb61f20140","success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}/get/responses/200/content/application~1json/examples/response":{"value":{"category":"Assets","createdBy":"e20b074746ec48f40147140f51e30a1a","createdOn":"2016-05-04 01:23:07","glAccountName":null,"glAccountNumber":null,"id":"8a8081ae547aac1e01547efb61f20140","name":"CASH","notes":null,"status":"Active","success":true,"type":"Cash","updatedBy":"e20b074746ec48f40147140f51e30a1a","updatedOn":"2016-05-05 20:07:38"},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}~1activate/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-codes~1{ac-id}~1deactivate/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods/get/responses/200/content/application~1json/examples/response":{"value":{"accountingPeriods":[{"createdBy":"e20b074746ec48f40147140f51e30a1a","createdOn":"2016-03-16 23:17:25","endDate":"2016-03-31","fileIds":{"accountsReceivableAccountAgingDetailExportFileId":"8a8081ae5374904f01538340274a13f4","accountsReceivableInvoiceAgingDetailExportFileId":"8a8081ae5374904f01538340273013f3","arRollForwardDetailExportFileId":null,"fxRealizedGainAndLossDetailExportFileId":null,"fxUnrealizedGainAndLossDetailExportFileId":null,"revenueDetailCsvFileId":"8a8081ae5374904f0153834033221418","revenueDetailExcelFileId":"8a8081ae5374904f0153834032e41417","unprocessedChargesFileId":null},"fiscalYear":2016,"id":"8a8081ae5374904f01538338b66e1005","name":"Mar 2016","notes":"","runTrialBalanceEnd":null,"runTrialBalanceErrorMessage":"Error creating the trial balance: exchange rate from USD to GBP on 08/03/2015 is not available.  Please import the rate and run trial balance again.","runTrialBalanceStart":"2016-03-16 23:25:22","runTrialBalanceStatus":"Error","startDate":"2016-03-01","status":"Open","updatedBy":"e20b074746ec48f40147140f51e30a1a","updatedOn":"2016-03-16 23:25:22"},{"createdBy":"e20b074746ec48f40147140f51e30a1a","createdOn":"2016-03-16 23:17:50","endDate":"2016-04-30","fileIds":{"accountsReceivableAccountAgingDetailExportFileId":"8a8081ae5374904f0153833e9a7a1364","accountsReceivableInvoiceAgingDetailExportFileId":"8a8081ae5374904f0153833e9a651363","arRollForwardDetailExportFileId":null,"fxRealizedGainAndLossDetailExportFileId":null,"fxUnrealizedGainAndLossDetailExportFileId":null,"revenueDetailCsvFileId":"8a8081ae5374904f0153833ea2d613af","revenueDetailExcelFileId":"8a8081ae5374904f0153833ea2c813ae","unprocessedChargesFileId":null},"fiscalYear":2016,"id":"8a8081ae5374904f0153833918af1007","name":"Apr 2016","notes":"","runTrialBalanceEnd":null,"runTrialBalanceErrorMessage":null,"runTrialBalanceStart":"2016-03-16 23:23:40","runTrialBalanceStatus":"Error","startDate":"2016-04-01","status":"Open","updatedBy":"e20b074746ec48f40147140f51e30a1a","updatedOn":"2016-03-16 23:23:40"},{"createdBy":"e20b074746ec48f40147140f51e30a1a","createdOn":"2016-03-16 23:23:29","endDate":"2016-05-31","fileIds":{"accountsReceivableAccountAgingDetailExportFileId":null,"accountsReceivableInvoiceAgingDetailExportFileId":null,"arRollForwardDetailExportFileId":null,"fxRealizedGainAndLossDetailExportFileId":null,"fxUnrealizedGainAndLossDetailExportFileId":null,"revenueDetailCsvFileId":"8a8081ae54c2eabb0154c307e2920034","revenueDetailExcelFileId":"8a8081ae54c2eabb0154c307e27e0033","unprocessedChargesFileId":null},"fiscalYear":2016,"id":"8a8081ae5374904f0153833e4590132d","name":"May 2016","notes":"","runTrialBalanceEnd":null,"runTrialBalanceErrorMessage":null,"runTrialBalanceStart":"2016-05-18 01:42:30","runTrialBalanceStatus":"Error","startDate":"2016-05-01","status":"Open","updatedBy":"e20b074746ec48f40147140f51e30a1a","updatedOn":"2016-05-18 01:42:30"},{"createdBy":"402881e522cf4f9b0122cf5d82860002","createdOn":"2014-07-28 23:52:46","endDate":null,"fileIds":{"accountsReceivableAccountAgingDetailExportFileId":null,"accountsReceivableInvoiceAgingDetailExportFileId":null,"arRollForwardDetailExportFileId":null,"fxRealizedGainAndLossDetailExportFileId":null,"fxUnrealizedGainAndLossDetailExportFileId":null,"revenueDetailCsvFileId":null,"revenueDetailExcelFileId":null,"unprocessedChargesFileId":null},"fiscalYear":0,"id":"e20b0747478025a1014780e489a60002","name":"Open-Ended","notes":null,"runTrialBalanceEnd":null,"runTrialBalanceErrorMessage":null,"runTrialBalanceStart":null,"runTrialBalanceStatus":"Pending","startDate":"2016-06-01","status":"Open","updatedBy":"e20b074746ec48f40147140f51e30a1a","updatedOn":"2016-03-16 23:23:29"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods/post/responses/200/content/application~1json/examples/response":{"value":{"id":"7b7181ae547aac1e01547efb61f20162","success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}/get/responses/200/content/application~1json/examples/response":{"value":{"createdBy":"e20b074746ec48f40147140f51e30a1a","createdOn":"2014-11-25 22:21:22","endDate":"2014-10-31","fileIds":{"accountsReceivableAccountAgingDetailExportFileId":"8a8081ae5002967c015012f1230e0914","accountsReceivableInvoiceAgingDetailExportFileId":"8a8081ae5002967c015012f122f10913","accountsReceivableDebitMemoAgingDetailExportFileId":"8a8081ae5002967c015012f122f40913","arRollForwardDetailExportFileId":"8a8081ae5002967c015012f15d7b09e2","fxRealizedGainAndLossDetailExportFileId":"8a8081ae5002967c015012f151a609ba","fxUnrealizedGainAndLossDetailExportFileId":"8a8081ae5002967c015012f150b509b8","revenueDetailCsvFileId":"8a8081ae5002967c015012f129a10926","revenueDetailExcelFileId":"8a8081ae5002967c015012f129870925","unprocessedChargesFileId":null},"fiscalYear":2014,"id":"e20b074749d2a38b0149eac2e9550aa9","name":"Oct 2014","notes":"","runTrialBalanceEnd":"2015-09-28 00:53:36","runTrialBalanceErrorMessage":null,"runTrialBalanceStart":"2015-09-28 00:53:13","runTrialBalanceStatus":"Completed","startDate":"2014-10-01","status":"Closed","success":true,"updatedBy":"e20b074746ec48f40147140f51e30a1a","updatedOn":"2015-09-28 00:53:13"},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1close/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1pending-close/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1reopen/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1accounting-periods~1{ap-id}~1run-trial-balance/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1journal-entries/post/responses/200/content/application~1json/examples/response":{"value":{"journalEntryNumber":"JE-00000001","success":true},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1journal-entries/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1journal-entries/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response":{"value":{"journalEntries":[{"accountingPeriodName":"Dec'16","aggregateCurrency":true,"currency":"USD","homeCurrency":"USD","journalEntryDate":"2016-12-31","journalEntryItems":[{"accountingCodeName":"Accounts Receivable","accountingCodeType":"AccountsReceivable","amount":100,"glAccountName":"Accounts Receivable","glAccountNumber":"10-001-000-1234","homeCurrencyAmount":100,"type":"Debit"},{"accountingCodeName":"Sales Revenue","accountingCodeType":"SalesRevenue","amount":100,"glAccountName":"Sales Revenue","glAccountNumber":"10-001-000-1000","homeCurrencyAmount":100,"type":"Credit"}],"notes":"note","number":"JE-00000006","segments":[{"segmentName":"Seg1","segmentValue":"seg value"}],"status":"Created","timePeriodEnd":"2016-12-31","timePeriodStart":"2016-12-01","transactionType":"Invoice Item","transferredToAccounting":"No"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}/get/responses/200/content/application~1json/examples/response":{"value":{"accountingPeriodName":"Jan'16","aggregateCurrency":true,"currency":"USD","homeCurrency":"USD","journalEntryDate":"2016-01-31","journalEntryItems":[{"accountingCodeName":"Deferred Revenue","accountingCodeType":"DeferredRevenue","amount":424.08,"glAccountName":null,"glAccountNumber":null,"homeCurrencyAmount":424.08,"type":"Debit"},{"accountingCodeName":"Professional Services Revenue","accountingCodeType":"SalesRevenue","amount":424.08,"glAccountName":null,"glAccountNumber":null,"homeCurrencyAmount":424.08,"type":"Credit"}],"notes":null,"number":"JE-00000001","segments":[{"segmentName":"Customer Code","segmentValue":"A00000001"},{"segmentName":"Charge Type","segmentValue":"OneTime"}],"status":"Created","success":true,"timePeriodEnd":"2016-01-31","timePeriodStart":"2016-01-01","transactionType":"Revenue Event Item","transferDateTime":null,"transferredBy":null,"transferredToAccounting":null},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}~1basic-information/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1journal-entries~1{je-number}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1journal-runs/post/responses/200/content/application~1json/examples/response":{"value":{"journalRunNumber":"JR-00000008","success":true},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1journal-runs/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1journal-runs/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1journal-runs~1{jr-number}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs~1{jr-number}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1journal-runs~1{jr-number}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs~1{jr-number}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1journal-runs~1{jr-number}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs~1{jr-number}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response":{"value":{"executedOn":"2014-11-15 22:05:12","journalEntryDate":"2016-02-02","number":"JR-00000002","segmentationRuleName":"s1","status":"Completed","success":true,"targetEndDate":"2016-03-31","targetStartDate":"2016-03-01","totalJournalEntryCount":2,"transactionTypes":[{"type":"Invoice Item"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs~1{jr-number}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs~1{jr-number}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs~1{jr-number}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1journal-runs~1{jr-number}~1cancel/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1bulk/post/responses/200/content/application~1json/examples/response":{"value":{"bulkKey":"402892f04c97b89a014c97bb30a50003","success":true},"key":"response","summary":"response","id":"paths/~1v1~1bulk/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1bulk/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1bulk/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1bulk/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1bulk/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1bulk~1{bulk-key}/get/responses/200/content/application~1json/examples/response":{"value":{"actionType":"UpdateAccountingCode","endedOn":"2015-04-07 14:32:01","errorCount":1,"inputSize":354,"outputSize":350,"outputType":"(url:.csv.zip)","outputURL":"https://rest.zuora.com/v1/files/402892c84c9285b1014c9293f5320007","processedCount":3,"startedOn":"2015-04-07 14:22:11","status":"Completed","success":true,"successCount":2,"totalCount":3,"uploadedBy":"smith@example.com","uploadedOn":"2015-04-07 14:22:09"},"key":"response","summary":"response","id":"paths/~1v1~1bulk~1{bulk-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1bulk~1{bulk-key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1bulk~1{bulk-key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1bulk~1{bulk-key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1bulk~1{bulk-key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1bulk~1{bulk-key}~1stop/put/responses/4XX/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition":{"value":{"name":"Account Edit Notification","eventTypeName":"AccountEdit","emailActive":true,"emailTemplateId":"f11e498862584a10a05b83ea70119659","communicationProfileId":"2c92c0f9446cd49501447539d6a72815"},"key":"Create a notification definition","summary":"Create a notification definition","id":"paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition"},"paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition with filter rules":{"value":{"name":"Account Edit Notification","eventTypeName":"AccountEdit","emailActive":true,"emailTemplateId":"f11e498862584a10a05b83ea70119659","communicationProfileId":"2c92c0f9446cd49501447539d6a72815","filterRule":{"condition":"Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS","description":"Filter rule to test if an account is a VIP account","parameters":{"_ACCOUNT_STATUS":{"description":"The status of the VIP Account","displayName":"VIP Account Status","options":["Draft","Active","Canceled"],"valueType":"STRING"},"_VIP_BALANCE_AMOUNT":{"description":"The minimum account balance","displayName":"VIP Account Balance","options":null,"valueType":"BIG_DECIMAL"}}},"filterRuleParams":{"_ACCOUNT_STATUS":"Active","_VIP_BALANCE_AMOUNT":"100000.0"}},"key":"Create a notification definition with filter rules","summary":"Create a notification definition with filter rules","id":"paths/~1notifications~1notification-definitions/post/requestBody/content/application~1json/examples/Create a notification definition with filter rules"},"paths/~1notifications~1notification-definitions/post/responses/400/content/application~1json/examples/response":{"value":"{\n  \"code\":\"ConstraintViolated\",\n  \"message\":\"The email template is defined on a different EventType other than the notification's\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions/post/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions/post/responses/404/content/application~1json/examples/response":{"value":"{\n  \"code\":\"404\",\n  \"message\":\"HTTP 404 Not Found\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions/post/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions/post/responses/405/content/application~1json/examples/response":{"value":"{\n  \"code\":\"405\",\n  \"message\":\"HTTP 405 Method Not Allowed\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions/post/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions/post/responses/415/content/application~1json/examples/response":{"value":"{\n  \"code\":\"415\",\n  \"message\":\"HTTP 415 Unsupported Media Type\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions/post/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions/post/responses/500/content/application~1json/examples/response":{"value":"{\n  \"code\":\"500\",\n  \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions/post/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions/get/responses/404/content/application~1json/examples/response":{"value":"{\n  \"code\":\"404\",\n  \"message\":\"HTTP 404 Not Found\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions/get/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions/get/responses/405/content/application~1json/examples/response":{"value":"{\n  \"code\":\"405\",\n  \"message\":\"HTTP 405 Method Not Allowed\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions/get/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions/get/responses/415/content/application~1json/examples/response":{"value":"{\n  \"code\":\"415\",\n  \"message\":\"HTTP 415 Unsupported Media Type\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions/get/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions/get/responses/500/content/application~1json/examples/response":{"value":"{\n  \"code\":\"500\",\n  \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions/get/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/get/responses/404/content/application~1json/examples/response":{"value":"{\n  \"code\":\"404\",\n  \"message\":\"HTTP 404 Not Found\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/get/responses/405/content/application~1json/examples/response":{"value":"{\n  \"code\":\"405\",\n  \"message\":\"HTTP 405 Method Not Allowed\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/get/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/get/responses/415/content/application~1json/examples/response":{"value":"{\n  \"code\":\"415\",\n  \"message\":\"HTTP 415 Unsupported Media Type\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/get/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/get/responses/500/content/application~1json/examples/response":{"value":"{\n  \"code\":\"500\",\n  \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/get/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/put/responses/400/content/application~1json/examples/response":{"value":"{\n  \"code\":\"ConstraintViolated\",\n  \"message\":\"The email template is defined on a different EventType other than the notification's\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/put/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/put/responses/404/content/application~1json/examples/response":{"value":"{\n  \"code\":\"404\",\n  \"message\":\"HTTP 404 Not Found\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/put/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/put/responses/405/content/application~1json/examples/response":{"value":"{\n  \"code\":\"405\",\n  \"message\":\"HTTP 405 Method Not Allowed\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/put/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/put/responses/415/content/application~1json/examples/response":{"value":"{\n  \"code\":\"415\",\n  \"message\":\"HTTP 415 Unsupported Media Type\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/put/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/put/responses/500/content/application~1json/examples/response":{"value":"{\n  \"code\":\"500\",\n  \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/put/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/delete/responses/400/content/application~1json/examples/response":{"value":"{\n  \"code\":\"ObjectNotFound\",\n  \"message\":\"The notification definition with id 6e569e1e05f040eda51a927b140c0ac2 does not exist\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/delete/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/delete/responses/404/content/application~1json/examples/response":{"value":"{\n  \"code\":\"404\",\n  \"message\":\"HTTP 404 Not Found\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/delete/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/delete/responses/405/content/application~1json/examples/response":{"value":"{\n  \"code\":\"405\",\n  \"message\":\"HTTP 405 Method Not Allowed\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/delete/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/delete/responses/415/content/application~1json/examples/response":{"value":"{\n  \"code\":\"415\",\n  \"message\":\"HTTP 415 Unsupported Media Type\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/delete/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1notification-definitions~1{id}/delete/responses/500/content/application~1json/examples/response":{"value":"{\n  \"code\":\"500\",\n  \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1notification-definitions~1{id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Create an email template":{"value":{"allowPartialSuccess":true,"emailTemplates":[{"active":true,"name":"Account Edit Email","eventTypeName":"AccountEdit","description":"Details of the email template","fromName":"Company Co. Ltd.","fromEmailType":"TenantEmail","toEmailType":"BillToContact","replyToEmailType":"TenantEmail","emailSubject":"Account {{DataSource.Account.AccountNumber}} has been edited","emailBody":"Dear user,<p>the account {{DataSource.Account.AccountNumber}} has been edited. <p>Company Co. Ltd."}]},"key":"Create an email template","summary":"Create an email template","id":"paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Create an email template"},"paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Update an email template":{"value":{"allowPartialSuccess":true,"emailTemplates":[{"id":"f11e498862584a10a05b83ea70119659","name":"Account Edit Email","eventTypeName":"AccountEdit","description":"Details of the email template","fromName":"Company Co. Ltd.","fromEmailType":"TenantEmail","toEmailType":"BillToContact","replyToEmailType":"TenantEmail","emailSubject":"Account {{DataSource.Account.AccountNumber}} has been edited","emailBody":"Dear user,<p>the account {{DataSource.Account.AccountNumber}} has been edited. <p>Company Co. Ltd."}]},"key":"Update an email template","summary":"Update an email template","id":"paths/~1notifications~1email-templates~1import/post/requestBody/content/application~1json/examples/Update an email template"},"paths/~1notifications~1email-templates/post/responses/400/content/application~1json/examples/response":{"value":"{\n  \"code\":\"ObjectNotFound\",\n  \"message\":\"eventType {com.zuora.notification, AccountEdit} does not exist\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates/post/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1email-templates/post/responses/404/content/application~1json/examples/response":{"value":"{\n  \"code\":\"404\",\n  \"message\":\"HTTP 404 Not Found\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates/post/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1email-templates/post/responses/405/content/application~1json/examples/response":{"value":"{\n  \"code\":\"405\",\n  \"message\":\"HTTP 405 Method Not Allowed\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates/post/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1email-templates/post/responses/415/content/application~1json/examples/response":{"value":"{\n  \"code\":\"415\",\n  \"message\":\"HTTP 415 Unsupported Media Type\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates/post/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1email-templates/post/responses/500/content/application~1json/examples/response":{"value":"{\n  \"code\":\"500\",\n  \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates/post/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1email-templates/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"active":true,"bccEmailAddress":"user@example.com","ccEmailAddress":"user@example.com","ccEmailType":"SpecificEmails","createdBy":"6e569e1e05f040eda51a927b140c0ac3","createdOn":"2017-04-18T07:36:19.798Z","description":"Email when an account is edited","emailBody":"Dear user,<p>the account <Account.Name> has been edited. </p><p>Example Co. Ltd.</p>","emailHeaders":{"My-Header-1":"Header value 1","My-Header-2":"Header value 2"},"emailSubject":"Account <Account.Number> has been edited","encodingType":"UTF8","eventTypeName":"AccountEdit","fromEmailType":"TenantEmail","fromName":"Example Co. Ltd.","id":"6e569e1e05f040eda51a927b140c0ac2","isHtml":true,"name":"Account Edit Email","replyToEmailType":"TenantEmail","toEmailAddress":"DummyEmailAddress@example.com","toEmailType":"SpecificEmails","updatedBy":"6e569e1e05f040eda51a927b140c0ac4","updatedOn":"2017-04-18T07:36:19.798Z"},{"active":true,"bccEmailAddress":"user@example.com","ccEmailAddress":"user@example.com","ccEmailType":"SpecificEmails","createdBy":"6e569e1e05f040eda51a927b140c0ac3","createdOn":"2017-04-18T07:37:20.798Z","description":"Email when an invoice is posted","emailBody":"Dear user,<p>the invoice <Invoice.Number> has been posted. </p><p>Example Co. Ltd.</p>","emailHeaders":{"My-Header-1":"Header value 1","My-Header-2":"Header value 2"},"emailSubject":"Invoice <Invoice.Number> has been posted","encodingType":"UTF8","eventCategory":1110,"fromEmailAddress":"EmailAddress1@example.com","fromEmailType":"SpecificEmail","fromName":"Example Co. Ltd.","id":"6e569e1e05f040eda51a927b70e31f4e","isHtml":true,"name":"Invoice Posted Email","replyToEmailType":"TenantEmail","toEmailType":"BillToContact","updatedBy":"6e569e1e05f040eda51a927b140c0ac4","updatedOn":"2017-04-18T07:37:20.798Z"}],"next":"/notification-definitions?start=1&limit=10"},"key":"response","summary":"response","id":"paths/~1notifications~1email-templates/get/responses/200/content/application~1json/examples/response"},"paths/~1notifications~1email-templates/get/responses/404/content/application~1json/examples/response":{"value":"{\n  \"code\":\"404\",\n  \"message\":\"HTTP 404 Not Found\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates/get/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1email-templates/get/responses/405/content/application~1json/examples/response":{"value":"{\n  \"code\":\"405\",\n  \"message\":\"HTTP 405 Method Not Allowed\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates/get/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1email-templates/get/responses/415/content/application~1json/examples/response":{"value":"{\n  \"code\":\"415\",\n  \"message\":\"HTTP 415 Unsupported Media Type\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates/get/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1email-templates/get/responses/500/content/application~1json/examples/response":{"value":"{\n  \"code\":\"500\",\n  \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates/get/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"active":true,"bccEmailAddress":"user@example.com","ccEmailAddress":"user@example.com","ccEmailType":"SpecificEmails","createdBy":"6e569e1e05f040eda51a927b140c0ac3","createdOn":"2017-04-18T07:36:19.798Z","description":"Email when an account is edited","emailBody":"Dear user,<p>the account <Account.Name> has been edited. </p><p>Example Co. Ltd.</p>","emailHeaders":{"My-Header-1":"Header value 1","My-Header-2":"Header value 2"},"emailSubject":"Account <Account.Number> has been edited","encodingType":"UTF8","eventTypeName":"AccountEdit","fromEmailType":"TenantEmail","fromName":"Example Co. Ltd.","id":"6e569e1e05f040eda51a927b140c0ac2","isHtml":true,"name":"Account Edit Email","replyToEmailType":"TenantEmail","toEmailAddress":"DummyEmailAddress@example.com","toEmailType":"SpecificEmails","updatedBy":"6e569e1e05f040eda51a927b140c0ac4","updatedOn":"2017-04-18T07:36:19.798Z"},"key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/get/responses/400/content/application~1json/examples/response":{"value":"{\n  \"code\":\"ObjectNotFound\",\n  \"message\":\"The email template with id 6e569e1e05f040eda51a927b140c0ac2 does not exist in this tenant\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/get/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/get/responses/404/content/application~1json/examples/response":{"value":"{\n  \"code\":\"404\",\n  \"message\":\"HTTP 404 Not Found\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/get/responses/405/content/application~1json/examples/response":{"value":"{\n  \"code\":\"405\",\n  \"message\":\"HTTP 405 Method Not Allowed\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/get/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/get/responses/415/content/application~1json/examples/response":{"value":"{\n  \"code\":\"415\",\n  \"message\":\"HTTP 415 Unsupported Media Type\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/get/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/get/responses/500/content/application~1json/examples/response":{"value":"{\n  \"code\":\"500\",\n  \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/get/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/put/responses/400/content/application~1json/examples/response":{"value":"{\n  \"code\":\"ObjectNotFound\",\n  \"message\":\"eventType {com.zuora.notification, AccountEdit} does not exist\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/put/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/put/responses/404/content/application~1json/examples/response":{"value":"{\n  \"code\":\"404\",\n  \"message\":\"HTTP 404 Not Found\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/put/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/put/responses/405/content/application~1json/examples/response":{"value":"{\n  \"code\":\"405\",\n  \"message\":\"HTTP 405 Method Not Allowed\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/put/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/put/responses/415/content/application~1json/examples/response":{"value":"{\n  \"code\":\"415\",\n  \"message\":\"HTTP 415 Unsupported Media Type\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/put/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/put/responses/500/content/application~1json/examples/response":{"value":"{\n  \"code\":\"500\",\n  \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/put/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/delete/responses/400/content/application~1json/examples/response":{"value":"{\n  \"code\":\"ObjectNotFound\",\n  \"message\":\"The email template with id 6e569e1e05f040eda51a927b140c0ac2 does not exist in this tenant\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/delete/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/delete/responses/404/content/application~1json/examples/response":{"value":"{\n  \"code\":\"404\",\n  \"message\":\"HTTP 404 Not Found\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/delete/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/delete/responses/405/content/application~1json/examples/response":{"value":"{\n  \"code\":\"405\",\n  \"message\":\"HTTP 405 Method Not Allowed\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/delete/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/delete/responses/415/content/application~1json/examples/response":{"value":"{\n  \"code\":\"415\",\n  \"message\":\"HTTP 415 Unsupported Media Type\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/delete/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1email-templates~1{id}/delete/responses/500/content/application~1json/examples/response":{"value":"{\n  \"code\":\"500\",\n  \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1email-templates~1{id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Without authentication":{"value":{"name":"Account Edit","eventTypeName":"AccountEdit","calloutBaseurl":"https://www.example.com/callout/AccountEdit","httpMethod":"POST"},"key":"Callout - Without authentication","summary":"Callout - Without authentication","id":"paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Without authentication"},"paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Base authentication":{"value":{"name":"Account Edit","eventTypeName":"AccountEdit","calloutBaseurl":"https://www.example.com/callout/AccountEdit","httpMethod":"POST","requiredAuth":true,"calloutAuth":{"username":"name","password":"pw123"}},"key":"Callout - Base authentication","summary":"Callout - Base authentication","id":"paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - Base authentication"},"paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication":{"value":{"name":"Account Edit","eventTypeName":"AccountEdit","calloutBaseurl":"https://www.example.com/callout/AccountEdit","httpMethod":"POST","requiredOauth2":true,"oauth2ProviderId":"8ad099a98b94d51e018ba3beb9ed6c29"},"key":"Callout - OAuth 2.0 authentication","summary":"Callout - OAuth 2.0 authentication","id":"paths/~1notifications~1callout-templates/post/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"},"paths/~1notifications~1callout-templates/post/responses/200/content/application~1json/examples/response":{"value":{"id":"dcc5a61ee76e496c984206131b5b83e7","createdBy":"8a90e08282f4ed040182f67bab2902ff","createdOn":"2024-06-17T04:07:13.000 UTC","updatedBy":"8a90e08282f4ed040182f67bab2902ff","updatedOn":"2024-06-17T04:07:13.000 UTC","eventTypeName":"AccountEdit","eventTypeNamespace":"user.notification","name":"Account Edit","description":"Callout when an account is edited","active":true,"calloutBaseurl":"https://www.example.com/callout/AccountEdit","calloutParams":null,"calloutHeaders":null,"httpMethod":"POST","requiredAuth":false,"calloutAuth":null,"requiredOauth2":false,"oauth2ProviderId":null,"calloutRetry":true,"contentType":"APPLICATION_JSON","useCustomRequestBody":false,"customRequestBody":null,"certificate":null,"hmacKey":null,"hmacValue":null,"hmacData":null,"hmacAlgorithm":null,"hmacSecret":null,"hmacOutputFormat":null,"confirmSuccessFromResponseContent":false},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/post/responses/200/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/post/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ObjectNotFound","message":"eventType {com.zuora.notification, AccountEdit} does not exist"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/post/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/post/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"404","message":"HTTP 404 Not Found"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/post/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/post/responses/405/content/application~1json/examples/response":{"value":{"reasons":[{"code":"405","message":"HTTP 405 Method Not Allowed"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/post/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/post/responses/415/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"HTTP 415 Unsupported Media Type"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/post/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"A temporary problem in the service occurred, you can retry later."}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/post/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"id":"dcc5a61ee76e496c984206131b5b83e7","createdBy":"8a90e08282f4ed040182f67bab2902ff","createdOn":"2024-06-17T04:07:13.000 UTC","updatedBy":"8a90e08282f4ed040182f67bab2902ff","updatedOn":"2024-06-17T04:07:13.000 UTC","eventTypeName":"AccountEdit","eventTypeNamespace":"user.notification","name":"Account Edit","description":"Callout when an account is edited","active":true,"calloutBaseurl":"https://www.example.com/callout/AccountEdit","calloutParams":null,"calloutHeaders":null,"httpMethod":"POST","requiredAuth":false,"calloutAuth":null,"requiredOauth2":false,"oauth2ProviderId":null,"calloutRetry":true,"contentType":"APPLICATION_JSON","useCustomRequestBody":false,"customRequestBody":null,"certificate":null,"hmacKey":null,"hmacValue":null,"hmacData":null,"hmacAlgorithm":null,"hmacSecret":null,"hmacOutputFormat":null,"confirmSuccessFromResponseContent":false},{"id":"a745b9dd39154591b6cc618465aeb133","createdBy":"8a90e08282f4ed040182f67bab2902ff","createdOn":"2024-06-17T04:09:03.000 UTC","updatedBy":"8a90e08282f4ed040182f67bab2902ff","updatedOn":"2024-06-17T04:09:03.000 UTC","eventTypeName":"AccountDelete","eventTypeNamespace":"user.notification","name":"Account Delete","description":"Callout when an account is deleted","active":true,"calloutBaseurl":"https://www.example.com/callout/AccountDelete","calloutParams":null,"calloutHeaders":null,"httpMethod":"POST","requiredAuth":false,"calloutAuth":null,"requiredOauth2":false,"oauth2ProviderId":null,"calloutRetry":true,"contentType":"APPLICATION_JSON","useCustomRequestBody":false,"customRequestBody":null,"certificate":null,"hmacKey":null,"hmacValue":null,"hmacData":null,"hmacAlgorithm":null,"hmacSecret":null,"hmacOutputFormat":null,"confirmSuccessFromResponseContent":false}],"next":"/notifications/callout-templates?start=21&limit=20"},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/get/responses/200/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/get/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ObjectNotFound","message":"eventType {com.zuora.notification, AccountEdit} does not exist"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/get/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/get/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"404","message":"HTTP 404 Not Found"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/get/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/get/responses/405/content/application~1json/examples/response":{"value":{"reasons":[{"code":"405","message":"HTTP 405 Method Not Allowed"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/get/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/get/responses/415/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"HTTP 415 Unsupported Media Type"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/get/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"A temporary problem in the service occurred, you can retry later."}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates/get/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"dcc5a61ee76e496c984206131b5b83e7","createdBy":"8a90e08282f4ed040182f67bab2902ff","createdOn":"2024-06-17T04:07:13.000 UTC","updatedBy":"8a90e08282f4ed040182f67bab2902ff","updatedOn":"2024-06-17T04:07:13.000 UTC","eventTypeName":"AccountEdit","eventTypeNamespace":"user.notification","name":"Account Edit","description":"Callout when an account is edited","active":true,"calloutBaseurl":"https://www.example.com/callout/AccountEdit","calloutParams":null,"calloutHeaders":null,"httpMethod":"POST","requiredAuth":false,"calloutAuth":null,"requiredOauth2":false,"oauth2ProviderId":null,"calloutRetry":true,"contentType":"APPLICATION_JSON","useCustomRequestBody":false,"customRequestBody":null,"certificate":null,"hmacKey":null,"hmacValue":null,"hmacData":null,"hmacAlgorithm":null,"hmacSecret":null,"hmacOutputFormat":null,"confirmSuccessFromResponseContent":false},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/get/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ObjectNotFound","message":"eventType {com.zuora.notification, AccountEdit} does not exist"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/get/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"404","message":"HTTP 404 Not Found"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/get/responses/405/content/application~1json/examples/response":{"value":{"reasons":[{"code":"405","message":"HTTP 405 Method Not Allowed"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/get/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/get/responses/415/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"HTTP 415 Unsupported Media Type"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/get/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"A temporary problem in the service occurred, you can retry later."}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/get/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Without authentication":{"value":{"name":"Account Edit","calloutBaseurl":"https://www.example.com/callout/AccountEdit","httpMethod":"POST"},"key":"Callout - Without authentication","summary":"Callout - Without authentication","id":"paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Without authentication"},"paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Base authentication":{"value":{"name":"Account Edit","calloutBaseurl":"https://www.example.com/callout/AccountEdit","httpMethod":"POST","requiredAuth":true,"calloutAuth":{"username":"name","password":"pw123"}},"key":"Callout - Base authentication","summary":"Callout - Base authentication","id":"paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - Base authentication"},"paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication":{"value":{"name":"Account Edit","calloutBaseurl":"https://www.example.com/callout/AccountEdit","httpMethod":"POST","requiredOauth2":true,"oauth2ProviderId":"8ad099a98b94d51e018ba3beb9ed6c29"},"key":"Callout - OAuth 2.0 authentication","summary":"Callout - OAuth 2.0 authentication","id":"paths/~1notifications~1callout-templates~1{id}/put/requestBody/content/application~1json/examples/Callout - OAuth 2.0 authentication"},"paths/~1notifications~1callout-templates~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"id":"dcc5a61ee76e496c984206131b5b83e7","createdBy":"8a90e08282f4ed040182f67bab2902ff","createdOn":"2024-06-17T04:07:13.000 UTC","updatedBy":"8a90e08282f4ed040182f67bab2902ff","updatedOn":"2024-06-17T04:07:13.000 UTC","eventTypeName":"AccountEdit","eventTypeNamespace":"user.notification","name":"Account Edit","description":"Callout when an account is edited","active":true,"calloutBaseurl":"https://www.example.com/callout/AccountEdit","calloutParams":null,"calloutHeaders":null,"httpMethod":"POST","requiredAuth":false,"calloutAuth":null,"requiredOauth2":false,"oauth2ProviderId":null,"calloutRetry":true,"contentType":"APPLICATION_JSON","useCustomRequestBody":false,"customRequestBody":null,"certificate":null,"hmacKey":null,"hmacValue":null,"hmacData":null,"hmacAlgorithm":null,"hmacSecret":null,"hmacOutputFormat":null,"confirmSuccessFromResponseContent":false},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/put/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ObjectNotFound","message":"eventType {com.zuora.notification, AccountEdit} does not exist"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/put/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/put/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"404","message":"HTTP 404 Not Found"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/put/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/put/responses/405/content/application~1json/examples/response":{"value":{"reasons":[{"code":"405","message":"HTTP 405 Method Not Allowed"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/put/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/put/responses/415/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"HTTP 415 Unsupported Media Type"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/put/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"A temporary problem in the service occurred, you can retry later."}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/put/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/delete/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ObjectNotFound","message":"eventType {com.zuora.notification, AccountEdit} does not exist"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/delete/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/delete/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"404","message":"HTTP 404 Not Found"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/delete/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/delete/responses/405/content/application~1json/examples/response":{"value":{"reasons":[{"code":"405","message":"HTTP 405 Method Not Allowed"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/delete/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/delete/responses/415/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"HTTP 415 Unsupported Media Type"}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/delete/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1callout-templates~1{id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"A temporary problem in the service occurred, you can retry later."}]},"key":"response","summary":"response","id":"paths/~1notifications~1callout-templates~1{id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Create a reusable block":{"value":{"allowPartialSuccess":true,"reusableBlocks":[{"name":"Footer Block","category":"Footers","content":"(The content of the block)"}]},"key":"Create a reusable block","summary":"Create a reusable block","id":"paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Create a reusable block"},"paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Update a reusable block":{"value":{"allowPartialSuccess":true,"reusableBlocks":[{"id":"385bcf09b2aa4a628098a88f62552180","active":true,"name":"Header Block","number":"RB-00000010","category":"Headers","tags":["logo"],"content":"(The content of the block)"}]},"key":"Update a reusable block","summary":"Update a reusable block","id":"paths/~1notifications~1reusable-blocks~1import/post/requestBody/content/application~1json/examples/Update a reusable block"},"paths/~1notifications~1reusable-blocks/post/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ObjectNotFound","message":"eventType {com.zuora.notification, AccountEdit} does not exist"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/post/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks/post/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"404","message":"HTTP 404 Not Found"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/post/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks/post/responses/405/content/application~1json/examples/response":{"value":{"reasons":[{"code":"405","message":"HTTP 405 Method Not Allowed"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/post/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks/post/responses/415/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"HTTP 415 Unsupported Media Type"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/post/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"500","message":"A temporary problem in the service occurred, you can retry later."}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/post/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks/get/responses/200/content/application~1json/examples/response":{"value":{"next":"/notifications/reusable-blocks?start=21&limit=20","data":[{"id":"c6af751e4a0041eebb000c51e95e6c2d","createdBy":"8a90e08282f4ed040182f67bab2902ff","createdOn":"2025-04-22T08:17:24.000 UTC","updatedBy":"8a90e08282f4ed040182f67bab2902ff","updatedOn":"2025-04-22T08:17:24.000 UTC","active":true,"name":"Header Block","number":"RB-00000010","category":"Headers","tags":[],"content":"(The content of the block)"},{"id":"385bcf09b2aa4a628098a88f62552180","createdBy":"8a90e08282f4ed040182f67bab2902ff","createdOn":"2025-04-17T03:36:39.000 UTC","updatedBy":"8a90e08282f4ed040182f67bab2902ff","updatedOn":"2025-04-22T08:55:07.000 UTC","active":true,"name":"Footer Block","number":"RB-00000009","category":"Footers","tags":[],"content":"(The content of the block)"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/get/responses/200/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks/get/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ObjectNotFound","message":"eventType {com.zuora.notification, AccountEdit} does not exist"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/get/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks/get/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"404","message":"HTTP 404 Not Found"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/get/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks/get/responses/405/content/application~1json/examples/response":{"value":{"reasons":[{"code":"405","message":"HTTP 405 Method Not Allowed"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/get/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks/get/responses/415/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"HTTP 415 Unsupported Media Type"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/get/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"500","message":"A temporary problem in the service occurred, you can retry later."}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks/get/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"c6af751e4a0041eebb000c51e95e6c2d","createdBy":"8a90e08282f4ed040182f67bab2902ff","createdOn":"2025-04-22T08:17:24.000 UTC","updatedBy":"8a90e08282f4ed040182f67bab2902ff","updatedOn":"2025-04-22T08:17:24.000 UTC","active":true,"name":"Header Block","number":"RB-00000010","category":"Headers","tags":[],"content":"(The content of the block)"},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/200/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ObjectNotFound","message":"eventType {com.zuora.notification, AccountEdit} does not exist"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"404","message":"HTTP 404 Not Found"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/405/content/application~1json/examples/response":{"value":{"reasons":[{"code":"405","message":"HTTP 405 Method Not Allowed"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/415/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"HTTP 415 Unsupported Media Type"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"500","message":"A temporary problem in the service occurred, you can retry later."}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/get/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ObjectNotFound","message":"eventType {com.zuora.notification, AccountEdit} does not exist"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"404","message":"HTTP 404 Not Found"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/405/content/application~1json/examples/response":{"value":{"reasons":[{"code":"405","message":"HTTP 405 Method Not Allowed"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/415/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"HTTP 415 Unsupported Media Type"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"500","message":"A temporary problem in the service occurred, you can retry later."}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/put/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ObjectNotFound","message":"eventType {com.zuora.notification, AccountEdit} does not exist"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"404","message":"HTTP 404 Not Found"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/405/content/application~1json/examples/response":{"value":{"reasons":[{"code":"405","message":"HTTP 405 Method Not Allowed"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/405/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/415/content/application~1json/examples/response":{"value":{"reasons":[{"code":"415","message":"HTTP 415 Unsupported Media Type"}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/415/content/application~1json/examples/response"},"paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"500","message":"A temporary problem in the service occurred, you can retry later."}]},"key":"response","summary":"response","id":"paths/~1notifications~1reusable-blocks~1{blockKey}/delete/responses/500/content/application~1json/examples/response"},"paths/~1notifications~1history/delete/responses/202/content/application~1json/examples/response":{"value":"{\n    \"id\": \"2be2f02afc504d1b83fb3cd095ce4dc6\",\n    \"status\": \"RUNNING\",\n    \"tenantId\": \"9\",\n    \"createdBy\": \"402881e522cf4f9b0122cf5d82860002\",\n    \"createdOn\": 1610358627000,\n    \"accountId\": \"2c9e8084769a87be0176f0cfa138001e\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1history/delete/responses/202/content/application~1json/examples/response"},"paths/~1notifications~1history/delete/responses/404/content/application~1json/examples/response":{"value":"{\n    \"reasons\": [\n        {\n            \"code\": \"404\",\n            \"message\": \"HTTP 404 Not Found\"\n        }\n    ]\n}","key":"response","summary":"response","id":"paths/~1notifications~1history/delete/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1history~1tasks~1{id}/get/responses/200/content/application~1json/examples/response":{"value":"{\n    \"id\": \"2be2f02afc504d1b83fb3cd095ce4dc6\",\n    \"status\": \"FINISHED\",\n    \"tenantId\": \"9\",\n    \"createdBy\": \"402881e522cf4f9b0122cf5d82860002\",\n    \"createdOn\": 1610358627000,\n    \"accountId\": \"2c9e8084769a87be0176f0cfa138001e\"\n}","key":"response","summary":"response","id":"paths/~1notifications~1history~1tasks~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1notifications~1history~1tasks~1{id}/get/responses/404/content/application~1json/examples/response":{"value":"{\n    \"reasons\": [\n        {\n            \"code\": \"ObjectNotFound\",\n            \"message\": \"history task with id 2be2f02afc504d1b83fb3cd095ce4dc7 not found\"\n        }\n    ]\n}","key":"response","summary":"response","id":"paths/~1notifications~1history~1tasks~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1notifications~1callout-histories~1resend/post/responses/202/content/application~1json/examples/response":{"value":{"a00000000000000000000000000000000":{"code":"ObjectNotFound","message":"Callout history does not exist."}},"key":"response","summary":"response","id":"paths/~1notifications~1callout-histories~1resend/post/responses/202/content/application~1json/examples/response"},"paths/~1notifications~1callout-histories~1resend/post/responses/400/content/application~1json/examples/response":{"value":{"a00000000000000000000000000000000":{"code":"ObjectNotFound","message":"Callout history does not exist."},"a00000000000000000000000000000001":{"code":"ObjectNotFound","message":"Callout history does not exist."}},"key":"response","summary":"response","id":"paths/~1notifications~1callout-histories~1resend/post/responses/400/content/application~1json/examples/response"},"paths/~1notifications~1email-histories~1resend/post/responses/202/content/application~1json/examples/response":{"value":{"a00000000000000000000000000000000":{"code":"ObjectNotFound","message":"Email history does not exist."}},"key":"response","summary":"response","id":"paths/~1notifications~1email-histories~1resend/post/responses/202/content/application~1json/examples/response"},"paths/~1notifications~1email-histories~1resend/post/responses/400/content/application~1json/examples/response":{"value":{"a00000000000000000000000000000000":{"code":"ObjectNotFound","message":"Email history does not exist."},"a00000000000000000000000000000001":{"code":"ObjectNotFound","message":"Email history does not exist."}},"key":"response","summary":"response","id":"paths/~1notifications~1email-histories~1resend/post/responses/400/content/application~1json/examples/response"},"paths/~1v1~1notification-history~1callout/get/responses/200/content/application~1json/examples/response":{"value":{"calloutHistories":[{"attemptedNum":3,"createTime":"2015-01-13T03:33:51","eventCategory":1210,"eventContext":{"<Account.Currency>":"USD","<Account.CurrencySymbol>":"$","<Account.ID>":"402881e54ade80c8014ade884c48000b","<Account.Name>":"test","<Account.Number>":"A00000001","<BillToContact.FirstName>":"Mary","<BillToContact.ID>":"402881e54ade80c8014ade884c51000c","<BillToContact.LastName>":"Smith","<BillToContact.WorkEmail>":"smith@example.com","<BillingAccount.ID>":"402881e54ade80c8014ade884c48000b","<Contact.ID>":"402881e54ade80c8014ade884c51000c","<Event.Category>":"SubscriptionCreated","<Event.ID>":"402892fa47866fe701478674a4ff0093","<Event.Timestamp>":"2015-01-13T22:31:43.248+0800","<Notification>":{"EmailTemplate":"New Subscription Created Default Email Template","Event":"New Subscription Created","Profile":"Default Profile","calloutAction":true,"emailAction":true,"id":"402892fa47866fe701478674a5c100eb","updatedBy":"402892fa47866fe7014786749d9b0002","updatedOn":"01/12/2015 03:23:08"},"<Object.ID>":"402881e54ae37f31014ae3b514e100fd","<Subscription.AutoRenew>":"No","<Subscription.CMRR>":"$250.00","<Subscription.ContractEffective>":"01/01/2016","<Subscription.CreateDate>":"01/13/2015","<Subscription.CreatedBy>":"smith@example.com","<Subscription.CustomerAcceptance>":"01/01/2016","<Subscription.ID>":"402881e54ae37f31014ae3b514e100fd","<Subscription.InitialTerm>":"50","<Subscription.RenewalTerm>":"0","<Subscription.ServiceActivation>":"01/01/2016","<Subscription.SubscriptionDetailTable>":{"Charge Name":"recurringcharge","Charge Type":"Recurring","Effective Start Date":"01 / 01 / 2016","QTY":5,"Total":250,"Unit Price":50},"<Subscription.SubscriptionName>":"A-S00000003","<Subscription.TCV>":"$12,500.00","<Subscription.TermEndDate>":"03/01/2020","<Subscription.TermSetting>":"termed","<Subscription.TermStartDate>":"01/01/2016"},"notification":"New Subscription Created","requestMethod":"POST","requestUrl":"https://www.google.com","responseCode":405}],"nextPage":"https://localhost:8080/apps/v1/notification-history/callout?page=2&pageSize=1&startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000","success":true},"key":"response","summary":"response","id":"paths/~1v1~1notification-history~1callout/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1notification-history~1email/get/responses/200/content/application~1json/examples/response":{"value":{"emailHistories":[{"accountId":"2c9e8084769a87be0176f0cfa138001e","bcc":"ceo@example.com,cto@example.com","cc":"bob@example.com,chris@example.com","errorMessage":null,"eventCategory":1210,"fromEmail":"no-reply@example.com","notification":"New Subscription Created","replyTo":"supportexample.com","result":"OK","sendTime":"2015-01-13T03:31:43","subject":"New subscription A-S00000003 was created and activated","toEmail":"smith@example.com"}],"nextPage":"https://localhost:8080/apps/v1/notification-history/email?page=2&pageSize=1&startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000","success":true},"key":"response","summary":"response","id":"paths/~1v1~1notification-history~1email/get/responses/200/content/application~1json/examples/response"},"paths/~1events~1event-triggers/post/responses/200/content/application~1json/examples/response":{"value":{"id":"5a70564ad08c412fb98e06a80c365c93","baseObject":"Invoice","condition":"changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0","eventType":{"name":"LargeInvoicePosted","displayName":"Large Invoice Posted","namespace":"user.notification"},"active":true},"key":"response","summary":"response","id":"paths/~1events~1event-triggers/post/responses/200/content/application~1json/examples/response"},"paths/~1events~1event-triggers/post/responses/400/content/application~1json/examples/response":{"value":"{\n  \"reasons\": [\n    {\n      \"code\": \"MissingRequiredField\",\n      \"message\": \"eventType is missing\"\n    }\n  ]\n}","key":"response","summary":"response","id":"paths/~1events~1event-triggers/post/responses/400/content/application~1json/examples/response"},"paths/~1events~1event-triggers/post/responses/500/content/application~1json/examples/response":{"value":"{\n  \"reasons\": [\n    {\n      \"code\": \"SystemError\",\n      \"message\": \"internal server error\"\n    }\n  ]\n}","key":"response","summary":"response","id":"paths/~1events~1event-triggers/post/responses/500/content/application~1json/examples/response"},"paths/~1events~1event-triggers/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"id":"ac1ee535e8524858a72edb464212729d","baseObject":"Invoice","condition":"changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0","description":"Trigger an event when an invoice is posted with amount over 1000","eventType":{"name":"LargeInvoicePosted","displayName":"Large Invoice Posted","description":"An invoice is posted with amount over 1000"},"active":true}],"next":"https://api.zuora.com/events/event-triggers?start=1&limit=1"},"key":"response","summary":"response","id":"paths/~1events~1event-triggers/get/responses/200/content/application~1json/examples/response"},"paths/~1events~1event-triggers/get/responses/400/content/application~1json/examples/response":{"value":"{\n  \"reasons\": [\n    {\n      \"code\": \"FieldConstraintViolation\",\n      \"message\": \"start should be >= 0\"\n    }\n  ]\n}","key":"response","summary":"response","id":"paths/~1events~1event-triggers/get/responses/400/content/application~1json/examples/response"},"paths/~1events~1event-triggers/get/responses/500/content/application~1json/examples/response":{"value":"{\n  \"reasons\": [\n    {\n      \"code\": \"SystemError\",\n      \"message\": \"internal server error\"\n    }\n  ]\n}","key":"response","summary":"response","id":"paths/~1events~1event-triggers/get/responses/500/content/application~1json/examples/response"},"paths/~1events~1event-triggers~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"ac1ee535e8524858a72edb464212729d","baseObject":"Invoice","condition":"changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0","description":"Trigger an event when an invoice is posted with amount over 1000","eventType":{"name":"LargeInvoicePosted","displayName":"Large Invoice Posted","description":"An invoice is posted with amount over 1000"},"active":true},"key":"response","summary":"response","id":"paths/~1events~1event-triggers~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1events~1event-triggers~1{id}/get/responses/404/content/application~1json/examples/response":{"value":"{\n  \"reasons\": [\n    {\n      \"code\": \"ObjectNotFound\",\n      \"message\": \"no event trigger found with the given id\"\n    }\n  ]\n}","key":"response","summary":"response","id":"paths/~1events~1event-triggers~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1events~1event-triggers~1{id}/get/responses/500/content/application~1json/examples/response":{"value":"{\n  \"reasons\": [\n    {\n      \"code\": \"SystemError\",\n      \"message\": \"internal server error\"\n    }\n  ]\n}","key":"response","summary":"response","id":"paths/~1events~1event-triggers~1{id}/get/responses/500/content/application~1json/examples/response"},"paths/~1events~1event-triggers~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"id":"5a70564ad08c412fb98e06a80c365c93","baseObject":"Invoice","condition":"changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0","description":"Trigger the event when an invoice is posted with amount over 1000","eventType":{"name":"LargeInvoicePosted","displayName":"Large Invoice Posted","namespace":"user.notification"},"active":true},"key":"response","summary":"response","id":"paths/~1events~1event-triggers~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1events~1event-triggers~1{id}/put/responses/404/content/application~1json/examples/response":{"value":"{\n  \"reasons\": [\n    {\n      \"code\": \"ObjectNotFound\",\n      \"message\": \"no event trigger found with the given id\"\n    }\n  ]\n}","key":"response","summary":"response","id":"paths/~1events~1event-triggers~1{id}/put/responses/404/content/application~1json/examples/response"},"paths/~1events~1event-triggers~1{id}/put/responses/500/content/application~1json/examples/response":{"value":"{\n  \"reasons\": [\n    {\n      \"code\": \"SystemError\",\n      \"message\": \"internal server error\"\n    }\n  ]\n}","key":"response","summary":"response","id":"paths/~1events~1event-triggers~1{id}/put/responses/500/content/application~1json/examples/response"},"paths/~1events~1event-triggers~1{id}/delete/responses/404/content/application~1json/examples/response":{"value":"{\n  \"reasons\": [\n    {\n      \"code\": \"ObjectNotFound\",\n      \"message\": \"no event trigger found with the given id\"\n    }\n  ]\n}","key":"response","summary":"response","id":"paths/~1events~1event-triggers~1{id}/delete/responses/404/content/application~1json/examples/response"},"paths/~1events~1event-triggers~1{id}/delete/responses/500/content/application~1json/examples/response":{"value":"{\n  \"reasons\": [\n    {\n      \"code\": \"SystemError\",\n      \"message\": \"internal server error\"\n    }\n  ]\n}","key":"response","summary":"response","id":"paths/~1events~1event-triggers~1{id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1events~1scheduled-events/post/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"FieldConstraintViolation","message":"name should follow ^[A-Za-z]{1,}[\\w\\-]*$"}]},"key":"response","summary":"response","id":"paths/~1events~1scheduled-events/post/responses/400/content/application~1json/examples/response"},"paths/~1events~1scheduled-events/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1events~1scheduled-events/post/responses/500/content/application~1json/examples/response"},"paths/~1events~1scheduled-events/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1events~1scheduled-events/get/responses/500/content/application~1json/examples/response"},"paths/~1events~1scheduled-events~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ResourceNotFound","message":"no resource found with the given identifier event-type by tenant id:10315 and id:59b8b0bfb3b94ce6a8fb96aed64d73c5"}]},"key":"response","summary":"response","id":"paths/~1events~1scheduled-events~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1events~1scheduled-events~1{id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1events~1scheduled-events~1{id}/get/responses/500/content/application~1json/examples/response"},"paths/~1events~1scheduled-events~1{id}/put/responses/400/content/application~1json/examples/response":{"value":{"reasons":[{"code":"FieldConstraintViolation","message":"name should follow ^[A-Za-z]{1,}[\\w\\-]*$"}]},"key":"response","summary":"response","id":"paths/~1events~1scheduled-events~1{id}/put/responses/400/content/application~1json/examples/response"},"paths/~1events~1scheduled-events~1{id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1events~1scheduled-events~1{id}/put/responses/500/content/application~1json/examples/response"},"paths/~1events~1scheduled-events~1{id}/delete/responses/404/content/application~1json/examples/response":{"value":{"reasons":[{"code":"ResourceNotFound","message":"no resource found with the given identifier event-type by tenant id:10315 and id:59b8b0bfb3b94ce6a8fb96aed64d73c5"}]},"key":"response","summary":"response","id":"paths/~1events~1scheduled-events~1{id}/delete/responses/404/content/application~1json/examples/response"},"paths/~1events~1scheduled-events~1{id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1events~1scheduled-events~1{id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a standard object":{"value":{"actions":[{"type":"addField","namespace":"com_zuora","object":"Account","field":{"name":"AccountGroup__c","definition":{"type":"string","label":"AccountGroup","maxLength":50}}}]},"key":"Add a custom field to a standard object","summary":"Add a custom field to a standard object","id":"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a standard object"},"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a standard object":{"value":{"actions":[{"type":"updateField","namespace":"com_zuora","object":"Account","field":{"name":"AccountGroup__c","required":true,"definition":{"description":"The account group number"}}}]},"key":"Update a custom field on a standard object","summary":"Update a custom field on a standard object","id":"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a standard object"},"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom object":{"value":{"actions":[{"type":"updateObject","namespace":"default","object":"Vehicle","label":"Vehicle","enableCreateRecordAuditing":true,"enableDeleteRecordAuditing":true}]},"key":"Update a custom object","summary":"Update a custom object","id":"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom object"},"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a custom object":{"value":{"actions":[{"type":"addField","namespace":"default","object":"Vehicle","field":{"name":"DeviceId__c","definition":{"type":"string","label":"DeviceId","maxLength":50}}}]},"key":"Add a custom field to a custom object","summary":"Add a custom field to a custom object","id":"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a custom field to a custom object"},"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a custom object":{"value":{"actions":[{"type":"updateField","namespace":"default","object":"Vehicle","field":{"name":"OrderId__c","required":true,"definition":{"description":"Linking to the Order object"}}}]},"key":"Update a custom field on a custom object","summary":"Update a custom field on a custom object","id":"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Update a custom field on a custom object"},"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a custom field from a custom object":{"value":{"actions":[{"type":"deleteField","namespace":"default","object":"Vehicle","field":{"name":"OrderId__c"}}]},"key":"Delete a custom field from a custom object","summary":"Delete a custom field from a custom object","id":"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a custom field from a custom object"},"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Rename a custom field on a custom object":{"value":{"actions":[{"type":"renameField","namespace":"default","object":"Vehicle","field":{"name":"Color__c","targetName":"CarColor__c"}}]},"key":"Rename a custom field on a custom object","summary":"Rename a custom field on a custom object","id":"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Rename a custom field on a custom object"},"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a relationship for a custom field":{"value":{"actions":[{"type":"addRelationship","namespace":"default","object":"Vehicle","relationship":{"namespace":"com_zuora","object":"orders","fields":{"OrderId__c":"Id"}}}]},"key":"Add a relationship for a custom field","summary":"Add a relationship for a custom field","id":"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Add a relationship for a custom field"},"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a relationship for a custom field":{"value":{"actions":[{"type":"deleteRelationship","namespace":"default","object":"Vehicle","relationship":{"namespace":"com_zuora","object":"orders","fields":{"OrderId__c":"Id"}}}]},"key":"Delete a relationship for a custom field","summary":"Delete a relationship for a custom field","id":"paths/~1objects~1migrations/post/requestBody/content/application~1json/examples/Delete a relationship for a custom field"},"paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned off":{"value":{"records":[{"DeviceId__c":"10101010","OrderId__c":"c086028c-5df8-427d-a3c8-7a7fb5d32d3d"}]},"key":"Partial success turned off","summary":"Partial success turned off","id":"paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned off"},"paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned on":{"value":{"allowPartialSuccess":true,"records":[{"DeviceId__c":"10101010","OrderId__c":"c086028c-5df8-427d-a3c8-7a7fb5d32d3d"},{"DeviceId__c":"10101011","OrderId__c":"c086028c-5df8-427d-a3c8-7a7fb5d32d3d"}]},"key":"Partial success turned on","summary":"Partial success turned on","id":"paths/~1objects~1records~1default~1{object}/post/requestBody/content/application~1json/examples/Partial success turned on"},"paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned off":{"value":{"records":[{"Id":"9ef0b1a0-e398-46aa-856f-76273b0d2988","type":"Vehicle","DeviceId__c":"10101010","OrderId__c":"c086028c-5df8-427d-a3c8-7a7fb5d32d3d","CreatedById":"8ad084a67f9c7138017fab8a8b511b5a","UpdatedById":"8ad084a67f9c7138017fab8a8b511b5a","CreatedDate":"2024-07-09T06:41:17.377Z","UpdatedDate":"2024-07-09T06:41:17.377Z"}],"unprocessedRecords":[]},"key":"Partial success turned off","summary":"Partial success turned off","id":"paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned off"},"paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned on":{"value":{"error":{"code":71012520,"message":"Request contains invalid record that failed validation against the object schema.","details":[{"code":71012526,"message":"Json input does not match schema. Error: Field [DeviceId__c] should be string type but received integer.","record":{"Id":"6d96fbde-213c-43c3-bbef-9b777b050a94","DeviceId__c":"10101011","OrderId__c":"c086028c-5df8-427d-a3c8-7a7fb5d32d3d"}}]},"records":[{"Id":"9ef0b1a0-e398-46aa-856f-76273b0d2988","type":"Vehicle","DeviceId__c":"10101010","OrderId__c":"c086028c-5df8-427d-a3c8-7a7fb5d32d3d","CreatedById":"8ad084a67f9c7138017fab8a8b511b5a","UpdatedById":"8ad084a67f9c7138017fab8a8b511b5a","CreatedDate":"2024-07-09T06:41:17.377Z","UpdatedDate":"2024-07-09T06:41:17.377Z"}],"unprocessedRecords":[]},"key":"Partial success turned on","summary":"Partial success turned on","id":"paths/~1objects~1records~1default~1{object}/post/responses/200/content/application~1json/examples/Partial success turned on"},"paths/~1objects~1jobs/post/responses/400/content/application~1json/examples/response":{"value":{"code":71013020,"message":"Bad Request"},"key":"response","summary":"response","id":"paths/~1objects~1jobs/post/responses/400/content/application~1json/examples/response"},"paths/~1objects~1jobs/post/responses/403/content/application~1json/examples/response":{"value":{"code":71012514,"message":"User does not have permission to delete custom objects."},"key":"response","summary":"response","id":"paths/~1objects~1jobs/post/responses/403/content/application~1json/examples/response"},"paths/~1objects~1jobs~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"code":71013040,"message":"Not Found."},"key":"response","summary":"response","id":"paths/~1objects~1jobs~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1objects~1jobs~1{id}~1files/post/responses/200/content/application~1json/examples/response":{"value":{"CreatedById":"2c92c0f96a07409d016a0a58ab1172ec","CreatedDate":"2021-03-10T00:05:54.207Z","Id":"5112347a-f7a1-4373-99df-c082984de7be","UpdatedById":"2c92c0f96a07409d016a0a58ab1172ec","UpdatedDate":"2021-03-10T00:08:15.539Z","namespace":"default","object":"vehicle","operation":"create","processingTime":0,"recordsProcessed":0,"status":"in_progress"},"key":"response","summary":"response","id":"paths/~1objects~1jobs~1{id}~1files/post/responses/200/content/application~1json/examples/response"},"paths/~1objects~1jobs~1{id}~1files/post/responses/400/content/application~1json/examples/response":{"value":{"code":71013620,"message":"Bad Request"},"key":"response","summary":"response","id":"paths/~1objects~1jobs~1{id}~1files/post/responses/400/content/application~1json/examples/response"},"paths/~1objects~1jobs~1{id}~1files/post/responses/403/content/application~1json/examples/response":{"value":{"code":71012515,"message":"User does not have permission to create custom objects."},"key":"response","summary":"response","id":"paths/~1objects~1jobs~1{id}~1files/post/responses/403/content/application~1json/examples/response"},"paths/~1objects~1jobs~1{id}~1files/post/responses/404/content/application~1json/examples/response":{"value":{"code":71013040,"message":"Not Found."},"key":"response","summary":"response","id":"paths/~1objects~1jobs~1{id}~1files/post/responses/404/content/application~1json/examples/response"},"paths/~1objects~1jobs~1{id}~1errors/get/responses/404/content/application~1json/examples/response":{"value":{"code":71013040,"message":"Not Found."},"key":"response","summary":"response","id":"paths/~1objects~1jobs~1{id}~1errors/get/responses/404/content/application~1json/examples/response"},"paths/~1objects~1jobs~1{id}~1cancel/patch/responses/200/content/application~1json/examples/response":{"value":{"CreatedById":"11e64eef-ada8-786d-9658-00259058c29c","CreatedDate":"2022-12-01T21:24:04.337Z","Id":"7f19b861-5ec7-479b-935c-fcfbd6477655","UpdatedById":"0fdfc048-0a9e-433f-ad23-d50e31448b2e","UpdatedDate":"2022-12-01T21:37:43.212Z","namespace":"default","object":"jobtest","operation":"create","processingTime":0,"recordsProcessed":0,"status":"cancelled"},"key":"response","summary":"response","id":"paths/~1objects~1jobs~1{id}~1cancel/patch/responses/200/content/application~1json/examples/response"},"paths/~1objects~1jobs~1{id}~1cancel/patch/responses/400/content/application~1json/examples/response":{"value":{"code":71013620,"message":"Bad Request"},"key":"response","summary":"response","id":"paths/~1objects~1jobs~1{id}~1cancel/patch/responses/400/content/application~1json/examples/response"},"paths/~1objects~1jobs~1{id}~1cancel/patch/responses/404/content/application~1json/examples/response":{"value":{"code":71013040,"message":"Job not found for id '7006ce52-91c9-11ed-a1eb-0242ac120002'."},"key":"response","summary":"response","id":"paths/~1objects~1jobs~1{id}~1cancel/patch/responses/404/content/application~1json/examples/response"},"paths/~1system-health~1api-requests~1volume-summary/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"error":0,"httpMethod":"DELETE","path":"/notifications/notification-definitions","success":10,"total":10},{"error":20,"httpMethod":"GET","path":"/query/jobs/{job-id}","success":10,"total":30},"..."]},"key":"response","summary":"response","id":"paths/~1system-health~1api-requests~1volume-summary/get/responses/200/content/application~1json/examples/response"},"paths/~1system-health~1api-requests~1volume-summary/get/responses/400/content/application~1json/examples/response":{"value":{"error":"Bad Request","message":"Timezone is different between 'startTime' and 'endTime'.","path":"/system-health/api-requests/volume-summary","status":400,"timestamp":"2022-09-29T05:54:46.007+00:00"},"key":"response","summary":"response","id":"paths/~1system-health~1api-requests~1volume-summary/get/responses/400/content/application~1json/examples/response"},"paths/~1system-health~1api-requests~1failures/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"tracing_identifier":null,"latency":104,"ip":"52.36.201.144","response_body":"{\"size\":0,\"records\":[],\"done\":true}","http_method":"GET","request_body":"","user_id":"2c92a0fd56368ec20156445b4a79554d","track_id":null,"request_path":"/v1/object/invoice/2c92c8fb7d37d586017d3c28f6925850","http_status":"404","zuora_response_code":"NOT_FOUND","api":"/v1/object/invoice/{id}","request_id":"42a18d47-9759-447c-ad57-79aa633487c9","user_agent":"Apache-HttpClient/4.5 (Java/1.8.0_342)","timestamp":"2025-01-19T06:43:51Z","status":"Error"},{"tracing_identifier":null,"latency":104,"ip":"52.36.201.144","response_body":"{\"size\":0,\"records\":[],\"done\":true}","http_method":"GET","request_body":"","user_id":"2c92a0fd56368ec20156445b4a79554d","track_id":null,"request_path":"/v1/object/invoice/2c92c8fb7d37d586017d3c28f6925850","http_status":"404","zuora_response_code":"NOT_FOUND","api":"/v1/object/invoice/{id}","request_id":"42a18d47-9759-447c-ad57-79aa633487c9","user_agent":"Apache-HttpClient/4.5 (Java/1.8.0_342)","timestamp":"2025-01-19T06:43:51Z","status":"Error"}],"nextPage":"/system-health/api-requests/failures?startTime=2024-08-01T09:07+0800&endTime=2024-08-05T09:07+0800&limit=10&page=2"},"key":"response","summary":"response","id":"paths/~1system-health~1api-requests~1failures/get/responses/200/content/application~1json/examples/response"},"paths/~1system-health~1api-requests~1failures/get/responses/400/content/application~1json/examples/response":{"value":{"error":"Bad Request","message":"Timezone is different between 'startTime' and 'endTime'.","path":"/system-health/api-requests/volume-summary","status":400,"timestamp":"2022-09-29T05:54:46.007+00:00"},"key":"response","summary":"response","id":"paths/~1system-health~1api-requests~1failures/get/responses/400/content/application~1json/examples/response"},"paths/~1system-health~1api-requests~1details/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"tracing_identifier":null,"latency":1913,"ip":"52.0.173.190","response_body":"{\"code\":\"REQUEST_EXCEEDED_LIMIT\",\"message\":\"Your total number of concurrent requests have exceeded the limit allowed by the system. Please resubmit your request later.\"}","http_method":"POST","request_body":null,"user_id":"4028e4883824800301382f1817921f3d","track_id":null,"request_path":"/apps/services/a/68.0","http_status":429,"zuora_response_code":"TOO_MANY_REQUESTS","api":"soap","request_id":"628fc2f4-8ab4-4e2d-bfd4-eb15fd4d2f52","user_agent":"Axis2","timestamp":"2025-01-04T13:10:53Z","status":"Error"},{"tracing_identifier":null,"latency":50218,"ip":"52.52.63.58","response_body":null,"http_method":"POST","request_body":null,"user_id":"4028e4883824800301382f1817922f3d","track_id":null,"request_path":"soap:login","http_status":200,"zuora_response_code":"Success","api":"soap:login","request_id":"34f4ce61-67be-42f5-bee5-c2665a905dfa","user_agent":"Axis2","timestamp":"2025-01-01T18:03:49Z","status":"Success"}],"nextPage":"/system-health/api-requests/details?startTime=2024-08-01T09:07+0800&endTime=2024-08-05T09:07+0800&limit=10&page=2"},"key":"response","summary":"response","id":"paths/~1system-health~1api-requests~1details/get/responses/200/content/application~1json/examples/response"},"paths/~1system-health~1api-requests~1details/get/responses/400/content/application~1json/examples/response":{"value":{"error":"Bad Request","message":"Timezone is different between 'startTime' and 'endTime'.","path":"/system-health/api-requests/volume-summary","status":400,"timestamp":"2022-09-29T05:54:46.007+00:00"},"key":"response","summary":"response","id":"paths/~1system-health~1api-requests~1details/get/responses/400/content/application~1json/examples/response"},"paths/~1system-health~1billing-documents~1volume-summary/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"totalFailedAccounts":10,"totalGeneratedCreditMemos":50,"totalGeneratedInvoices":100}]},"key":"response","summary":"response","id":"paths/~1system-health~1billing-documents~1volume-summary/get/responses/200/content/application~1json/examples/response"},"paths/~1system-health~1billing-documents~1volume-summary/get/responses/400/content/application~1json/examples/response":{"value":{"error":"Bad Request","message":"Timezone is different between 'startTime' and 'endTime'.","path":"/system-health/billing-doc/volume-summary","status":400,"timestamp":"2022-09-29T05:54:46.007+00:00"},"key":"response","summary":"response","id":"paths/~1system-health~1billing-documents~1volume-summary/get/responses/400/content/application~1json/examples/response"},"paths/~1system-health~1payments~1volume-summary/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"error":80,"paymentGatewayType":"Sample","paymentMethodType":"CreditCard","success":20,"total":100},{"error":10,"paymentGatewayType":"Adyen","paymentMethodType":"CreditCard","success":190,"total":200},"..."]},"key":"response","summary":"response","id":"paths/~1system-health~1payments~1volume-summary/get/responses/200/content/application~1json/examples/response"},"paths/~1system-health~1payments~1volume-summary/get/responses/400/content/application~1json/examples/response":{"value":{"error":"Bad Request","message":"Timezone is different between 'startTime' and 'endTime'.","path":"/system-health/payments/volume-summary","status":400,"timestamp":"2022-09-29T05:54:46.007+00:00"},"key":"response","summary":"response","id":"paths/~1system-health~1payments~1volume-summary/get/responses/400/content/application~1json/examples/response"},"paths/~1system-health~1payments~1details/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"payment_method_type":"CreditCardReferenceTransaction","amount":750000,"payment_status":"Error","source_type":"PaymentRun","payment_gateway_response_code":"12","payment_gateway_response_msg":"Not enough balance","request_duration":2094,"payment_number":"P-IDN-00077028","payment_id":"8a128a9c93d4070e0194339b8d8b300b","zuora_response_code":"Declined","currency":"Rupiah","source_id":"PR-00151770","payment_gateway_type":"Adyen","payment_date":"2025-01-05"},{"payment_method_type":"CreditCardReferenceTransaction","amount":750000,"payment_status":"Error","source_type":"PaymentRun","payment_gateway_response_code":"12","payment_gateway_response_msg":"Not enough balance","request_duration":2094,"payment_number":"P-IDN-00077028","payment_id":"8a128a9c93d4070e0194339b8d8b300b","zuora_response_code":"Declined","currency":"Rupiah","source_id":"PR-00151770","payment_gateway_type":"Adyen","payment_date":"2025-01-05"}],"nextPage":"/system-health/payments/details?startTime=2025-01-01T09:07+0800&endTime=2025-01-30T09:07+0800&pageSize=1&sort=amount&page=4"},"key":"response","summary":"response","id":"paths/~1system-health~1payments~1details/get/responses/200/content/application~1json/examples/response"},"paths/~1system-health~1payments~1details/get/responses/400/content/application~1json/examples/response":{"value":{"error":"Bad Request","message":"Timezone is different between 'startTime' and 'endTime'.","path":"/system-health/payments/volume-summary","status":400,"timestamp":"2022-09-29T05:54:46.007+00:00"},"key":"response","summary":"response","id":"paths/~1system-health~1payments~1details/get/responses/400/content/application~1json/examples/response"},"paths/~1system-health~1tax~1details/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"error_message":"","document_number":"INV419655124","vendor_name":"AvaTax","event_source":"avalara","error_category":"","account_id":"8a1283368cd9a250018cee13373471a7","event_type":"taxGenerate","total_duration":145,"zuora_request_id":"881cf248-5c26-4ca2-b984-8426faf05a22","account_name":"Amy Lawrence's Account","vendor_duration":145,"sub_error_category":"","status":"success","timestamp":"2025-01-10T04:08:58"},{"error_message":"","document_number":"INV519605124","vendor_name":"AvaTax","event_source":"avalara","error_category":"","account_id":"8a1283368cd9a250018cee13373471a7","event_type":"taxGenerate","total_duration":149,"zuora_request_id":"881cf248-5c26-4cq2-b984-8426faf05a22","account_name":"Amy Lawrence's Account","vendor_duration":145,"sub_error_category":"","status":"success","timestamp":"2025-01-10T04:08:58"}],"nextPage":"/system-health/tax/details?pageSize=1&startTime=2025-01-10T09:07+0800&endTime=2025-01-12T09:07+0800&sort=-timestamp&page=3"},"key":"response","summary":"response","id":"paths/~1system-health~1tax~1details/get/responses/200/content/application~1json/examples/response"},"paths/~1system-health~1tax~1details/get/responses/400/content/application~1json/examples/response":{"value":{"error":"Bad Request","message":"Timezone is different between 'startTime' and 'endTime'.","path":"/system-health/payments/volume-summary","status":400,"timestamp":"2022-09-29T05:54:46.007+00:00"},"key":"response","summary":"response","id":"paths/~1system-health~1tax~1details/get/responses/400/content/application~1json/examples/response"},"paths/~1auth_providers/post/requestBody/content/application~1json/examples/basicAuth":{"value":{"auth_provider":{"name":"billing-basic-auth","service_name":"billing","description":"Basic authentication for the billing API","auth_type":"basic_auth","active":true,"credentials":{"username":"api-user","password":"api-secret-password"}}},"key":"basicAuth","summary":"Basic authentication provider","id":"paths/~1auth_providers/post/requestBody/content/application~1json/examples/basicAuth"},"paths/~1auth_providers/post/requestBody/content/application~1json/examples/s3":{"value":{"auth_provider":{"name":"prod-s3","service_name":"billing","description":"Production S3 credentials","auth_type":"s3","active":true,"credentials":{"access_key":"AKIAEXAMPLE","secret_key":"your-secret-key","region":"us-west-2"}}},"key":"s3","summary":"Amazon S3 authentication provider","id":"paths/~1auth_providers/post/requestBody/content/application~1json/examples/s3"},"paths/~1auth_providers/post/responses/201/content/application~1json/examples/response":{"value":{"id":"ffdb2cd6-d55d-4401-ac52-38d9e7c1d0cd","status":"created"},"key":"response","summary":"response","id":"paths/~1auth_providers/post/responses/201/content/application~1json/examples/response"},"paths/~1auth_providers/post/responses/400/content/application~1json/examples/response":{"value":{"errors":["auth_provider is required"]},"key":"response","summary":"response","id":"paths/~1auth_providers/post/responses/400/content/application~1json/examples/response"},"paths/~1auth_providers/post/responses/422/content/application~1json/examples/response":{"value":{"errors":["Missing required S3 credential fields: region"]},"key":"response","summary":"response","id":"paths/~1auth_providers/post/responses/422/content/application~1json/examples/response"},"paths/~1auth_providers/post/responses/500/content/application~1json/examples/response":{"value":{"errors":["Internal server error"]},"key":"response","summary":"response","id":"paths/~1auth_providers/post/responses/500/content/application~1json/examples/response"},"paths/~1auth_providers~1{provider_id}/put/requestBody/content/application~1json/example":{"value":{"auth_provider":{"name":"prod-s3-updated","description":"Updated production S3 credentials","active":false,"credentials":{"access_key":"AKIANEW","region":"us-east-1","secret_key":"****************"}}},"id":"paths/~1auth_providers~1{provider_id}/put/requestBody/content/application~1json/example"},"paths/~1auth_providers~1{provider_id}/put/responses/200/content/application~1json/examples/response":{"value":{"status":"updated"},"key":"response","summary":"response","id":"paths/~1auth_providers~1{provider_id}/put/responses/200/content/application~1json/examples/response"},"paths/~1auth_providers~1{provider_id}/put/responses/400/content/application~1json/examples/response":{"value":{"errors":["Invalid or incomplete credentials for auth type"]},"key":"response","summary":"response","id":"paths/~1auth_providers~1{provider_id}/put/responses/400/content/application~1json/examples/response"},"paths/~1auth_providers~1{provider_id}/put/responses/404/content/application~1json/examples/response":{"value":{"errors":["Provider not found"]},"key":"response","summary":"response","id":"paths/~1auth_providers~1{provider_id}/put/responses/404/content/application~1json/examples/response"},"paths/~1auth_providers~1{provider_id}/put/responses/422/content/application~1json/examples/response":{"value":{"errors":["Invalid AWS region: us-hhh-2"]},"key":"response","summary":"response","id":"paths/~1auth_providers~1{provider_id}/put/responses/422/content/application~1json/examples/response"},"paths/~1auth_providers~1{provider_id}/put/responses/500/content/application~1json/examples/response":{"value":{"errors":["Internal server error"]},"key":"response","summary":"response","id":"paths/~1auth_providers~1{provider_id}/put/responses/500/content/application~1json/examples/response"},"paths/~1auth_providers~1{provider_id}/delete/responses/200/content/application~1json/examples/response":{"value":{"status":"deleted"},"key":"response","summary":"response","id":"paths/~1auth_providers~1{provider_id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1auth_providers~1{provider_id}/delete/responses/401/content/application~1json/examples/response":{"value":{"errors":["Authentication failed"]},"key":"response","summary":"response","id":"paths/~1auth_providers~1{provider_id}/delete/responses/401/content/application~1json/examples/response"},"paths/~1auth_providers~1{provider_id}/delete/responses/404/content/application~1json/examples/response":{"value":{"errors":["Provider not found"]},"key":"response","summary":"response","id":"paths/~1auth_providers~1{provider_id}/delete/responses/404/content/application~1json/examples/response"},"paths/~1auth_providers~1{provider_id}/delete/responses/500/content/application~1json/examples/response":{"value":{"errors":["Internal server error"]},"key":"response","summary":"response","id":"paths/~1auth_providers~1{provider_id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1workflows~1versions~1{version_id}/delete/responses/200/content/application~1json/examples/response":{"value":{"id":113,"success":true},"key":"response","summary":"response","id":"paths/~1workflows~1versions~1{version_id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1versions~1{version_id}/delete/responses/403/content/application~1json/examples/response":{"value":{"errors":[{"code":"invalid","status":403,"title":"Cannot delete the active version of a workflow."}]},"key":"response","summary":"response","id":"paths/~1workflows~1versions~1{version_id}/delete/responses/403/content/application~1json/examples/response"},"paths/~1workflows/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"active_version":{"description":"","id":49,"status":"Active","type":"Workflow::Setup","version":"0.0.1"},"calloutTrigger":true,"createdAt":"2019-05-31T14:52:38.171Z","description":"","id":48,"interval":null,"latest_inactive_versions":[{"calloutTrigger":true,"createdAt":"2021-09-22T19:30:52.350Z","description":"","id":50,"interval":"","name":"test","ondemandTrigger":true,"priority":"Medium","scheduledTrigger":false,"status":"Inactive","timezone":"Sydney","type":"Workflow::Setup","updatedAt":"2021-09-22T19:30:52.350Z","version":"0.0.2"},{"calloutTrigger":true,"createdAt":"2021-09-22T19:30:52.350Z","description":"","id":51,"interval":"","name":"test","ondemandTrigger":true,"priority":"Medium","scheduledTrigger":false,"status":"Inactive","timezone":"Sydney","type":"Workflow::Setup","updatedAt":"2021-09-22T19:30:52.350Z","version":"0.0.3"}],"name":"New test workflow","ondemandTrigger":true,"scheduledTrigger":false,"status":"Active","timezone":null,"updatedAt":"2019-06-03T21:02:26.694Z"}],"pagination":{"next_page":"https://rest.zuora.com/workflows?page=2&page_length=1","page":1,"page_length":1}},"key":"response","summary":"response","id":"paths/~1workflows/get/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1import/post/responses/200/content/application~1json/examples/response":{"value":{"id":3373,"name":"Checking Workflow","description":"","type":"Workflow::Setup","version":"0.0.1","ondemandTrigger":true,"calloutTrigger":false,"scheduledTrigger":false,"interval":"","timezone":"","createdAt":"2019-10-03T14:14:39.139Z","updatedAt":"2019-10-03T14:14:39.139Z"},"key":"response","summary":"response","id":"paths/~1workflows~1import/post/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1metrics.json/get/responses/200/content/application~1json/examples/response":{"value":{"metrics":[{"date":"2019-01-16","values":{"taskCount":1417}},{"date":"2019-08-02","values":{"taskCount":24}},{"date":"2019-05-23","values":{"taskCount":2}}]},"key":"response","summary":"response","id":"paths/~1workflows~1metrics.json/get/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1tasks/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"action_type":"If","call_type":"SOAP","data":{"Callout":{"RequestBody":{"queryString":"Select Id From Contact Where LastName = 'Drew' AND FirstName = 'Nancy' AND  WorkEmail = 'nancy@xyz.com'"},"RequestHeaders":{"Content-Type":"application/json"},"ResponseBody":{"message":"An unexpected error occurred\n"},"ResponseCode":500,"ResponseHeaders":{"cache-control":["max-age=0, no-cache, no-store"],"connection":["close"],"content-type":["text/plain; charset=UTF-8"],"date":["Thu, 19 Sep 2019 12:35:43 GMT"],"expires":["Thu, 19 Sep 2019 12:35:43 GMT"],"pragma":["no-cache"],"server":["kong/0.9.9"],"x-n":["S"]},"URL":"https://rest.apisandbox.zuora.com/v1/action/query"},"Files":{"XML_52881.xml":{"name":"JSONData_xslt.xml","object_class":"Workflow","size":0.011725425720214844}},"Tasks":{"Previous":{"ErrorClass":"WorkflowError::Callout","ErrorReason":"Callout response was 500 after 1 tries.","Id":2770,"Status":"Error"}},"Workflow":{"ExecutionDate":"2019-09-19","ExecutionDateTime":"2019-09-19T12:35:37","LastRunDate":"2019-09-19","LastRunDateTime":"2019-09-19T12:34:41","WorkflowRunUser":"test-user"}},"end_time":"2019-09-19T12:35:43.942Z","error":null,"error_class":null,"error_details":null,"id":2771,"instance":true,"name":"If","object":null,"object_id":null,"original_task_id":2582,"original_workflow_id":416,"parameters":{"if_clause":"{% if 0 > 1 %}\r\nTrue\r\n{% else %}\r\nFalse\r\n{% endif %}","strict_variables":"true"},"start_time":"2019-09-19T12:35:43.857Z","status":"Success","tags":[],"workflow_id":476}],"pagination":{"next_page":"https://rest.zuora.com/workflows/tasks?page=2&page_length=1","page":1,"page_length":1}},"key":"response","summary":"response","id":"paths/~1workflows~1tasks/get/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1tasks~1batch_update/put/responses/200/content/application~1json/examples/response":{"value":{"data":[{"action_type":"If","call_type":"SOAP","data":{"Callout":{"RequestBody":{"queryString":"Select Id From Contact Where LastName = 'Drew' AND FirstName = 'Nancy' AND  WorkEmail = 'nancy@xyz.com'"},"RequestHeaders":{"Content-Type":"application/json"},"ResponseBody":{"message":"An unexpected error occurred\n"},"ResponseCode":500,"ResponseHeaders":{"cache-control":["max-age=0, no-cache, no-store"],"connection":["close"],"content-type":["text/plain; charset=UTF-8"],"date":["Thu, 19 Sep 2019 12:35:43 GMT"],"expires":["Thu, 19 Sep 2019 12:35:43 GMT"],"pragma":["no-cache"],"server":["kong/0.9.9"],"x-n":["S"]},"URL":"https://rest.apisandbox.zuora.com/v1/action/query"},"Files":{"XML_52881.xml":{"name":"JSONData_xslt.xml","object_class":"Workflow","size":0.011725425720214844}},"Tasks":{"Previous":{"ErrorClass":"WorkflowError::Callout","ErrorReason":"Callout response was 500 after 1 tries.","Id":2770,"Status":"Error"}},"Workflow":{"ExecutionDate":"2019-09-19","ExecutionDateTime":"2019-09-19T12:35:37","LastRunDate":"2019-09-19","LastRunDateTime":"2019-09-19T12:34:41","WorkflowRunUser":"test-user"}},"end_time":"2019-09-19T12:35:43.942Z","error":null,"error_class":null,"error_details":null,"id":2771,"instance":true,"name":"If","object":null,"object_id":null,"original_task_id":2582,"original_workflow_id":416,"parameters":{"if_clause":"{% if 0 > 1 %}\r\nTrue\r\n{% else %}\r\nFalse\r\n{% endif %}","strict_variables":"true"},"start_time":"2019-09-19T12:35:43.857Z","status":"Success","tags":[],"workflow_id":476}],"pagination":{"page":null,"page_length":null}},"key":"response","summary":"response","id":"paths/~1workflows~1tasks~1batch_update/put/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1tasks~1batch_update/put/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"Task","status":400,"title":"Data not present or not in array."}]},"key":"response","summary":"response","id":"paths/~1workflows~1tasks~1batch_update/put/responses/400/content/application~1json/examples/response"},"paths/~1workflows~1tasks~1batch_update/put/responses/404/content/application~1json/examples/response":{"value":{"errors":[{"code":"Task","status":404,"title":"Missing ids for tasks."}]},"key":"response","summary":"response","id":"paths/~1workflows~1tasks~1batch_update/put/responses/404/content/application~1json/examples/response"},"paths/~1workflows~1tasks~1{task_id}/get/responses/200/content/application~1json/examples/response":{"value":{"action_type":"If","call_type":"SOAP","data":{"Callout":{"RequestBody":{"queryString":"Select Id From Contact Where LastName = 'Drew' AND FirstName = 'Nancy' AND  WorkEmail = 'nancy@xyz.com'"},"RequestHeaders":{"Content-Type":"application/json"},"ResponseBody":{"message":"An unexpected error occurred\n"},"ResponseCode":500,"ResponseHeaders":{"cache-control":["max-age=0, no-cache, no-store"],"connection":["close"],"content-type":["text/plain; charset=UTF-8"],"date":["Thu, 19 Sep 2019 12:35:43 GMT"],"expires":["Thu, 19 Sep 2019 12:35:43 GMT"],"pragma":["no-cache"],"server":["kong/0.9.9"],"x-n":["S"]},"URL":"https://rest.apisandbox.zuora.com/v1/action/query"},"Files":{"XML_52881.xml":{"name":"JSONData_xslt.xml","object_class":"Workflow","size":0.011725425720214844}},"Tasks":{"Previous":{"ErrorClass":"WorkflowError::Callout","ErrorReason":"Callout response was 500 after 1 tries.","Id":2770,"Status":"Error"}},"Workflow":{"ExecutionDate":"2019-09-19","ExecutionDateTime":"2019-09-19T12:35:37","LastRunDate":"2019-09-19","LastRunDateTime":"2019-09-19T12:34:41","WorkflowRunUser":"test-user"}},"end_time":"2019-09-19T12:35:43.942Z","error":null,"error_class":null,"error_details":null,"id":2771,"instance":true,"name":"If","object":null,"object_id":null,"original_task_id":2582,"original_workflow_id":416,"parameters":{"if_clause":"{% if 0 > 1 %}\r\nTrue\r\n{% else %}\r\nFalse\r\n{% endif %}","strict_variables":"true"},"start_time":"2019-09-19T12:35:43.857Z","status":"Success","tags":[],"workflow_id":476},"key":"response","summary":"response","id":"paths/~1workflows~1tasks~1{task_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1tasks~1{task_id}~1rerun/post/responses/200/content/application~1json/examples/response":{"value":{"action_type":"If","call_type":"SOAP","data":{"Callout":{"RequestBody":{"queryString":"Select Id From Contact Where LastName = 'Drew' AND FirstName = 'Nancy' AND  WorkEmail = 'nancy@xyz.com'"},"RequestHeaders":{"Content-Type":"application/json"},"ResponseBody":{"message":"An unexpected error occurred\n"},"ResponseCode":500,"ResponseHeaders":{"cache-control":["max-age=0, no-cache, no-store"],"connection":["close"],"content-type":["text/plain; charset=UTF-8"],"date":["Thu, 19 Sep 2019 12:35:43 GMT"],"expires":["Thu, 19 Sep 2019 12:35:43 GMT"],"pragma":["no-cache"],"server":["kong/0.9.9"],"x-n":["S"]},"URL":"https://rest.apisandbox.zuora.com/v1/action/query"},"Files":{"XML_52881.xml":{"name":"JSONData_xslt.xml","object_class":"Workflow","size":0.011725425720214844}},"Tasks":{"Previous":{"ErrorClass":"WorkflowError::Callout","ErrorReason":"Callout response was 500 after 1 tries.","Id":2770,"Status":"Error"}},"Workflow":{"ExecutionDate":"2019-09-19","ExecutionDateTime":"2019-09-19T12:35:37","LastRunDate":"2019-09-19","LastRunDateTime":"2019-09-19T12:34:41","WorkflowRunUser":"test-user"}},"end_time":"2019-09-19T12:35:43.942Z","error":null,"error_class":null,"error_details":null,"id":2771,"instance":true,"name":"If","object":null,"object_id":null,"original_task_id":2582,"original_workflow_id":416,"parameters":{"if_clause":"{% if 0 > 1 %}\r\nTrue\r\n{% else %}\r\nFalse\r\n{% endif %}","strict_variables":"true"},"start_time":"2019-09-19T12:35:43.857Z","status":"Success","tags":[],"workflow_id":476},"key":"response","summary":"response","id":"paths/~1workflows~1tasks~1{task_id}~1rerun/post/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1workflow_runs~1{workflow_run_id}/get/responses/200/content/application~1json/examples/response":{"value":{"cpuTime":19.02,"createdAt":"2019-09-10 19:32:21 UTC","definitionId":19026,"definitionName":"Invoice posting workflow","finishedAt":"2019-09-10 19:33:34 UTC","id":19063,"name":"WF-19027-00000032","originalWorkflowId":19027,"runTime":64.513026,"status":"Finished","tags":[],"tasks":{"error":0,"expected":4,"pending":0,"processing":0,"queued":0,"stopped":0,"success":4,"total":4},"type":"Workflow::Instance","updatedAt":"2019-09-10 19:33:34 UTC"},"key":"response","summary":"response","id":"paths/~1workflows~1workflow_runs~1{workflow_run_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}/delete/responses/200/content/application~1json/examples/response":{"value":{"id":19080,"success":true},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}/delete/responses/404/content/application~1json/examples/response":{"value":{"errors":["Invalid ID / Multiple objects returned - SchemaId: 2 InstanceId: 2 ObjectId: 19080"]},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}/delete/responses/404/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}/get/responses/200/content/application~1json/examples/response":{"value":{"active_version":{"description":"","id":49,"status":"Active","type":"Workflow::Setup","version":"0.0.1"},"calloutTrigger":true,"createdAt":"2021-09-22T19:30:52.350Z","description":"","id":2,"interval":"","name":"test","ondemandTrigger":true,"priority":"Medium","scheduledTrigger":false,"status":"Active","timezone":"Sydney","updatedAt":"2021-09-22T19:30:52.350Z"},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}/patch/responses/200/content/application~1json/examples/response":{"value":{"id":265,"name":"Refresh products","description":"Retrieve and update products","status":"Active","ondemandTrigger":true,"calloutTrigger":true,"scheduledTrigger":false,"interval":null,"timezone":null,"createdAt":"2021-02-04T13:39:10.530+08:00","updatedAt":"2021-07-23T11:43:48.576+08:00","active_version":{"id":265,"description":"the first description","type":"Workflow::Setup","version":"0.0.1","status":"Active"}},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}/patch/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}/patch/responses/404/content/application~1json/examples/response":{"value":{"errors":["Invalid ID / Multiple objects returned - SchemaId: 2 InstanceId: 2 ObjectId: 19080"]},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}/patch/responses/404/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}/patch/responses/422/content/application~1json/examples/response":{"value":{"reasons":[{"fieldName":"status","title":"on is not a valid status. Choose from Active or Inactive"},{"fieldName":"interval","title":"The entered cron interval is not valid, rebuild schedule and submit again."}],"success":false},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}/patch/responses/422/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}~1export/get/responses/200/content/application~1json/examples/response":{"value":{"linkages":[{"linkage_type":"Start","source_task_id":null,"source_workflow_id":286,"target_task_id":849}],"tasks":[{"action_type":"Callout","assignment":[],"call_type":"SOAP","concurrent_limit":9999999,"css":{"left":"470px","top":"160px"},"error":null,"error_class":null,"error_details":null,"id":849,"iterate_row_reference":null,"name":"Call Echo","object":null,"object_batched_reference":null,"object_id":null,"original_task_id":null,"original_workflow_id":null,"parameters":{"authorization":{"type":"none"},"body_type":"raw","datas":[{"key":"","value":""}],"headers":[{"key":"","value":""}],"include_response_code":"true","method":"GET","raw_body":"","retry_rules":{"current_retry_count":"0","retry_count":"0","retry_window":"30"},"strict_variables":"true","url":"http://scooterlabs.com/echo","validate_response":"false","validation":{"status_codes":["","200"],"zuora_call":"false"},"validation_scheme":""},"priority":"Medium","process_id":null,"status":null,"tags":[""],"task_id":null}],"workflow":{"call_type":null,"callout_trigger":true,"css":{"left":"30px","top":"40px"},"data":{},"delete_ttl":60,"description":"","finished_at":null,"id":286,"interval":null,"name":"Call Echo","notifications":{},"ondemand_trigger":true,"original_workflow_id":null,"parameters":{},"priority":"Medium","scheduled_trigger":false,"started_at":null,"status":null,"sync_trigger":false,"task_summary":{},"timezone":null,"type":"Workflow::Setup","version":"0.0.1"}},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}~1export/get/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}~1export/get/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"invalid","status":400,"title":"The input of version '1' is invalid."}]},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}~1export/get/responses/400/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}~1export/get/responses/404/content/application~1json/examples/response":{"value":{"errors":[{"code":"invalid","status":400,"title":"Workflow version '1' is not found."}]},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}~1export/get/responses/404/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}~1run/post/responses/200/content/application~1json/examples/response":{"value":{"createdAt":"2019-09-19 18:25:33 UTC","id":400,"name":"WF-396-00000003","originalWorkflowId":396,"status":"Queued","type":"Workflow::Instance","updatedAt":"2019-09-19 18:25:33 UTC"},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}~1run/post/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}~1run/post/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"invalid","status":400,"title":"Callout mode is not turned on in this workflow."}]},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}~1run/post/responses/400/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}~1run/post/responses/406/content/application~1json/examples/response":{"value":{"errors":[{"code":"invalid","status":406,"title":"Required field for Workflow-Message1 does not have a set value. Ensure parameter 'Message' is present."}],"parameters":{"workflow":{}}},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}~1run/post/responses/406/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}~1run/post/responses/409/content/application~1json/examples/response":{"value":{"errors":[{"code":"invalid","status":406,"title":"Workflow WF-396-00000002 with Id 399 is an instance/run."}]},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}~1run/post/responses/409/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}~1versions/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"calloutTrigger":true,"createdAt":"2019-05-31T14:52:38.171Z","description":"","id":48,"interval":null,"name":"New test workflow","ondemandTrigger":true,"scheduledTrigger":false,"timezone":null,"type":"Workflow::Setup","updatedAt":"2019-06-03T21:02:26.694Z","version":"0.0.1"},{"calloutTrigger":true,"createdAt":"2019-05-31T14:52:38.171Z","description":"","id":49,"interval":null,"name":"New test workflow","ondemandTrigger":true,"scheduledTrigger":false,"timezone":null,"type":"Workflow::Setup","updatedAt":"2019-06-03T21:02:26.694Z","version":"0.0.2"}]},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}~1versions/get/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1{workflow_id}~1versions~1import/post/responses/200/content/application~1json/examples/response":{"value":{"id":3373,"name":"Checking Workflow","description":"","status":"Active","ondemandTrigger":true,"calloutTrigger":false,"scheduledTrigger":false,"interval":"","timezone":"","createdAt":"2024-11-15T12:51:45.859+08:00","updatedAt":"2024-11-15T12:51:45.859+08:00","active_version":{"id":3373,"description":"","type":"Workflow::Setup","version":"0.0.1","status":"Inactive"}},"key":"response","summary":"response","id":"paths/~1workflows~1{workflow_id}~1versions~1import/post/responses/200/content/application~1json/examples/response"},"paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/200/content/application~1json/example"},"paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/404/content/application~1json/example":{"value":{"errors":[{"code":"Invalid","status":404,"title":"Workflow run '19080' is not found"}]},"id":"paths/~1workflows~1workflow_runs~1{workflow_run_id}~1stop/put/responses/404/content/application~1json/example"},"paths/~1query~1jobs/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"createdBy":"514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2","id":"bf3b5640-ddd1-4b4f-9a81-906ec2b84a89","query":"SELECT s.id FROM Subscription s JOIN RatePlan rp ON s.id = rp.subscriptionid WHERE rp.name = 'Premium Monthly'","queryStatus":"in_progress","remainingRetries":3,"sourceData":"LIVE","updatedOn":"2018-08-17T13:14:38.855Z","useIndexJoin":false},{"createdBy":"514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2","dataFile":"https://example.s3.us-west-2.amazonaws.com/3a3e85c4-96e7-486b-ae02-827120104301_24921638725108715.json?X-Amz-Security-Token=...","id":"3a3e85c4-96e7-486b-ae02-827120104301","outputRows":24516,"processingTime":9212,"query":"SELECT accountnumber, balance FROM Account WHERE Account.balance > 100","queryStatus":"completed","remainingRetries":3,"sourceData":"LIVE","updatedOn":"2018-08-17T13:14:19.17Z","useIndexJoin":false}]},"key":"response","summary":"response","id":"paths/~1query~1jobs/get/responses/200/content/application~1json/examples/response"},"paths/~1query~1jobs/post/responses/200/content/application~1json/examples/response":{"value":{"data":{"id":"5948abde-b875-4d06-ad07-c2138853d8bc","query":"SELECT accountnumber, balance FROM Account WHERE Account.balance > 100","useIndexJoin":false,"sourceData":"LIVE","queryStatus":"accepted","remainingRetries":3,"retries":3,"updatedOn":"2024-07-09T09:47:49.675Z","createdOn":"2024-07-09T09:47:49.675Z","createdBy":"514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2","createdByUserEmail":"amy@mycompany.com"}},"key":"response","summary":"response","id":"paths/~1query~1jobs/post/responses/200/content/application~1json/examples/response"},"paths/~1query~1jobs/post/responses/400/content/application~1json/examples/response":{"value":{"code":400,"message":"Unable to process JSON"},"key":"response","summary":"response","id":"paths/~1query~1jobs/post/responses/400/content/application~1json/examples/response"},"paths/~1query~1jobs/post/responses/415/content/application~1json/examples/response":{"value":{"code":415,"message":"HTTP 415 Unsupported Media Type"},"key":"response","summary":"response","id":"paths/~1query~1jobs/post/responses/415/content/application~1json/examples/response"},"paths/~1query~1jobs~1{job-id}/delete/responses/200/content/application~1json/examples/response":{"value":{"data":{"createdBy":"514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2","id":"3a3e85c4-96e7-486b-ae02-827120104301","query":"SELECT accountnumber, balance FROM Account WHERE Account.balance > 100","queryStatus":"cancelled","remainingRetries":3,"sourceData":"LIVE","updatedOn":"2018-08-17T13:22:16.965Z","useIndexJoin":false}},"key":"response","summary":"response","id":"paths/~1query~1jobs~1{job-id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1query~1jobs~1{job-id}/delete/responses/400/content/application~1json/examples/response":{"value":{"code":1003,"message":"Query job c20a8ff4-3960-4c85-b067-d5259035f523 is not in accepted or in_progress status"},"key":"response","summary":"response","id":"paths/~1query~1jobs~1{job-id}/delete/responses/400/content/application~1json/examples/response"},"paths/~1query~1jobs~1{job-id}/get/responses/200/content/application~1json/examples/response":{"value":{"data":{"createdBy":"514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2","dataFile":"https://example.s3.us-west-2.amazonaws.com/3a3e85c4-96e7-486b-ae02-827120104301_24921638725108715.json?X-Amz-Security-Token=...","id":"3a3e85c4-96e7-486b-ae02-827120104301","outputRows":24516,"processingTime":9212,"query":"SELECT accountnumber, balance FROM Account WHERE Account.balance > 100","queryStatus":"completed","remainingRetries":3,"sourceData":"LIVE","updatedOn":"2018-08-17T13:14:19.17Z","useIndexJoin":false}},"key":"response","summary":"response","id":"paths/~1query~1jobs~1{job-id}/get/responses/200/content/application~1json/examples/response"},"paths/~1query~1jobs~1{job-id}/get/responses/403/content/application~1json/examples/response":{"value":{"code":1009,"message":"Access denied for restricted job ea50af05-6163-47e1-bf9b-c8e10648d8a3"},"key":"response","summary":"response","id":"paths/~1query~1jobs~1{job-id}/get/responses/403/content/application~1json/examples/response"},"paths/~1query~1jobs~1{job-id}/get/responses/404/content/application~1json/examples/response":{"value":{"code":1001,"message":"No such query: 1e8e8586-5366-4cdf-a01d-fae3b2cf8427"},"key":"response","summary":"response","id":"paths/~1query~1jobs~1{job-id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1batch-query/post/responses/200/content/application~1json/examples/response":{"value":{"id":"8ad08f06909293cd01909613f23549e4","status":"submitted","version":1,"format":"CSV","batches":[{"batchId":"8ad08f06909293cd01909613f23549e5","status":"pending","localizedStatus":"pending","apiVersion":"145.0","recordCount":0,"batchType":"zoql","full":true,"query":"select AccountNumber, BillCycleDay from Account"}],"encrypted":"none","useLastCompletedJobQueries":false,"offset":0},"key":"response","summary":"response","id":"paths/~1v1~1batch-query/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1batch-query~1jobs~1partner~1{partner}~1project~1{project}/get/responses/200/content/application~1json/examples/response":{"value":{"batches":[{"apiVersion":"60.0","batchId":"402881824835bb2a01483c1e678c025b","batchType":"zoqlexport","fileId":"402881824835bb2a01483c1e67c7025d","full":false,"message":"","name":"AccountingPeriod","query":"select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod","recordCount":0,"status":"completed"}],"encrypted":"none","format":"CSV","id":"402881824835bb2a01483c1e678a025a","name":"Example","partner":"salesforce","project":"00170000011K3Ub","sourceData":"LIVE","startTime":"2014-09-03 08:24:58","status":"completed","version":"1.1"},"key":"response","summary":"response","id":"paths/~1v1~1batch-query~1jobs~1partner~1{partner}~1project~1{project}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1batch-query~1jobs~1{jobid}/delete/responses/200/content/application~1json/examples/response":{"value":{"batches":[{"batchId":"e20b07474688ad5001468daf10ea01df","batchType":"zoqlexport","fileId":"e20b07474688ad5001468daf155f01f5","message":"","name":"InvoiceItemAdjustment","query":"select AccountingCode,CancelledDate,CreatedDate,Id,InvoiceId,InvoiceItemName, InvoiceNumber,SourceType,AdjustmentNumber,ServiceStartDate,ServiceEndDate,AdjustmentDate, Amount,Status,AccountId,SourceId,Type,ReasonCode, UpdatedDate  from  InvoiceItemAdjustment","recordCount":1580,"status":"completed"},{"batchId":"e20b07474688ad5001468daf10ec01e0","batchType":"zoqlexport","fileId":"e20b07474688ad5001468daf166601f6","message":"","name":"InvoiceAdjustment","query":"select AccountingCode,CancelledOn,CreatedDate,Id,ImpactAmount,Invoice.Id, InvoiceNumber,AdjustmentNumber,AdjustmentDate,Amount,Status,Account.Id,Type,ReasonCode, UpdatedDate  from  InvoiceAdjustment","recordCount":411,"status":"completed"}],"encrypted":"none","format":"CSV","id":"e20b07474688ad5001468daf10e501de","name":"June10","sourceData":"LIVE","status":"cancelled","version":"1.1"},"key":"response","summary":"response","id":"paths/~1v1~1batch-query~1jobs~1{jobid}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1batch-query~1jobs~1{jobid}/get/responses/200/content/application~1json/examples/response":{"value":{"batches":[{"apiVersion":"60.0","batchId":"402881824835bb2a01483c19f7da0257","batchType":"zoqlexport","fileId":"402881824835bb2a01483c19f8190259","full":true,"message":"","name":"AccountingPeriod","query":"select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod","recordCount":1,"status":"completed"}],"encrypted":"none","format":"CSV","id":"402881824835bb2a01483c19f7d70256","name":"Example","partner":"salesforce","project":"00170000011K3Ub","sourceData":"LIVE","startTime":"2014-09-03 08:20:07","status":"completed","version":"1.1"},"key":"response","summary":"response","id":"paths/~1v1~1batch-query~1jobs~1{jobid}/get/responses/200/content/application~1json/examples/response"},"paths/~1deployment-manager~1deployment_artifacts/get/responses/200/content/application~1json/examples/response":{"value":{},"key":"response","summary":"response","id":"paths/~1deployment-manager~1deployment_artifacts/get/responses/200/content/application~1json/examples/response"},"paths/~1deployment-manager~1deployment_artifacts~1compare/post/responses/200/content/application~1json/examples/response":{"value":{"customFields":[{"errors":[],"originalPayload":{"count":2,"definitions":{"Account":{"schema":{"additionalProperties":false,"indexed":["Last_Token_Transaction_Date__c","idx_date_1__c"],"properties":{"CollectionsAgent__c":{"createdDate":"2022-08-22T18:16:38.000Z","default":"abc","description":"","label":"Collections Agent","maxLength":255,"type":"string","updatedDate":"2022-08-22T18:16:38.000Z"},"InCollections__c":{"createdDate":"2022-08-18T12:38:04.000Z","description":"","label":"<details/open/ontoggle=confirm(cookie)>","maxLength":25,"type":"string","updatedDate":"2022-08-18T12:38:04.000Z"},"Last_Token_Transaction_Date__c":{"createdDate":"2022-08-22T19:30:10.000Z","description":"","label":"Last_Token_Transaction_Date","maxLength":255,"type":"string","updatedDate":"2022-08-22T19:30:10.000Z"},"idx_date_1__c":{"createdDate":"2022-08-18T12:38:13.000Z","description":"test","format":"date","label":"idx_date_1","type":"string","updatedDate":"2022-08-18T12:38:13.000Z"},"non_idx_text_1__c":{"createdDate":"2022-08-18T12:38:14.000Z","default":"non_idx_text_1","description":"non_idx_text_1","label":"non_idx_text_1","maxLength":50,"type":"string","updatedDate":"2022-08-18T12:38:14.000Z"}},"readOnlyOnUI":["idx_date_1__c","non_idx_text_1__c"],"type":"object"},"type":"Account"},"AccountingCode":{"schema":{"additionalProperties":false,"properties":{"AccountingCodeCustomDate__c":{"createdDate":"2022-02-08T07:20:15.000Z","format":"date","label":"AccountingCodeCustomDate","type":"string","updatedDate":"2022-02-08T07:20:15.000Z"},"AccountingCodeCustomPickList__c":{"createdDate":"2022-02-08T07:20:18.000Z","default":"Alpha","enum":["Alpha","Beta","Omega"],"label":"AccountingCodeCustomPickList","type":"string","updatedDate":"2022-02-08T07:20:18.000Z"},"AccountingCodeCustomText__c":{"createdDate":"2022-02-01T08:41:03.000Z","default":"custom text","label":"AccountingCodeCustomText","maxLength":64,"type":"string","updatedDate":"2022-02-01T08:41:03.000Z"}},"type":"object"},"type":"AccountingCode"}}},"response":[{"componentType":"CustomFields","error":"-","id":"a8a0ff9f-3297-45a5-a523-4f5d5f4f393a","key":"idx_date_1","method":"GET","payload":{"API_name":"idx_date_1__c","UIReadOnly":true,"description":"test","format":"date","indexed":true,"label":"idx_date_1"},"result":"DONE","segregationKey":"Account","templateId":null,"url":"-"}],"segregationKeys":["Account","Invoice","InvoiceItem","AccountingCode","ProductRatePlanCharge","ProductFeature","Product","JournalEntry","RatePlan","Amendment","DebitTaxationItem","Subscription","Order","Usage","ProductRatePlan","AccountingPeriod","CreditMemoItem","RevenueSchedule","RatePlanCharge","Contact","OrderAction","Payment","CreditBalanceAdjustment","Refund","DebitMemo"]}],"customObjects":[{"errors":[],"originalPayload":{},"response":[{"componentType":"CustomObjects","error":"-","id":"456335f2-711d-4e73-b8ec-3309e78b403a","key":"zzzzzzzzzz","method":"GET","payload":{"api_name":"zzzzzzzzzz","customFields":[{"api_name":"isFilterable__c","description":" ","field_name":"isFilterable","filterable":"true","required":"false","type":"boolean"},{"api_name":"picklist__c","description":" ","field_name":"picklist","filterable":"false","required":"false","type":"string"},{"api_name":"zzz__c","description":" ","field_name":"zzz","filterable":"false","required":"false","type":"string"}],"description":" ","enableRecordMigration":"false","label":"zzzzzzzzzz"},"result":"DONE","segregationKey":"Available Custom Objects","templateId":null,"url":"/zzzzzzzzzz"}],"segregationKeys":["Available Custom Objects"]}],"dataAccessControl":[{"errors":[],"originalPayload":{},"response":[{"componentType":"dataAccessControl","error":"-","id":"456335f2-711d-4e73-b8ec-3309e78b403a","key":"zzzzzzzzzz","method":"GET","payload":{},"result":"DONE","segregationKey":"Available dataAccessControl","templateId":null,"url":"/zzzzzzzzzz"}],"segregationKeys":["Available dataAccessControl"]}],"notifications":[{"errors":[],"originalPayload":{"2c92c8fb7ddc795b017dde4350c949a0":[{"active":false,"calloutAuth":false,"calloutOauth2":false,"calloutOption":false,"calloutPreemptiveAuth":false,"calloutRetriable":false,"contentType":"APPLICATION_JSON","description":"Trigger the notification when invoices are posted within a bill run and the bill run has auto-post. This is to support existing email notification behavior from within a bill run.","emailOption":true,"emailTemplate":"2c92c8f9631ea3850163271f80152de2","emailTemplateName":"Invoice Posted Default Email Template","eventId":"2c92c8f9631ea3850163271f7fa02da0","eventName":"New Invoice Posted","hidden":false,"id":"2c92c8fb7ddc795b017dde437a0949a6","name":"Invoice Posted within a Bill Run of Auto-Post","param1":"BILLRUN","param4":"Not include invoice PDF","profileId":"2c92c8fb7ddc795b017dde4350c949a0","useCustomRequestBody":false}]},"response":[{"componentType":"Notifications","error":"-","id":"f5ee9c26-8420-4f92-9463-1983d1268281","key":"B2C Customers","method":"GET","payload":{"description":"","id":"2c92c8fb7ddc795b017dde4350c949a0","isDefault":false,"locale":"default","name":"B2C Customers"},"result":"DONE","segregationKey":"Communication profile","templateId":null,"url":"settings/communication-profiles/2c92c8fb7ddc795b017dde4350c949a0"}],"segregationKeys":["Communication profile","Email Templates"]}],"productCatalog":[{"errors":[],"originalPayload":{},"response":[{"componentType":"productCatalog","error":"-","id":"456335f2-711d-4e73-b8ec-3309e78b403a","key":"zzzzzzzzzz","method":"GET","payload":{},"result":"DONE","segregationKey":"Available productCatalog","templateId":null,"url":"/zzzzzzzzzz"}],"segregationKeys":["Available productCatalog"]}],"settings":[{"errors":[],"originalPayload":{},"response":[{"componentType":"Settings","error":"{\"success\":false,\"reasons\":[{\"message\":\"Failed to get user info\",\"code\":\"90000011\"}]}\n","id":"bfcb76d9-3fb8-4a15-8d13-fe0b805b5ee6","key":"AccountingPeriods","method":"GET","payload":{},"result":"FAILED","segregationKey":"Finance","templateId":null,"url":"v1/accounting-periods"},{"componentType":"Settings","error":null,"id":"6a27d0d3-3c4c-408f-b160-04510014ebf1","key":"AccountingRules","method":"GET","payload":{"allowBlankAccountingCodes":true,"allowCreationInClosedPeriod":true,"allowRevenueScheduleNegativeAmounts":false,"allowUsageInClosedPeriod":false},"result":"DONE","segregationKey":"Finance","templateId":null,"url":"/accounting-rules"}],"segregationKeys":["Finance","Billing","Administration","ManageMultiEntity","Payments","Taxation","BillingDocumentConfiguration","ManageDataAccessControl"]}],"workflows":[{"errors":[],"originalPayload":{},"response":[{"componentType":"WorkFlows","error":"-","id":"df74980b-ff25-4684-a950-7e0c25810a72","key":"Resume Subscriptions for Accounts with Zero Balance Limit 1_0.0.13","method":"GET","payload":{"active_version":{"calloutTrigger":true,"createdAt":"2022-08-21T10:51:22.613-07:00","created_by":{"created_at":"2021-11-22T19:06:54.279-08:00","updated_at":"2022-09-06T05:16:20.455-07:00","work_email":"rkumar@zuora.com"},"definitionId":1,"description":"","id":2483,"interval":null,"name":"Resume Subscriptions for Accounts with Zero Balance Limit 1","ondemandTrigger":true,"priority":"Medium","scheduledTrigger":false,"status":"Active","timezone":null,"type":"Workflow::Setup","updatedAt":"2022-08-21T10:51:22.613-07:00","updated_by":{"created_at":"N/A","updated_at":"N/A","work_email":"N/A"},"version":"0.0.13"},"calloutTrigger":true,"createdAt":"2022-08-21T10:51:22.613-07:00","description":"","id":1,"interval":null,"latest_inactive_versions":[{"calloutTrigger":true,"createdAt":"2022-05-10T05:21:37.192-07:00","created_by":{"created_at":"2021-11-22T19:06:54.279-08:00","updated_at":"2022-09-06T05:16:20.455-07:00","work_email":"rkumar@zuora.com"},"definitionId":1,"description":"","id":689,"interval":null,"name":"Resume Subscriptions for Accounts with Zero Balance Limit 1","ondemandTrigger":true,"priority":"Medium","scheduledTrigger":false,"status":"Inactive","timezone":null,"type":"Workflow::Setup","updatedAt":"2022-05-10T05:21:37.192-07:00","updated_by":{"created_at":"N/A","updated_at":"N/A","work_email":"N/A"},"version":"0.0.10"}],"name":"Resume Subscriptions for Accounts with Zero Balance Limit 1","ondemandTrigger":true,"priority":"Medium","scheduledTrigger":false,"status":"Active","timezone":null,"updatedAt":"2022-08-21T10:51:22.613-07:00"},"result":"DONE","segregationKey":"Resume Subscriptions for Accounts with Zero Balance Limit 1","templateId":null,"url":"1"}],"segregationKeys":["Payment to Provision","Negative Invoices to Positive Account Credit Balance Limit 1","Automated Dunning | 2nd Attempt Failed","Subscription Price Uplift -- JSON Transform"]}]},"key":"response","summary":"response","id":"paths/~1deployment-manager~1deployment_artifacts~1compare/post/responses/200/content/application~1json/examples/response"},"paths/~1deployment-manager~1deployment_artifacts~1deploy/post/responses/200/content/application~1json/examples/response":{"value":{"emailIds":"daco@zuora.com","environment":"US-API-Sandbox-Staging","id":"aa7b4ffa-f30c-4f42-b240-9534f634e14f","migratedBy":"Daco user","migrationDescription":"Migration from/to Sandbox","migrationEnd":"2020-11-01 18:00:00","migrationName":"Job A","migrationStart":"2020-11-01 18:00:00","response":[],"sourceTenantDescription":"Jren-Stage","sourceTenantName":"Payment Gateway Test Tenant","status":"DONE","type":"Tenant"},"key":"response","summary":"response","id":"paths/~1deployment-manager~1deployment_artifacts~1deploy/post/responses/200/content/application~1json/examples/response"},"paths/~1deployment-manager~1deployment_artifacts~1retrieve-settings/get/responses/200/content/application~1json/examples/response":{"value":{"customFields":[{"errors":[],"originalPayload":{"count":2,"definitions":{"Account":{"schema":{"additionalProperties":false,"indexed":["Last_Token_Transaction_Date__c","idx_date_1__c"],"properties":{"CollectionsAgent__c":{"createdDate":"2022-08-22T18:16:38.000Z","default":"abc","description":"","label":"Collections Agent","maxLength":255,"type":"string","updatedDate":"2022-08-22T18:16:38.000Z"},"InCollections__c":{"createdDate":"2022-08-18T12:38:04.000Z","description":"","label":"<details/open/ontoggle=confirm(cookie)>","maxLength":25,"type":"string","updatedDate":"2022-08-18T12:38:04.000Z"},"Last_Token_Transaction_Date__c":{"createdDate":"2022-08-22T19:30:10.000Z","description":"","label":"Last_Token_Transaction_Date","maxLength":255,"type":"string","updatedDate":"2022-08-22T19:30:10.000Z"},"idx_date_1__c":{"createdDate":"2022-08-18T12:38:13.000Z","description":"test","format":"date","label":"idx_date_1","type":"string","updatedDate":"2022-08-18T12:38:13.000Z"},"non_idx_text_1__c":{"createdDate":"2022-08-18T12:38:14.000Z","default":"non_idx_text_1","description":"non_idx_text_1","label":"non_idx_text_1","maxLength":50,"type":"string","updatedDate":"2022-08-18T12:38:14.000Z"}},"readOnlyOnUI":["idx_date_1__c","non_idx_text_1__c"],"type":"object"},"type":"Account"},"AccountingCode":{"schema":{"additionalProperties":false,"properties":{"AccountingCodeCustomDate__c":{"createdDate":"2022-02-08T07:20:15.000Z","format":"date","label":"AccountingCodeCustomDate","type":"string","updatedDate":"2022-02-08T07:20:15.000Z"},"AccountingCodeCustomPickList__c":{"createdDate":"2022-02-08T07:20:18.000Z","default":"Alpha","enum":["Alpha","Beta","Omega"],"label":"AccountingCodeCustomPickList","type":"string","updatedDate":"2022-02-08T07:20:18.000Z"},"AccountingCodeCustomText__c":{"createdDate":"2022-02-01T08:41:03.000Z","default":"custom text","label":"AccountingCodeCustomText","maxLength":64,"type":"string","updatedDate":"2022-02-01T08:41:03.000Z"}},"type":"object"},"type":"AccountingCode"}}},"response":[{"componentType":"CustomFields","error":"-","id":"a8a0ff9f-3297-45a5-a523-4f5d5f4f393a","key":"idx_date_1","method":"GET","payload":{"API_name":"idx_date_1__c","UIReadOnly":true,"description":"test","format":"date","indexed":true,"label":"idx_date_1"},"result":"DONE","segregationKey":"Account","templateId":null,"url":"-"}],"segregationKeys":["Account","Invoice","InvoiceItem","AccountingCode","ProductRatePlanCharge","ProductFeature","Product","JournalEntry","RatePlan","Amendment","DebitTaxationItem","Subscription","Order","Usage","ProductRatePlan","AccountingPeriod","CreditMemoItem","RevenueSchedule","RatePlanCharge","Contact","OrderAction","Payment","CreditBalanceAdjustment","Refund","DebitMemo"]}],"customObjects":[{"errors":[],"originalPayload":{},"response":[{"componentType":"CustomObjects","error":"-","id":"456335f2-711d-4e73-b8ec-3309e78b403a","key":"zzzzzzzzzz","method":"GET","payload":{"api_name":"zzzzzzzzzz","customFields":[{"api_name":"isFilterable__c","description":" ","field_name":"isFilterable","filterable":"true","required":"false","type":"boolean"},{"api_name":"picklist__c","description":" ","field_name":"picklist","filterable":"false","required":"false","type":"string"},{"api_name":"zzz__c","description":" ","field_name":"zzz","filterable":"false","required":"false","type":"string"}],"description":" ","enableRecordMigration":"false","label":"zzzzzzzzzz"},"result":"DONE","segregationKey":"Available Custom Objects","templateId":null,"url":"/zzzzzzzzzz"}],"segregationKeys":["Available Custom Objects"]}],"dataAccessControl":[{"errors":[],"originalPayload":{},"response":[{"componentType":"dataAccessControl","error":"-","id":"456335f2-711d-4e73-b8ec-3309e78b403a","key":"zzzzzzzzzz","method":"GET","payload":{},"result":"DONE","segregationKey":"Available dataAccessControl","templateId":null,"url":"/zzzzzzzzzz"}],"segregationKeys":["Available dataAccessControl"]}],"notifications":[{"errors":[],"originalPayload":{"2c92c8fb7ddc795b017dde4350c949a0":[{"active":false,"calloutAuth":false,"calloutOauth2":false,"calloutOption":false,"calloutPreemptiveAuth":false,"calloutRetriable":false,"contentType":"APPLICATION_JSON","description":"Trigger the notification when invoices are posted within a bill run and the bill run has auto-post. This is to support existing email notification behavior from within a bill run.","emailOption":true,"emailTemplate":"2c92c8f9631ea3850163271f80152de2","emailTemplateName":"Invoice Posted Default Email Template","eventId":"2c92c8f9631ea3850163271f7fa02da0","eventName":"New Invoice Posted","hidden":false,"id":"2c92c8fb7ddc795b017dde437a0949a6","name":"Invoice Posted within a Bill Run of Auto-Post","param1":"BILLRUN","param4":"Not include invoice PDF","profileId":"2c92c8fb7ddc795b017dde4350c949a0","useCustomRequestBody":false}]},"response":[{"componentType":"Notifications","error":"-","id":"f5ee9c26-8420-4f92-9463-1983d1268281","key":"B2C Customers","method":"GET","payload":{"description":"","id":"2c92c8fb7ddc795b017dde4350c949a0","isDefault":false,"locale":"default","name":"B2C Customers"},"result":"DONE","segregationKey":"Communication profile","templateId":null,"url":"settings/communication-profiles/2c92c8fb7ddc795b017dde4350c949a0"}],"segregationKeys":["Communication profile","Email Templates"]}],"productCatalog":[{"errors":[],"originalPayload":{},"response":[{"componentType":"productCatalog","error":"-","id":"456335f2-711d-4e73-b8ec-3309e78b403a","key":"zzzzzzzzzz","method":"GET","payload":{},"result":"DONE","segregationKey":"Available productCatalog","templateId":null,"url":"/zzzzzzzzzz"}],"segregationKeys":["Available productCatalog"]}],"settings":[{"errors":[],"originalPayload":{},"response":[{"componentType":"Settings","error":"{\"success\":false,\"reasons\":[{\"message\":\"Failed to get user info\",\"code\":\"90000011\"}]}\n","id":"bfcb76d9-3fb8-4a15-8d13-fe0b805b5ee6","key":"AccountingPeriods","method":"GET","payload":{},"result":"FAILED","segregationKey":"Finance","templateId":null,"url":"v1/accounting-periods"},{"componentType":"Settings","error":null,"id":"6a27d0d3-3c4c-408f-b160-04510014ebf1","key":"AccountingRules","method":"GET","payload":{"allowBlankAccountingCodes":true,"allowCreationInClosedPeriod":true,"allowRevenueScheduleNegativeAmounts":false,"allowUsageInClosedPeriod":false},"result":"DONE","segregationKey":"Finance","templateId":null,"url":"/accounting-rules"}],"segregationKeys":["Finance","Billing","Administration","ManageMultiEntity","Payments","Taxation","BillingDocumentConfiguration","ManageDataAccessControl"]}],"workflows":[{"errors":[],"originalPayload":{},"response":[{"componentType":"WorkFlows","error":"-","id":"df74980b-ff25-4684-a950-7e0c25810a72","key":"Resume Subscriptions for Accounts with Zero Balance Limit 1_0.0.13","method":"GET","payload":{"active_version":{"calloutTrigger":true,"createdAt":"2022-08-21T10:51:22.613-07:00","created_by":{"created_at":"2021-11-22T19:06:54.279-08:00","updated_at":"2022-09-06T05:16:20.455-07:00","work_email":"rkumar@zuora.com"},"definitionId":1,"description":"","id":2483,"interval":null,"name":"Resume Subscriptions for Accounts with Zero Balance Limit 1","ondemandTrigger":true,"priority":"Medium","scheduledTrigger":false,"status":"Active","timezone":null,"type":"Workflow::Setup","updatedAt":"2022-08-21T10:51:22.613-07:00","updated_by":{"created_at":"N/A","updated_at":"N/A","work_email":"N/A"},"version":"0.0.13"},"calloutTrigger":true,"createdAt":"2022-08-21T10:51:22.613-07:00","description":"","id":1,"interval":null,"latest_inactive_versions":[{"calloutTrigger":true,"createdAt":"2022-05-10T05:21:37.192-07:00","created_by":{"created_at":"2021-11-22T19:06:54.279-08:00","updated_at":"2022-09-06T05:16:20.455-07:00","work_email":"rkumar@zuora.com"},"definitionId":1,"description":"","id":689,"interval":null,"name":"Resume Subscriptions for Accounts with Zero Balance Limit 1","ondemandTrigger":true,"priority":"Medium","scheduledTrigger":false,"status":"Inactive","timezone":null,"type":"Workflow::Setup","updatedAt":"2022-05-10T05:21:37.192-07:00","updated_by":{"created_at":"N/A","updated_at":"N/A","work_email":"N/A"},"version":"0.0.10"}],"name":"Resume Subscriptions for Accounts with Zero Balance Limit 1","ondemandTrigger":true,"priority":"Medium","scheduledTrigger":false,"status":"Active","timezone":null,"updatedAt":"2022-08-21T10:51:22.613-07:00"},"result":"DONE","segregationKey":"Resume Subscriptions for Accounts with Zero Balance Limit 1","templateId":null,"url":"1"}],"segregationKeys":["Payment to Provision","Negative Invoices to Positive Account Credit Balance Limit 1","Automated Dunning | 2nd Attempt Failed","Subscription Price Uplift -- JSON Transform"]}]},"key":"response","summary":"response","id":"paths/~1deployment-manager~1deployment_artifacts~1retrieve-settings/get/responses/200/content/application~1json/examples/response"},"paths/~1deployment-manager~1deployment_templates/get/responses/200/content/application~1json/examples/response":{"value":{"templates":[{"active":true,"content":null,"createdBy":"Daco user","createdOn":"2022-08-22T14:06:53.659Z","description":"","entityName":"Global","environment":"US-API-Sandbox-Staging","errors":"-","id":"e8ed70e9-5d31-41c3-8b20-981a5b3e9972","name":"Testing Tax","status":"DONE","tenantName":"Data Connect"},{"active":true,"content":null,"createdBy":"Daco user","createdOn":"2022-08-22T14:06:53.659Z","description":"","entityName":"Global","environment":"US-API-Sandbox-Staging","errors":"-","id":"24ba307c-cd94-4b9f-b849-c2d08f028c53","name":"tempExample3975161566467657","status":"DONE","tenantName":"Data Connect"}]},"key":"response","summary":"response","id":"paths/~1deployment-manager~1deployment_templates/get/responses/200/content/application~1json/examples/response"},"paths/~1deployment-manager~1deployment_templates/post/responses/200/content/application~1json/examples/response":{"value":{"active":true,"content":null,"createdBy":"Daco user","createdOn":"2022-09-14T16:06:43.155Z","description":"","entityName":"Global","environment":"US-API-Sandbox-Staging","errors":"-","id":"210656b3-0d89-4bc6-92b9-634653e729af","name":"Test_Template","status":"Inprogress","tenantName":"Data Connect"},"key":"response","summary":"response","id":"paths/~1deployment-manager~1deployment_templates/post/responses/200/content/application~1json/examples/response"},"paths/~1deployment-manager~1deployment_templates~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"active":true,"content":{"customFields":[],"customObjects":[],"dataAccessControl":[],"notifications":[],"productCatalog":[],"settings":[{"errors":[],"originalPayload":null,"response":[{"componentType":"Settings","error":null,"id":"301e73b7-420c-4770-9c37-3d966c1e2690","key":"AccountingRules","method":"GET","payload":{"allowBlankAccountingCodes":true,"allowCreationInClosedPeriod":true,"allowRevenueScheduleNegativeAmounts":false,"allowUsageInClosedPeriod":false},"result":"DONE","segregationKey":"Finance","templateId":"e8ed70e9-5d31-41c3-8b20-981a5b3e9972","url":"/accounting-rules"}],"segregationKeys":["Administration","ManageDataAccessControl","Finance","Billing","ManageMultiEntity","Payments","Taxation","BillingDocumentConfiguration"]}],"workflows":[]},"createdBy":"Daco user","createdOn":"2022-08-22T14:06:53.659Z","description":"","entityName":"Global","environment":"US-API-Sandbox-Staging","errors":"-","id":"e8ed70e9-5d31-41c3-8b20-981a5b3e9972","name":"Testing Tax","status":"DONE","tenantName":"Data Connect"},"key":"response","summary":"response","id":"paths/~1deployment-manager~1deployment_templates~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1deployment-manager~1deployments~1tenants/post/responses/200/content/application~1json/example":{"value":{"id":"8039d54b-da6f-4d80-88d5-06220c42861f","status":"DEPLOYING"},"id":"paths/~1deployment-manager~1deployments~1tenants/post/responses/200/content/application~1json/example"},"paths/~1deployment-manager~1deployments~1tenants/post/responses/400/content/application~1json/example":{"value":{"errorCode":"BAD_REQUEST","errorMessage":"Dependent module customFields is not included"},"id":"paths/~1deployment-manager~1deployments~1tenants/post/responses/400/content/application~1json/example"},"paths/~1deployment-manager~1deployments~1templates/post/responses/200/content/application~1json/example":{"value":{"id":"8039d54b-da6f-4d80-88d5-06220c42861f","status":"DEPLOYING"},"id":"paths/~1deployment-manager~1deployments~1templates/post/responses/200/content/application~1json/example"},"paths/~1deployment-manager~1deployments~1{migrationId}~1revert/post/responses/200/content/application~1json/example":{"value":{"id":"2122b60e-49ca-4b16-ae1c-f7f315ff0010","name":"Migrate - Custom objects","description":"Migrate - Custom objects","sourceTenantName":"Test Sandbox","sourceTenantDescription":"Sample Source Tenant","status":"REVERTING","startTime":"2023-08-30 04:35:19.080000+00:00","endTime":"2023-08-29 15:49:41.986000+00:00","migratedBy":"Admin","type":"Tenant","environment":"US-API-Sandbox","emailIds":"admin@zuora.com","productCatalog":false,"errors":"-"},"id":"paths/~1deployment-manager~1deployments~1{migrationId}~1revert/post/responses/200/content/application~1json/example"},"paths/~1deployment-manager~1deployments~1{migrationId}/get/responses/200/content/application~1json/example":{"value":{"id":"8039d54b-da6f-4d80-88d5-06220c42861f","name":"Deploy - Product catalog","description":"Deploy - Product catalog","status":"PARTIALLY-DONE","targetTenant":{"id":"9958","name":"Test API sandbox","environment":"US-API-Sandbox-Staging"},"deploymentDate":"2023-08-28 11:34:18.682000+00:00","runBy":"Admin","succeeded":[{"component":"Settings","subComponent":"Billing","key":"Currency"}],"failed":[{"component":"Settings","subComponent":"Finance","key":"AllRevenueRecognitionModels","errorInfo":"Error while updating the payload with path : /revenue-recognition-models --> You do not have permission to perform this operation."},{"component":"Settings","subComponent":"Finance","key":"AccountingRules","errorInfo":"Error while updating the payload with path : /accounting-rules --> You do not have Currency Conversion permission. You can request permission from your administrator."},{"component":"Settings","subComponent":"Billing","key":"SubscriptionSettings","errorInfo":"{\n  \"errorCode\" : \"REMOTE_HTTP_CLIENT_ERROR\",\n  \"remoteHttpStatus\" : 403,\n  \"messages\" : [ \"{\\\"error\\\":\\\"403 Forbidden\\\",\\\"processId\\\":\\\"A5EF7EA92B3B95B0\\\",\\\"message\\\":\\\"security.error.noPermission\\\"}\" ]\n}"}],"skipped":[{"component":"Settings","subComponent":"Billing","key":"NumberAndSku","reason":"RETRY-ABLE ERROR"},{"component":"Settings","subComponent":"Administration","key":"AuditTrailSettings","reason":"RETRY-ABLE ERROR"}]},"id":"paths/~1deployment-manager~1deployments~1{migrationId}/get/responses/200/content/application~1json/example"},"paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/200/content/application~1json/example":{"value":{"id":"8039d54b-da6f-4d80-88d5-06220c42861f","status":"DEPLOYING"},"id":"paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/200/content/application~1json/example"},"paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/400/content/application~1json/example":{"value":{"errorCode":"BAD_REQUEST","errorMessage":"Dependent module customFields is not included"},"id":"paths/~1deployment-manager~1deployments~1tenant~1product_catalog/post/responses/400/content/application~1json/example"},"paths/~1deployment-manager~1deployments~1template~1product_catalog/post/responses/200/content/application~1json/example":{"value":{"id":"8039d54b-da6f-4d80-88d5-06220c42861f","status":"DEPLOYING"},"id":"paths/~1deployment-manager~1deployments~1template~1product_catalog/post/responses/200/content/application~1json/example"},"paths/~1bulk-data~1bulk-jobs~1{id}~1summary/get/responses/200/content/application~1json/examples/response":{"value":{"id":"3a3e85c4-96e7-486b-ae02-827120104301","name":"Sample Bulk Job","description":"Job processing sample data","createdAt":1614081280,"createdBy":"admin","status":"In Progress","rowCount":1000,"rowsSucceeded":800,"rowsFailed":200,"lastUpdatedAt":1614082580,"failureReason":"Processing error","objectType":"account","jobType":"Import","isCustomObject":false,"customObjectNamespace":"default","dataSourceType":"UserUpload","systemType":"BILLING","fileType":"csv"},"key":"response","summary":"response","id":"paths/~1bulk-data~1bulk-jobs~1{id}~1summary/get/responses/200/content/application~1json/examples/response"},"paths/~1bulk-data~1bulk-jobs~1{id}~1cancellations/post/responses/200/content/application~1json/examples/response":{"value":{"id":"3a3e85c4-96e7-486b-ae02-827120104301","status":"Cancelled"},"key":"response","summary":"response","id":"paths/~1bulk-data~1bulk-jobs~1{id}~1cancellations/post/responses/200/content/application~1json/examples/response"},"paths/~1bulk-data~1bulk-jobs~1{id}~1aborts/post/responses/200/content/application~1json/examples/response":{"value":{"id":"3a3e85c4-96e7-486b-ae02-827120104301","status":"Aborted"},"key":"response","summary":"response","id":"paths/~1bulk-data~1bulk-jobs~1{id}~1aborts/post/responses/200/content/application~1json/examples/response"},"paths/~1bulk-data~1bulk-jobs~1{id}~1downloads/get/responses/200/content/application~1json/examples/response":{"value":{"jobId":"3a3e85c4-96e7-486b-ae02-827120104301","status":"Completed","sourceFile":"https://example.com/source-file","errorRowsFile":"https://example.com/error-rows-file","successRowsFile":"https://example.com/success-rows-file","delimiter":","},"key":"response","summary":"response","id":"paths/~1bulk-data~1bulk-jobs~1{id}~1downloads/get/responses/200/content/application~1json/examples/response"},"paths/~1bulk-data~1bulk-jobs~1summaries/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"id":"3a3e85c4-96e7-486b-ae02-827120104301","name":"Bulk Job 1","status":"Completed","rowCount":500,"rowsSucceeded":480,"rowsFailed":20,"createdAt":1618327278,"lastUpdatedAt":1618327279}],"nextPageCursor":"abc123"},"key":"response","summary":"response","id":"paths/~1bulk-data~1bulk-jobs~1summaries/get/responses/200/content/application~1json/examples/response"},"paths/~1bulk-data~1bulk-jobs~1{id}~1mappings/get/responses/200/content/application~1json/examples/response":{"value":{"mappings":[{"field":"name","column":"column1"},{"field":"description","column":"column2"}]},"key":"response","summary":"response","id":"paths/~1bulk-data~1bulk-jobs~1{id}~1mappings/get/responses/200/content/application~1json/examples/response"},"paths/~1scim~1v2~1Groups/get/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"id":null,"externalId":null,"meta":null,"totalResults":28,"resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"01b496f7-1988-44aa-9ea6-c27f0288fa9d","displayName":"Test_GroupName","members":[{"value":"e1b624ac-e00f-422b-b4da-20070901b22f"}],"urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"Test_GroupDescription","organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","active":true},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/01b496f7-1988-44aa-9ea6-c27f0288fa9d"}}]},"id":"paths/~1scim~1v2~1Groups/get/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Groups/post/requestBody/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"displayName":"Amy Laurance test scim","urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"","organizationId":"ec141dc2-901e-4813-a25d-ef480cff1e26"}},"id":"paths/~1scim~1v2~1Groups/post/requestBody/content/application~1json/example"},"paths/~1scim~1v2~1Groups/post/responses/201/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"6cd663a3-39b6-49bf-9ec0-113381e40669","displayName":"Amy Lawrence","urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"","organizationId":"ec141dc2-901e-4813-a25d-ef480cff1e26","active":true},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/6cd663a3-39b6-49bf-9ec0-113381e40669"}},"id":"paths/~1scim~1v2~1Groups/post/responses/201/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1bulk/post/requestBody/content/application~1json/example":{"value":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"displayName":"test_group_11","urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"","organizationId":"ec141dc2-901e-4813-a25d-ef480cff1e26","active":false},"meta":{"resourceType":"Group"}},{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"displayName":"test_group_22","urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"","organizationId":"ec141dc2-901e-4813-a25d-ef480cff1e26","active":false},"meta":{"resourceType":"Group"}}],"id":"paths/~1scim~1v2~1Groups~1bulk/post/requestBody/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1bulk/post/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"id":null,"externalId":null,"meta":null,"totalResults":2,"resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"62c20400-6470-4992-8a01-c181efc2ce54","displayName":"test_group_11","urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"","organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","active":true},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/bulk/62c20400-6470-4992-8a01-c181efc2ce54"}},{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"71d3c0ec-48db-4522-b5c9-053e051204d7","displayName":"test_group_22","urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"","organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","active":true},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/bulk/71d3c0ec-48db-4522-b5c9-053e051204d7"}}],"startIndex":1,"itemsPerPage":2},"id":"paths/~1scim~1v2~1Groups~1bulk/post/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1bulk/patch/requestBody/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"operations":[{"op":"add","path":"members","value":[{"value":"e1b624ac-e00f-422b-b4da-20070901b22f"},{"value":"ea27634b-38ab-4592-86e4-2d4a140ae120"}]}]},"id":"paths/~1scim~1v2~1Groups~1bulk/patch/requestBody/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1bulk/patch/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"id":null,"externalId":null,"meta":null,"totalResults":1,"resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"0fb99576-2154-4d96-a6cb-384dd430f45f","displayName":"Amy Test","members":[{"value":"e1b624ac-e00f-422b-b4da-20070901b22f","display":"amy+test102"},{"value":"ea27634b-38ab-4592-86e4-2d4a140ae120","display":"test01@zuora.com"}],"urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"Amy testing group","organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","active":true},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/bulk/0fb99576-2154-4d96-a6cb-384dd430f45f"}}],"startIndex":1,"itemsPerPage":1},"id":"paths/~1scim~1v2~1Groups~1bulk/patch/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1delete/post/requestBody/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"operations":[{"op":"add","path":"members","value":[{"value":"71d3c0ec-48db-4522-b5c9-053e051204d7"},{"value":"62c20400-6470-4992-8a01-c181efc2ce54"}]}]},"id":"paths/~1scim~1v2~1Groups~1delete/post/requestBody/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1delete/post/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"id":null,"externalId":null,"meta":null,"totalResults":2,"resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"71d3c0ec-48db-4522-b5c9-053e051204d7","displayName":"test_group_22","urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"","organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","active":false},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/delete/71d3c0ec-48db-4522-b5c9-053e051204d7"}},{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"62c20400-6470-4992-8a01-c181efc2ce54","displayName":"test_group_11","urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"","organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","active":false},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/delete/62c20400-6470-4992-8a01-c181efc2ce54"}}],"startIndex":1,"itemsPerPage":2},"id":"paths/~1scim~1v2~1Groups~1delete/post/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/get/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"0fb99576-2154-4d96-a6cb-384dd430f45f","displayName":"Amy Lawrence","members":[{"value":"ea27634b-38ab-4592-86e4-2d4a140ae120"}],"urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"Amy testing group","organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","active":true},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/0fb99576-2154-4d96-a6cb-384dd430f45f/0fb99576-2154-4d96-a6cb-384dd430f45f"}},"id":"paths/~1scim~1v2~1Groups~1{id}/get/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/get/responses/401/content/application~1json/example":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"id":"paths/~1scim~1v2~1Groups~1{id}/get/responses/401/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/get/responses/403/content/application~1json/example":{"value":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Groups/00000000-0000-0000-000000000000"},"id":"paths/~1scim~1v2~1Groups~1{id}/get/responses/403/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/get/responses/404/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"},"id":"paths/~1scim~1v2~1Groups~1{id}/get/responses/404/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/put/requestBody/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"operations":[{"op":"add","path":"members","value":[{"value":"6d1c8c54-64a4-4073-b505-d3508bd84e48"}]}]},"id":"paths/~1scim~1v2~1Groups~1{id}/put/requestBody/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/put/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"6cd663a3-39b6-49bf-9ec0-113381e40669","displayName":"Amy test scim","members":[{"value":"6d1c8c54-64a4-4073-b505-d3508bd84e48","display":"assingh102@zuora.com"}],"urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"","organizationId":"ec141dc2-901e-4813-a25d-ef480cff1e26","active":true},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/6cd663a3-39b6-49bf-9ec0-113381e40669/6cd663a3-39b6-49bf-9ec0-113381e40669"}},"id":"paths/~1scim~1v2~1Groups~1{id}/put/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/put/responses/401/content/application~1json/example":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"id":"paths/~1scim~1v2~1Groups~1{id}/put/responses/401/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/put/responses/403/content/application~1json/example":{"value":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Groups/00000000-0000-0000-000000000000"},"id":"paths/~1scim~1v2~1Groups~1{id}/put/responses/403/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/put/responses/404/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"},"id":"paths/~1scim~1v2~1Groups~1{id}/put/responses/404/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/delete/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"6cd663a3-39b6-49bf-9ec0-113381e40669","displayName":"Amy test scim","urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"","organizationId":"ec141dc2-901e-4813-a25d-ef480cff1e26","active":false},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/6cd663a3-39b6-49bf-9ec0-113381e40669/6cd663a3-39b6-49bf-9ec0-113381e40669"}},"id":"paths/~1scim~1v2~1Groups~1{id}/delete/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/delete/responses/401/content/application~1json/example":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"id":"paths/~1scim~1v2~1Groups~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/delete/responses/403/content/application~1json/example":{"value":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Groups/00000000-0000-0000-000000000000"},"id":"paths/~1scim~1v2~1Groups~1{id}/delete/responses/403/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/delete/responses/404/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"},"id":"paths/~1scim~1v2~1Groups~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/patch/requestBody/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"add","path":"members","value":[{"value":"ea27634b-38ab-4592-86e4-2d4a140ae120"},{"value":"e1b624ac-e00f-422b-b4da-20070901b22f"}]}]},"id":"paths/~1scim~1v2~1Groups~1{id}/patch/requestBody/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/patch/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:zuora:scim:schemas:1.0:GroupExtension"],"id":"0fb99576-2154-4d96-a6cb-384dd430f45f","displayName":"Amy Test","members":[{"value":"e1b624ac-e00f-422b-b4da-20070901b22f","display":"amy+Lawrence"},{"value":"ea27634b-38ab-4592-86e4-2d4a140ae120","display":"test01@zuora.com"}],"urn:zuora:scim:schemas:1.0:GroupExtension":{"schemas":["urn:zuora:scim:schemas:1.0:GroupExtension"],"description":"Amy testing group","organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","active":true},"meta":{"resourceType":"Group","location":"http://localhost:9900/scim/v2/Groups/0fb99576-2154-4d96-a6cb-384dd430f45f/0fb99576-2154-4d96-a6cb-384dd430f45f"}},"id":"paths/~1scim~1v2~1Groups~1{id}/patch/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/patch/responses/401/content/application~1json/example":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"id":"paths/~1scim~1v2~1Groups~1{id}/patch/responses/401/content/application~1json/example"},"paths/~1scim~1v2~1Groups~1{id}/patch/responses/403/content/application~1json/example":{"value":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Groups/00000000-0000-0000-000000000000"},"id":"paths/~1scim~1v2~1Groups~1{id}/patch/responses/403/content/application~1json/example"},"paths/~1scim~1v2~1ResourceTypes/get/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"totalResults":2,"resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"id":"User","name":"User","description":"SCIM 2.0 User","endpoint":"/v2/Users","schema":"urn:ietf:params:scim:schemas:core:2.0:User","schemaExtensions":[{"schema":"urn:zuora:scim:schemas:1.0:UserExtension","required":true}],"meta":{"resourceType":"ResourceType","location":"http://localhost:9900/scim/v2/ResourceTypes/User"}},{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"id":"Group","name":"Group","description":"SCIM 2.0 Group","endpoint":"/v2/Groups","schema":"urn:ietf:params:scim:schemas:core:2.0:Group","schemaExtensions":[{"schema":"urn:zuora:scim:schemas:1.0:GroupExtension","required":true}],"meta":{"resourceType":"ResourceType","location":"http://localhost:9900/scim/v2/ResourceTypes/Group"}}],"startIndex":1,"itemsPerPage":2},"id":"paths/~1scim~1v2~1ResourceTypes/get/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1ResourceTypes/get/responses/401/content/application~1json/example":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"id":"paths/~1scim~1v2~1ResourceTypes/get/responses/401/content/application~1json/example"},"paths/~1scim~1v2~1ResourceTypes/get/responses/403/content/application~1json/example":{"value":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/ResourceTypes"},"id":"paths/~1scim~1v2~1ResourceTypes/get/responses/403/content/application~1json/example"},"paths/~1scim~1v2~1ResourceTypes/get/responses/404/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"},"id":"paths/~1scim~1v2~1ResourceTypes/get/responses/404/content/application~1json/example"},"paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"id":"User","name":"User","description":"SCIM 2.0 User","endpoint":"/v2/Users","schema":"urn:ietf:params:scim:schemas:core:2.0:User","schemaExtensions":[{"schema":"urn:zuora:scim:schemas:1.0:UserExtension","required":true}],"meta":{"resourceType":"ResourceType","location":"http://localhost:9900/scim/v2/ResourceTypes/User"}},"id":"paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/401/content/application~1json/example":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"id":"paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/401/content/application~1json/example"},"paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/403/content/application~1json/example":{"value":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/ResourceTypes/"},"id":"paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/403/content/application~1json/example"},"paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/404/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"},"id":"paths/~1scim~1v2~1ResourceTypes~1{id}/get/responses/404/content/application~1json/example"},"paths/~1scim~1v2~1Schemas/get/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"id":null,"externalId":null,"meta":null,"totalResults":4,"resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Schema"],"id":"urn:ietf:params:scim:schemas:core:2.0:User","name":"User","description":"User Account","attributes":[{"name":"active","type":"boolean","multiValued":false,"description":"A Boolean value indicating the User's administrative status.","required":false,"caseExact":true,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"addresses","type":"complex","subAttributes":[{"name":"country","type":"string","multiValued":false,"description":"The country name component.","required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"formatted","type":"string","multiValued":false,"description":"The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines.","required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"locality","type":"string","multiValued":false,"description":"The city or locality component.","required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"postalCode","type":"string","multiValued":false,"description":"The zipcode or postal code component.","required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"primary","type":"boolean","multiValued":false,"description":"A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g., the preferred address. The primary attribute value 'true' MUST appear no more than once.","required":false,"caseExact":true,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"region","type":"string","multiValued":false,"description":"The state or region component.","required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"streetAddress","type":"string","multiValued":false,"description":"The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. This attribute MAY contain newlines.","required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"type","type":"string","multiValued":false,"description":"A label indicating the attribute's function; e.g., 'work' or 'home'.","required":false,"canonicalValues":["other","work","home"],"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"}],"multiValued":true,"description":"Physical mailing addresses for this User.","required":false,"caseExact":true,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"displayName","type":"string","multiValued":false,"description":"The name of the User, suitable for display to end-users. The name SHOULD be the full name of the User being described if known.","required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"emails","type":"complex","subAttributes":[{"name":"display","type":"string","multiValued":false,"description":"A human readable name, primarily used for display purposes.","required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"primary","type":"boolean","multiValued":false,"description":"A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g., the preferred mailing address or primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","required":false,"caseExact":true,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"type","type":"string","multiValued":false,"description":"A label indicating the attribute's function; e.g., 'work' or 'home'.","required":false,"canonicalValues":["other","work","home"],"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"},{"name":"value","type":"string","multiValued":false,"description":"E-mail addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","required":false,"caseExact":false,"mutability":"readWrite","returned":"default","uniqueness":"none"}],"multiValued":true,"description":"E-mail addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","required":false,"caseExact":true,"mutability":"readWrite","returned":"default","uniqueness":"none"}]}]},"id":"paths/~1scim~1v2~1Schemas/get/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Schemas/get/responses/401/content/application~1json/example":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"id":"paths/~1scim~1v2~1Schemas/get/responses/401/content/application~1json/example"},"paths/~1scim~1v2~1Schemas/get/responses/403/content/application~1json/example":{"value":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Schemas"},"id":"paths/~1scim~1v2~1Schemas/get/responses/403/content/application~1json/example"},"paths/~1scim~1v2~1Schemas/get/responses/404/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"},"id":"paths/~1scim~1v2~1Schemas/get/responses/404/content/application~1json/example"},"paths/~1scim~1v2~1Users/post/requestBody/content/application~1json/example":{"value":[{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"name":{"givenName":"Amy","familyName":"Lawrence","formatted":"Amy Lawrence"},"active":true,"emails":[{"value":"amy+Lawrence@zuora.com","type":"work","primary":true}],"roles":[{"value":"ADMIN"}],"externalId":"asdasdasdS","userName":"amy+test102","preferredLanguage":"en","locale":"en-US","urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e"}}],"id":"paths/~1scim~1v2~1Users/post/requestBody/content/application~1json/example"},"paths/~1scim~1v2~1Users/post/responses/200/content/application~1json/example":{"value":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"e1b624ac-e00f-422b-b4da-20070901b22f","externalId":"amy+test102","meta":{"created":"2024-09-05T07:44:44.262Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/e1b624ac-e00f-422b-b4da-20070901b22f"},"userName":"amy+test102","name":{"formatted":"Amy Lawrence","familyName":"Lawrence","givenName":"Amy"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"amy+test102@zuora.com","display":"amy+test102@zuora.com","type":"work","primary":true}],"roles":[{"value":"ADMIN","display":"ADMIN"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","status":"ACTIVE","ssoEnabled":true,"region":"EU"}},"id":"paths/~1scim~1v2~1Users/post/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Users~1bulk/post/requestBody/content/application~1json/example":{"value":[{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"name":{"givenName":"Amy","familyName":"Lawrence","formatted":"Amy Lawrence"},"emails":[{"value":"Amy+test3@zuora.com","type":"work","primary":true}],"roles":[{"value":"USER"}],"userName":"Amy+test3@zuora.com","preferredLanguage":"en","locale":"en-US","urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"ec141dc2-901e-4813-a25d-ef480cff1e26"}},{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"name":{"givenName":"Amy","familyName":"Lawrence","formatted":"Amy Lawrence"},"emails":[{"value":"Amy+test4@zuora.com","type":"work","primary":true}],"roles":[{"value":"USER"}],"userName":"Amy+test4@zuora.com","preferredLanguage":"en","locale":"en-US","urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"ec141dc2-901e-4813-a25d-ef480cff1e26"}}],"id":"paths/~1scim~1v2~1Users~1bulk/post/requestBody/content/application~1json/example"},"paths/~1scim~1v2~1Users~1bulk/post/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"id":null,"externalId":null,"meta":null,"totalResults":2,"resources":[{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"8b40ccce-5fb7-4643-9b78-e194fe5303e6","externalId":"Amy+test3@zuora.com","meta":{"created":"2024-10-03T09:37:39.851Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/bulk/8b40ccce-5fb7-4643-9b78-e194fe5303e6"},"userName":"Amy+test3@zuora.com","name":{"formatted":"Amy Lawrence","familyName":"Amy","givenName":"Lawrence"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"Amy+test3@zuora.com","display":"Amy+test3@zuora.com","type":"work","primary":true}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","status":"ACTIVE","ssoEnabled":true,"region":"EU"}},{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"41aa4e47-01e2-4d85-a6bc-d88e18477011","externalId":"Amy+test4@zuora.com","meta":{"created":"2024-10-03T09:37:40.161Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/bulk/41aa4e47-01e2-4d85-a6bc-d88e18477011"},"userName":"Amy+test4@zuora.com","name":{"formatted":"Amy Lawrence","familyName":"Amy","givenName":"Lawrence"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"Amy+test4@zuora.com","display":"Amy+test4@zuora.com","type":"work","primary":true}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","status":"ACTIVE","ssoEnabled":true,"region":"EU"}}],"startIndex":1,"itemsPerPage":2},"id":"paths/~1scim~1v2~1Users~1bulk/post/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Users~1bulk/patch/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"id":null,"externalId":null,"meta":null,"totalResults":2,"resources":[{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"41aa4e47-01e2-4d85-a6bc-d88e18477011","externalId":"Amy+test4@zuora.com","meta":{"created":"2024-10-03T09:37:40.161Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/bulk/41aa4e47-01e2-4d85-a6bc-d88e18477011"},"userName":"Amy+test4@zuora.com","name":{"formatted":"Amy Lawrence","familyName":"Amy","givenName":"Lawrence"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"updated2@example.com","display":"updated2@example.com","type":"work","primary":true}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","status":"ACTIVE","ssoEnabled":true,"region":"EU"}},{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"8b40ccce-5fb7-4643-9b78-e194fe5303e6","externalId":"Amy+test3@zuora.com","meta":{"created":"2024-10-03T09:37:39.851Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/bulk/8b40ccce-5fb7-4643-9b78-e194fe5303e6"},"userName":"Amy+test3@zuora.com","name":{"formatted":"Amy Lawrence","familyName":"Amy","givenName":"Lawrence"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"updated3@example.com","display":"updated3@example.com","type":"work","primary":true}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","status":"ACTIVE","ssoEnabled":true,"region":"EU"}}],"startIndex":1,"itemsPerPage":2},"id":"paths/~1scim~1v2~1Users~1bulk/patch/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Users~1delete/post/responses/200/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"id":null,"externalId":null,"meta":null,"totalResults":2,"resources":[{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"ebc229f7-aef2-44ad-8e5f-9d1cf0b4c724","meta":{"created":"2024-02-19T08:23:08.488Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/delete/ebc229f7-aef2-44ad-8e5f-9d1cf0b4c724"},"userName":"0392538e-caf3-4125-aa1d-82fe1f5132b3","name":{"formatted":"Amy Lawrence","familyName":"Amy","givenName":"Lawrence"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":false,"emails":[{"value":"0392538e-caf3-4125-aa1d-82fe1f5132b3@zuora.com","display":"0392538e-caf3-4125-aa1d-82fe1f5132b3@zuora.com","type":"work","primary":true}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","status":"INACTIVE","ssoEnabled":false,"region":"US"}}],"startIndex":1,"itemsPerPage":2},"id":"paths/~1scim~1v2~1Users~1delete/post/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Users~1delete/post/responses/401/content/application~1json/example":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"id":"paths/~1scim~1v2~1Users~1delete/post/responses/401/content/application~1json/example"},"paths/~1scim~1v2~1Users~1delete/post/responses/403/content/application~1json/example":{"value":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Users/delete"},"id":"paths/~1scim~1v2~1Users~1delete/post/responses/403/content/application~1json/example"},"paths/~1scim~1v2~1Users~1delete/post/responses/404/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"},"id":"paths/~1scim~1v2~1Users~1delete/post/responses/404/content/application~1json/example"},"paths/~1scim~1v2~1Users~1{id}/get/responses/200/content/application~1json/examples/user":{"value":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"eb48a32d-2fe6-48d1-8a18-797919f3810a","meta":{"created":"2023-07-13T06:15:25.836Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/eb48a32d-2fe6-48d1-8a18-797919f3810a"},"userName":"Amy+555","name":{"formatted":"Amy Lawrence","familyName":"Amy","givenName":"Lawrence"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"asmurugesan+555@zuora.com","display":"asmurugesan+555@zuora.com","type":"work","primary":true}],"groups":[{"value":"7f5c248e-44e8-48d3-bacc-b5bd1253c2e4","display":""}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"rc141dc2-901e-4813-a25d-ef480cff1e26","status":"ACTIVE","ssoEnabled":false,"region":"EU"}},"key":"user","summary":"Example of a user response","id":"paths/~1scim~1v2~1Users~1{id}/get/responses/200/content/application~1json/examples/user"},"paths/~1scim~1v2~1Users~1{id}/get/responses/401/content/application~1json/examples/UnauthorizedError":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"key":"UnauthorizedError","summary":"Unauthorized example response","id":"paths/~1scim~1v2~1Users~1{id}/get/responses/401/content/application~1json/examples/UnauthorizedError"},"paths/~1scim~1v2~1Users~1{id}/get/responses/403/content/application~1json/examples/ForbiddenError":{"value":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Users/00000000-0000-0000-000000000000"},"key":"ForbiddenError","summary":"Forbidden example response","id":"paths/~1scim~1v2~1Users~1{id}/get/responses/403/content/application~1json/examples/ForbiddenError"},"paths/~1scim~1v2~1Users~1{id}/get/responses/404/content/application~1json/examples/NotFoundError":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"},"key":"NotFoundError","summary":"Not Found example response","id":"paths/~1scim~1v2~1Users~1{id}/get/responses/404/content/application~1json/examples/NotFoundError"},"paths/~1scim~1v2~1Users~1{id}/put/requestBody/content/application~1json/example":{"value":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"4ae68f98-2762-4001-b95c-34569b413e8e","externalId":"Amy+test5","meta":{"created":"2023-01-04T18:48:30.180Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/4ae68f98-2762-4001-b95c-34569b413e8e"},"userName":"Amy+test6","name":{"formatted":"Amy Lawrence","familyName":"Amy","givenName":"Lawrence"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"Amy+test5-updated@zuora.com"}],"groups":[{"value":"0fb99576-2154-4d96-a6cb-384dd430f45f","display":"Amy Test"}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"ec141dc2-901e-4813-a25d-ef480cff1e26","status":"ACTIVE","ssoEnabled":true,"region":"EU"}},"id":"paths/~1scim~1v2~1Users~1{id}/put/requestBody/content/application~1json/example"},"paths/~1scim~1v2~1Users~1{id}/put/responses/200/content/application~1json/example":{"value":{"id":"123456","userName":"johndoe","displayName":"John Doe","active":true,"emails":[{"value":"johndoe@example.com","primary":true}],"meta":{"resourceType":"User","created":"2023-01-01T12:00:00Z","lastModified":"2023-01-01T12:00:00Z"},"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"totalResults":1,"resources":[{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"4ae68f98-2762-4001-b95c-34569b413e8e","externalId":"Amy+test6","meta":{"created":"2024-10-03T10:22:09.727Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/4ae68f98-2762-4001-b95c-34569b413e8e"},"userName":"assingh151@zuora.com","name":{"formatted":"Amy Lawrence","familyName":"Amy","givenName":"Lawrence"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"Amy+test5-updated@zuora.com","display":"Amy+test5-updated@zuora.com","type":"work","primary":true}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","status":"ACTIVE","ssoEnabled":true,"region":"EU"}}],"startIndex":1,"itemsPerPage":1},"id":"paths/~1scim~1v2~1Users~1{id}/put/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Users~1{id}/put/responses/401/content/application~1json/example":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"id":"paths/~1scim~1v2~1Users~1{id}/put/responses/401/content/application~1json/example"},"paths/~1scim~1v2~1Users~1{id}/put/responses/403/content/application~1json/example":{"value":{"timestamp":"2023-07-28T10:47:07.931+00:00","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Users/00000000-0000-0000-000000000000"},"id":"paths/~1scim~1v2~1Users~1{id}/put/responses/403/content/application~1json/example"},"paths/~1scim~1v2~1Users~1{id}/put/responses/404/content/application~1json/example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"Resource not found"},"id":"paths/~1scim~1v2~1Users~1{id}/put/responses/404/content/application~1json/example"},"paths/~1scim~1v2~1Users~1{id}/delete/responses/200/content/application~1json/example":{"value":{"id":"123456","userName":"johndoe","displayName":"John Doe","active":true,"emails":[{"value":"johndoe@example.com","primary":true}],"meta":{"resourceType":"User","created":"2023-01-01T12:00:00Z","lastModified":"2023-01-01T12:00:00Z"}},"id":"paths/~1scim~1v2~1Users~1{id}/delete/responses/200/content/application~1json/example"},"paths/~1scim~1v2~1Users~1{id}/delete/responses/204/content/application~1json/example":{"value":{"message":"User successfully deleted."},"id":"paths/~1scim~1v2~1Users~1{id}/delete/responses/204/content/application~1json/example"},"paths/~1scim~1v2~1Users~1{id}/delete/responses/401/content/application~1json/example":{"value":{"success":false,"reasons":[{"message":"Unauthorized","code":"90000011"}]},"id":"paths/~1scim~1v2~1Users~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1scim~1v2~1Users~1{id}/delete/responses/403/content/application~1json/example":{"value":{"timestamp":"2023-07-28T10:47:07.931Z","status":403,"error":"Forbidden","message":"Admin access denied","path":"/scim/v2/Users/123"},"id":"paths/~1scim~1v2~1Users~1{id}/delete/responses/403/content/application~1json/example"},"paths/~1scim~1v2~1Users~1{id}/patch/responses/200/content/application~1json/example":{"value":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"4ae68f98-2762-4001-b95c-34569b413e8e","externalId":"assingh151@zuora.com","meta":{"created":"2024-10-03T10:22:09.727Z","resourceType":"User","location":"http://localhost:9900/scim/v2/Users/4ae68f98-2762-4001-b95c-34569b413e8e/4ae68f98-2762-4001-b95c-34569b413e8e"},"userName":"assingh151@zuora.com","name":{"formatted":"Amy Lawrence","familyName":"Amy","givenName":"Lawrence"},"displayName":"Amy Lawrence","preferredLanguage":"en","locale":"en-US","active":true,"emails":[{"value":"updatedEmail@zuora.com","display":"updatedEmail@zuora.com","type":"work","primary":true}],"roles":[{"value":"USER","display":"USER"}],"urn:zuora:scim:schemas:1.0:UserExtension":{"schemas":["urn:zuora:scim:schemas:1.0:UserExtension"],"organizationId":"5619df2e-fa8c-47fa-9c1e-16ab5af4936e","status":"ACTIVE","ssoEnabled":true,"region":"EU"}},"id":"paths/~1scim~1v2~1Users~1{id}/patch/responses/200/content/application~1json/example"},"paths/~1admin~1audit~1v2~1global-logins/post/requestBody/content/application~1json/example":{"value":{"dateRange":{"startDate":"2025-05-01T00:00:00.000Z","endDate":"2025-05-29T23:59:59.000Z"},"pagination":{"items":100,"page":0},"sort":{"field":"timestamp","order":"DESC"}},"id":"paths/~1admin~1audit~1v2~1global-logins/post/requestBody/content/application~1json/example"},"paths/~1admin~1audit~1v2~1global-logins/post/responses/200/content/application~1json/example":{"value":{"count":100,"firstPageToken":"0","lastPageToken":"34","nextToken":"1","previousToken":null,"totalPages":35,"totalElements":3484,"events":[{"eventId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","timestamp":"2025-05-29T14:32:01.000Z","username":"admin@zuora.com","userId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","action":"LOGIN","actionDetails":"Successful login via SSO","tenantId":null,"namespace":"global","clientid":"zuora-ui","clienttype":"BROWSER","ipaddress":"192.168.1.100","hostname":"one.zuora.com","status":"SUCCESS","logintype":"SSO","browsertype":"Chrome","browserversion":"125.0.6422.76"},{"eventId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","timestamp":"2025-05-29T14:30:15.000Z","username":"user2@company.com","userId":"e47ac10b-58cc-4372-a567-0e02b2c3d480","action":"LOGIN","actionDetails":"Failed login - invalid credentials","tenantId":null,"namespace":"global","clientid":"zuora-ui","clienttype":"BROWSER","ipaddress":"10.0.0.50","hostname":"one.zuora.com","status":"FAILURE","logintype":"PASSWORD","browsertype":"Firefox","browserversion":"126.0"}]},"id":"paths/~1admin~1audit~1v2~1global-logins/post/responses/200/content/application~1json/example"},"paths/~1admin~1audit~1v2~1global-settings/post/requestBody/content/application~1json/example":{"value":{"dateRange":{"startDate":"2025-05-01T00:00:00.000Z","endDate":"2025-05-29T23:59:59.000Z"},"pagination":{"items":50,"page":0},"filter":{"should":[{"field":"settingtype","values":["ROLE_BINDING","PERMISSION"]}]},"sort":{"field":"timestamp","order":"DESC"}},"id":"paths/~1admin~1audit~1v2~1global-settings/post/requestBody/content/application~1json/example"},"paths/~1admin~1audit~1v2~1global-settings/post/responses/200/content/application~1json/example":{"value":{"count":50,"firstPageToken":"0","lastPageToken":"5","nextToken":"1","previousToken":null,"totalPages":6,"totalElements":278,"events":[{"eventId":"c3d4e5f6-a7b8-9012-cdef-234567890123","timestamp":"2025-05-28T10:15:30.000Z","username":"orgadmin@company.com","userId":"d47ac10b-58cc-4372-a567-0e02b2c3d481","action":"UPDATE","actionDetails":"Role binding updated for user","objectType":"ROLE_BINDING","objectId":"rb-12345","objectname":"Billing Admin Role","namespace":"global","settingtype":"ROLE_BINDING","changetype":"MODIFY","transactionid":"txn-abc123"},{"eventId":"d4e5f6a7-b8c9-0123-defg-345678901234","timestamp":"2025-05-28T09:45:12.000Z","username":"orgadmin@company.com","userId":"d47ac10b-58cc-4372-a567-0e02b2c3d481","action":"CREATE","actionDetails":"New permission group created","objectType":"PERMISSION_GROUP","objectId":"pg-67890","objectname":"Custom Report Access","namespace":"global","settingtype":"PERMISSION","changetype":"CREATE","transactionid":"txn-def456"}]},"id":"paths/~1admin~1audit~1v2~1global-settings/post/responses/200/content/application~1json/example"},"paths/~1admin~1audit~1v2~1tenant-logins/post/requestBody/content/application~1json/example":{"value":{"dateRange":{"startDate":"2025-05-01T00:00:00.000Z","endDate":"2025-05-29T23:59:59.000Z"},"pagination":{"items":100,"page":0},"filter":{"must":[{"field":"tenantId","values":["10138"]}],"should":[{"field":"status","values":["SUCCESS","FAILURE"]}]},"sort":{"field":"timestamp","order":"DESC"}},"id":"paths/~1admin~1audit~1v2~1tenant-logins/post/requestBody/content/application~1json/example"},"paths/~1admin~1audit~1v2~1tenant-logins/post/responses/200/content/application~1json/example":{"value":{"count":100,"firstPageToken":"0","lastPageToken":"12","nextToken":"1","previousToken":null,"totalPages":13,"totalElements":1250,"events":[{"eventId":"e5f6a7b8-c9d0-1234-efgh-456789012345","timestamp":"2025-05-29T16:20:45.000Z","username":"billing.user@customer.com","userId":"a47ac10b-58cc-4372-a567-0e02b2c3d482","action":"LOGIN","actionDetails":"Successful login","tenantId":"10138","tenantUsername":"billing.user","namespace":"tenant","clientid":"zuora-ui","clienttype":"BROWSER","ipaddress":"203.0.113.50","hostname":"one.zuora.com","status":"SUCCESS","logintype":"PASSWORD","browsertype":"Chrome","browserversion":"125.0.6422.76"},{"eventId":"f6a7b8c9-d0e1-2345-fghi-567890123456","timestamp":"2025-05-29T16:18:30.000Z","username":"api.client@customer.com","userId":"b47ac10b-58cc-4372-a567-0e02b2c3d483","action":"LOGIN","actionDetails":"OAuth2 client credentials grant","tenantId":"10138","tenantUsername":"api.client","namespace":"tenant","clientid":"client-app-001","clienttype":"API","ipaddress":"10.20.30.40","hostname":"api.zuora.com","status":"SUCCESS","logintype":"OAUTH","browsertype":null,"browserversion":null}]},"id":"paths/~1admin~1audit~1v2~1tenant-logins/post/responses/200/content/application~1json/example"},"paths/~1admin~1audit~1v2~1tenant-settings/post/requestBody/content/application~1json/example":{"value":{"dateRange":{"startDate":"2025-05-01T00:00:00.000Z","endDate":"2025-05-29T23:59:59.000Z"},"pagination":{"items":100,"page":0},"filter":{"must":[{"field":"tenantId","values":["10138"]},{"field":"settingtype","values":["SECURITY_POLICY"],"operator":"EQUALS"}]},"sort":{"field":"timestamp","order":"DESC"}},"id":"paths/~1admin~1audit~1v2~1tenant-settings/post/requestBody/content/application~1json/example"},"paths/~1admin~1audit~1v2~1tenant-settings/post/responses/200/content/application~1json/example":{"value":{"count":25,"firstPageToken":"0","lastPageToken":"0","nextToken":null,"previousToken":null,"totalPages":1,"totalElements":25,"events":[{"eventId":"a7b8c9d0-e1f2-3456-ghij-678901234567","timestamp":"2025-05-25T11:30:00.000Z","username":"tenant.admin@customer.com","userId":"c47ac10b-58cc-4372-a567-0e02b2c3d484","action":"UPDATE","actionDetails":"Password policy updated - minimum length changed from 8 to 12","objectType":"SECURITY_POLICY","objectId":"sp-10138-001","objectname":"Password Policy","tenantId":"10138","namespace":"tenant","settingtype":"SECURITY_POLICY","attributeid":"minPasswordLength","attributename":"Minimum Password Length","changetype":"MODIFY","transactionid":"txn-sp-789"},{"eventId":"b8c9d0e1-f2a3-4567-hijk-789012345678","timestamp":"2025-05-24T09:15:22.000Z","username":"tenant.admin@customer.com","userId":"c47ac10b-58cc-4372-a567-0e02b2c3d484","action":"UPDATE","actionDetails":"MFA enforcement enabled for all users","objectType":"SECURITY_POLICY","objectId":"sp-10138-001","objectname":"MFA Settings","tenantId":"10138","namespace":"tenant","settingtype":"SECURITY_POLICY","attributeid":"mfaEnforcement","attributename":"MFA Enforcement","changetype":"MODIFY","transactionid":"txn-sp-790"}]},"id":"paths/~1admin~1audit~1v2~1tenant-settings/post/responses/200/content/application~1json/example"},"paths/~1admin~1audit~1v2~1tenant-objects/post/requestBody/content/application~1json/example":{"value":{"dateRange":{"startDate":"2025-05-01T00:00:00.000Z","endDate":"2025-05-29T23:59:59.000Z"},"pagination":{"items":100,"page":0},"filter":{"must":[{"field":"tenantId","values":["10138"]},{"field":"objectType","values":["USER"]}],"exclude":[{"field":"action","values":["LOGIN"]}]},"sort":{"field":"timestamp","order":"DESC"}},"id":"paths/~1admin~1audit~1v2~1tenant-objects/post/requestBody/content/application~1json/example"},"paths/~1admin~1audit~1v2~1tenant-objects/post/responses/200/content/application~1json/example":{"value":{"count":45,"firstPageToken":"0","lastPageToken":"0","nextToken":null,"previousToken":null,"totalPages":1,"totalElements":45,"events":[{"eventId":"c9d0e1f2-a3b4-5678-ijkl-890123456789","timestamp":"2025-05-29T08:45:00.000Z","username":"tenant.admin@customer.com","userId":"c47ac10b-58cc-4372-a567-0e02b2c3d484","action":"CREATE","actionDetails":"New user created with Billing Admin role","objectType":"USER","objectId":"usr-new-001","objectname":"new.user@customer.com","tenantId":"10138","namespace":"tenant","changetype":"CREATE","itemtype":"USER","itemid":"usr-new-001","transactionid":"txn-usr-101"},{"eventId":"d0e1f2a3-b4c5-6789-jklm-901234567890","timestamp":"2025-05-28T17:20:00.000Z","username":"tenant.admin@customer.com","userId":"c47ac10b-58cc-4372-a567-0e02b2c3d484","action":"UPDATE","actionDetails":"User role changed from Viewer to Editor","objectType":"USER","objectId":"usr-existing-002","objectname":"existing.user@customer.com","tenantId":"10138","namespace":"tenant","changetype":"MODIFY","itemtype":"USER","itemid":"usr-existing-002","transactionid":"txn-usr-102"},{"eventId":"e1f2a3b4-c5d6-7890-klmn-012345678901","timestamp":"2025-05-27T14:10:00.000Z","username":"tenant.admin@customer.com","userId":"c47ac10b-58cc-4372-a567-0e02b2c3d484","action":"DELETE","actionDetails":"User deactivated","objectType":"USER","objectId":"usr-old-003","objectname":"deactivated.user@customer.com","tenantId":"10138","namespace":"tenant","changetype":"DELETE","itemtype":"USER","itemid":"usr-old-003","transactionid":"txn-usr-103"}]},"id":"paths/~1admin~1audit~1v2~1tenant-objects/post/responses/200/content/application~1json/example"},"paths/~1admin~1integrations~1data~1global-users/get/responses/200/content/application~1json/example":{"value":{"data":[{"userId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","userName":"admin@company.com","firstName":"John","lastName":"Smith","status":"ACTIVE","workEmail":"john.smith@company.com","federatedId":"john.smith@idp.company.com","ssoEnabled":true,"oneIdRole":"Organization Admin","createdOn":"2024-01-15T10:30:00.000Z","deactivatedOn":null,"userGroups":"Billing Admins, Platform Users","lastLogin":"2025-05-29T14:32:01.000Z"},{"userId":"e47ac10b-58cc-4372-a567-0e02b2c3d480","userName":"billing.user@company.com","firstName":"Jane","lastName":"Doe","status":"ACTIVE","workEmail":"jane.doe@company.com","federatedId":null,"ssoEnabled":false,"oneIdRole":"Standard User","createdOn":"2024-03-20T08:00:00.000Z","deactivatedOn":null,"userGroups":"Billing Users","lastLogin":"2025-05-28T09:15:00.000Z"},{"userId":"d47ac10b-58cc-4372-a567-0e02b2c3d481","userName":"deactivated.user@company.com","firstName":"Bob","lastName":"Wilson","status":"INACTIVE","workEmail":"bob.wilson@company.com","federatedId":"bob.wilson@idp.company.com","ssoEnabled":true,"oneIdRole":"Standard User","createdOn":"2023-06-10T14:00:00.000Z","deactivatedOn":"2025-04-01T00:00:00.000Z","userGroups":"","lastLogin":"2025-03-15T11:22:00.000Z"}],"page":0,"size":20,"totalElements":150,"totalPages":8,"hasNext":true},"id":"paths/~1admin~1integrations~1data~1global-users/get/responses/200/content/application~1json/example"},"paths/~1admin~1integrations~1data~1global-roles/get/responses/200/content/application~1json/example":{"value":{"data":[{"roleSetId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","roleName":"Organization Admin","description":"Full administrative access to the organization","appType":"REVENUE","entityId":null,"organizationId":"org-12345678-abcd-efgh-ijkl-123456789012","status":"ENABLED","roleType":"DEFAULT","sourceType":"USER","permissionGroupIds":["pg-11111111-aaaa-bbbb-cccc-111111111111","pg-22222222-aaaa-bbbb-cccc-222222222222"],"globalRoleIds":"gr-9f2c7a41-b6de-4e83-91ab-7c2d5e4f8a19","createdOn":"2023-01-01T00:00:00.000Z","updatedOn":"2023-01-01T00:00:00.000Z","createdByUsername":"system"},{"roleSetId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","roleName":"Custom Billing Manager","description":"Custom role for billing management across tenants","appType":"BILLING","entityId":null,"organizationId":"org-12345678-abcd-efgh-ijkl-123456789012","status":"DISABLED","roleType":"CUSTOM","sourceType":"USER","permissionGroupIds":["pg-33333333-aaaa-bbbb-cccc-333333333333"],"globalRoleIds":["gr-44444444-aaaa-bbbb-cccc-444444444444"],"createdOn":"2024-06-15T10:30:00.000Z","updatedOn":"2025-02-20T14:00:00.000Z","createdByUsername":"admin@company.com"}],"page":0,"size":20,"totalElements":45,"totalPages":3,"hasNext":true},"id":"paths/~1admin~1integrations~1data~1global-roles/get/responses/200/content/application~1json/example"},"paths/~1admin~1integrations~1data~1tenant-roles/get/responses/200/content/application~1json/example":{"value":{"data":[{"roleSetId":"c3d4e5f6-a7b8-9012-cdef-234567890123","roleName":"Billing Admin","description":"Full billing administrative access for this tenant","appType":"BILLING","entityId":"ent-98765432-dcba-hgfe-lkji-210987654321","organizationId":"org-12345678-abcd-efgh-ijkl-123456789012","status":"ACTIVE","roleType":"SYSTEM","sourceType":"BUILT_IN","permissionGroupIds":["pg-55555555-aaaa-bbbb-cccc-555555555555","pg-66666666-aaaa-bbbb-cccc-666666666666"],"globalRoleIds":[],"createdOn":"2023-01-01T00:00:00.000Z","updatedOn":"2023-01-01T00:00:00.000Z","createdByUsername":"system"},{"roleSetId":"d4e5f6a7-b8c9-0123-defg-345678901234","roleName":"Invoice Viewer","description":"Read-only access to invoices and payments","appType":"BILLING","entityId":"ent-98765432-dcba-hgfe-lkji-210987654321","organizationId":"org-12345678-abcd-efgh-ijkl-123456789012","status":"ACTIVE","roleType":"CUSTOM","sourceType":"USER_CREATED","permissionGroupIds":["pg-77777777-aaaa-bbbb-cccc-777777777777"],"globalRoleIds":[],"createdOn":"2024-08-10T09:00:00.000Z","updatedOn":"2025-01-05T16:30:00.000Z","createdByUsername":"admin@company.com"}],"page":0,"size":20,"totalElements":12,"totalPages":1,"hasNext":false},"id":"paths/~1admin~1integrations~1data~1tenant-roles/get/responses/200/content/application~1json/example"},"paths/~1admin~1integrations~1data~1tenant-roles-permissions/get/responses/200/content/application~1json/example":{"value":{"data":[{"roleSetId":"c3d4e5f6-a7b8-9012-cdef-234567890123","roleName":"Billing Admin","description":"Full billing administrative access for this tenant","appType":"BILLING","entityId":"ent-98765432-dcba-hgfe-lkji-210987654321","status":"ACTIVE","roleType":"SYSTEM","createdOn":"2023-01-01T00:00:00.000Z","updatedOn":"2023-01-01T00:00:00.000Z","permissions":[{"permissionGroupId":"pg-55555555-aaaa-bbbb-cccc-555555555555","permissionGroupName":"Invoice Management","category":"Billing","permissions":["invoice.create","invoice.read","invoice.update","invoice.delete","invoice.post"]},{"permissionGroupId":"pg-66666666-aaaa-bbbb-cccc-666666666666","permissionGroupName":"Payment Management","category":"Billing","permissions":["payment.create","payment.read","payment.update","payment.refund"]},{"permissionGroupId":"pg-88888888-aaaa-bbbb-cccc-888888888888","permissionGroupName":"Subscription Management","category":"Commerce","permissions":["subscription.create","subscription.read","subscription.update","subscription.cancel","subscription.renew"]}]},{"roleSetId":"d4e5f6a7-b8c9-0123-defg-345678901234","roleName":"Invoice Viewer","description":"Read-only access to invoices and payments","appType":"BILLING","entityId":"ent-98765432-dcba-hgfe-lkji-210987654321","status":"ACTIVE","roleType":"CUSTOM","createdOn":"2024-08-10T09:00:00.000Z","updatedOn":"2025-01-05T16:30:00.000Z","permissions":[{"permissionGroupId":"pg-77777777-aaaa-bbbb-cccc-777777777777","permissionGroupName":"Invoice Read-Only","category":"Billing","permissions":["invoice.read","payment.read","creditMemo.read","debitMemo.read"]}]}],"page":0,"size":20,"totalElements":12,"totalPages":1,"hasNext":false},"id":"paths/~1admin~1integrations~1data~1tenant-roles-permissions/get/responses/200/content/application~1json/example"},"paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/200/content/application~1json/examples/response":{"value":{"jobId":"ff80808186beca0a0186bedbf7d3006f","jobStatus":"Accepted","success":true},"key":"response","summary":"response","id":"paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/400/content/application~1json/examples/response":{"value":{"processId":"4C0112A0983D040C","reasons":[{"code":59620220,"message":"The queryType is invalid"}],"requestId":"46a352ed-57a2-4a9f-b7cb-a8c864d839f3","success":false},"key":"response","summary":"response","id":"paths/~1v1~1multi-organizations~1data-labeling-job/post/responses/400/content/application~1json/examples/response"},"paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/200/content/application~1json/examples/response":{"value":{"jobId":"ff80808186b966950186b97922e200ab","jobStatus":"Completed","objectType":"Account","progress":{"failed":1,"labeled":9,"timeout":1},"success":true,"totalObject":11},"key":"response","summary":"response","id":"paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/404/content/application~1json/examples/response":{"value":{"processId":"4C0112A0983D039B","reasons":[{"code":"50000020","message":"The job does not exist"}],"requestId":"46a352ed-57a2-4a9f-b7cb-a8c864d839f3","success":false},"key":"response","summary":"response","id":"paths/~1v1~1multi-organizations~1data-labeling-job~1{job-id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/success":{"value":{"success":true,"jobId":"ff8080818bb300af018bb325fe0c58f3"},"key":"success","summary":"success","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/success"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/fail":{"value":{"success":false,"processId":"1B81A64621CAD85D","requestId":"c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f","reasons":[{"code":"50000020","message":"Error Message"}]},"key":"fail","summary":"fail","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/200/content/application~1json/examples/fail"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/success":{"value":{"success":true,"jobs":[{"id":"ff8080818c6748aa018c675a17d758e0","createdOn":1702541006000,"createdOnReadable":"2023-12-14T16:03:26+0800","updatedOn":1702541007000,"updatedOnReadable":"2023-12-14T16:03:27+0800","updatedByUsername":"test1702540260413@test.com","status":"COMPLETED","type":"BookingDate","batchSentCount":1,"batchFinishedCount":1,"errorCount":0,"progress":"100.00%"},{"id":"ff8080818c6748aa018c6778737f58e2","createdOn":1702542996000,"createdOnReadable":"2023-12-14T16:36:36+0800","updatedOn":1702542997000,"updatedOnReadable":"2023-12-14T16:36:37+0800","updatedByUsername":"test1702540260413@test.com","status":"COMPLETED","type":"BookingDate","batchSentCount":1,"batchFinishedCount":1,"errorCount":0,"progress":"100.00%"}]},"key":"success","summary":"success","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/success"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/fail":{"value":{"success":false,"processId":"1B81A64621CAD85D","requestId":"c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f","reasons":[{"code":"50000020","message":"Error Message"}]},"key":"fail","summary":"fail","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/200/content/application~1json/examples/fail"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success":{"value":{"success":true,"job":{"id":"ff8080818c6748aa018c675a17d758e0","createdOn":1702541006000,"createdOnReadable":"2023-12-14T16:03:26+0800","updatedOn":1702541007000,"updatedOnReadable":"2023-12-14T16:03:27+0800","updatedByUsername":"test1702540260413@test.com","status":"COMPLETED","type":"BookingDate","batchSentCount":1,"batchFinishedCount":1,"errorCount":0,"progress":"100.00%"}},"key":"success","summary":"success","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail":{"value":{"success":false,"processId":"1B81A64621CAD85D","requestId":"c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f","reasons":[{"code":"50000020","message":"Error Message"}]},"key":"fail","summary":"fail","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/requestBody/content/application~1json/example":{"value":{"status":"Stopping"},"id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/requestBody/content/application~1json/example"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1bookingdate~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/success":{"value":{"success":true,"jobId":"ff8080818bb300af018bb325fe0c58f3"},"key":"success","summary":"success","id":"paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/success"},"paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/fail":{"value":{"success":false,"processId":"1B81A64621CAD85D","requestId":"c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f","reasons":[{"code":"50000020","message":"Error Message"}]},"key":"fail","summary":"fail","id":"paths/~1v1~1uno~1data-backfill~1jobs/post/responses/200/content/application~1json/examples/fail"},"paths/~1v1~1uno~1data-backfill~1jobs/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1jobs/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1jobs/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1jobs/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success":{"value":{"success":true,"job":{"id":"ff8080818bb300af018bb325fe0c58f3","importType":"RatePlanCharge","uploadedFileId":"ff8080818bb300af018bb325fe0c58f2","uploadedFileName":"file.csv","uploadedFileUrl":"http://localhost:8080/apps/v1/files/ff8080818bb300af018bb325fe0c58f2","uploadedFileSize":"798Byte","uploadedBy":"test1699515471903@test.com","uploadedOn":"1699517693000","resultFileId":"ff8080818bb300af018bb32605c358f6","resultFileName":"file.csv_result.zip","resultFileUrl":"http://localhost:8080/apps/v1/files/ff8080818bb300af018bb32605c358f6","totalCount":2,"failedCount":1,"completedOn":"1699517695000","status":"Completed","failureMessage":"","startedProcessingOn":"1699517693000","outputSize":"492Byte","outputType":"(url:.csv.zip)","inputFileSize":798,"outputFileSize":492,"processedCount":2,"successCount":1,"remainingTime":1,"remainingTimeText":"","completedPercentage":100}},"key":"success","summary":"success","id":"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success"},"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail":{"value":{"success":false,"processId":"1B81A64621CAD85D","requestId":"c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f","reasons":[{"code":"50000020","message":"Error Message"}]},"key":"fail","summary":"fail","id":"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"},"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/requestBody/content/application~1json/example":{"value":{"status":"Stopping"},"id":"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/requestBody/content/application~1json/example"},"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/success":{"value":{"success":true,"jobs":[{"id":"ff8080818bb300af018bb325fe0c58f3","type":"RatePlanCharge","uploadedFileId":"ff8080818bb300af018bb325fe0c58f2","uploadedFileName":"file.csv","uploadedFileUrl":"http://localhost:8080/apps/v1/files/ff8080818bb300af018bb325fe0c58f2","uploadedFileSize":"798Byte","uploadedBy":"test1699515471903@test.com","uploadedOn":"1699517693000","resultFileId":"ff8080818bb300af018bb32605c358f6","resultFileName":"file.csv_result.zip","resultFileUrl":"http://localhost:8080/apps/v1/files/ff8080818bb300af018bb32605c358f6","totalCount":2,"failedCount":1,"completedOn":"1699517695000","status":"Completed","failureMessage":"","startedProcessingOn":"1699517693000","outputSize":"492Byte","outputType":"(url:.csv.zip)","inputFileSize":798,"outputFileSize":492,"processedCount":2,"successCount":1,"remainingTime":1,"remainingTimeText":"","completedPercentage":100}]},"key":"success","summary":"success","id":"paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/success"},"paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/fail":{"value":{"success":false,"processId":"1B81A64621CAD85D","requestId":"c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f","reasons":[{"code":"50000020","message":"Error Message"}]},"key":"fail","summary":"fail","id":"paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/200/content/application~1json/examples/fail"},"paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1listjobs/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/success":{"value":"","key":"success","summary":"success","id":"paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/success"},"paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/fail":{"value":{"success":false,"processId":"1B81A64621CAD85D","requestId":"c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f","reasons":[{"code":"50000020","message":"Error Message"}]},"key":"fail","summary":"fail","id":"paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/200/content/text~1csv/examples/fail"},"paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1jobs~1{type}~1template/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/success":{"value":{"success":true,"jobs":[{"id":"ff8080818c6748aa018c675a17d758e0","createdOn":1702541006000,"createdOnReadable":"2023-12-14T16:03:26+0800","updatedOn":1702541007000,"updatedOnReadable":"2023-12-14T16:03:27+0800","updatedByUsername":"test1702540260413@test.com","status":"COMPLETED","type":"RatePlanCharge","batchSentCount":1,"batchFinishedCount":1,"errorCount":0,"progress":"100.00%"},{"id":"ff8080818c6748aa018c6778737f58e2","createdOn":1702542996000,"createdOnReadable":"2023-12-14T16:36:36+0800","updatedOn":1702542997000,"updatedOnReadable":"2023-12-14T16:36:37+0800","updatedByUsername":"test1702540260413@test.com","status":"COMPLETED","type":"OrderLineItem","batchSentCount":1,"batchFinishedCount":1,"errorCount":0,"progress":"100.00%"}]},"key":"success","summary":"success","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/success"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/fail":{"value":{"success":false,"processId":"1B81A64621CAD85D","requestId":"c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f","reasons":[{"code":"50000020","message":"Error Message"}]},"key":"fail","summary":"fail","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/200/content/application~1json/examples/fail"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/success":{"value":{"success":true,"jobId":"ff8080818bb300af018bb325fe0c58f3"},"key":"success","summary":"success","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/success"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/fail":{"value":{"success":false,"processId":"1B81A64621CAD85D","requestId":"c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f","reasons":[{"code":"50000020","message":"Error Message"}]},"key":"fail","summary":"fail","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/200/content/application~1json/examples/fail"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success":{"value":{"success":true,"job":{"id":"ff8080818c6748aa018c675a17d758e0","createdOn":1702541006000,"createdOnReadable":"2023-12-14T16:03:26+0800","updatedOn":1702541007000,"updatedOnReadable":"2023-12-14T16:03:27+0800","updatedByUsername":"test1702540260413@test.com","status":"COMPLETED","type":"RatePlanCharge","batchSentCount":1,"batchFinishedCount":1,"errorCount":0,"progress":"100.00%"}},"key":"success","summary":"success","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/success"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail":{"value":{"success":false,"processId":"1B81A64621CAD85D","requestId":"c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f","reasons":[{"code":"50000020","message":"Error Message"}]},"key":"fail","summary":"fail","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/200/content/application~1json/examples/fail"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/requestBody/content/application~1json/example":{"value":{"status":"Stopping"},"id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/requestBody/content/application~1json/example"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno~1data-backfill~1propagation~1jobs~1{jobId}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/200/content/application~1json/examples/response":{"value":{"idList":["2c9890508ad035db018ad0d8d1685fef","2c9890508ad035db018ad0d8d4ec6013"],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1booking-transaction/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/200/content/application~1json/examples/response":{"value":{"idList":["2c9890508ad035db018ad0d8d1685fef","2c9890508ad035db018ad0d8d4ec6013"],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1billing-transaction/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1rev-rec-events/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1uno-regenerate~1rev-rec-events~1daily-consumption/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1action~1create/post/responses/200/content/application~1json/examples/response":{"value":[{"Id":"2c93808457d787030157e0324aea5158","Success":true}],"key":"response","summary":"response","id":"paths/~1v1~1action~1create/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1action~1create/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1action~1create/post/responses/401/content/application~1json/examples/response"},"paths/~1v1~1action~1delete/post/responses/200/content/application~1json/examples/response":{"value":[{"id":"2c93808457d787030157e031fcd34e19","success":true}],"key":"response","summary":"response","id":"paths/~1v1~1action~1delete/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1action~1delete/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1action~1delete/post/responses/401/content/application~1json/examples/response"},"paths/~1v1~1action~1query/post/responses/200/content/application~1json/examples/response":{"value":{"size":1,"records":[{"BillCycleDay\"":1,"Id":"8ad09378905a5af201907ca1edb524c2","AccountNumber":"A00000212"}],"done":true},"key":"response","summary":"response","id":"paths/~1v1~1action~1query/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1action~1query/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1action~1query/post/responses/401/content/application~1json/examples/response"},"paths/~1v1~1action~1queryMore/post/responses/200/content/application~1json/examples/response":{"value":{"size":252070,"records":[{"Id":"2c92c0855460118101546e8ccbfc76d4"},{"Id":"2c92c0855460118101546e8ccbfd76d7"}],"queryLocator":"2c92c0f9602fb240016049ac7e0b47e7-4000","done":false},"key":"response","summary":"response","id":"paths/~1v1~1action~1queryMore/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1action~1queryMore/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1action~1queryMore/post/responses/401/content/application~1json/examples/response"},"paths/~1v1~1action~1update/post/responses/200/content/application~1json/examples/response":{"value":[{"Id":"8ad09378905a5af201907ca1edb524c2","Success":true}],"key":"response","summary":"response","id":"paths/~1v1~1action~1update/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1action~1update/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1action~1update/post/responses/401/content/application~1json/examples/response"},"paths/~1settings~1batch-requests/post/responses/200/content/application~1json/examples/response":{"value":{"responses":[{"children":[],"id":"1","method":"GET","response":{"body":{"allowAutoPostBillRun":true,"autoPostBillRunDefaultValue":true,"availableToCreditValidationLevel":"HeaderLevel","billToTermEndWhenAutoRenew":true,"daysInMonth":"UseActualDays","includeChildUsage":true,"includeNegativeInvoice":true,"invoicePastEndOfTerm":false,"legalDocumentGeneratingRule":"GroupByOriginalSRPC","notSendZeroItemsForTax":false,"oneTimeCreditBack":false,"preGenerateInvoicePdf":false,"proratePeriodOfRecurringCharge":true,"prorateRecurringMonthlyCharges":true,"prorateRecurringWeeklyCharges":true,"prorateUsageMonthlyCharges":true,"prorateUsageWeeklyCharges":true,"prorationUnit":"ProrateByDay","rateUsageIndividually":true,"recurringChargeStyle":"Advanced","takeContactSnapshot":true,"taxAddressOwner":"SubscriptionOwner","taxInclusiveRoundingRule":"RoundingNetAmount","taxRateChangeOption":"OneTaxItem","timeOfDailyInvoice":0,"transactionOnSubscription":true,"zuoraTaxRoundingDiffDispersion":false},"status":"200 OK"},"url":"/billing-rules"},{"children":[],"id":"2","method":"GET","response":{"body":{"allowBlankAccountingCodes":true,"allowCreationInClosedPeriod":true,"allowRevenueScheduleNegativeAmounts":true,"allowUsageInClosedPeriod":true,"differentCurrencies":false},"status":"200 OK"},"url":"/accounting-rules"}]},"key":"response","summary":"response","id":"paths/~1settings~1batch-requests/post/responses/200/content/application~1json/examples/response"},"paths/~1settings~1listing/get/responses/200/content/application~1json/examples/response":{"value":{"settings":[{"context":"Entity","description":"Accounting Rules settings","httpOperations":[{"method":"GET","parameters":[],"responseType":{},"url":"/settings/accounting-rules"},{"method":"PUT","parameters":[],"requestType":{},"responseType":{},"url":"/settings/accounting-rules"}],"key":"AccountingRules","pathPattern":"/accounting-rules"}]},"key":"response","summary":"response","id":"paths/~1settings~1listing/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1files~1{file-id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1files~1{file-id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1files~1{file-id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1files~1{file-id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1files~1{file-id}~1restore/put/responses/200/content/application~1json/examples/response":{"value":{"success":true,"fileId":"402881888e89748b018e897a6a500025","status":"RESTORE_IN_PROGRESS"},"key":"response","summary":"response","id":"paths/~1v1~1files~1{file-id}~1restore/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1files~1{file-id}~1restore/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1files~1{file-id}~1restore/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1files~1{file-id}~1restore/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1files~1{file-id}~1restore/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1files~1{file-id}~1status/get/responses/200/content/application~1json/examples/response":{"value":{"success":true,"accessible":true,"status":"RESTORED"},"key":"response","summary":"response","id":"paths/~1v1~1files~1{file-id}~1status/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1files~1{file-id}~1status/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1files~1{file-id}~1status/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1files~1{file-id}~1status/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1files~1{file-id}~1status/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1object~1import/post/responses/200/content/application~1json/examples/response":{"value":{"Id":"2c92c0f8601fab5701601fee2bf67056","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1import/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1import/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1import/post/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1import~1{id}/get/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1import~1{id}/get/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1import~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"done":true,"records":{},"size":0},"key":"response","summary":"response","id":"paths/~1v1~1object~1import~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/200/content/application~1json/examples/response":{"value":{"inverse":false,"rateSetName":"RateSet_EU","rates":{"2019-04-28":{"GBP":1.135239621,"USD":0.889028445,"providerExchangeRateDate":"2019-04-28"},"2019-04-29":{"GBP":1.134623962,"USD":0.892140244,"providerExchangeRateDate":"2019-04-29"},"2019-04-30":{"GBP":1.134589832,"USD":0.892243287,"providerExchangeRateDate":"2019-04-30"}},"success":true},"key":"response","summary":"response","id":"paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1custom-exchange-rates~1{currency}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1attachments/post/responses/200/content/application~1json/examples/response":{"value":{"fileId":"402880ea536ff494015372a7ea12001e","id":"402880ea536ff494015372a7ea17001f","success":true},"key":"response","summary":"response","id":"paths/~1v1~1attachments/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1attachments/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1attachments/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1attachments/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1attachments/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{attachment-id}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{attachment-id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{attachment-id}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{attachment-id}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{attachment-id}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{attachment-id}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{attachment-id}/get/responses/200/content/application~1json/examples/response":{"value":{"createdBy":"4028e487327fd45a0132829ebb673ff9","createdOn":"2016-05-02 13:09:17","description":"","fileContentType":"text/plain","fileId":"8a8083e1545b706a01547316d9094400","fileName":"AttachTest.txt","id":"8a8083e1545b706a01547316d93f4401","success":true,"updatedBy":"4028e487327fd45a0132829ebb673ff9","updatedOn":"2016-05-02 13:09:17"},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{attachment-id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{attachment-id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{attachment-id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{attachment-id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{attachment-id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{attachment-id}/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{attachment-id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{attachment-id}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{attachment-id}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{attachment-id}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{attachment-id}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/200/content/application~1json/examples/response":{"value":{"attachments":[{"createdBy":"402881e522cf4f9b0122cf5d82860002","createdOn":"2016-03-21 14:00:47","description":null,"fileContentType":"application/pdf","fileId":"402896b95397c169015397c2ebc50002","fileName":"Search _ Splunk.pdf","id":"402896b95397c169015397c2ebca0003","success":true,"updatedBy":"402881e522cf4f9b0122cf5d82860002","updatedOn":"2016-03-21 14:00:47"},{"createdBy":"4028e487327fd45a0132829ebb673ff9","createdOn":"2016-05-02 13:09:17","description":"","fileContentType":"text/plain","fileId":"8a8083e1545b706a01547316d9094400","fileName":"AttachTest.txt","id":"8a8083e1545b706a01547316d93f4401","updatedBy":"4028e487327fd45a0132829ebb673ff9","updatedOn":"2016-05-02 13:09:17"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1attachments~1{object-type}~1{object-key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1object-metadata/get/responses/200/content/application~1json/examples/dq-context":{"value":[{"objectName":"account","label":"Account","category":"core","supportCustomField":true,"href":"/object-metadata/account?context=DQ"},{"objectName":"subscription","label":"Subscription","category":"core","supportCustomField":true,"href":"/object-metadata/subscription?context=DQ"}],"key":"dq-context","summary":"DQ context","id":"paths/~1object-metadata/get/responses/200/content/application~1json/examples/dq-context"},"paths/~1object-metadata/get/responses/200/content/application~1json/examples/oq-context":{"value":[{"objectName":"contact","label":"Contact","category":"core","supportCustomField":false,"href":"/object-metadata/contact?context=OQ"}],"key":"oq-context","summary":"OQ context","id":"paths/~1object-metadata/get/responses/200/content/application~1json/examples/oq-context"},"paths/~1object-metadata/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"9458f78d-ae13-4a71-87d9-532182c6eb0f"},"id":"paths/~1object-metadata/get/responses/500/content/application~1json/example"},"paths/~1object-metadata/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000001,"message":"Invalid authentication credentials"}],"requestId":"9458f78d-ae13-4a71-87d9-532182c6eb0f"},"id":"paths/~1object-metadata/get/responses/4XX/content/application~1json/example"},"paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/account-dq":{"value":{"$schema":"https://json-schema.org/draft/2020-12/schema,","$id":"https://api.zuora.com/schemas/account,","title":"account","description":"Account object schema","type":"object","x-zuora-context":"OQ","x-zuora-category":"core","x-zuora-support-custom-field":true,"properties":{"accountId":{"type":"string","x-zuora-filterable":true,"x-zuora-sortable":false,"x-zuora-object-key":true},"accountNumber":{"type":"string","maxLength":50,"x-zuora-filterable":true,"x-zuora-sortable":false,"x-zuora-object-key":true},"balance":{"type":"number","description":"Account balance","x-zuora-type":"currency","x-zuora-filterable":true},"billToContactId":{"type":"string","format":"uuid","description":"Bill-to contact reference","x-zuora-type":"zuuid","x-zuora-filterable":true,"x-zuora-relationship":{"object":"Contact","cardinality":"manyToOne","fields":{"BillToContactId":"Id"}}},"createdById":{"type":"string","x-zuora-type":"zuuid","x-zuora-filterable":true,"x-zuora-sortable":false,"x-zuora-object-key":false},"createdDate":{"type":"string","x-zuora-filterable":true,"x-zuora-sortable":false,"x-zuora-object-key":false},"currency":{"type":"string","x-zuora-filterable":true,"x-zuora-sortable":true,"enum":["USD","EUR","GBP"]},"deleted":{"type":"boolean","description":"Unique identifier","x-zuora-filterable":true,"x-zuora-sortable":false,"x-zuora-object-key":false},"description":{"type":"string","maxLength":255,"x-zuora-filterable":true,"x-zuora-sortable":false,"x-zuora-object-key":false},"duration":{"type":"string","maxLength":255,"x-zuora-indexed":true,"x-zuora-object-key":false},"id":{"type":"string","format":"uuid","description":"Unique identifier","readOnly":true,"x-zuora-type":"zuuid","x-zuora-filterable":true,"x-zuora-sortable":false,"x-zuora-object-key":true},"name":{"type":"string","maxLength":255,"description":"Account name","x-zuora-type":"string","x-zuora-filterable":true,"x-zuora-sortable":true},"quantity":{"type":"number","maxLength":16,"x-zuora-filterable":true,"x-zuora-sortable":false,"x-zuora-object-key":false},"rbeStatus":{"type":"string","maxLength":9,"x-zuora-filterable":true,"x-zuora-sortable":false,"x-zuora-object-key":false,"enum":["Importing","Pending","Processed"]},"startDateTime":{"type":"string","x-zuora-filterable":true,"x-zuora-sortable":true,"x-zuora-object-key":false},"status":{"type":"string","x-zuora-filterable":true,"x-zuora-sortable":true,"enum":["Draft","Active","Canceled"]},"uom":{"type":"string","maxLength":50,"x-zuora-filterable":true,"x-zuora-sortable":false,"x-zuora-object-key":false}},"required":["createdById","id","name","startDateTime","uom"],"x-zuora-relationships":[{"object":"Contact","cardinality":"manyToOne","fields":{"BillToContactId":"Id"}}]},"key":"account-dq","summary":"Account schema for DQ context","id":"paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/account-dq"},"paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/invoice-dse":{"value":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.zuora.com/schemas/Invoice","title":"Invoice","description":"Invoice object schema","type":"object","x-zuora-context":"DSE","x-zuora-support-custom-field":true,"properties":{"Id":{"type":"string","description":"Invoice ID","readOnly":true,"x-zuora-type":"string","x-zuora-selectable":true},"AccountId":{"type":"string","description":"Account ID reference","x-zuora-type":"string","x-zuora-selectable":true,"x-zuora-filterable":true,"x-zuora-createable":true},"Amount":{"type":"number","description":"Invoice amount","x-zuora-type":"decimal","x-zuora-selectable":true,"x-zuora-filterable":true},"Status":{"type":"string","enum":["Draft","Posted","Canceled"],"description":"Invoice status","x-zuora-type":"picklist","x-zuora-selectable":true,"x-zuora-filterable":true}},"required":["Id","AccountId"],"x-zuora-relationships":[{"object":"Account","cardinality":"manyToOne","label":"Account","directRelationship":true,"path":"Account"}]},"key":"invoice-dse","summary":"Invoice schema for DSE context","id":"paths/~1object-metadata~1{objectName}/get/responses/200/content/application~1schema+json/examples/invoice-dse"},"paths/~1object-metadata~1{objectName}/get/responses/500/content/application~1json/example":{"value":{"reasons":[{"code":50000060,"message":"An unexpected error occurred. Please try again or reach out to Zuora Support"}],"requestId":"9458f78d-ae13-4a71-87d9-532182c6eb0f"},"id":"paths/~1object-metadata~1{objectName}/get/responses/500/content/application~1json/example"},"paths/~1object-metadata~1{objectName}/get/responses/4XX/content/application~1json/example":{"value":{"reasons":[{"code":50000040,"message":"Object UnknownObject does not exist. Check the name or query /metadata to list available resources."}],"requestId":"9458f78d-ae13-4a71-87d9-532182c6eb0f"},"id":"paths/~1object-metadata~1{objectName}/get/responses/4XX/content/application~1json/example"},"paths/~1v1~1describe~1{object}/get/responses/200/content/text~1xml/example":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?> <object href=\"https://apisandbox-api.zuora.com/rest/api/describe/Account\"> <name>Account</name> <label>Account</label> <fields> <field> <name>AccountNumber</name> <label>Account Number</label> <selectable>true</selectable> <createable>true</createable> <updateable>true</updateable> <filterable>true</filterable> <custom>false</custom> <maxlength></maxlength> <required>false</required> <type>text</type> <contexts> <context>soap</context> <context>export</context> </contexts> </field> </fields> <related-objects> <object href=\"https://apisandbox-api.zuora.com/rest/api/describe/Contact\"> <name>BillToContact</name> <label>Bill To</label> <cardinality>TO_ONE</cardinality> <direct-relationship>true</direct-relationship> <path>Account.BillToContact</path> </object> </related-objects> </object>","id":"paths/~1v1~1describe~1{object}/get/responses/200/content/text~1xml/example"},"paths/~1v1~1describe~1{object}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1describe~1{object}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1object~1product/post/responses/200/content/application~1json/examples/response":{"value":{"Id":"2c93808457d787030157e03246ae5129","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1product/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}],"Success":false},"key":"response","summary":"response","id":"paths/~1v1~1object~1product/post/responses/400/content/application~1json/examples/response"},"paths/~1v1~1object~1product/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product/post/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1product~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"CreatedById":"2c93808457d787030157e02e62af2097","CreatedDate":"2016-10-20T05:42:05.000+02:00","Description":"Create product via API_new","EffectiveEndDate":"2066-10-20","EffectiveStartDate":"1966-10-20","Id":"2c93808457d787030157e02e7be22210","Name":"P_1476934925293_new","SKU":"API-SKU1476934925293","UpdatedById":"2c93808457d787030157e02e62af2097","UpdatedDate":"2016-10-20T05:42:05.000+02:00"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product~1{id}/get/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product~1{id}/get/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1product~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"done":true,"records":{},"size":0},"key":"response","summary":"response","id":"paths/~1v1~1object~1product~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1object~1product~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"Id":"2c93808457d787030157e02e7be22210","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1product~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product~1{id}/put/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product~1{id}/put/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1product~1{id}/delete/responses/200/content/application~1json/examples/response":{"value":{"id":"2c93808457d787030157e02e7a22220e","success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1product~1{id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product~1{id}/delete/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product~1{id}/delete/responses/401/content/application~1json/examples/response"},"paths/~1v1~1catalog~1products/get/responses/200/content/application~1json/examples/response":{"value":{"products":[{"category":"Base Products","description":"","effectiveEndDate":"2020-01-01","effectiveStartDate":"2017-01-01","id":"8a8082c45aa81b51015ad5a2d07d0e89","name":"ABC","productNumber":"PC-00000011","productRatePlans":"https://rest.zuora.com/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan","sku":"SKU-00000987"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1catalog~1products/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1catalog~1products/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1catalog~1products/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1catalog~1products/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1catalog~1products/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1catalog~1products~1{product-key}/get/responses/200/content/application~1json/examples/response":{"value":{"category":"Base Products","description":"","effectiveEndDate":"2020-01-01","effectiveStartDate":"2017-01-01","id":"8a8082c45aa81b51015ad5a2d07d0e89","name":"ABC","productNumber":"PC-00000006","productRatePlans":"https://rest.zuora.com/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan","sku":"SKU-00000987","success":true},"key":"response","summary":"response","id":"paths/~1v1~1catalog~1products~1{product-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1catalog~1products~1{product-key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1catalog~1products~1{product-key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1catalog~1products~1{product-key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1catalog~1products~1{product-key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups/post/responses/200/content/application~1json/examples/response":{"value":{"catalogGroupNumber":"CG-00000001","description":"some description","id":"4028e5ab7f1b600c017f1b7a5e8901d2","name":"test","productRatePlans":[{"description":null,"effectiveEndDate":"2023-02-21","effectiveStartDate":"2022-02-21","grade":1,"id":"4028e5ab7f1b600c017f1b787d5d01cf","name":"222","status":"Active"}],"type":"Grading"},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups/get/responses/200/content/application~1json/examples/response":{"value":{"catalogGroups":[{"catalogGroupNumber":"CG-00000001","description":"some description","id":"4028e5ab7f1b600c017f1b7a5e8901d2","name":"test","productRatePlans":[{"description":null,"effectiveEndDate":"2023-02-21","effectiveStartDate":"2022-02-21","grade":1,"id":"4028e5ab7f1b600c017f1b787d5d01cf","name":"222","status":"Active"}],"type":"Grading"}],"nextPage":false},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/200/content/application~1json/examples/response":{"value":{"catalogGroupNumber":"CG-00000001","description":"some description","id":"4028e5ab7f1b600c017f1b7a5e8901d2","name":"test","productRatePlans":[{"description":null,"effectiveEndDate":"2023-02-21","effectiveStartDate":"2022-02-21","grade":1,"id":"4028e5ab7f1b600c017f1b787d5d01cf","name":"222","status":"Active"}],"type":"Grading"},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups~1{catalog-group-key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/200/content/application~1json/examples/response":{"value":{"catalogGroupNumber":"CG-00000001","description":"some description","id":"4028e5ab7f1b600c017f1b7a5e8901d2","name":"test","productRatePlans":[{"description":null,"effectiveEndDate":"2023-02-21","effectiveStartDate":"2022-02-21","grade":1,"id":"4028e5ab7f1b600c017f1b787d5d01cf","name":"222","status":"Active"}],"type":"Grading"},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups~1{catalog-group-key}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":"true"},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1catalog-groups~1{catalog-group-key}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/200/content/application~1json/examples/response":{"value":{"productRatePlans":[{"description":"","effectiveEndDate":"2020-07-31","effectiveStartDate":"2016-07-01","grade":3,"id":"40289f466464127601646473d6f7000f","name":"New Rate Plan","productRatePlanCharges":[{"applyDiscountTo":null,"billingDay":"DefaultFromCustomer","billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","billingTiming":"IN_ADVANCE","defaultQuantity":null,"description":"","discountClass":null,"discountLevel":null,"endDateCondition":"Subscription_End","financeInformation":{"deferredRevenueAccountingCode":"","deferredRevenueAccountingCodeType":null,"recognizedRevenueAccountingCode":"","recognizedRevenueAccountingCodeType":null},"id":"40289f4664641276016464740dd0001c","listPriceBase":"Per_Billing_Period","model":"FlatFee","name":"New Component","numberOfPeriods":null,"overageCalculationOption":null,"overageUnusedUnitsCreditOption":null,"priceChangeOption":null,"priceIncreasePercentage":null,"pricing":[{"currency":"USD","discountAmount":null,"discountPercentage":null,"includedUnits":null,"overagePrice":null,"price":100,"tiers":null}],"pricingSummary":["USD100"],"productChargeDefinitions":"https://rest.zuora.com/v1/product-charge-definitions?charge=8a80808e8aaf3b0a018aaf3f2beb022b&rateplan=8a80808e8aaf3b0a018aaf3ed4cf021e","productDiscountApplyDetails":[],"productRatePlanChargeNumber":"PRPC-00000001","revRecCode":"","revRecTriggerCondition":"ContractEffectiveDate","revenueRecognitionRuleName":"Recognize upon invoicing","smoothingModel":null,"specificBillingPeriod":null,"specificListPriceBase":null,"taxCode":"","taxMode":null,"taxable":false,"triggerEvent":"ContractEffective","type":"Recurring","unusedIncludedUnitPrice":null,"uom":null,"upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"useDiscountSpecificAccountingCode":null,"useTenantDefaultForPriceChange":null}],"productRatePlanNumber":"PRP-00000001","status":"Active"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1products~1{product-key}~1product-rate-plans/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-rate-plans~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"description":"","effectiveEndDate":"2032-02-01","effectiveStartDate":"2012-02-01","externalIdSourceSystem":"apple","externallyManagedPlanIds":["Apple0001","Apple0002","Google0003"],"grade":3,"id":"402888e67f8b3a68017f8bbb2a06062d","name":"New Rate Plan Change","productRatePlanNumber":"PRP-00000008","status":"Active","success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-rate-plans~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-rate-plans~1{id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-rate-plans~1{id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-rate-plans~1{id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-rate-plans~1{id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"success":true,"productRatePlans":[{"id":"2c989020823f450c01823fef40421eb6","status":"Active","name":"My rate plan - Monthly Basic","description":"","effectiveStartDate":"2024-01-01","effectiveEndDate":"2026-01-01","externalIdSourceSystem":"apple","externallyManagedPlanIds":["zuora-us-monthly-basic"],"productRatePlanNumber":1001}]},"key":"response","summary":"response","id":"paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-rate-plans~1external-id~1{id}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan/post/responses/200/content/application~1json/examples/response":{"value":{"Id":"2c93808457d787030157e0324735512b","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan/post/responses/400/content/application~1json/examples/response":{"value":{"Errors":[{"Code":"INVALID_VALUE","Message":"The account number 123xProxy is invalid."}],"Success":false},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan/post/responses/400/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan/post/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"CreatedById":"2c93808457d787030157e02d84c116d5","CreatedDate":"2016-10-20T05:41:09.000+02:00","Description":"Test create product rateplan via API","EffectiveEndDate":"2066-10-20","EffectiveStartDate":"1966-10-20","Grade":3,"Id":"2c93808457d787030157e02da0d91852","Name":"ProductRatePlan1476934869186_new","ProductId":"2c93808457d787030157e02da0231850","UpdatedById":"2c93808457d787030157e02d84c116d5","UpdatedDate":"2016-10-20T05:41:09.000+02:00"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"done":true,"records":{},"size":0},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"Id":"2c93808457d787030157e02da0d91852","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan~1{id}/put/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/200/content/application~1json/examples/response":{"value":{"id":"2c93808457d787030157e02d9dde184f","success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan~1{id}/delete/responses/401/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions/post/responses/200/content/application~1json/examples/response":{"value":{"id":"2c9890f78aba5c16018ababa00120019","success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions/get/responses/200/content/application~1json/examples/response":{"value":{"productRatePlanDefinitions":[{"id":"2c9890f78b212d76018b218993c9005c","productRatePlanChargeId":"2c9890f78aba5c16018ababa00120019","productRatePlanChargeName":"New Component","productRatePlanChargeNumber":"PRPC-NEW-00000175","productRatePlanId":"2c9890678b1ca909018b1caea5c30000","productRatePlanName":"New Rate Plan2","productRatePlanNumber":"PRP-NEW-00000353"},{"id":"2c9890f78b212d76018b21742683005a","productRatePlanChargeId":"2c9890f78b212d76018b2174263c004a","productRatePlanChargeName":"API_Usage_Tiered-multi","productRatePlanChargeNumber":"PRPC-NEW-00000246","productRatePlanId":"2c9890678b1ca909018b1caea5c30000","productRatePlanName":"New Rate Plan2","productRatePlanNumber":"PRP-NEW-00000353"}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"2c9890f78b212d76018b21937228005d","productRatePlanChargeId":"2c9890e489f227bd0189f22f3482001f","productRatePlanChargeName":"Per Unit","productRatePlanChargeNumber":null,"productRatePlanId":"2c9890678b1ca909018b1caea5c30000","productRatePlanName":"New Rate Plan2","productRatePlanNumber":"PRP-NEW-00000353","success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-rateplan-definitions~1{product-rateplan-definition-key}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"edca018c566983fa11f6d38381b10000","name":"Attribute based pricing charge with formula","type":"Recurring","model":"FlatFee","uom":null,"pricingSummary":["USD60"],"pricing":[{"currency":"USD","price":60,"tiers":null,"includedUnits":null,"overagePrice":null,"discountPercentage":null,"discountAmount":null}],"defaultQuantity":null,"applyDiscountTo":null,"discountLevel":null,"discountClass":null,"applyToBillingPeriodPartially":false,"productDiscountApplyDetails":[],"endDateCondition":"Subscription_End","upToPeriods":null,"upToPeriodsType":null,"billingDay":"DefaultFromCustomer","listPriceBase":"Per_Billing_Period","specificListPriceBase":null,"billingTiming":"IN_ADVANCE","ratingGroup":null,"billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","specificBillingPeriod":null,"smoothingModel":null,"numberOfPeriods":null,"overageCalculationOption":null,"overageUnusedUnitsCreditOption":null,"unusedIncludedUnitPrice":null,"usageRecordRatingOption":null,"priceChangeOption":null,"priceIncreasePercentage":null,"useTenantDefaultForPriceChange":true,"taxable":false,"taxCode":"","taxMode":null,"isPrepaid":false,"prepaidOperationType":null,"prepaidUom":null,"prepaidQuantity":null,"prepaidTotalQuantity":null,"validityPeriodType":"SUBSCRIPTION_TERM","validityPeriodAlignment":"ChargeStart","validityPeriodProrationOption":"ProrateUnits","specificValidityPeriodLength":12,"drawdownRate":null,"drawdownUom":null,"drawdownPriority":1,"creditOption":"TimeBased","isRollover":false,"rolloverPeriods":0,"rolloverPeriodLength":0,"rolloverPeriodType":"Month","rolloverFundPriority":1,"rolloverEndDateType":"ChargeEndDate","fundSupportAccountHierarchy":true,"rolloverApply":"ApplyLast","triggerEvent":"ContractEffective","description":"","revRecCode":null,"revRecTriggerCondition":null,"revenueRecognitionRuleName":"Recognize upon invoicing","useDiscountSpecificAccountingCode":null,"excludeItemBookingFromRevenueAccounting":false,"excludeItemBillingFromRevenueAccounting":false,"financeInformation":{"deferredRevenueAccountingCode":"","deferredRevenueAccountingCodeType":null,"recognizedRevenueAccountingCode":"","recognizedRevenueAccountingCodeType":null,"accountsReceivableAccountingCode":"Accounts Receivable","accountsReceivableAccountingCodeType":"AccountsReceivable","contractAssetAccountingCode":null,"contractAssetAccountingCodeType":null,"contractLiabilityAccountingCode":null,"contractLiabilityAccountingCodeType":null,"adjustmentLiabilityAccountingCode":null,"adjustmentLiabilityAccountingCodeType":null,"unbilledReceivablesAccountingCode":null,"unbilledReceivablesAccountingCodeType":null,"adjustmentRevenueAccountingCode":null,"adjustmentRevenueAccountingCodeType":null,"contractRecognizedRevenueAccountingCode":null,"contractRecognizedRevenueAccountingCodeType":null},"deliverySchedule":null,"isStackedDiscount":false,"productRatePlanChargeNumber":null,"formula":"lookup(\"soldToRegion__c\" = fieldLookup(\"subscription\", \"soldToRegion__c\"))","productChargeDefinitions":"https://rest-staging2.zuora.com/apps/v1/product-charge-definitions?charge=edca018c566983fa11f6d38381b10000","success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-rate-plan-charges~1{product-rate-plan-charge-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/valid_per_specific_months":{"value":{"Name":"Maximum Specific List Price Base Charge","Description":"Charge with maximum specific list price base","ChargeModel":"Flat Fee Pricing","ChargeType":"Recurring","ProductRatePlanId":"{YourProductRatePlanId}","BillCycleType":"DefaultFromCustomer","BillingPeriod":"Month","TriggerEvent":"ContractEffective","ListPriceBase":"Per Specific Months","SpecificListPriceBase":120,"ProductRatePlanChargeTierData":{"ProductRatePlanChargeTier":[{"Price":99.99}]},"UseDiscountSpecificAccountingCode":false},"key":"valid_per_specific_months","summary":"SpecificListPriceBase at upper bound example","id":"paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/valid_per_specific_months"},"paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/prepaid_charge":{"value":{"Name":"Prepaid charge","Description":"Unit-based prepaid charge","ChargeModel":"Per Unit Pricing","ChargeType":"Recurring","ProductRatePlanId":"{YourProductRatePlanId}","BillCycleType":"DefaultFromCustomer","BillingPeriod":"Month","TriggerEvent":"ContractEffective","UOM":"Each","DefaultQuantity":10,"ChargeFunction":"Prepayment","PrepaymentUnitType":"UNIT","DrawdownScope":"ACCOUNT","IsPrepaid":true,"PrepaidOperationType":"topup","PrepaidUom":"Each","PrepaidQuantity":10,"ProductRatePlanChargeTierData":{"ProductRatePlanChargeTier":[{"Price":10}]},"UseDiscountSpecificAccountingCode":false,"CreditOption":"FullCreditBack","IsRollover":true,"RolloverApply":"ApplyFirst","RolloverPeriodLength":6,"RolloverPeriods":1,"ValidityPeriodType":"SPECIFIC_MONTHS","SpecificValidityPeriodLength":12,"ValidityPeriodAlignment":"TermStart","ValidityPeriodProrationOption":"ProrateUnits","RolloverPeriodType":"Quarter","RolloverFundPriority":2,"RolloverEndDateType":"ChargeEndDate","FundSupportAccountHierarchy":true,"DrawdownPriority":5},"key":"prepaid_charge","summary":"Create a unit-based prepaid charge","id":"paths/~1v1~1object~1product-rate-plan-charge/post/requestBody/content/application~1json/examples/prepaid_charge"},"paths/~1v1~1object~1product-rate-plan-charge/post/responses/200/content/application~1json/examples/response":{"value":{"Id":"2c93808457d787030157e03197714910","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge/post/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge/post/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"AccountingCode":"name_1476935155610","BillCycleDay":1,"BillCycleType":"DefaultFromCustomer","BillingPeriod":"Month","BillingPeriodAlignment":"AlignToCharge","BillingTiming":"In Advance","ChargeModel":"Flat Fee Pricing","ChargeType":"Recurring","ChargeFunction":"Prepayment","CommitmentType":"UNIT","IsPrepaid":true,"PrepaidOperationType":"topup","PrepaidQuantity":10,"PrepaidTotalQuantity":10,"PrepaidUom":"Each","ValidityPeriodType":"MONTH","DrawdownRate":null,"DrawdownUom":null,"CreditOption":"TimeBased","IsRollover":true,"RolloverApply":"ApplyFirst","RolloverPeriodLength":6,"RolloverPeriods":1,"CreatedById":"2c93808457d787030157e031dd264c85","CreatedDate":"2016-10-20T05:45:55.000+02:00","DefaultQuantity":1,"DeferredRevenueAccount":"name_1476935155610","Description":"Recurring Flat Fee Pricing","EndDateCondition":"SubscriptionEnd","Id":"2c93808457d787030157e032002b4e21","IncludedUnits":0,"LegacyRevenueReporting":false,"ListPriceBase":"Per Billing Period","Name":"Recurring_Flat Fee Pricing1476935155610","NumberOfPeriod":1,"OverageCalculationOption":"EndOfSmoothingPeriod","OverageUnusedUnitsCreditOption":"NoCredit","PriceChangeOption":"NoChange","PriceIncreasePercentage":0,"ProductRatePlanId":"2c93808457d787030157e031ff054e1e","RecognizedRevenueAccount":"name_1476935155610","RevenueRecognitionRuleName":"Recognize upon invoicing","Taxable":false,"TriggerEvent":"ContractEffective","UpToPeriodsType":"Billing Periods","ValidityPeriodAlignment":"ChargeStart","ValidityPeriodProrationOption":"ProrateUnits","SpecificValidityPeriodLength":12,"RolloverPeriodType":"Month","RolloverFundPriority":1,"RolloverEndDateType":"ChargeEndDate","FundSupportAccountHierarchy":true,"DrawdownPriority":1,"UpdatedById":"2c93808457d787030157e031dd264c85","UpdatedDate":"2016-10-20T05:45:55.000+02:00","UseTenantDefaultForPriceChange":true,"Formula":""},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"done":true,"records":{},"size":0},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"Id":"2c93808457d787030157e03197714910","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/404/content/application~1json/examples/response":{"value":{"done":true,"records":{},"size":0},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge~1{id}/put/responses/404/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/200/content/application~1json/examples/response":{"value":{"id":"2c93808457d787030157e031fcd34e19","success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge~1{id}/delete/responses/401/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions/post/responses/200/content/application~1json/examples/response":{"value":{"chargeDefinitionId":"8a90988c8b177a24018b17857411002a","chargeDefinitionNumber":"CD-00002089","success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions/get/responses/200/content/application~1json/examples/response":{"value":{"chargeDefinitions":[{"applyDiscountTo":null,"billingDay":"DefaultFromCustomer","billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","billingTiming":"IN_ADVANCE","chargeModel":"FlatFee","defaultQuantity":1,"deliverySchedule":null,"description":"","discountClass":null,"discountLevel":null,"effectiveEndDate":"2023-10-13 09:00:00","effectiveStartDate":"2022-10-07 09:00:00","endDateCondition":"Subscription_End","financeInformation":{"accountsReceivableAccountingCode":null,"accountsReceivableAccountingCodeType":null,"deferredRevenueAccountingCode":"","deferredRevenueAccountingCodeType":null,"recognizedRevenueAccountingCode":"","recognizedRevenueAccountingCodeType":null},"isDefault":true,"isStackedDiscount":false,"listPriceBase":"Per_Billing_Period","numberOfPeriods":null,"overageCalculationOption":null,"overageUnusedUnitsCreditOption":null,"priceChangeOption":null,"priceIncreasePercentage":null,"prices":[{"currency":"EUR","price":10},{"currency":"JPY","price":20},{"currency":"USD","price":25}],"productChargeDefinitionId":"2c9890f78b0d09d2018b0d13c7fd0004","productChargeDefinitionNumber":"CD-00000201","productDiscountApplyDetails":[],"productRatePlanChargeId":"2c9890f78b0d09d2018b0d13c7fd0004","productRatePlanChargeNumber":null,"productRatePlanId":null,"productRatePlanName":null,"productRatePlanNumber":null,"ratingGroup":null,"revRecCode":null,"revRecTriggerCondition":null,"revenueRecognitionRuleName":"Recognize upon invoicing","smoothingModel":null,"specificBillingPeriod":null,"specificListPriceBase":null,"taxCode":"","taxMode":null,"taxable":false,"term":null,"termPeriodType":null,"termType":null,"triggerEvent":"ContractEffective","uom":null,"upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"useDiscountSpecificAccountingCode":null,"useTenantDefaultForPriceChange":true}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1bulk/post/responses/200/content/application~1json/examples/response":{"value":{"summary":{"successCount":1,"failureCount":0,"failures":[]},"results":[{"chargeDefinitionId":"8a9084f99325571d01932a15d64a3a1b","chargeDefinitionNumber":"CD-00052014","success":true}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1bulk/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1bulk/post/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1bulk/post/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1bulk/post/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1bulk/post/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1bulk/put/responses/200/content/application~1json/examples/response":{"value":{"chargeDefinitions":[{"applyDiscountTo":null,"billingDay":"DefaultFromCustomer","billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","billingTiming":"IN_ADVANCE","chargeModel":"FlatFee","defaultQuantity":1,"deliverySchedule":null,"description":"","discountClass":null,"discountLevel":null,"endDateCondition":"Subscription_End","financeInformation":{"accountsReceivableAccountingCode":null,"accountsReceivableAccountingCodeType":null,"deferredRevenueAccountingCode":"","deferredRevenueAccountingCodeType":null,"recognizedRevenueAccountingCode":"","recognizedRevenueAccountingCodeType":null},"isDefault":true,"isStackedDiscount":false,"listPriceBase":"Per_Billing_Period","numberOfPeriods":null,"overageCalculationOption":null,"overageUnusedUnitsCreditOption":null,"priceChangeOption":null,"priceIncreasePercentage":null,"prices":[{"currency":"EUR","price":10},{"currency":"JPY","price":20},{"currency":"USD","price":25}],"productChargeDefinitionId":"2c9890f78b0d09d2018b0d13c7fd0004","productChargeDefinitionNumber":"CD-00000201","productDiscountApplyDetails":[],"productRatePlanChargeId":"2c9890f78b0d09d2018b0d13c7fd0004","productRatePlanChargeNumber":null,"productRatePlanId":null,"productRatePlanName":null,"productRatePlanNumber":null,"ratingGroup":null,"revRecCode":null,"revRecTriggerCondition":null,"revenueRecognitionRuleName":"Recognize upon invoicing","smoothingModel":null,"specificBillingPeriod":null,"specificListPriceBase":null,"taxCode":"","taxMode":null,"taxable":false,"term":null,"termPeriodType":null,"termType":null,"triggerEvent":"ContractEffective","uom":null,"upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"useDiscountSpecificAccountingCode":null,"useTenantDefaultForPriceChange":true}],"success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1bulk/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1bulk/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1bulk/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1bulk/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1bulk/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/200/content/application~1json/examples/response":{"value":{"applyDiscountTo":null,"billingDay":"DefaultFromCustomer","billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","billingTiming":"IN_ADVANCE","chargeModel":"FlatFee","defaultQuantity":1,"deliverySchedule":null,"description":"","discountClass":null,"discountLevel":null,"effectiveEndDate":"2023-10-13 09:00:00","effectiveStartDate":"2022-10-07 09:00:00","endDateCondition":"Subscription_End","financeInformation":{"accountsReceivableAccountingCode":null,"accountsReceivableAccountingCodeType":null,"deferredRevenueAccountingCode":"","deferredRevenueAccountingCodeType":null,"recognizedRevenueAccountingCode":"","recognizedRevenueAccountingCodeType":null},"isDefault":true,"isStackedDiscount":false,"listPriceBase":"Per_Billing_Period","numberOfPeriods":null,"overageCalculationOption":null,"overageUnusedUnitsCreditOption":null,"priceChangeOption":null,"priceIncreasePercentage":null,"prices":[{"currency":"EUR","price":10},{"currency":"JPY","price":20},{"currency":"USD","price":25}],"productChargeDefinitionId":"2c9890f78b0d09d2018b0d13c7fd0004","productChargeDefinitionNumber":"CD-00000201","productDiscountApplyDetails":[],"productRatePlanChargeId":"2c9890f78b0d09d2018b0d13c7fd0004","productRatePlanChargeNumber":null,"productRatePlanId":null,"productRatePlanName":null,"productRatePlanNumber":null,"ratingGroup":null,"revRecCode":null,"revRecTriggerCondition":null,"revenueRecognitionRuleName":"Recognize upon invoicing","smoothingModel":null,"specificBillingPeriod":null,"specificListPriceBase":null,"success":true,"taxCode":"","taxMode":null,"taxable":false,"term":null,"termPeriodType":null,"termType":null,"triggerEvent":"ContractEffective","uom":null,"upToPeriods":null,"upToPeriodsType":null,"usageRecordRatingOption":null,"useDiscountSpecificAccountingCode":null,"useTenantDefaultForPriceChange":true},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/get/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/200/content/application~1json/examples/response":{"value":{"applyDiscountTo":null,"billingPeriod":"Month","billingPeriodAlignment":"AlignToCharge","billingTiming":"IN_ADVANCE","chargeModel":"FlatFee","defaultQuantity":1,"discountClass":null,"discountLevel":null,"effectiveEndDate":"2023-10-13 09:00:00","effectiveStartDate":"2022-10-07 09:00:00","isDefault":true,"listPriceBase":"Per_Billing_Period","numberOfPeriods":null,"prices":[{"currency":"USD","price":20}],"productChargeDefinitionId":"2c9890f78b0d09d2018b0d13c7fd0004","productChargeDefinitionNumber":"CD-00000201","productRatePlanChargeId":"2c9890f78b0d09d2018b0d13c7fd0004","productRatePlanChargeNumber":null,"productRatePlanId":null,"productRatePlanName":null,"productRatePlanNumber":null,"ratingGroup":null,"smoothingModel":null,"specificBillingPeriod":null,"specificListPriceBase":null,"success":true,"taxCode":"","taxMode":null,"taxable":false,"term":null,"termPeriodType":null,"termType":null,"uom":null},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/put/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/500/content/application~1json/examples/response"},"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1product-charge-definitions~1{product-charge-definition-key}/delete/responses/4XX/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"CreatedById":"2c93808457d787030157e02fd0f132a4","CreatedDate":"2016-10-20T05:43:38.000+02:00","Currency":"USD","EndingUnit":0,"Id":"2c93808457d787030157e02fe725341f","Price":30,"PriceFormat":"Flat Fee","StartingUnit":0,"Tier":1,"UpdatedById":"2c93808457d787030157e02fd0f132a4","UpdatedDate":"2016-10-20T05:43:38.000+02:00"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/401/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/404/content/application~1json/examples/response":{"value":{"done":true,"records":{},"size":0},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/get/responses/404/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/200/content/application~1json/examples/response":{"value":{"Id":"2c92c0f86c85891e016c88d55a6e543b","Success":true},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/401/content/application~1json/examples/response":{"value":{"message":"Authentication error"},"key":"response","summary":"response","id":"paths/~1v1~1object~1product-rate-plan-charge-tier~1{id}/put/responses/401/content/application~1json/examples/response"},"paths/~1v1~1revpro-accounting-codes/put/responses/200/content/application~1json/examples/response":{"value":{"success":true},"key":"response","summary":"response","id":"paths/~1v1~1revpro-accounting-codes/put/responses/200/content/application~1json/examples/response"},"paths/~1v1~1revpro-accounting-codes/put/responses/500/content/application~1json/examples/response":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"response","summary":"response","id":"paths/~1v1~1revpro-accounting-codes/put/responses/500/content/application~1json/examples/response"},"paths/~1v1~1revpro-accounting-codes/put/responses/4XX/content/application~1json/examples/response":{"value":{"processId":"738CBB9234B47A47","reasons":[{"code":"58730222","message":"orderDate may not be null"}],"requestId":"d7479cf6-b410-4630-b841-268ccd48f0d2","success":false},"key":"response","summary":"response","id":"paths/~1v1~1revpro-accounting-codes/put/responses/4XX/content/application~1json/examples/response"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","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":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]},"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}},"servers":[{"url":"https://rest.test.zuora.com"},{"url":"https://rest.sandbox.na.zuora.com","description":"US API Sandbox Cloud 1"},{"url":"https://rest.apisandbox.zuora.com","description":"US API Sandbox Cloud 2"},{"url":"https://rest.na.zuora.com","description":"US Production Cloud 1"},{"url":"https://rest.zuora.com","description":"US Production Cloud 2"},{"url":"https://rest.test.eu.zuora.com"},{"url":"https://rest.sandbox.eu.zuora.com","description":"EU API Sandbox"},{"url":"https://rest.eu.zuora.com","description":"EU Production"},{"url":"https://rest.test.ap.zuora.com"},{"url":"https://rest.ap.zuora.com","description":"APAC Production"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"Payload","label":"Payload"},{"lang":"curl","label":"cURL"}]},"mockServer":{"url":"/_mock/v1-api-reference/api","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/v1-api-reference/api.json?download"},{"url":"/_bundle/v1-api-reference/api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"API Reference","description":"\n\nWelcome to the v1 API reference for the Zuora Billing, Payments, and Platform!\n\nIf you are new to the Zuora API, start with our [Get started](https://developer.zuora.com/docs/get-started/introduction) guide to make your first call. \nTo learn about the common use cases of the Zuora v1 API, check out the [API Tutorials](https://developer.zuora.com/docs/get-started/tutorials/).\n\n\n**Important**: This API Reference only showcases the parameters, fields, and behaviors available for the latest API minor version (`2025-08-12`). \nFor more information about Zuora API versions, see [API versions](https://developer.zuora.com/v1-api-reference/api-versions/) and [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n\n\nWe recommend that you upgrade to the latest API version to take advantage of the latest Zuora capabilities. \nFor instructions about upgrading the API version, see [API upgrade guide](https://developer.zuora.com/v1-api-reference/api-upgrade-guide/).\n\nTry the v1 API in our Postman collection:\n\n  \n<a href=\"https://god.gw.postman.com/run-collection/931729-e324e9d4-9443-4759-8862-a25aa186dbbd?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D931729-e324e9d4-9443-4759-8862-a25aa186dbbd%26entityType%3Dcollection%26workspaceId%3D96800895-4ec5-4a21-af99-d701ba81924e\"><img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In Postman\" style=\"width: 128px; height: 32px;\"></a>\n\n\nSome of our older APIs are no longer recommended but still available, not\naffecting any existing integration. To find related API documentation, see\n[Older API\nReference](https://developer.zuora.com/v1-api-reference/older-api/overview/).\n\nThe 4-byte UTF-8 characters are not supported for text fields, such as the account names or bill-to contacts' first and last names.\n\n### More OpenAPI specification options\n\nTo support your integration with our OpenAPI specifications, whether using in-house solutions or third-party tools, we provide the following resources:\n\n- **Order-to-Cash operations (detailed)**: Download <a href=\"https://developer.zuora.com/yaml/apis/zuora-openapi-for-otc.yaml\" download>Order-to-Cash OpenAPI spec</a>, which includes full descriptions and examples\n- **Order-to-Cash operations (compact)**: Download <a href=\"https://developer.zuora.com/yaml/apis/zuora-openapi-for-otc-compact.yaml\" download>Order-to-Cash Compact OpenAPI spec</a>, which excludes descriptions and code examples.\n- **Full OpenAPI spec (compact)**: Download <a href=\"https://developer.zuora.com/yaml/apis/zuora-openapi-full-compact.yaml\" download>Compact OpenAPI Spec</a>, which covers the entire API set without descriptions or samples.\n  \nIf you need a different API specification beyond the options above, contact <a href=\"https://support.zuora.com\" target=\"_blank\">Zuora Global Support</a>, and we will provide a custom spec tailored to your needs.\n"}},"baseSlug":"/v1-api-reference/api","routesMapping":{}}